Table Widget API

For the objects provided by tables and cells in Qt, CukeTest provides two controls, Table and TableItem. And it provides APIs for manipulating table data around table-related controls, which can be satisfied whether it is obtaining or editing. The type files are as follows:

Table control: Table

Used to describe the object type of the table view control-Table, because it is a view component of Qt, it can change the display effect such as sorting, and it exists as a composite container of cells.

Type Definition

JavaScript
Python
export interface IQTable extends IQtControl {
    getItem(rowIndex: number, columnInndex: number): IQTableItem;
    findItem(text: string): Promise<IQTableItem | null>;
    scrollTo(rowIndex: number, columnIndex:number): Promise<void>;
    scrollToBottom(): Promise<void>;
    cellValue(rowIndex: number, columnNameOrIndex: number | String): Promise<string>;
    setCellValue(rowIndex: number, columnNameOrIndex: number | String, value: String): Promise<void>;
    columnHeaders(): Promise<string[]>;
    data(): Promise<string[][]>;
    rowData(rowIndex: number): Promise<string[]>

    rowCount(): Promise<number>;
    columnCount(): Promise<number>;
}
class QTable(QtControl):
	def columnHeaders() -> List[str]
	def cellValue(rowIndex: int, columnNameOrIndex: Union[str, int]) -> str
	def setCellValue(rowIndex: int, columnNameOrIndex: Union[str, int], value: str) -> None
	def data() -> "List[List[str]]"
	def getItem(rowIndex: int, columnIndex: int) -> "QTableItem"
	def findItem(text: str, options: Optional[FindItemOptional]=None) -> "QTableItem"
	def rowData(rowIndex: int) -> List[str]
	def select(rowIndex: int, columnIndex: int) -> "QTableItem"
	def rowCount() -> int
	def columnCount() -> int
	def scrollToTop() -> None
	def scrollTo(rowIndex: int, columnIndex: int) -> "QTableItem"
	def scrollToBottom() -> None

getItem(rowIndex, colIndex): TableItem

Get the cell object at the specified row and column position.

  • rowIndex: number type, representing the row position index of the target cell, starting from 0 to calculate the position;
  • colIndex: number type, representing the column position index of the target cell, starting from 0 to calculate the position;
  • Return value: TableItem type, which is the automation object of the target cell control type. If the cell corresponding to the row and column position is invalid, the error of 1003: ObjectNotExist will appear after the call.

findItem(text: string): Promise<IQTableItem | null>

Search for the target cell based on the name, and return the automation object of the target cell, or return null if it is not found.

  • text: string type, the content or text of the desired target cell;
  • Return value: Promise<IQTableItem> or Promise<null> type, asynchronously search the target cell in the application, and return null if it is not found.

scrollTo(rowIndex, colIndex): Promise<void>

Scroll to the target index position. If the target location has not been loaded, it will be loaded until the target index location is loaded.

  • rowIndex: number type, representing the row position index of the target cell, starting from 0 to calculate the position;
  • colIndex: number type, representing the column position index of the target cell, starting from 0 to calculate the position;
  • Return value: Asynchronous method that does not return any value.

scrollToBottom(): Promise<void>

Scroll to the bottom of the table.

  • Return value: Asynchronous method that does not return any value.

setCellValue(rowIndex, columnNameOrIndex, value): Promise<void>

Edit the value of the target row and column cell, the column position can also be passed in a string, if you do so, it will look for the corresponding column position in the header.

  • rowIndex: number type, representing the row position index of the target cell, starting from 0 to calculate the position;
  • colNameOrIndex: number type or string type, representing the column position index of the target cell, starting from 0 to calculate the position; you can also pass in the name of the target column in the header, such as "Name", ' ID" or something.
  • value: string type, the expected cell value.
  • Return value: Asynchronous method that does not return any value. If the row and column position exceeds, or the column name passed in does not exist, 1006: OutOfRange will be thrown.

cellValue(rowIndex, columnNameOrIndex): Promise<string>

