Class: QgsTableEditorWidget

A reusable widget for editing simple spreadsheet-style tables.

Table content is retrieved and set using the QgsTableContents class. The editor has support for table foreground and background colors, and numeric formats.

Added in version 3.12.

QgsTableEditorWidget

Class Hierarchy

Base classes

QTableWidget
QTableView
QAbstractItemView
QAbstractScrollArea
QFrame
QWidget
QObject
QPaintDevice

class qgis.gui.QgsTableEditorWidget

Bases: QTableWidget

__init__(parent: QWidget | None = None)

Constructor for QgsTableEditorWidget with the specified parent widget.

Parameters:

parent (Optional[QWidget] = None)

signal activeCellChanged

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

canMergeSelection(self) → bool

Returns True if a selection has been made which can be merged.

Added in version 3.40.

Return type:

bool

canSplitSelection(self) → bool

Returns True if a selection has been made which can be split.

Added in version 3.40.

Return type:

bool

clearSelectedCells(self)

Clears the contents of the currently selected cells.

columnsAssociatedWithSelection(self) → List[int]

Returns a list of the columns associated with the current table selected cells.

See also

rowsAssociatedWithSelection()

Return type:

List[int]

deleteColumns(self)

Deletes all columns associated with the current selected cells.

See also

deleteRows()

deleteRows(self)

Deletes all rows associated with the current selected cells.

See also

deleteColumns()

expandColumnSelection(self)

Expands out the selection to include whole columns associated with the current selected cells.

See also

expandRowSelection()

expandRowSelection(self)

Expands out the selection to include whole rows associated with the current selected cells.

See also

expandColumnSelection()

hasMixedSelectionNumericFormat(self) → bool

Returns True if the current selection has a mix of numeric formats.

See also

selectionNumericFormat()

Return type:

bool

insertColumnsAfter(self)

Inserts new columns after the current selection.

See also

insertColumnsBefore()

insertColumnsBefore(self)

Inserts new columns before the current selection.

See also

insertColumnsAfter()

insertRowsAbove(self)

Inserts new rows above the current selection.

See also

insertRowsBelow()

insertRowsBelow(self)

Inserts new rows below the current selection.

See also

insertRowsAbove()

isHeaderCellSelected(self) → bool

Returns True if any header cells are selected.

Return type:

bool

mergeSelectedCells(self)

Merges selected table cells.

See also

splitSelectedCells()

Added in version 3.40.

rowsAssociatedWithSelection(self) → List[int]

Returns a list of the rows associated with the current table selected cells.

See also

columnsAssociatedWithSelection()

Return type:

List[int]

selectionBackgroundColor(self) → QColor

Returns the background color for the currently selected cells.

If the selected cells have a mix of different background colors then an invalid color will be returned.

See also

setSelectionBackgroundColor()

See also

selectionForegroundColor()

Return type:

QColor

selectionCellProperty(self) → QgsProperty

Returns the QgsProperty used for the contents of the currently selected cells.

If the returned value is a default constructed QgsProperty, then the selected cells have a mix of different properties.

Added in version 3.16.

Return type:

QgsProperty

selectionColumnWidth(self) → float

Returns the width (in millimeters) of the columns associated with the current selection, or 0 if an automatic column width is desired.

See also

setSelectionColumnWidth()

Return type:

float

selectionForegroundColor(self) → QColor

Returns the foreground color for the currently selected cells.

If the selected cells have a mix of different foreground colors then an invalid color will be returned.

See also

setSelectionForegroundColor()

See also

selectionBackgroundColor()

Deprecated since version 3.40: Use selectionTextFormat() instead.

Return type:

QColor

selectionHorizontalAlignment(self) → Qt.Alignment

Returns the horizontal alignment for the currently selected cells.

If the returned value contains both horizontal and vertical alignment flags, then the selected cells have a mix of different horizontal alignments.

See also

selectionVerticalAlignment()

Return type:

Qt.Alignment

selectionNumericFormat(self) → QgsNumericFormat | None

Returns the numeric format used for the currently selected cells, or None if the selection has no numeric format set.

If the selected cells have a mix of different formats then None will be returned.

See also

setSelectionNumericFormat()

See also

hasMixedSelectionNumericFormat()

Return type:

Optional[QgsNumericFormat]

selectionRowHeight(self) → float

Returns the height (in millimeters) of the rows associated with the current selection, or 0 if an automatic row height is desired, or -1 if the selection has mixed row heights.

See also

setSelectionRowHeight()

Return type:

float

