PySide6.QtWidgets.QTableWidgetItem¶

class QTableWidgetItem¶

The QTableWidgetItem class provides an item for use with the QTableWidget class. More…

Synopsis¶

Methods¶

def __init__()
def background()
def checkState()
def column()
def flags()
def font()
def foreground()
def icon()
def isSelected()
def row()
def setBackground()
def setCheckState()
def setFlags()
def setFont()
def setForeground()
def setIcon()
def setSelected()
def setSizeHint()
def setStatusTip()
def setText()
def setTextAlignment()
def setToolTip()
def setWhatsThis()
def sizeHint()
def statusTip()
def tableWidget()
def text()
def textAlignment()
def toolTip()
def type()
def whatsThis()

Virtual methods¶

def clone()
def data()
def __lt__()
def read()
def setData()
def write()

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description¶

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

Table items are used to hold pieces of information for table widgets. Items usually contain text, icons, or checkboxes

The QTableWidgetItem class is a convenience class that replaces the QTableItem class in Qt 3. It provides an item for use with the QTableWidget class.

Top-level items are constructed without a parent then inserted at the position specified by a pair of row and column numbers:

newItem = QTableWidgetItem(tr("%1").arg(()
    pow(row, column+1)))
tableWidget.setItem(row, column, newItem)

Each item can have its own background brush which is set with the setBackground() function. The current background brush can be found with background() . The text label for each item can be rendered with its own font and brush. These are specified with the setFont() and setForeground() functions, and read with font() and foreground() .

By default, items are enabled, editable, selectable, checkable, and can be used both as the source of a drag and drop operation and as a drop target. Each item’s flags can be changed by calling setFlags() with the appropriate value (see Qt::ItemFlags). Checkable items can be checked and unchecked with the setCheckState() function. The corresponding checkState() function indicates whether the item is currently checked.

Subclassing¶

When subclassing QTableWidgetItem to provide custom items, it is possible to define new types for them so that they can be distinguished from standard items. The constructors for subclasses that require this feature need to call the base class constructor with a new type value equal to or greater than UserType .

See also

QTableWidget Model/View Programming QListWidgetItem QTreeWidgetItem

class ItemType¶

(inherits enum.IntEnum) This enum describes the types that are used to describe table widget items.

Constant

Description

QTableWidgetItem.Type

The default type for table widget items.

QTableWidgetItem.UserType

The minimum value for custom types. Values below UserType are reserved by Qt.

Constant	Description
QTableWidgetItem.Type	The default type for table widget items.
QTableWidgetItem.UserType	The minimum value for custom types. Values below UserType are reserved by Qt.

You can define new user types in QTableWidgetItem subclasses to ensure that custom items are treated specially.

See also

type()

__init__(other)¶

Parameters:: other – QTableWidgetItem

Constructs a copy of other. Note that type() and tableWidget() are not copied.

This function is useful when reimplementing clone() .

See also

data() flags()

__init__([type=QTableWidgetItem.ItemType.Type])

Parameters:: type – int

Constructs a table item of the specified type that does not belong to any table.

See also

type()

__init__(text[, type=QTableWidgetItem.ItemType.Type])

Parameters:

text – str
type – int

Constructs a table item with the given text.

See also

type()

__init__(icon, text[, type=QTableWidgetItem.ItemType.Type])

Parameters:

icon – QIcon
text – str
type – int

Constructs a table item with the given icon and text.

See also

type()

background()¶

Return type:: QBrush

Returns the brush used to render the item’s background.

See also

setBackground() foreground()

checkState()¶

Return type:: CheckState

Returns the checked state of the table item.

See also

setCheckState() flags()

clone()¶

Return type:: QTableWidgetItem

Creates a copy of the item.

column()¶

Return type:: int

Returns the column of the item in the table. If the item is not in a table, this function will return -1.

See also

row()

data(role)¶

Parameters:: role – int
Return type:: object

Returns the item’s data for the given role.

See also

setData()

flags()¶

Return type:: Combination of ItemFlag

Returns the flags used to describe the item. These determine whether the item can be checked, edited, and selected.

See also

setFlags()

font()¶

Return type:: QFont

Returns the font used to render the item’s text.

See also

setFont()

foreground()¶

Return type:: QBrush

Returns the brush used to render the item’s foreground (e.g. text).

See also

setForeground() background()

icon()¶

Return type:: QIcon

Returns the item’s icon.

See also

setIcon() iconSize

isSelected()¶

Return type:: bool

Returns true if the item is selected, otherwise returns false.

See also

setSelected()

__lt__(other)¶

Parameters:: other – QTableWidgetItem
Return type:: bool

Returns true if the item is less than the other item; otherwise returns false.

read(in)¶

Parameters:: in – QDataStream

Reads the item from stream in.

See also

write()

row()¶

Return type:: int

Returns the row of the item in the table. If the item is not in a table, this function will return -1.

See also

column()

setBackground(brush)¶

Parameters:: brush – QBrush

Sets the item’s background brush to the specified brush. Setting a default-constructed brush will let the view use the default color from the style.

See also

background() setForeground()

setCheckState(state)¶

Parameters:: state – CheckState

Sets the check state of the table item to be state.

See also

checkState()

setData(role, value)¶

Parameters:

role – int
value – object

Sets the item’s data for the given role to the specified value.

Note

The default implementation treats Qt::EditRole and Qt::DisplayRole as referring to the same data.