Qt 4.8
Public Types | Public Functions | Public Variables | Protected Functions | List of all members
QStyleOptionHeader Class Reference

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

#include <qstyleoption.h>

Inheritance diagram for QStyleOptionHeader:
QStyleOption

Public Types

enum  SectionPosition { Beginning, Middle, End, OnlyOneSection }
 This enum lets you know where the section's position is in relation to the other sections. More...
 
enum  SelectedPosition { NotAdjacent, NextIsSelected, PreviousIsSelected, NextAndPreviousAreSelected }
 This enum lets you know where the section's position is in relation to the selected section. More...
 
enum  SortIndicator { None, SortUp, SortDown }
 Indicates which direction the sort indicator should be drawn. More...
 
enum  StyleOptionType { Type = SO_Header }
 This enum is used to hold information about the type of the style option, and is defined for each QStyleOption subclass. More...
 
enum  StyleOptionVersion { Version = 1 }
 This enum is used to hold information about the version of the style option, and is defined for each QStyleOption subclass. More...
 
- Public Types inherited from QStyleOption
enum  OptionType {
  SO_Default, SO_FocusRect, SO_Button, SO_Tab,
  SO_MenuItem, SO_Frame, SO_ProgressBar, SO_ToolBox,
  SO_Header, SO_Q3DockWindow, SO_DockWidget, SO_Q3ListViewItem,
  SO_ViewItem, SO_TabWidgetFrame, SO_TabBarBase, SO_RubberBand,
  SO_ToolBar, SO_GraphicsItem, SO_Complex = 0xf0000, SO_Slider,
  SO_SpinBox, SO_ToolButton, SO_ComboBox, SO_Q3ListView,
  SO_TitleBar, SO_GroupBox, SO_SizeGrip, SO_CustomBase = 0xf00,
  SO_ComplexCustomBase = 0xf000000
}
 This enum is used internally by QStyleOption, its subclasses, and qstyleoption_cast() to determine the type of style option. More...
 
enum  StyleOptionType { Type = SO_Default }
 This enum is used to hold information about the type of the style option, and is defined for each QStyleOption subclass. More...
 
enum  StyleOptionVersion { Version = 1 }
 This enum is used to hold information about the version of the style option, and is defined for each QStyleOption subclass. More...
 

Public Functions

 QStyleOptionHeader ()
 Constructs a QStyleOptionHeader, initializing the members variables to their default values. More...
 
 QStyleOptionHeader (const QStyleOptionHeader &other)
 Constructs a copy of the other style option. More...
 
- Public Functions inherited from QStyleOption
void init (const QWidget *w)
 Use initFrom(widget) instead. More...
 
void initFrom (const QWidget *w)
 
QStyleOptionoperator= (const QStyleOption &other)
 Assign other to this QStyleOption. More...
 
 QStyleOption (int version=QStyleOption::Version, int type=SO_Default)
 Constructs a QStyleOption with the specified version and type. More...
 
 QStyleOption (const QStyleOption &other)
 Constructs a copy of other. More...
 
 ~QStyleOption ()
 Destroys this style option object. More...
 

Public Variables

QIcon icon
 the icon of the header More...
 
Qt::Alignment iconAlignment
 the alignment flags for the icon of the header More...
 
Qt::Orientation orientation
 the header's orientation (horizontal or vertical) More...
 
SectionPosition position
 the section's position in relation to the other sections More...
 
int section
 which section of the header is being painted More...
 
SelectedPosition selectedPosition
 the section's position in relation to the selected section More...
 
SortIndicator sortIndicator
 the direction the sort indicator should be drawn More...
 
QString text
 the text of the header More...
 
Qt::Alignment textAlignment
 the alignment flags for the text of the header More...
 
- Public Variables inherited from QStyleOption
Qt::LayoutDirection direction
 the text layout direction that should be used when drawing text in the control More...
 
QFontMetrics fontMetrics
 the font metrics that should be used when drawing text in the control More...
 
QPalette palette
 the palette that should be used when painting the control More...
 
QRect rect
 the area that should be used for various calculations and painting More...
 
QStyle::State state
 the style flags that are used when drawing the control More...
 
int type
 the option type of the style option More...
 
int version
 the version of the style option More...
 

Protected Functions

 QStyleOptionHeader (int version)
 

Additional Inherited Members

Detailed Description

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

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 widgets/styles{Styles} example.

See also
QStyleOption

Definition at line 251 of file qstyleoption.h.

Enumerations

◆ SectionPosition

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

  • Beginning At the beginining of the header
  • Middle In the middle of the header
  • End At the end of the header
  • OnlyOneSection Only one header section
See also
position
Enumerator
Beginning 
Middle 
End 
OnlyOneSection 

Definition at line 257 of file qstyleoption.h.

◆ SelectedPosition

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

  • NotAdjacent Not adjacent to the selected section
  • NextIsSelected The next section is selected
  • PreviousIsSelected The previous section is selected
  • NextAndPreviousAreSelected Both the next and previous section are selected
See also
selectedPosition
Enumerator
NotAdjacent 
NextIsSelected 
PreviousIsSelected 
NextAndPreviousAreSelected 

Definition at line 258 of file qstyleoption.h.

◆ SortIndicator

Indicates which direction the sort indicator should be drawn.

  • None No sort indicator is needed
  • SortUp Draw an up indicator
  • SortDown Draw a down indicator
