QStandardItem

PyQt5.QtGui.QStandardItem

Description

The QStandardItem class provides an item for use with the QStandardItemModel class.

Items usually contain text, icons, or checkboxes.

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(). Checkable items can be checked and unchecked with the setCheckState() function. The corresponding checkState() function indicates whether the item is currently checked.

You can store application-specific data in an item by calling setData().

Each item can have a two-dimensional table of child items. This makes it possible to build hierarchies of items. The typical hierarchy is the tree, in which case the child table is a table with a single column (a list).

The dimensions of the child table can be set with setRowCount() and setColumnCount(). Items can be positioned in the child table with setChild(). Get a pointer to a child item with child(). New rows and columns of children can also be inserted with insertRow() and insertColumn(), or appended with appendRow() and appendColumn(). When using the append and insert functions, the dimensions of the child table will grow as needed.

An existing row of children can be removed with removeRow() or takeRow(); correspondingly, a column can be removed with removeColumn() or takeColumn().

An item’s children can be sorted by calling sortChildren().

Subclassing

When subclassing QStandardItem to provide custom items, it is possible to define new types for them so that they can be distinguished from the base class. The type() function should be reimplemented to return a new type value equal to or greater than UserType.

Reimplement data() and setData() if you want to perform custom handling of data queries and/or control how an item’s data is represented.

Reimplement clone() if you want QStandardItemModel to be able to create instances of your custom item class on demand (see setItemPrototype()).

Reimplement read() and write() if you want to control how items are represented in their serialized form.

Reimplement operator<() if you want to control the semantics of item comparison. operator<() determines the sorted order when sorting items with sortChildren() or with sort().

See also

QStandardItemModel, Item View Convenience Classes, Model/View Programming.

Enums

ItemType

This enum describes the types that are used to describe standard items.

You can define new user types in QStandardItem subclasses to ensure that custom items are treated specially; for example, when items are sorted.

See also

type().

Member	Value	Description
Type	0	The default type for standard items.
UserType	1000	The minimum value for custom types. Values below are reserved by Qt.

Methods

__init__()

Constructs an item.

---

__init__(str)

Constructs an item with the given text.

---

__init__(QStandardItem)

Constructs a copy of other. Note that model() is not copied.

This function is useful when reimplementing clone().

---

__init__(QIcon, str)

Constructs an item with the given icon and text.

---

__init__(int, columns: int = 1)

Constructs an item with rows rows and columns columns of child items.

---

accessibleDescription() → str

See also

setAccessibleDescription().

---

accessibleText() → str

See also

setAccessibleText().

---

appendColumn(Iterable[QStandardItem])

TODO

---

appendRow(Iterable[QStandardItem])

TODO

---

appendRow(QStandardItem)

TODO

---

appendRows(Iterable[QStandardItem])

TODO

---

background() → QBrush

See also

setBackground().

---

checkState() → CheckState

See also

setCheckState().

---

child(int, column: int = 0) → QStandardItem

Returns the child item at (row, column) if one has been set; otherwise returns 0.

See also

setChild(), takeChild(), parent().

---

clearData()

Removes all the data from all roles previously set.

See also

data(), setData().

---

clone() → QStandardItem

Returns a copy of this item. The item’s children are not copied.

When subclassing QStandardItem, you can reimplement this function to provide QStandardItemModel with a factory that it can use to create new items on demand.

See also

setItemPrototype(), operator=().

---

column() → int

Returns the column where the item is located in its parent’s child table, or -1 if the item has no parent.

See also

row(), parent().

---

columnCount() → int

Returns the number of child item columns that the item has.

See also

setColumnCount(), rowCount().

---

data(role: int = Qt.UserRole+1) → Any

Returns the item’s data for the given role, or an invalid QVariant if there is no data for the role.

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

See also

setData().

---

emitDataChanged()

Causes the model associated with this item to emit a dataChanged() signal for this item.

You normally only need to call this function if you have subclassed QStandardItem and reimplemented data() and/or setData().

See also

setData().

---

flags() → ItemFlags

Returns the item flags for the item.

The item flags determine how the user can interact with the item.

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.

See also

setFlags().

---

font() → QFont

See also

setFont().

---

foreground() → QBrush

See also

setForeground().

---

__ge__(QStandardItem) → bool

TODO

---

hasChildren() → bool

Returns true if this item has any children; otherwise returns false.

See also

rowCount(), columnCount(), child().

---

icon() → QIcon

See also

setIcon().

---

index() → QModelIndex

Returns the QModelIndex associated with this item.

When you need to invoke item functionality in a QModelIndex-based API (e.g. QAbstractItemView), you can call this function to obtain an index that corresponds to the item’s location in the model.

If the item is not associated with a model, an invalid QModelIndex is returned.

See also

model(), itemFromIndex().

---

insertColumn(int, Iterable[QStandardItem])

Inserts a column at column containing items. If necessary, the row count is increased to the size of items.

See also

insertColumns(), insertRow().

---

insertColumns(int, int)

Inserts count columns of child items at column column.

See also

insertColumn(), insertRows().

---

insertRow(int, Iterable[QStandardItem])

Inserts a row at row containing items. If necessary, the column count is increased to the size of items.

See also

insertRows(), insertColumn().

---

insertRow(int, QStandardItem)

TODO

---

insertRows(int, int)

Inserts count rows of child items at row row.

See also

insertRow(), insertColumns().

---

insertRows(int, Iterable[QStandardItem])

Inserts items at row. The column count won’t be changed.

See also

insertRow(), insertColumn().

---

isAutoTristate() → bool

TODO

---

isCheckable() → bool

TODO

---

isDragEnabled() → bool

TODO

---

isDropEnabled() → bool

TODO

---

isEditable() → bool

TODO

---

isEnabled() → bool

TODO

---

isSelectable() → bool

TODO

---

isTristate() → bool

TODO

---

isUserTristate() → bool

TODO

---

__lt__(QStandardItem) → bool

TODO

---

model() → QStandardItemModel

Returns the QStandardItemModel that this item belongs to.

If the item is not a child of another item that belongs to the model, this function returns 0.

See also

index().

---

parent() → QStandardItem

Returns the item’s parent item, or 0 if the item has no parent.

Note: For toplevel items returns 0. To receive toplevel item’s parent use invisibleRootItem() instead.

See also

child(), invisibleRootItem().

---

read(QDataStream)

Reads the item from stream in. Only the data and flags of the item are read, not the child items.

See also

write().

---

removeColumn(int)

Removes the given column. The items that were in the column are deleted.

See also

takeColumn(), removeColumns(), removeRow().

---

removeColumns(int, int)

Removes count columns at column column. The items that were in those columns are deleted.

See also

removeColumn(), removeRows().

---

removeRow(int)

Removes the given row. The items that were in the row are deleted.

See also

takeRow(), removeRows(), removeColumn().

---

removeRows(int, int)

Removes count rows at row row. The items that were in those rows are deleted.

See also

removeRow(), removeColumn().

---

row() → int

Returns the row where the item is located in its parent’s child table, or -1 if the item has no parent.

See also

column(), parent().

---

rowCount() → int

Returns the number of child item rows that the item has.

See also

setRowCount(), columnCount().

---

setAccessibleDescription(str)

See also

accessibleDescription().

---

setAccessibleText(str)

See also

accessibleText().

---

setAutoTristate(bool)

Determines that the item is tristate and controlled by QTreeWidget if tristate is true. This enables automatic management of the state of parent items in QTreeWidget (checked if all children are checked, unchecked if all children are unchecked, or partially checked if only some children are checked).

See also

isAutoTristate(), setCheckable(), setCheckState().

---

setBackground(Union[QBrush, QColor, GlobalColor, QGradient])

See also

background().

---

setCheckable(bool)

Sets whether the item is user-checkable. If checkable is true, the item can be checked by the user; otherwise, the user cannot check the item.

The item delegate will render a checkable item with a check box next to the item’s text.

See also

isCheckable(), setCheckState(), setUserTristate(), setAutoTristate().

---

setCheckState(CheckState)

See also

checkState().

---

setChild(int, QStandardItem)

TODO

---

setChild(int, int, QStandardItem)

Sets the child item at (row, column) to item. This item (the parent item) takes ownership of item. If necessary, the row count and column count are increased to fit the item.

Note: Passing a null pointer as item removes the item.

See also

child().

---

setColumnCount(int)

Sets the number of child item columns to columns. If this is less than columnCount(), the data in the unwanted columns is discarded.

See also

columnCount(), setRowCount().

---

setData(Any, role: int = Qt.UserRole+1)

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

If you subclass QStandardItem and reimplement this function, your reimplementation should call emitDataChanged() if you do not call the base implementation of . This will ensure that e.g. views using the model are notified of the changes.

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

See also

ItemDataRole, data(), setFlags().

---

setDragEnabled(bool)

TODO

---

setDropEnabled(bool)

TODO

---

setEditable(bool)

Sets whether the item is editable. If editable is true, the item can be edited by the user; otherwise, the user cannot edit the item.

How the user can edit items in a view is determined by the view’s edit triggers; see QAbstractItemView::editTriggers.

See also

isEditable(), setFlags().

---

setEnabled(bool)

Sets whether the item is enabled. If enabled is true, the item is enabled, meaning that the user can interact with the item; if enabled is false, the user cannot interact with the item.

This flag takes precedence over the other item flags; e.g. if an item is not enabled, it cannot be selected by the user, even if the ItemIsSelectable flag has been set.

See also

isEnabled(), ItemIsEnabled, setFlags().

---

setFlags(Union[ItemFlags, ItemFlag])

Sets the item flags for the item to flags.

The item flags determine how the user can interact with the item. This is often used to disable an item.

See also

flags(), setData().

---

setFont(QFont)

See also

font().

---

setForeground(Union[QBrush, QColor, GlobalColor, QGradient])

See also

foreground().

---

setIcon(QIcon)

See also

icon().

---

setRowCount(int)

Sets the number of child item rows to rows. If this is less than rowCount(), the data in the unwanted rows is discarded.

See also

rowCount(), setColumnCount().

---

setSelectable(bool)

Sets whether the item is selectable. If selectable is true, the item can be selected by the user; otherwise, the user cannot select the item.

You can control the selection behavior and mode by manipulating their view properties; see QAbstractItemView::selectionMode and QAbstractItemView::selectionBehavior.

See also

isSelectable(), setFlags().

---

setSizeHint(QSize)

See also

sizeHint().

---

setStatusTip(str)

See also

statusTip().

---

setText(str)

See also

text().

---

setTextAlignment(Union[Alignment, AlignmentFlag])

See also

textAlignment().

---

setToolTip(str)

See also

toolTip().

---

setTristate(bool)

TODO

---

setUserTristate(bool)

Sets whether the item is tristate and controlled by the user. If tristate is true, the user can cycle through three separate states; otherwise, the item is checkable with two states. (Note that this also requires that the item is checkable; see isCheckable().)

See also

isUserTristate(), setCheckable(), setCheckState().

---

setWhatsThis(str)

TODO

---

sizeHint() → QSize

See also

setSizeHint().

---

sortChildren(int, order: SortOrder = AscendingOrder)

Sorts the children of the item using the given order, by the values in the given column.

Note: This function is recursive, therefore it sorts the children of the item, its grandchildren, etc.

See also

operator<().

---

statusTip() → str

See also

setStatusTip().

---

takeChild(int, column: int = 0) → QStandardItem

Removes the child item at (row, column) without deleting it, and returns a pointer to the item. If there was no child at the given location, then this function returns 0.

Note that this function, unlike takeRow() and takeColumn(), does not affect the dimensions of the child table.

See also

child(), takeRow(), takeColumn().

---

takeColumn(int) → List[QStandardItem]

Removes column without deleting the column items, and returns a list of pointers to the removed items. For items in the column that have not been set, the corresponding pointers in the list will be 0.

See also

removeColumn(), insertColumn(), takeRow().

---

takeRow(int) → List[QStandardItem]

Removes row without deleting the row items, and returns a list of pointers to the removed items. For items in the row that have not been set, the corresponding pointers in the list will be 0.

See also

removeRow(), insertRow(), takeColumn().

---

text() → str

See also

setText().

---

textAlignment() → Alignment

See also

setTextAlignment().

---

toolTip() → str

See also

setToolTip().

---

type() → int

Returns the type of this item. The type is used to distinguish custom items from the base class. When subclassing QStandardItem, you should reimplement this function and return a new value greater than or equal to UserType.

See also

Type.

---

whatsThis() → str

TODO

---

write(QDataStream)

Writes the item to stream out. Only the data and flags of the item are written, not the child items.

See also

read().