Table (hwx.gui)

A Table widget used to display/edit a list of list of values.

Inherits:

Public Methods

addRow (self, *values)
clearSelection (self)
getColumnWidth (self, col=’all’)
getRowHeight (self, row=’all’)
getSelectedRows (self)
getValue (self, row, col)
isSelected (self, row, col)
selectCells (self, row=’all’, col=’all’, select=True, clear=True)
selectRow (self, row, clear=True)
setColumnWidth (self, width, col=’all’)
setRowHeight (self, height=20, row=’all’)
setValues (self, values, rowOrder=False)
unselectCells (self, row=’all’, col=’all’)

Property Details

columnLabels()

The text in the column headers.

numCols()

The number of columns in the table.

numRows()

The number of rows in the table.

readOnly()

Determines whether the cells are readonly or not.

rowLabels()

Text in the row headers.

Method Details

addRow(self, *values)

Appends a row of values.

param values:The values to be set in row of the table
type values:list[list[str]]
clearSelection(self)

Unselects all cells.

getColumnWidth(self, col='all')

Gets the width of the column.

param col:The indices of columns. Defaults to “all”.
type col:str, list[int]
returns:The width of the column.
rtype:int
getRowHeight(self, row='all')

Gets the row height.

param row:A list of indices of rows. Defaults to “all”.
type row:str, list[str]
getSelectedRows(self)

Returns a list of row indicies for all rows that are selected.

getValue(self, row, col)

Gets the value from the specified row and column.

param row:The row index of the table.
type row:int
param col:The column index of the table.
type col:int
returns:The text at the specified row and column.
rtype:str
isSelected(self, row, col)

Returns True if the specified cell is selected, False otherwise.

param row:The index of row.
type row:int
param col:The index of col.
type col:int
selectCells(self, row='all', col='all', select=True, clear=True)

Selects the specified cells.

param row:The indices of rows. Defaults to “all”.
type row:Union[str, list[int]], optional
param col:The indices of columns. Defaults to “all”.
type col:Union[str, list[int]], optional
param select:Determines whether the specified cells will be selected. Defaults to True.
type select:bool, optional
param clear:Determines whether the previously selected will be cleared. Defaults to True.
type clear:bool, optional
selectRow(self, row, clear=True)

Selects all cells of a row and ensures the row is visible.

param row:The row to be selected.
type row:int
param clear:Determines whether the previously selected will be cleared. Defaults to True.
type clear:bool
setColumnWidth(self, width, col='all')

Sets the column width.

param width:The width the column.
type width:int
param col:The indices of columns. Defaults to “all”.
type col:str, list[str]
setRowHeight(self, height=20, row='all')

Sets specific row height.

param height:height to set the rows. Defaults to 20.
type height:int
param row:A list of indices of rows. Defaults to “all”.
type row:str, list[int]
setValues(self, values, rowOrder=False)

Sets the cell text from the list of list of values.

param values:The values to be set in cell of the table
type values:list[list[str]]
param rowOrder:Determines if values will be transposed. Defaults to False.
type rowOrder:bool
unselectCells(self, row='all', col='all')

Deselects the specified cells.

param row:The indices of rows. Defaults to “all”.
type row:Union[str, list[int]], optional
param col:The indices of columns. Defaults to “all”.
type col:Union[str, list[int]], optional