CopperSpice API  1.9.1
QStyleOptionHeader Class Reference

Stores parameters for drawing a header. More...

Inheritance diagram for QStyleOptionHeader:
QStyleOption

Public Types

enum  SectionPosition
 
enum  SelectedPosition
 
enum  SortIndicator
 
enum  StyleOptionType
 
enum  StyleOptionVersion
 
- Public Types inherited from QStyleOption
enum  OptionType
 
enum  StyleOptionType
 
enum  StyleOptionVersion
 

Public Methods

 QStyleOptionHeader ()
 
 QStyleOptionHeader (const QStyleOptionHeader &other)
 
QStyleOptionHeader & operator= (const QStyleOptionHeader &other) = default
 
- Public Methods inherited from QStyleOption
 QStyleOption (const QStyleOption &other)
 
 QStyleOption (int version=QStyleOption::Version, int type=SO_Default)
 
 ~QStyleOption ()
 
void initFrom (const QWidget *widget)
 
QStyleOption & operator= (const QStyleOption &other)
 

Public Members

QIcon icon
 
Qt::Alignment iconAlignment
 
Qt::Orientation orientation
 
SectionPosition position
 
int section
 
SelectedPosition selectedPosition
 
SortIndicator sortIndicator
 
QString text
 
Qt::Alignment textAlignment
 
- Public Members inherited from QStyleOption
int type
 
int version
 

Additional Inherited Members

Detailed Description

The QStyleOptionHeader class is used to describe the parameters for drawing a header. This class contains all the information QStyle functions need to draw the item views' header pane, header sort arrow, and header label.

See also
QStyleOption

Member Enumeration Documentation

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

ConstantValueDescription
QStyleOptionHeader::Beginning0At the beginning of the header
QStyleOptionHeader::Middle1In the middle of the header
QStyleOptionHeader::End2At the end of the header
QStyleOptionHeader::OnlyOneSection3Only one header section
See also
position

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

ConstantValueDescription
QStyleOptionHeader::NotAdjacent0 Not adjacent to the selected section
QStyleOptionHeader::NextIsSelected1 The next section is selected
QStyleOptionHeader::PreviousIsSelected2 The previous section is selected
QStyleOptionHeader::NextAndPreviousAreSelected3 Both the next and previous section are selected
See also
selectedPosition

Indicates which direction the sort indicator should be drawn

ConstantValueDescription
QStyleOptionHeader::None0 No sort indicator is needed
QStyleOptionHeader::SortUp1 Draw an up indicator
QStyleOptionHeader::SortDown2Draw a down indicator
See also
sortIndicator

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

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.

ConstantValueDescription
QStyleOptionHeader::TypeSO_Header The type of style option provided (SO_Header for this class).
See also
StyleOptionVersion

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

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.

ConstantValueDescription
QStyleOptionHeader::Version11
See also
StyleOptionType

Constructor & Destructor Documentation

QStyleOptionHeader::QStyleOptionHeader ( )

Constructs an empty QStyleOptionHeader.

QStyleOptionHeader::QStyleOptionHeader ( const QStyleOptionHeader &  other)
inline

Copy constructs a new QStyleOptionHeader from other.

Method Documentation

QStyleOptionHeader & QStyleOptionHeader::operator= ( const QStyleOptionHeader &  other)
default

Copy assigns from other and returns a reference to this object.

Member Data Documentation

QIcon QStyleOptionHeader::icon

This variable holds the icon of the header. The default value is an empty icon.

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.