|  | Home · All Classes · Modules

# QStandardItem Class Reference
[QtGui module]

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

### Types

- enum ItemType { Type, UserType }

### Methods

- __init__ (self)
- __init__ (self, QString text)
- __init__ (self, QIcon icon, QString text)
- __init__ (self, int rows, int columns = 1)
- __init__ (self, QStandardItem other)
- QString accessibleDescription (self)
- QString accessibleText (self)
- appendColumn (self, unknown-type aitems)
- appendRow (self, unknown-type aitems)
- appendRow (self, QStandardItem aitem)
- appendRows (self, unknown-type aitems)
- QBrush background (self)
- Qt.CheckState checkState (self)
- QStandardItem child (self, int row, int column = 0)
- QStandardItem clone (self)
- int column (self)
- int columnCount (self)
- QVariant data (self, int role = Qt.UserRole+1)
- emitDataChanged (self)
- Qt.ItemFlags flags (self)
- QFont font (self)
- QBrush foreground (self)
- bool hasChildren (self)
- QIcon icon (self)
- QModelIndex index (self)
- insertColumn (self, int column, unknown-type items)
- insertColumns (self, int column, int count)
- insertRow (self, int row, unknown-type items)
- insertRow (self, int arow, QStandardItem aitem)
- insertRows (self, int row, int count)
- insertRows (self, int row, unknown-type items)
- bool isCheckable (self)
- bool isDragEnabled (self)
- bool isDropEnabled (self)
- bool isEditable (self)
- bool isEnabled (self)
- bool isSelectable (self)
- bool isTristate (self)
- QStandardItemModel model (self)
- QStandardItem parent (self)
- read (self, QDataStream in)
- removeColumn (self, int column)
- removeColumns (self, int column, int count)
- removeRow (self, int row)
- removeRows (self, int row, int count)
- int row (self)
- int rowCount (self)
- setAccessibleDescription (self, QString aaccessibleDescription)
- setAccessibleText (self, QString aaccessibleText)
- setBackground (self, QBrush abrush)
- setCheckable (self, bool checkable)
- setCheckState (self, Qt.CheckState acheckState)
- setChild (self, int row, int column, QStandardItem item)
- setChild (self, int arow, QStandardItem aitem)
- setColumnCount (self, int columns)
- setData (self, QVariant value, int role = Qt.UserRole+1)
- setDragEnabled (self, bool dragEnabled)
- setDropEnabled (self, bool dropEnabled)
- setEditable (self, bool editable)
- setEnabled (self, bool enabled)
- setFlags (self, Qt.ItemFlags flags)
- setFont (self, QFont afont)
- setForeground (self, QBrush abrush)
- setIcon (self, QIcon aicon)
- setRowCount (self, int rows)
- setSelectable (self, bool selectable)
- setSizeHint (self, QSize asizeHint)
- setStatusTip (self, QString astatusTip)
- setText (self, QString atext)
- setTextAlignment (self, Qt.Alignment atextAlignment)
- setToolTip (self, QString atoolTip)
- setTristate (self, bool tristate)
- setWhatsThis (self, QString awhatsThis)
- QSize sizeHint (self)
- sortChildren (self, int column, Qt.SortOrder order = Qt.AscendingOrder)
- QString statusTip (self)
- QStandardItem takeChild (self, int row, int column = 0)
- unknown-type takeColumn (self, int column)
- unknown-type takeRow (self, int row)
- QString text (self)
- Qt.Alignment textAlignment (self)
- QString toolTip (self)
- int type (self)
- QString whatsThis (self)
- write (self, QDataStream out)

### Special Methods

- bool __ge__ (self, QStandardItem other)
- bool __lt__ (self, QStandardItem other)

## Detailed 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 QStandardItemModel.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 QStandardItemModel.sort().

## Type Documentation

### QStandardItem.ItemType

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

Constant | Value | Description
--- | --- | ---
`QStandardItem.Type` | `0` | The default type for standard items.
`QStandardItem.UserType` | `1000` | The minimum value for custom types. Values below UserType are reserved by Qt.

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

