QStyleOptionHeader Class | Qt Widgets 5.15.0

- Qt 5.15
- Qt Widgets
- C++ Classes
- QStyleOptionHeader
- Qt 5.15.0 Reference Documentation

# QStyleOptionHeader Class

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

Header: | #include <QStyleOptionHeader>
qmake: | QT += widgets
Inherits: | QStyleOption

- List of all members, including inherited members

## Public Types

enum | SectionPosition { Beginning, Middle, End, OnlyOneSection }
enum | SelectedPosition { NotAdjacent, NextIsSelected, PreviousIsSelected, NextAndPreviousAreSelected }
enum | SortIndicator { None, SortUp, SortDown }
enum | StyleOptionType { Type }
enum | StyleOptionVersion { Version }

## Public Functions

| QStyleOptionHeader(const QStyleOptionHeader &other)
| QStyleOptionHeader()

## Public Variables

QIcon | icon
Qt::Alignment | iconAlignment
Qt::Orientation | orientation
QStyleOptionHeader::SectionPosition | position
int | section
QStyleOptionHeader::SelectedPosition | selectedPosition
QStyleOptionHeader::SortIndicator | sortIndicator
QString | text
Qt::Alignment | textAlignment

## 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, the access to the member variables is direct (i.e., using the `.` or `->` operator). This low-level feel 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.

## Member Type Documentation

### enum QStyleOptionHeader::SectionPosition

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

Constant | Value | Description
--- | --- | ---
`QStyleOptionHeader::Beginning` | `0` | At the beginining of the header
`QStyleOptionHeader::Middle` | `1` | In the middle of the header
`QStyleOptionHeader::End` | `2` | At the end of the header
`QStyleOptionHeader::OnlyOneSection` | `3` | Only one header section

See also position.

### enum QStyleOptionHeader::SelectedPosition

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

Constant | Value | Description
--- | --- | ---
`QStyleOptionHeader::NotAdjacent` | `0` | Not adjacent to the selected section
`QStyleOptionHeader::NextIsSelected` | `1` | The next section is selected
`QStyleOptionHeader::PreviousIsSelected` | `2` | The previous section is selected
`QStyleOptionHeader::NextAndPreviousAreSelected` | `3` | Both the next and previous section are selected

See also selectedPosition.

### enum QStyleOptionHeader::SortIndicator

Indicates which direction the sort indicator should be drawn

Constant | Value | Description
--- | --- | ---
`QStyleOptionHeader::None` | `0` | No sort indicator is needed
`QStyleOptionHeader::SortUp` | `1` | Draw an up indicator
`QStyleOptionHeader::SortDown` | `2` | Draw a down indicator

See also sortIndicator.

### enum QStyleOptionHeader::StyleOptionType

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

Constant | Value | Description
--- | --- | ---
`QStyleOptionHeader::Type` | `SO_Header` | 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.

### enum QStyleOptionHeader::StyleOptionVersion

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

Constant | Value | Description
--- | --- | ---
`QStyleOptionHeader::Version` | `1` | 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.

## Member Function Documentation

### QStyleOptionHeader::QStyleOptionHeader(const QStyleOptionHeader &other)

Constructs a copy of the other style option.

### QStyleOptionHeader::QStyleOptionHeader()

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

## Member Variable Documentation

### QIcon QStyleOptionHeader::icon

This variable holds the icon of the header

The default value is an empty icon, i.e. an icon with neither a pixmap nor a filename.

### Qt::Alignment QStyleOptionHeader::iconAlignment

This variable holds the alignment flags for the icon of the header

The default value is Qt::AlignLeft.

### Qt::Orientation QStyleOptionHeader::orientation

This variable holds the header's orientation (horizontal or vertical)

The default orientation is Qt::Horizontal

### QStyleOptionHeader::SectionPosition QStyleOptionHeader::position

This variable holds the section's position in relation to the other sections

The default value is QStyleOptionHeader::Beginning.

### int QStyleOptionHeader::section

This variable holds which section of the header is being painted

The default value is 0.

### QStyleOptionHeader::SelectedPosition QStyleOptionHeader::selectedPosition

This variable holds the section's position in relation to the selected section

The default value is QStyleOptionHeader::NotAdjacent

### QStyleOptionHeader::SortIndicator QStyleOptionHeader::sortIndicator

This variable holds the direction the sort indicator should be drawn

The default value is QStyleOptionHeader::None.

### QString QStyleOptionHeader::text

This variable holds the text of the header

The default value is an empty string.

### Qt::Alignment QStyleOptionHeader::textAlignment

This variable holds the alignment flags for the text of the header

The default value is Qt::AlignLeft.