Get the value of the target row and column cell, which can be understood as the Getter method relative to the setCellValue() method.

  • rowIndex: number type, representing the row position index of the target cell, starting from 0 to calculate the position;
  • colNameOrIndex: number type or string type, representing the column position index of the target cell, starting from 0 to calculate the position; you can also pass in the name of the target column in the header, such as "Name", ' ID" or something.
  • Return value: Promise<string> type, return the result of string type asynchronously, no matter what content is in the target cell. If the row and column position exceeds, or the column name passed in does not exist, 1006: OutOfRange will be thrown.

columnHeaders(): Promise<string[]>

Get the content of the header and return it as a string array.

  • Return value: Promise<string[]> type, asynchronously returns an array of string type, no matter what is in the header.

data(): Promise<string[][]>

Get all the content in the table and return it as a two-dimensional array.

  • Return value: Promise<string[][]> type, which is a two-dimensional string array.

If the table data is as follows:

Student ID Name Gender
0001 Xiao Wang Male
0002 Xiao Ming Male
0003 Little Red Female

Then the array returned by the data() method is as follows:

[
    ['0001','Xiao Wang','Male'],
    ['0002','Xiao Ming','Male'],
    ['0003','Little Red','Female']
]

rowData(rowIndex): Promise<string[]>

Get the data of the target row and return it as a string array.

  • rowIndex: number type, representing the row position index of the target cell, starting from 0 to calculate the position;
  • Return value: Promise<string[]> type, asynchronously returns an array of string type, no matter what is in the target cell. If the row and column position exceeds, or the column name passed in does not exist, 1006: OutOfRange will be thrown.

rowCount(): Promise<number>

Get the number of rows in the table. If the table contains parts that have not been loaded, only the number of rows that have been loaded will be counted.

  • Return value: Promise<number>, return the result of number type asynchronously.

columnCount(): Promise<number>

Get the number of columns in the table. The value is consistent with the length of the array returned by the columnHeaders() method.

  • Return value: Promise<number>, return the result of number type asynchronously.

Cell Control: TableItem

Definition and method for cell control.

Type file definition

JavaScript
Python
export interface IQTableItem extends IQtControl {
    select(): Promise<void>;
    scrollIntoView(): Promise<void>;
    set(value: String): Promise<void>;
    toggleCheck(checkState: boolean | 'partial'): Promise<void>;
    data(roleId?:number): Promise<string|int>;

    value(): Promise<string>;
    editable(): Promise<boolean>;
    selected(): Promise<boolean>;
    rowIndex(): Promise<number>;
    columnIndex(): Promise<number>;
    checkState(): Promise<boolean | 'partial'>;
}
class QTableItem(QItemViewItem):
	def value() -> str
	def select() -> None
	def scrollIntoView() -> None
	def set(value: str) -> None
    def data(roleId: int = None) -> Union[str, int]
	def rowIndex() -> int
	def columnIndex() -> int
	def checkState() -> bool
	def toggleCheck(checkState: bool) -> None

Object manipulation API

The following are the object methods of the TableItem control.

select(): Promise<void>

Select the target cell.

  • Return value: Asynchronous method that does not return any value.

scrollIntoView(): Promise<void>

Scroll to the target cell position.

  • Return value: Asynchronous method that does not return any value.

set(value): Promise<void>

Modify the value of the cell directly.

  • value: string type, the expected cell value.
  • Return value: Asynchronous method that does not return any value.

toggleCheck(checkState: boolean | 'partial'): Promise<void>

Checks or unchecks the checkboxes in the cells.

  • checkState: boolean type or partial string. true means checked, false means unchecked, and "partial" means partially checked (common for checkboxes with sub-options).
  • Return Value: Asynchronous methods that do not return any value.

data(roleId?:number): Promise<string|int>

Pass role, return cell data content, do not pass the use of the default role = DisplayRole

  • Return value: string type or int type data content.

The role value can be referred toenum Qt::ItemDataRole

Get the text data content of the cell:

JavaScript
Python
const { RunSettings } = require("leanpro.common");
const { QtAuto } = require("leanpro.qt");
(async () => {
    await RunSettings.set({slowMo: 1000, reportSteps: true});

    let modelQt = QtAuto.loadModel(__dirname + "/recording.tmodel");

    //Launching a Qt application file "dockwidgets"
    await QtAuto.launchQtProcessAsync("C:\\Program Files\\LeanPro\\CukeTest\\bin/dockwidgets.exe");

    //Waiting for Qt application "dockwidgets"
    await modelQt.getApplication("dockwidgets").exists(10);
    const role = 0
    //Click "34"
    console.log(await modelQt.getTableItem("34").data(role))

    //Click "58"
    console.log(await modelQt.getTableItem("58").data(role))

    //Click "81"
    console.log(await modelQt.getTableItem("81").data(role))

    //Click "42"
    console.log(await modelQt.getTableItem("42").data(role))

    //Click "2"
    console.log(await modelQt.getTableItem("2").data(role))

    //close Window "Dock_Widgets"
    await modelQt.getWindow("Dock_Widgets").close();

    //Close the Qt application "dockwidgets"
    await modelQt.getApplication("dockwidgets").quit();
})();
import os
from leanproAuto import RunSettings, QtAuto

RunSettings.set({"slowMo": 1000, "reportSteps": True})

modelQt = QtAuto.loadModel(os.path.dirname(os.path.realpath(__file__)) + "/recording_2.tmodel")


#Launching a Qt application file "dockwidgets"
QtAuto.launchQtProcessAsync("C:\\Program Files\\LeanPro\\CukeTest\\bin\\dockwidgets.exe")

#Waiting for Qt application "dockwidgets"
modelQt.getApplication("dockwidgets").exists(10)
role = 0

#Click "34"
print(modelQt.getTableItem("34").data(role))

#Click "58"
print(modelQt.getTableItem("58").data(role))

#Click "81"
print(modelQt.getTableItem("81").data(role))

#Click "42"
print(modelQt.getTableItem("42").data(role))

#Click "2"
print(modelQt.getTableItem("2").data(role))

#close Window "Dock_Widgets"
modelQt.getWindow("Dock_Widgets").close()

#Close the Qt application "dockwidgets"
modelQt.getApplication("dockwidgets").quit()

value(): Promise<string>

Modify the value of the cell directly.

  • Return value: string type, the value in the target cell. Check to get the control value of the cell tableItem control.

JavaScript
Python
let value = await model.getTableItem("tableItem").value();
assert.equal(value,'tableItem');
value = model.getTableItem("tableItem").value()
assert value == 'tableItem'

editable(): Promise<boolean>

Whether the cell can be edited, true for editable, false for non-editable.

  • Return value: boolean type, whether the cell is editable or not.

selected(): Promise<boolean>

The cell's selection status, true for selected, false for unselected (collapsed).

  • Return value: boolean type, if or not the cell is selected.

rowIndex(): Promise<number>

Get the row index position of the current cell.

  • Return value: number type, the row index position in the cell.

columnIndex(): Promise<number>

Get the row index position of the current cell.

  • Return value: number type, the column index position in the cell.

checkState(): Promise<boolean | 'partial'>

Get the status of the checkbox in the cell.

  • Return value: boolean type or partial string. true means checked, false means unchecked, "partial" means partially checked (common for checkboxes with sub-options).

header control: HeaderItem

Definitions and methods for table header controls. The usual behavior of clicking on a table header is to select the corresponding row or column.

Not only tables have headers, but some trees also have headers, and the same can be done with this control.

If you just need to get the contents of a table header without actually clicking or manipulating the header, it is recommended that you still use the rowHeaders() and columnHeaders() methods provided by the Table control to retrieve the array of header contents directly.

Type Document Definition

JavaScript
Python
export interface IQHeaderItem extends IQtControl {
    itemIndex(): Promise<number>;
    value(): Promise<string>;
    scrollIntoView(): Promise<void>;
}
class IQHeaderItem(IQtControl):
	def itemIndex() -> int
	def value() -> str

Object Operation API

Here are the object methods for the HeaderItem control.

value(): Promise<string>

Gets the contents of a table header.

  • Return value: string type, the value of the target sheet header.

Check to get the control value of the table header headerItem control.

JavaScript
Python
let value = await model.getHeaderItem("headerItem").value();
assert.equal(value, 'headerItem');
value = model.getHeaderItem("headerItem").value()
assert value == 'headerItem'

itemIndex(): Promise<number>

Gets the index position of the current table header, starting at 0.

  • Return value: number type, the index position of the row in the cell.

Chinese version click here.