## Method Documentation

### QStandardItem.__init__ (self)

Constructs an item.

### QStandardItem.__init__ (self, QString text)

Constructs an item with the given text.

### QStandardItem.__init__ (self, QIcon icon, QString text)

Constructs an item with the given icon and text.

### QStandardItem.__init__ (self, int rows, int columns = 1)

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

### QStandardItem.__init__ (self, QStandardItem other)

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

This function is useful when reimplementing clone().

### QString QStandardItem.accessibleDescription (self)

Returns the item's accessible description.

The accessible description is used by assistive technologies (i.e. for users who cannot use conventional means of interaction).

See also setAccessibleDescription() and accessibleText().

### QString QStandardItem.accessibleText (self)

Returns the item's accessible text.

The accessible text is used by assistive technologies (i.e. for users who cannot use conventional means of interaction).

See also setAccessibleText() and accessibleDescription().

### QStandardItem.appendColumn (self, unknown-type aitems)

The aitems argument has it's ownership transferred to Qt.

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

See also insertColumn().

### QStandardItem.appendRow (self, unknown-type aitems)

The aitems argument has it's ownership transferred to Qt.

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

See also insertRow().

### QStandardItem.appendRow (self, QStandardItem aitem)

The aitem argument has it's ownership transferred to Qt.

This is an overloaded function.

Appends a row containing item.

When building a list or a tree that has only one column, this function provides a convenient way to append a single new item.

### QStandardItem.appendRows (self, unknown-type aitems)

The aitems argument has it's ownership transferred to Qt.

Appends rows containing items. The column count will not change.

See also insertRow().

### QBrush QStandardItem.background (self)

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

See also foreground() and setBackground().

### Qt.CheckState QStandardItem.checkState (self)

Returns the checked state of the item.

See also setCheckState() and isCheckable().

### QStandardItem QStandardItem.child (self, int row, int column = 0)

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

See also setChild(), takeChild(), and parent().

### QStandardItem QStandardItem.clone (self)

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 QStandardItemModel.setItemPrototype() and operator=().

### int QStandardItem.column (self)

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() and parent().

### int QStandardItem.columnCount (self)

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

See also setColumnCount() and rowCount().

### QVariant QStandardItem.data (self, int role = Qt.UserRole+1)

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 Qt.EditRole and Qt.DisplayRole as referring to the same data.

See also setData().

### QStandardItem.emitDataChanged (self)

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

This function was introduced in Qt 4.4.

See also setData().

### Qt.ItemFlags QStandardItem.flags (self)

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

### QFont QStandardItem.font (self)

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

See also setFont().

### QBrush QStandardItem.foreground (self)

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

See also setForeground() and background().

### bool QStandardItem.hasChildren (self)

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

See also rowCount(), columnCount(), and child().

### QIcon QStandardItem.icon (self)

Returns the item's icon.

See also setIcon() and iconSize.

### QModelIndex QStandardItem.index (self)

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() and QStandardItemModel.itemFromIndex().

### QStandardItem.insertColumn (self, int column, unknown-type items)

The items argument has it's ownership transferred to Qt.

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

See also insertColumns() and insertRow().

### QStandardItem.insertColumns (self, int column, int count)

Inserts count columns of child items at column column.

See also insertColumn() and insertRows().

### QStandardItem.insertRow (self, int row, unknown-type items)

The items argument has it's ownership transferred to Qt.

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

See also insertRows() and insertColumn().

### QStandardItem.insertRow (self, int arow, QStandardItem aitem)

The aitem argument has it's ownership transferred to Qt.

This is an overloaded function.

Inserts a row at row containing item.

When building a list or a tree that has only one column, this function provides a convenient way to insert a single new item.

### QStandardItem.insertRows (self, int row, int count)

Inserts items at row. The column count wont be changed.

See also insertRow() and insertColumn().

### QStandardItem.insertRows (self, int row, unknown-type items)

The items argument has it's ownership transferred to Qt.

Inserts count rows of child items at row row.

See also insertRow() and insertColumns().

### bool QStandardItem.isCheckable (self)

