QStyleOptionViewItem#

The QStyleOptionViewItem class is used to describe the parameters used to draw an item in a view widget. More…

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#

QStyleOptionViewItem contains all the information that QStyle functions need to draw the items for Qt’s model/view classes.

For performance reasons, there are few member functions and the access to the member variables is direct (i.e., using the . or -> operator). This makes the structures straightforward to use and emphasizes that these are simply parameters used by the style functions.

For an example demonstrating how style options can be used, see the Styles example.

See also

QStyleOption Model/View Programming

class PySide6.QtWidgets.QStyleOptionViewItem#

PySide6.QtWidgets.QStyleOptionViewItem(other)

PySide6.QtWidgets.QStyleOptionViewItem(version)

Parameters:

other – PySide6.QtWidgets.QStyleOptionViewItem
version – int

Constructs a QStyleOptionViewItem , initializing the members variables to their default values.

Constructs a copy of the other style option.

PySide6.QtWidgets.QStyleOptionViewItem.StyleOptionType#

This enum is used to hold information about the type of the style option, and is defined for each QStyleOption subclass.

Constant

Description

QStyleOptionViewItem.Type

The type of style option provided ( SO_ViewItem for this class).

Constant	Description
QStyleOptionViewItem.Type	The type of style option provided ( `SO_ViewItem` for this class).

The type is used internally by QStyleOption , its subclasses, and qstyleoption_cast() to determine the type of style option. In general you do not need to worry about this unless you want to create your own QStyleOption subclass and your own styles.

See also

StyleOptionVersion

PySide6.QtWidgets.QStyleOptionViewItem.StyleOptionVersion#

This enum is used to hold information about the version of the style option, and is defined for each QStyleOption subclass.

Constant

Description

QStyleOptionViewItem.Version

4

Constant	Description
QStyleOptionViewItem.Version	4

The version is used by QStyleOption subclasses to implement extensions without breaking compatibility. If you use qstyleoption_cast() , you normally do not need to check it.

See also

StyleOptionType

PySide6.QtWidgets.QStyleOptionViewItem.Position#

This enum describes the position of the item’s decoration.

Constant

Description

QStyleOptionViewItem.Left

On the left of the text.

QStyleOptionViewItem.Right

On the right of the text.

QStyleOptionViewItem.Top

Above the text.

QStyleOptionViewItem.Bottom

Below the text.

See also

decorationPosition

Constant	Description
QStyleOptionViewItem.Left	On the left of the text.
QStyleOptionViewItem.Right	On the right of the text.
QStyleOptionViewItem.Top	Above the text.
QStyleOptionViewItem.Bottom	Below the text.

PySide6.QtWidgets.QStyleOptionViewItem.ViewItemFeature#

(inherits enum.Flag) This enum describes the different types of features an item can have.

Constant

Description

QStyleOptionViewItem.None

Indicates a normal item.

QStyleOptionViewItem.WrapText

Indicates an item with wrapped text.

QStyleOptionViewItem.Alternate

Indicates that the item’s background is rendered using alternateBase.

QStyleOptionViewItem.HasCheckIndicator

Indicates that the item has a check state indicator.

QStyleOptionViewItem.HasDisplay

Indicates that the item has a display role.

QStyleOptionViewItem.HasDecoration

Indicates that the item has a decoration role.

Constant	Description
QStyleOptionViewItem.None	Indicates a normal item.
QStyleOptionViewItem.WrapText	Indicates an item with wrapped text.
QStyleOptionViewItem.Alternate	Indicates that the item’s background is rendered using alternateBase.
QStyleOptionViewItem.HasCheckIndicator	Indicates that the item has a check state indicator.
QStyleOptionViewItem.HasDisplay	Indicates that the item has a display role.
QStyleOptionViewItem.HasDecoration	Indicates that the item has a decoration role.

PySide6.QtWidgets.QStyleOptionViewItem.ViewItemPosition#

This enum is used to represent the placement of the item on a row. This can be used to draw items differently depending on their placement, for example by putting rounded edges at the beginning and end, and straight edges in between.

Constant

Description

QStyleOptionViewItem.Invalid

The ViewItemPosition is unknown and should be disregarded.

QStyleOptionViewItem.Beginning

The item appears at the beginning of the row.

QStyleOptionViewItem.Middle

The item appears in the middle of the row.

QStyleOptionViewItem.End

The item appears at the end of the row.

QStyleOptionViewItem.OnlyOne

The item is the only one on the row, and is therefore both at the beginning and the end.

Constant	Description
QStyleOptionViewItem.Invalid	The ViewItemPosition is unknown and should be disregarded.
QStyleOptionViewItem.Beginning	The item appears at the beginning of the row.
QStyleOptionViewItem.Middle	The item appears in the middle of the row.
QStyleOptionViewItem.End	The item appears at the end of the row.
QStyleOptionViewItem.OnlyOne	The item is the only one on the row, and is therefore both at the beginning and the end.

PySide6.QtWidgets.QStyleOptionViewItem.displayAlignment#

PySide6.QtWidgets.QStyleOptionViewItem.decorationAlignment#

PySide6.QtWidgets.QStyleOptionViewItem.textElideMode#

PySide6.QtWidgets.QStyleOptionViewItem.decorationPosition#

PySide6.QtWidgets.QStyleOptionViewItem.decorationSize#

PySide6.QtWidgets.QStyleOptionViewItem.font#

PySide6.QtWidgets.QStyleOptionViewItem.showDecorationSelected#

PySide6.QtWidgets.QStyleOptionViewItem.features#

PySide6.QtWidgets.QStyleOptionViewItem.locale#

PySide6.QtWidgets.QStyleOptionViewItem.widget#

PySide6.QtWidgets.QStyleOptionViewItem.index#

PySide6.QtWidgets.QStyleOptionViewItem.checkState#

PySide6.QtWidgets.QStyleOptionViewItem.icon#

PySide6.QtWidgets.QStyleOptionViewItem.text#

PySide6.QtWidgets.QStyleOptionViewItem.viewItemPosition#

PySide6.QtWidgets.QStyleOptionViewItem.backgroundBrush#