Qyoto  4.0.5
Qyoto is a C# language binding for Qt
 All Classes Namespaces Functions Variables Typedefs Enumerations Properties
QtGui.QStyleOptionHeader Class Reference

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

Inheritance diagram for QtGui.QStyleOptionHeader:
Collaboration diagram for QtGui.QStyleOptionHeader:

Public Types

enum  SectionPosition { Beginning = 0, End = 2, Middle = 1, OnlyOneSection = 3 }
  More...
 
enum  SelectedPosition { NextAndPreviousAreSelected = 3, NextIsSelected = 1, NotAdjacent = 0, PreviousIsSelected = 2 }
  More...
 
enum  SortIndicator { None = 0, SortDown = 2, SortUp = 1 }
  More...
 
enum  StyleOptionType { Type = 8 }
  More...
 
enum  StyleOptionVersion { Version = 1 }
  More...
 
- Public Types inherited from QtGui.QStyleOption
enum  OptionType {
  SO_Button = 2, SO_ComboBox = 983044, SO_Complex = 983040, SO_ComplexCustomBase = 251658240,
  SO_CustomBase = 3840, SO_Default = 0, SO_DockWidget = 10, SO_FocusRect = 1,
  SO_Frame = 5, SO_GraphicsItem = 17, SO_GroupBox = 983047, SO_Header = 8,
  SO_MenuItem = 4, SO_ProgressBar = 6, SO_Q3DockWindow = 9, SO_Q3ListView = 983045,
  SO_Q3ListViewItem = 11, SO_RubberBand = 15, SO_SizeGrip = 983048, SO_Slider = 983041,
  SO_SpinBox = 983042, SO_Tab = 3, SO_TabBarBase = 14, SO_TabWidgetFrame = 13,
  SO_TitleBar = 983046, SO_ToolBar = 16, SO_ToolBox = 7, SO_ToolButton = 983043,
  SO_ViewItem = 12
}
  More...
 
enum  StyleOptionType { Type = 0 }
  More...
 
enum  StyleOptionVersion { Version = 1 }
  More...
 

Public Member Functions

 QStyleOptionHeader ()
 
 
 QStyleOptionHeader (QStyleOptionHeader other)
 
 
override void CreateProxy ()
 
new void Dispose ()
 
- Public Member Functions inherited from QtGui.QStyleOption
 QStyleOption (QStyleOption other)
 
 
 QStyleOption (int version=(int) QStyleOption.StyleOptionVersion.Version, int type=(int) QStyleOption.OptionType.SO_Default)
 
 
new void Init (QWidget w)
 
 
new void InitFrom (QWidget w)
 
 
new void Dispose ()
 

Protected Member Functions

 QStyleOptionHeader (System.Type dummy)
 
 QStyleOptionHeader (int version)
 
 
- Protected Member Functions inherited from QtGui.QStyleOption
 QStyleOption (System.Type dummy)
 

Properties

new QIcon Icon [get, set]
 
 
new Qt.AlignmentFlag IconAlignment [get, set]
 
 
new Qt.Orientation Orientation [get, set]
 
 
new
QStyleOptionHeader.SectionPosition 
Position [get, set]
 
 
new int Section [get, set]
 
 
new
QStyleOptionHeader.SelectedPosition 
selectedPosition [get, set]
 
 
new
QStyleOptionHeader.SortIndicator 
sortIndicator [get, set]
 
 
new string Text [get, set]
 
 
new Qt.AlignmentFlag TextAlignment [get, set]
 
 
- Properties inherited from QtGui.QStyleOption
virtual System.IntPtr SmokeObject [get, set]
 
new Qt.LayoutDirection Direction [get, set]
 
 
new QFontMetrics FontMetrics [get, set]
 
 
new QPalette Palette [get, set]
 
 
new QRect Rect [get, set]
 
 
new QStyle.StateFlag State [get, set]
 
 
new int Type [get, set]
 
 
new int Version [get, set]
 
 

Additional Inherited Members

- Protected Attributes inherited from QtGui.QStyleOption
SmokeInvocation interceptor
 

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 Styles example.

See also QStyleOption.

Member Enumeration Documentation

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

See also position.

Enumerator:
Beginning 

At the beginining of the header

End 

At the end of the header

Middle 

In the middle of the header

OnlyOneSection 

Only one header section

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

See also selectedPosition.

Enumerator:
NextAndPreviousAreSelected 

Both the next and previous section are selected

NextIsSelected 

The next section is selected

NotAdjacent 

Not adjacent to the selected section

PreviousIsSelected 

The previous section is selected

Indicates which direction the sort indicator should be drawn

See also sortIndicator.

Enumerator:
None 

No sort indicator is needed

SortDown 

Draw a down indicator

SortUp 

Draw an up indicator

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.

See also StyleOptionVersion.

Enumerator:
Type 

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

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.

See also StyleOptionType.

Enumerator:
Version 

1

Constructor & Destructor Documentation

QtGui.QStyleOptionHeader.QStyleOptionHeader ( System.Type  dummy)
protected
QtGui.QStyleOptionHeader.QStyleOptionHeader ( )

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

QtGui.QStyleOptionHeader.QStyleOptionHeader ( QStyleOptionHeader  other)

Constructs a copy of the other style option.

QtGui.QStyleOptionHeader.QStyleOptionHeader ( int  version)
protected

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

Member Function Documentation

override void QtGui.QStyleOptionHeader.CreateProxy ( )
virtual

Reimplemented from QtGui.QStyleOption.

new void QtGui.QStyleOptionHeader.Dispose ( )

Property Documentation

new QIcon QtGui.QStyleOptionHeader.Icon
getset

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.

new Qt.AlignmentFlag QtGui.QStyleOptionHeader.IconAlignment
getset

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

The default value is Qt::AlignLeft.

new Qt.Orientation QtGui.QStyleOptionHeader.Orientation
getset

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

The default orientation is Qt::Horizontal

new QStyleOptionHeader.SectionPosition QtGui.QStyleOptionHeader.Position
getset

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

The default value is QStyleOptionHeader::Beginning.

new int QtGui.QStyleOptionHeader.Section
getset

This variable holds which section of the header is being painted.

The default value is 0.

new QStyleOptionHeader.SelectedPosition QtGui.QStyleOptionHeader.selectedPosition
getset

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

The default value is QStyleOptionHeader::NotAdjacent

new QStyleOptionHeader.SortIndicator QtGui.QStyleOptionHeader.sortIndicator
getset

This variable holds the direction the sort indicator should be drawn.

The default value is QStyleOptionHeader::None.

new string QtGui.QStyleOptionHeader.Text
getset

This variable holds the text of the header.

The default value is an empty string.

new Qt.AlignmentFlag QtGui.QStyleOptionHeader.TextAlignment
getset

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

The default value is Qt::AlignLeft.