Returns whether the item is user-checkable.

The default value is false.

See also setCheckable(), checkState(), and isTristate().

### bool QStandardItem.isDragEnabled (self)

Returns whether the item is drag enabled. An item that is drag enabled can be dragged by the user.

The default value is true.

Note that item dragging must be enabled in the view for dragging to work; see QAbstractItemView.dragEnabled.

See also setDragEnabled(), isDropEnabled(), and flags().

### bool QStandardItem.isDropEnabled (self)

Returns whether the item is drop enabled. When an item is drop enabled, it can be used as a drop target.

The default value is true.

See also setDropEnabled(), isDragEnabled(), and flags().

### bool QStandardItem.isEditable (self)

Returns whether the item can be edited by the user.

When an item is editable (and enabled), the user can edit the item by invoking one of the view's edit triggers; see QAbstractItemView.editTriggers.

The default value is true.

See also setEditable() and flags().

### bool QStandardItem.isEnabled (self)

Returns whether the item is enabled.

When an item is enabled, the user can interact with it. The possible types of interaction are specified by the other item flags, such as isEditable() and isSelectable().

The default value is true.

See also setEnabled() and flags().

### bool QStandardItem.isSelectable (self)

Returns whether the item is selectable by the user.

The default value is true.

See also setSelectable() and flags().

### bool QStandardItem.isTristate (self)

Returns whether the item is tristate; that is, if it's checkable with three separate states.

The default value is false.

See also setTristate(), isCheckable(), and checkState().

### QStandardItemModel QStandardItem.model (self)

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

### QStandardItem QStandardItem.parent (self)

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

See also child().

### QStandardItem.read (self, QDataStream in)

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

See also write().

### QStandardItem.removeColumn (self, int column)

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

See also takeColumn(), removeColumns(), and removeRow().

### QStandardItem.removeColumns (self, int column, int count)

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

See also removeColumn() and removeRows().

### QStandardItem.removeRow (self, int row)

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

See also takeRow(), removeRows(), and removeColumn().

### QStandardItem.removeRows (self, int row, int count)

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

See also removeRow() and removeColumn().

### int QStandardItem.row (self)

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() and parent().

### int QStandardItem.rowCount (self)

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

See also setRowCount() and columnCount().

### QStandardItem.setAccessibleDescription (self, QString aaccessibleDescription)

Sets the item's accessible description to the string specified by accessibleDescription.

The accessible description is used by assistive technologies (i.e. for users who cannot use conventional means of interaction).

See also accessibleDescription() and setAccessibleText().

### QStandardItem.setAccessibleText (self, QString aaccessibleText)

Sets the item's accessible text to the string specified by accessibleText.

The accessible text is used by assistive technologies (i.e. for users who cannot use conventional means of interaction).

See also accessibleText() and setAccessibleDescription().

### QStandardItem.setBackground (self, QBrush abrush)

Sets the item's background brush to the specified brush.

See also background() and setForeground().

### QStandardItem.setCheckable (self, bool checkable)

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(), and setTristate().

### QStandardItem.setCheckState (self, Qt.CheckState acheckState)

Sets the check state of the item to be state.

See also checkState() and setCheckable().

### QStandardItem.setChild (self, int row, int column, QStandardItem item)

The item argument has it's ownership transferred to Qt.

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.

See also child().

### QStandardItem.setChild (self, int arow, QStandardItem aitem)

The aitem argument has it's ownership transferred to Qt.

This is an overloaded function.

Sets the child at row to item.

### QStandardItem.setColumnCount (self, int columns)

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() and setRowCount().

### QStandardItem.setData (self, QVariant value, int role = 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 setData(). This will ensure that e.g. views using the model are notified of the changes.

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

See also Qt.ItemDataRole, data(), and setFlags().

### QStandardItem.setDragEnabled (self, bool dragEnabled)

Sets whether the item is drag enabled. If dragEnabled is true, the item can be dragged by the user; otherwise, the user cannot drag the item.

Note that you also need to ensure that item dragging is enabled in the view; see QAbstractItemView.dragEnabled.

