TTkTableModelList

class TTkTableModelList(*, data: list[list[object]] = None, header: list[str] = None, indexes: list[str] = None)

Bases: TTkAbstractTableModel

TTkTableModelList extends TTkAbstractTableModel, including a basic model with a 2d list data structure

Parameters:

• data (list[list]) – the 2D List model for the view to present.

• header (list[str], optional) – the header labels, defaults to the column number.

• indexes (list[str], optional) – the index labels, defaults to the line number.

Signals

dataChanged	This signal is emitted whenever the data in an existing item changes.
modelChanged	This signal is emitted whenever the model changes.

Members

dataChanged: pyTTkSignal

This signal is emitted whenever the data in an existing item changes.

If more items are affected, the pos/size definne the minimum area including all of those changes.

When reimplementing the setData() function, this signal must be emitted explicitly.

Parameters:

• pos (tuple(int,int)) – the topLeft margin of the modified area

• size (tuple(int,int)) – the size of the modified area

modelChanged: pyTTkSignal

This signal is emitted whenever the model changes.

When the model topology changes, this signal must be emitted explicitly.

Methods

columnCount() → int

Returns the number of columns of the current moodel.

Returns:

int

data(row: int, col: int) → Any

Returns the data stored for the item referred to by the row/column.

Note: If you do not have a value to return, return None instead of returning 0.

Parameters:

• row (int) – the row position of the data

• col (int) – the column position of the data

Returns:

object

flags(row: int, col: int) → ItemFlag

Returns the item flags for the given row,column.

The base class implementation returns a combination of flags that enables the item (ItemIsEnabled) and allows it to be selected (ItemIsSelectable).

Parameters:

• row (int) – the row position od the data

• col (int) – the column position of the data

Returns:

TTkConstant.ItemFlag

headerData(num: int, orientation: int)

Returns the data for the given role and section in the header with the specified orientation.

For horizontal headers, the section number corresponds to the column number. Similarly, for vertical headers, the section number corresponds to the row number.

Parameters:

• pos (int) – the position (col or row) of the header

• orientation (TTkConstant.Direction) – the orienttin of the header to be retrieved

Returns:

TTkString

index(row: int, col: int) → TTkModelIndex

Returns the index of the item in the model specified by the given row, column.

Parameters:

• row (int) – the row position of the index

• col (int) – the column position of the index

Returns:

TTkModelIndex

insertColumns(column: int, count: int) → bool

On models that support this, inserts <count> new columns into the model before the given column..

If column is 0, the columns are prepended to any existing columns.

If column is TTkAbstractTableModel.columnCount(), the columns are appended to any existing columns.

If you implement your own model, you can reimplement this function if you want to support insertions. Alternatively, you can provide your own API for altering the data.

Note

The base class implementation (TTkAbstractTableModel) of this function does nothing and returns false.

Parameters:

• column (int) – Starting position of columns to insert (0-based index).

• count (int) – The number of columns to be inserted.

Returns:

true if the columns were successfully inserted; otherwise returns false.

Return type:

bool

insertRows(row: int, count: int) → bool

On models that support this, inserts count rows into the model before the given row.

If row is 0, the rows are prepended to any existing rows in the parent.

If row is TTkAbstractTableModel.rowCount(), the rows are appended to any existing rows in the parent.

If you implement your own model, you can reimplement this function if you want to support insertions. Alternatively, you can provide your own API for altering the data.

Note

The base class implementation (TTkAbstractTableModel) of this function does nothing and returns false.

Parameters:

• row (int) – Starting position of rows to insert (0-based index)

• count (int) – The number of rows to be inserted.

Returns:

true if the rows were successfully inserted; otherwise returns false.

Return type:

bool

modelList() → list[list]

removeColumns(column: int, count: int) → bool

On models that support this, removes count columns starting with the given column.

If you implement your own model, you can reimplement this function if you want to support removing. Alternatively, you can provide your own API for altering the data.

Note

The base class implementation (TTkAbstractTableModel) of this function does nothing and returns false.

Parameters:

• column (int) – Starting position of columns to remove (0-based index)

• count (int) – The number of columns to remove.

Returns:

true if the columns were successfully removed; otherwise returns false.

Return type:

bool

removeRows(row: int, count: int) → bool

On models that support this, removes count rows starting with the given row.

If you implement your own model, you can reimplement this function if you want to support removing. Alternatively, you can provide your own API for altering the data.

Note

The base class implementation (TTkAbstractTableModel) of this function does nothing and returns false.

Parameters:

• row (int) – Starting position of rows to remove (0-based index)

• count (int) – The number of rows to remove.

Returns:

true if the rows were successfully removed; otherwise returns false.

Return type:

bool

rowCount() → int

Returns the number of rows of the current model.

Returns:

int

setData(row: int, col: int, data: object) → None

Returns true if successful; otherwise returns false.

The dataChanged() signal should be emitted if the data was successfully set.

The base class implementation returns false. This function and data() must be reimplemented for editable models.

Parameters:

• row (int) – the row position of the data

• col (int) – the column position of the data

• data (object) – the data to be set in the (row,col) position of the table

Returns:

bool

setModelList(modelList: list[list]) → None

sort(column: int, order: SortOrder) → None

Sorts the model by column in the given order.

Parameters:

• column (int) – The column index to be sorted, if -1 is provided the original unsorted order is used.

• order (TTkConstant.SortOrder) – the sorting order