class QTableWidgetItem#

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

Synopsis#

Methods#

Virtual methods#

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 .

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.

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

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:
  • iconQIcon

  • text – str

  • type – int

Constructs a table item with the given icon and text.

See also

type()

__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__(other)
Parameters:

otherQTableWidgetItem

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

This function is useful when reimplementing clone() .

See also

data() flags()

background()#
Return type:

QBrush

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

checkState()#
Return type:

CheckState

Returns the checked state of the table item.

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).

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:

otherQTableWidgetItem

Return type:

bool

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

read(in)#
Parameters:

inQDataStream

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:

brushQBrush

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.

setCheckState(state)#
Parameters:

stateCheckState

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.

See also

data()

setFlags(flags)#
Parameters:

flags – Combination of ItemFlag

Sets the flags for the item to the given flags. These determine whether the item can be selected or modified.

See also

flags()

setFont(font)#
Parameters:

fontQFont

Sets the font used to display the item’s text to the given font.

setForeground(brush)#
Parameters:

brushQBrush

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

setIcon(icon)#
Parameters:

iconQIcon

Sets the item’s icon to the icon specified.

setSelected(select)#
Parameters:

select – bool

Sets the selected state of the item to select.

See also

isSelected()

setSizeHint(size)#
Parameters:

sizeQSize

Sets the size hint for the table item to be size. If no size hint is set or size is invalid, the item delegate will compute the size hint based on the item data.

See also

sizeHint()

setStatusTip(statusTip)#
Parameters:

statusTip – str

Sets the status tip for the table item to the text specified by statusTip. QTableWidget mouse tracking needs to be enabled for this feature to work.

setText(text)#
Parameters:

text – str

Sets the item’s text to the text specified.

setTextAlignment(alignment)#
Parameters:

alignment – Combination of AlignmentFlag

Sets the text alignment for the item’s text to the alignment specified.

setTextAlignment(alignment)
Parameters:

alignmentAlignmentFlag

setTextAlignment(alignment)
Parameters:

alignment – int

Note

This function is deprecated.

Use the overload that takes a Qt::Alignment argument.

Sets the text alignment for the item’s text to the alignment specified.

See also

textAlignment() Alignment

setToolTip(toolTip)#
Parameters:

toolTip – str

Sets the item’s tooltip to the string specified by toolTip.

setWhatsThis(whatsThis)#
Parameters:

whatsThis – str

Sets the item’s “What’s This?” help to the string specified by whatsThis.

sizeHint()#
Return type:

QSize

Returns the size hint set for the table item.

See also

setSizeHint()

statusTip()#
Return type:

str

Returns the item’s status tip.

See also

setStatusTip()

tableWidget()#
Return type:

QTableWidget

Returns the table widget that contains the item.

text()#
Return type:

str

Returns the item’s text.

See also

setText()

textAlignment()#
Return type:

int

Returns the text alignment for the item’s text.

Note

This function returns an int for historical reasons. It will be corrected to return Qt::Alignment in Qt 7.

See also

Alignment

toolTip()#
Return type:

str

Returns the item’s tooltip.

See also

setToolTip()

type()#
Return type:

int

Returns the type passed to the QTableWidgetItem constructor.

whatsThis()#
Return type:

str

Returns the item’s “What’s This?” help.

See also

setWhatsThis()

write(out)#
Parameters:

outQDataStream

Writes the item to stream out.

See also

read()