See also isDragEnabled(), setDropEnabled(), and setFlags().

### QStandardItem.setDropEnabled (self, bool dropEnabled)

Sets whether the item is drop enabled. If dropEnabled is true, the item can be used as a drop target; otherwise, it cannot.

Note that you also need to ensure that drops are enabled in the view; see QWidget.acceptDrops(); and that the model supports the desired drop actions; see QAbstractItemModel.supportedDropActions().

See also isDropEnabled(), setDragEnabled(), and setFlags().

### QStandardItem.setEditable (self, bool editable)

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() and setFlags().

### QStandardItem.setEnabled (self, bool enabled)

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 Qt.ItemIsSelectable flag has been set.

See also isEnabled(), Qt.ItemIsEnabled, and setFlags().

### QStandardItem.setFlags (self, Qt.ItemFlags flags)

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() and setData().

### QStandardItem.setFont (self, QFont afont)

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

See also font(), setText(), and setForeground().

### QStandardItem.setForeground (self, QBrush abrush)

Sets the brush used to display the item's foreground (e.g. text) to the given brush.

See also foreground(), setBackground(), and setFont().

### QStandardItem.setIcon (self, QIcon aicon)

Sets the item's icon to the icon specified.

See also icon().

### QStandardItem.setRowCount (self, int rows)

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() and setColumnCount().

### QStandardItem.setSelectable (self, bool selectable)

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() and setFlags().

### QStandardItem.setSizeHint (self, QSize asizeHint)

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

See also sizeHint().

### QStandardItem.setStatusTip (self, QString astatusTip)

Sets the item's status tip to the string specified by statusTip.

See also statusTip(), setToolTip(), and setWhatsThis().

### QStandardItem.setText (self, QString atext)

Sets the item's text to the text specified.

See also text(), setFont(), and setForeground().

### QStandardItem.setTextAlignment (self, Qt.Alignment atextAlignment)

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

See also textAlignment().

### QStandardItem.setToolTip (self, QString atoolTip)

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

See also toolTip(), setStatusTip(), and setWhatsThis().

### QStandardItem.setTristate (self, bool tristate)

Sets whether the item is tristate. If tristate is true, the item is checkable with 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 isTristate(), setCheckable(), and setCheckState().

### QStandardItem.setWhatsThis (self, QString awhatsThis)

Sets the item's "What's This?" help to the string specified by whatsThis.

See also whatsThis(), setStatusTip(), and setToolTip().

### QSize QStandardItem.sizeHint (self)

Returns the size hint set for the item, or an invalid QSize if no size hint has been set.

If no size hint has been set, the item delegate will compute the size hint based on the item data.

See also setSizeHint().

### QStandardItem.sortChildren (self, int column, Qt.SortOrder order = Qt.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<().

### QString QStandardItem.statusTip (self)

Returns the item's status tip.

See also setStatusTip(), toolTip(), and whatsThis().

### QStandardItem QStandardItem.takeChild (self, int row, int column = 0)

The QStandardItem result

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(), and takeColumn().

### unknown-type QStandardItem.takeColumn (self, int column)

The unknown-type result

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(), and takeRow().

### unknown-type QStandardItem.takeRow (self, int row)

The unknown-type result

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(), and takeColumn().

### QString QStandardItem.text (self)

Returns the item's text. This is the text that's presented to the user in a view.

See also setText().

### Qt.Alignment QStandardItem.textAlignment (self)

Returns the text alignment for the item's text.

See also setTextAlignment().

### QString QStandardItem.toolTip (self)

Returns the item's tooltip.

See also setToolTip(), statusTip(), and whatsThis().

### int QStandardItem.type (self)

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 QStandardItem.Type.

### QString QStandardItem.whatsThis (self)

Returns the item's "What's This?" help.

See also setWhatsThis(), toolTip(), and statusTip().

### QStandardItem.write (self, QDataStream out)

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

See also read().

### bool QStandardItem.__ge__ (self, QStandardItem other)

### bool QStandardItem.__lt__ (self, QStandardItem other)