selectionTextFormat(self) → QgsTextFormat

Returns the text format for the currently selected cells.

Returns an invalid QgsTextFormat if the selection has mixed text format.

Added in version 3.16.

Return type:

QgsTextFormat

selectionVerticalAlignment(self) → Qt.Alignment

Returns the horizontal alignment for the currently selected cells.

If the returned value contains both horizontal and vertical alignment flags, then the selected cells have a mix of different vertical alignments.

See also

selectionVerticalAlignment()

Return type:

Qt.Alignment

setIncludeTableHeader(self, included: bool)

Sets whether the table includes a header row.

Parameters:

included (bool)

setSelectionBackgroundColor(self, color: QColor | Qt.GlobalColor)

Sets the background color for the currently selected cells.

See also

selectionBackgroundColor()

See also

setSelectionForegroundColor()

Parameters:

color (Union[QColor, Qt.GlobalColor])

setSelectionCellProperty(self, property: QgsProperty)

Sets the cell contents QgsProperty for the currently selected cells.

Added in version 3.16.

Parameters:

property (QgsProperty)

setSelectionColumnWidth(self, height: float)

Sets the column width (in millimeters) for the currently selected columns, or 0 for automatic column width.

See also

setSelectionRowHeight()

Parameters:

height (float)

setSelectionForegroundColor(self, color: QColor | Qt.GlobalColor)

Sets the foreground color for the currently selected cells.

See also

selectionForegroundColor()

See also

setSelectionBackgroundColor()

Deprecated since version 3.40: Use setSelectionTextFormat() instead.

Parameters:

color (Union[QColor, Qt.GlobalColor])

setSelectionHorizontalAlignment(self, alignment: Qt.Alignment | Qt.AlignmentFlag)

Sets the horizontal alignment for the currently selected cells.

See also

selectionHorizontalAlignment()

See also

setSelectionVerticalAlignment()

Added in version 3.16.

Parameters:

alignment (Union[Qt.Alignment, Qt.AlignmentFlag])

setSelectionNumericFormat(self, format: QgsNumericFormat | None)

Sets the numeric format to use for the currently selected cells.

Ownership of format is transferred to the widget.

See also

selectionNumericFormat()

Parameters:

format (Optional[QgsNumericFormat])

setSelectionRowHeight(self, height: float)

Sets the row height (in millimeters) for the currently selected rows, or 0 for automatic row height.

See also

setSelectionColumnWidth()

Parameters:

height (float)

setSelectionTextFormat(self, format: QgsTextFormat)

Sets the text format for the selected cells.

Added in version 3.16.

Parameters:

format (QgsTextFormat)

setSelectionVerticalAlignment(self, alignment: Qt.Alignment | Qt.AlignmentFlag)

Sets the vertical alignment for the currently selected cells.

See also

selectionVerticalAlignment()

See also

setSelectionHorizontalAlignment()

Added in version 3.16.

Parameters:

alignment (Union[Qt.Alignment, Qt.AlignmentFlag])

setTableColumnWidth(self, column: int, width: float)

Sets the configured column width for the specified column. Set width to 0 if an automatic width should be used for the column.

This should be called after a call to setTableContents().

See also

tableColumnWidth()

Parameters:

• column (int)

• width (float)

setTableContents(self, contents: Any)

Sets the contents to show in the editor widget.

See also

tableContents()

Parameters:

contents (Any)

setTableHeaders(self, headers: Iterable[Any])

Sets the table headers.

See also

tableHeaders()

Parameters:

headers (Iterable[Any])

setTableRowHeight(self, row: int, height: float)

Sets the configured row height for the specified row. Set height to 0 if an automatic height should be used for the row.

This should be called after a call to setTableContents().

See also

tableRowHeight()

Parameters:

• row (int)

• height (float)

splitSelectedCells(self)

Splits (un-merges) selected table cells.

See also

mergeSelectedCells()

Added in version 3.40.

signal tableChanged

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

tableColumnWidth(self, column: int) → float

Returns the configured column width for the specified column, or 0 if an automatic width should be used for the column.

Parameters:

column (int)

Return type:

float

tableContents(self) → Any

Returns the current contents of the editor widget table.

See also

setTableContents()

Return type:

Any

tableHeaders(self) → List[Any]

Returns the table header values.

See also

setTableHeaders()

Return type:

List[Any]

tableRowHeight(self, row: int) → float

Returns the configured row height for the specified row, or 0 if an automatic height should be used for the row.

Parameters:

row (int)

Return type:

float