class QStyleOptionHeader

The QStyleOptionHeader class is used to describe the parameters for drawing a header. More…

Inherited by: QStyleOptionHeaderV2

Synopsis

Methods

• def __init__()

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

QStyleOptionHeader contains all the information that QStyle functions need to draw the item views’ header pane, header sort arrow, and header label.

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.

See also

QStyleOption

class StyleOptionType

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

Constant	Description
QStyleOptionHeader.Type	The type of style option provided ( SO_Header 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

class StyleOptionVersion

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

Constant	Description
QStyleOptionHeader.Version	1

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

class SectionPosition

This enum lets you know where the section’s position is in relation to the other sections.

Constant	Description
QStyleOptionHeader.Beginning	At the beginining of the header
QStyleOptionHeader.Middle	In the middle of the header
QStyleOptionHeader.End	At the end of the header
QStyleOptionHeader.OnlyOneSection	Only one header section

See also

position

class SelectedPosition

This enum lets you know where the section’s position is in relation to the selected section.

Constant	Description
QStyleOptionHeader.NotAdjacent	Not adjacent to the selected section
QStyleOptionHeader.NextIsSelected	The next section is selected
QStyleOptionHeader.PreviousIsSelected	The previous section is selected
QStyleOptionHeader.NextAndPreviousAreSelected	Both the next and previous section are selected

See also

selectedPosition

class SortIndicator

Indicates which direction the sort indicator should be drawn

Constant	Description
QStyleOptionHeader.None	No sort indicator is needed
QStyleOptionHeader.SortUp	Draw an up indicator
QStyleOptionHeader.SortDown	Draw a down indicator

See also

sortIndicator

PySide6.QtWidgets.QStyleOptionHeader.section

PySide6.QtWidgets.QStyleOptionHeader.text

PySide6.QtWidgets.QStyleOptionHeader.textAlignment

PySide6.QtWidgets.QStyleOptionHeader.icon

PySide6.QtWidgets.QStyleOptionHeader.iconAlignment

PySide6.QtWidgets.QStyleOptionHeader.position

PySide6.QtWidgets.QStyleOptionHeader.selectedPosition

PySide6.QtWidgets.QStyleOptionHeader.sortIndicator

PySide6.QtWidgets.QStyleOptionHeader.orientation

__init__()

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

__init__(other)

Parameters:

other – QStyleOptionHeader

Constructs a copy of the other style option.

__init__(version)

Parameters:

version – int

Constructs a copy of the other style option.