See also
sortIndicator
Enumerator
None 
SortUp 
SortDown 

Definition at line 260 of file qstyleoption.h.

◆ StyleOptionType

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

  • 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
Enumerator
Type 

Definition at line 254 of file qstyleoption.h.

◆ StyleOptionVersion

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

  • 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
Enumerator
Version 

Definition at line 255 of file qstyleoption.h.

Constructors and Destructors

◆ QStyleOptionHeader() [1/3]

QStyleOptionHeader::QStyleOptionHeader ( )

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

Definition at line 1494 of file qstyleoption.cpp.

1500 {
1501 }
SortIndicator sortIndicator
the direction the sort indicator should be drawn
Definition: qstyleoption.h:269
Qt::Orientation orientation
the header&#39;s orientation (horizontal or vertical)
Definition: qstyleoption.h:270
Qt::Alignment textAlignment
the alignment flags for the text of the header
Definition: qstyleoption.h:264
SectionPosition position
the section&#39;s position in relation to the other sections
Definition: qstyleoption.h:267
QStyleOption(int version=QStyleOption::Version, int type=SO_Default)
Constructs a QStyleOption with the specified version and type.
Qt::Alignment iconAlignment
the alignment flags for the icon of the header
Definition: qstyleoption.h:266
SelectedPosition selectedPosition
the section&#39;s position in relation to the selected section
Definition: qstyleoption.h:268
int section
which section of the header is being painted
Definition: qstyleoption.h:262

◆ QStyleOptionHeader() [2/3]

QStyleOptionHeader::QStyleOptionHeader ( const QStyleOptionHeader other)
inline

Constructs a copy of the other style option.

Definition at line 273 of file qstyleoption.h.

273 : QStyleOption(Version, Type) { *this = other; }
QStyleOption(int version=QStyleOption::Version, int type=SO_Default)
Constructs a QStyleOption with the specified version and type.

◆ QStyleOptionHeader() [3/3]

QStyleOptionHeader::QStyleOptionHeader ( int  version)
protected
Warning
This function is not part of the public interface.

Definition at line 1506 of file qstyleoption.cpp.

1512 {
1513 }
int version
the version of the style option
Definition: qstyleoption.h:86
SortIndicator sortIndicator
the direction the sort indicator should be drawn
Definition: qstyleoption.h:269
Qt::Orientation orientation
the header&#39;s orientation (horizontal or vertical)
Definition: qstyleoption.h:270
Qt::Alignment textAlignment
the alignment flags for the text of the header
Definition: qstyleoption.h:264
SectionPosition position
the section&#39;s position in relation to the other sections
Definition: qstyleoption.h:267
QStyleOption(int version=QStyleOption::Version, int type=SO_Default)
Constructs a QStyleOption with the specified version and type.
Qt::Alignment iconAlignment
the alignment flags for the icon of the header
Definition: qstyleoption.h:266
SelectedPosition selectedPosition
the section&#39;s position in relation to the selected section
Definition: qstyleoption.h:268
int section
which section of the header is being painted
Definition: qstyleoption.h:262

Properties

◆ icon

QStyleOptionHeader::icon

the icon of the header

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

Definition at line 265 of file qstyleoption.h.

Referenced by QHeaderView::paintSection(), and QHeaderView::sectionSizeFromContents().

◆ iconAlignment

QStyleOptionHeader::iconAlignment

the alignment flags for the icon of the header

The default value is Qt::AlignLeft.

Definition at line 266 of file qstyleoption.h.

Referenced by QHeaderView::paintSection().

◆ orientation

QStyleOptionHeader::orientation

the header's orientation (horizontal or vertical)

The default orientation is Qt::Horizontal

Definition at line 270 of file qstyleoption.h.

Referenced by QHeaderView::initStyleOption(), and QHeaderView::paintSection().

◆ position

QStyleOptionHeader::position

the section's position in relation to the other sections

The default value is QStyleOptionHeader::Beginning.

Definition at line 267 of file qstyleoption.h.

Referenced by QTableCornerButton::paintEvent(), and QHeaderView::paintSection().

◆ section

QStyleOptionHeader::section

which section of the header is being painted

The default value is 0.

Definition at line 262 of file qstyleoption.h.

Referenced by QHeaderView::initStyleOption(), QHeaderView::paintSection(), and QHeaderView::sectionSizeFromContents().

◆ selectedPosition

QStyleOptionHeader::selectedPosition

the section's position in relation to the selected section

The default value is QStyleOptionHeader::NotAdjacent

Definition at line 268 of file qstyleoption.h.

Referenced by QHeaderView::paintSection().

◆ sortIndicator

QStyleOptionHeader::sortIndicator

the direction the sort indicator should be drawn

The default value is QStyleOptionHeader::None.

Definition at line 269 of file qstyleoption.h.

Referenced by QHeaderView::paintSection().

◆ text

QStyleOptionHeader::text

the text of the header

The default value is an empty string.

Definition at line 263 of file qstyleoption.h.

Referenced by QHeaderView::paintSection(), QHeaderView::sectionSizeFromContents(), and QMacStyle::sizeFromContents().

◆ textAlignment

QStyleOptionHeader::textAlignment

the alignment flags for the text of the header

The default value is Qt::AlignLeft.

Definition at line 264 of file qstyleoption.h.

Referenced by QHeaderView::paintSection().


The documentation for this class was generated from the following files: