<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
<html><head><title>QStyleOptionHeader Class Reference</title><style>h3.fn,span.fn { margin-left: 1cm; text-indent: -1cm }
a:link { color: #004faf; text-decoration: none }
a:visited { color: #672967; text-decoration: none }
td.postheader { font-family: sans-serif }
tr.address { font-family: sans-serif }
body { background: #ffffff; color: black; }
</style></head><body><table border="0" cellpadding="0" cellspacing="0" width="100%"><tr /><td align="left" valign="top" width="32"><img align="left" border="0" height="32" src="images/rb-logo.png" width="32" /></td><td width="1">  </td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a> · <a href="classes.html"><font color="#004faf">All Classes</font></a> · <a href="modules.html"><font color="#004faf">Modules</font></a></td></table><h1 align="center">QStyleOptionHeader Class Reference<br /><sup><sup>[<a href="qtgui.html">QtGui</a> module]</sup></sup></h1><p>The QStyleOptionHeader class is used to describe the parameters
for drawing a header. <a href="#details">More...</a></p>
<p>Inherits <a href="qstyleoption.html">QStyleOption</a>.</p><h3>Types</h3><ul><li><div class="fn" />enum <b><a href="qstyleoptionheader.html#SectionPosition-enum">SectionPosition</a></b> { Beginning, Middle, End, OnlyOneSection }</li><li><div class="fn" />enum <b><a href="qstyleoptionheader.html#SelectedPosition-enum">SelectedPosition</a></b> { NotAdjacent, NextIsSelected, PreviousIsSelected, NextAndPreviousAreSelected }</li><li><div class="fn" />enum <b><a href="qstyleoptionheader.html#SortIndicator-enum">SortIndicator</a></b> { None, SortUp, SortDown }</li><li><div class="fn" />enum <b><a href="qstyleoptionheader.html#StyleOptionType-enum">StyleOptionType</a></b> { Type }</li><li><div class="fn" />enum <b><a href="qstyleoptionheader.html#StyleOptionVersion-enum">StyleOptionVersion</a></b> { Version }</li></ul><h3>Methods</h3><ul><li><div class="fn" /><b><a href="qstyleoptionheader.html#QStyleOptionHeader">__init__</a></b> (<i>self</i>)</li><li><div class="fn" /><b><a href="qstyleoptionheader.html#QStyleOptionHeader-2">__init__</a></b> (<i>self</i>, QStyleOptionHeader <i>other</i>)</li></ul><h3>Members</h3><ul><li><div class="fn" />QIcon <b><a href="qstyleoptionheader.html#icon-var">icon</a></b></li><li><div class="fn" />Qt.Alignment <b><a href="qstyleoptionheader.html#iconAlignment-var">iconAlignment</a></b></li><li><div class="fn" />Qt.Orientation <b><a href="qstyleoptionheader.html#orientation-var">orientation</a></b></li><li><div class="fn" />SectionPosition <b><a href="qstyleoptionheader.html#position-var">position</a></b></li><li><div class="fn" />int <b><a href="qstyleoptionheader.html#section-var">section</a></b></li><li><div class="fn" />SelectedPosition <b><a href="qstyleoptionheader.html#selectedPosition-var">selectedPosition</a></b></li><li><div class="fn" />SortIndicator <b><a href="qstyleoptionheader.html#sortIndicator-var">sortIndicator</a></b></li><li><div class="fn" />QString <b><a href="qstyleoptionheader.html#text-var">text</a></b></li><li><div class="fn" />Qt.Alignment <b><a href="qstyleoptionheader.html#textAlignment-var">textAlignment</a></b></li></ul><a name="details" /><hr /><h2>Detailed Description</h2><p>The QStyleOptionHeader class is used to describe the parameters
for drawing a header.</p>
<p>QStyleOptionHeader contains all the information that <a href="qstyle.html">QStyle</a> functions need to draw the item views'
header pane, header sort arrow, and header label.</p>
<p>For performance reasons, the access to the member variables is
direct (i.e., using the <tt>.</tt> or <tt>-></tt> operator).
This low-level feel makes the structures straightforward to use and
emphasizes that these are simply parameters used by the style
functions.</p>
<p>For an example demonstrating how style options can be used, see
the <a href="widgets-styles.html">Styles</a> example.</p>
<hr /><h2>Type Documentation</h2><h3 class="fn"><a name="SectionPosition-enum" />QStyleOptionHeader.SectionPosition</h3><p>This enum lets you know where the section's position is in
relation to the other sections.</p>
<table class="valuelist">
<tr class="odd" valign="top">
<th class="tblConst">Constant</th>
<th class="tblval">Value</th>
<th class="tbldscr">Description</th>
</tr>
<tr>
<td class="topAlign"><tt>QStyleOptionHeader.Beginning</tt></td>
<td class="topAlign"><tt>0</tt></td>
<td class="topAlign">At the beginining of the header</td>
</tr>
<tr>
<td class="topAlign"><tt>QStyleOptionHeader.Middle</tt></td>
<td class="topAlign"><tt>1</tt></td>
<td class="topAlign">In the middle of the header</td>
</tr>
<tr>
<td class="topAlign"><tt>QStyleOptionHeader.End</tt></td>
<td class="topAlign"><tt>2</tt></td>
<td class="topAlign">At the end of the header</td>
</tr>
<tr>
<td class="topAlign">
<tt>QStyleOptionHeader.OnlyOneSection</tt></td>
<td class="topAlign"><tt>3</tt></td>
<td class="topAlign">Only one header section</td>
</tr>
</table>
<p><b>See also</b> <a href="qstyleoptionheader.html#position-var">position</a>.</p>
<h3 class="fn"><a name="SelectedPosition-enum" />QStyleOptionHeader.SelectedPosition</h3><p>This enum lets you know where the section's position is in
relation to the selected section.</p>
<table class="valuelist">
<tr class="odd" valign="top">
<th class="tblConst">Constant</th>
<th class="tblval">Value</th>
<th class="tbldscr">Description</th>
</tr>
<tr>
<td class="topAlign"><tt>QStyleOptionHeader.NotAdjacent</tt></td>
<td class="topAlign"><tt>0</tt></td>
<td class="topAlign">Not adjacent to the selected section</td>
</tr>
<tr>
<td class="topAlign">
<tt>QStyleOptionHeader.NextIsSelected</tt></td>
<td class="topAlign"><tt>1</tt></td>
<td class="topAlign">The next section is selected</td>
</tr>
<tr>
<td class="topAlign">
<tt>QStyleOptionHeader.PreviousIsSelected</tt></td>
<td class="topAlign"><tt>2</tt></td>
<td class="topAlign">The previous section is selected</td>
</tr>
<tr>
<td class="topAlign">
<tt>QStyleOptionHeader.NextAndPreviousAreSelected</tt></td>
<td class="topAlign"><tt>3</tt></td>
<td class="topAlign">Both the next and previous section are
selected</td>
</tr>
</table>
<p><b>See also</b> <a href="qstyleoptionheader.html#selectedPosition-var">selectedPosition</a>.</p>
<h3 class="fn"><a name="SortIndicator-enum" />QStyleOptionHeader.SortIndicator</h3><p>Indicates which direction the sort indicator should be drawn</p>
<table class="valuelist">
<tr class="odd" valign="top">
<th class="tblConst">Constant</th>
<th class="tblval">Value</th>
<th class="tbldscr">Description</th>
</tr>
<tr>
<td class="topAlign"><tt>QStyleOptionHeader.None</tt></td>
<td class="topAlign"><tt>0</tt></td>
<td class="topAlign">No sort indicator is needed</td>
</tr>
<tr>
<td class="topAlign"><tt>QStyleOptionHeader.SortUp</tt></td>
<td class="topAlign"><tt>1</tt></td>
<td class="topAlign">Draw an up indicator</td>
</tr>
<tr>
<td class="topAlign"><tt>QStyleOptionHeader.SortDown</tt></td>
<td class="topAlign"><tt>2</tt></td>
<td class="topAlign">Draw a down indicator</td>
</tr>
</table>
<p><b>See also</b> <a href="qstyleoptionheader.html#sortIndicator-var">sortIndicator</a>.</p>
<h3 class="fn"><a name="StyleOptionType-enum" />QStyleOptionHeader.StyleOptionType</h3><p>This enum is used to hold information about the type of the
style option, and is defined for each <a href="qstyleoption.html">QStyleOption</a> subclass.</p>
<table class="valuelist">
<tr class="odd" valign="top">
<th class="tblConst">Constant</th>
<th class="tblval">Value</th>
<th class="tbldscr">Description</th>
</tr>
<tr>
<td class="topAlign"><tt>QStyleOptionHeader.Type</tt></td>
<td class="topAlign"><tt>SO_Header</tt></td>
<td class="topAlign">The type of style option provided (<a href="qstyleoption.html#OptionType-enum">SO_Header</a> for this
class).</td>
</tr>
</table>
<p>The type is used internally by <a href="qstyleoption.html">QStyleOption</a>, its subclasses, and <a href="qstyleoption.html#qstyleoption_cast">qstyleoption_cast</a>() to
determine the type of style option. In general you do not need to
worry about this unless you want to create your own <a href="qstyleoption.html">QStyleOption</a> subclass and your own
styles.</p>
<p><b>See also</b> <a href="qstyleoptionheader.html#StyleOptionVersion-enum">StyleOptionVersion</a>.</p>
<h3 class="fn"><a name="StyleOptionVersion-enum" />QStyleOptionHeader.StyleOptionVersion</h3><p>This enum is used to hold information about the version of the
style option, and is defined for each <a href="qstyleoption.html">QStyleOption</a> subclass.</p>
<table class="valuelist">
<tr class="odd" valign="top">
<th class="tblConst">Constant</th>
<th class="tblval">Value</th>
<th class="tbldscr">Description</th>
</tr>
<tr>
<td class="topAlign"><tt>QStyleOptionHeader.Version</tt></td>
<td class="topAlign"><tt>1</tt></td>
<td class="topAlign">1</td>
</tr>
</table>
<p>The version is used by <a href="qstyleoption.html">QStyleOption</a> subclasses to implement
extensions without breaking compatibility. If you use <a href="qstyleoption.html#qstyleoption_cast">qstyleoption_cast</a>(), you
normally do not need to check it.</p>
<p><b>See also</b> <a href="qstyleoptionheader.html#StyleOptionType-enum">StyleOptionType</a>.</p>
<hr /><h2>Method Documentation</h2><h3 class="fn"><a name="QStyleOptionHeader" />QStyleOptionHeader.__init__ (<i>self</i>)</h3><p>Constructs a <a href="qstyleoptionheader.html">QStyleOptionHeader</a>, initializing the
members variables to their default values.</p>
<h3 class="fn"><a name="QStyleOptionHeader-2" />QStyleOptionHeader.__init__ (<i>self</i>, <a href="qstyleoptionheader.html">QStyleOptionHeader</a> <i>other</i>)</h3><p>Constructs a copy of the <i>other</i> style option.</p>
<hr /><h2>Member Documentation</h2><h3 class="fn"><a name="icon-var" /><a href="qicon.html">QIcon</a> icon</h3><p>This variable holds the icon of the header.</p>
<p>The default value is an empty icon, i.e. an icon with neither a
pixmap nor a filename.</p>
<h3 class="fn"><a name="iconAlignment-var" /><a href="qt-alignment.html">Qt.Alignment</a> iconAlignment</h3><p>This variable holds the alignment flags for the icon of the
header.</p>
<p>The default value is <a href="qt.html#AlignmentFlag-enum">Qt.AlignLeft</a>.</p>
<h3 class="fn"><a name="orientation-var" /><a href="qt.html#Orientation-enum">Qt.Orientation</a> orientation</h3><p>This variable holds the header's orientation (horizontal or
vertical).</p>
<p>The default orientation is <a href="qt.html#Orientation-enum">Qt.Horizontal</a></p>
<h3 class="fn"><a name="position-var" /><a href="qstyleoptionheader.html#SectionPosition-enum">SectionPosition</a> position</h3><p>This variable holds the section's position in relation to the
other sections.</p>
<p>The default value is <a href="qstyleoptionheader.html#SectionPosition-enum">QStyleOptionHeader.Beginning</a>.</p>
<h3 class="fn"><a name="section-var" />int section</h3><p>This variable holds which section of the header is being
painted.</p>
<p>The default value is 0.</p>
<h3 class="fn"><a name="selectedPosition-var" /><a href="qstyleoptionheader.html#SelectedPosition-enum">SelectedPosition</a> selectedPosition</h3><p>This variable holds the section's position in relation to the
selected section.</p>
<p>The default value is <a href="qstyleoptionheader.html#SelectedPosition-enum">QStyleOptionHeader.NotAdjacent</a></p>
<h3 class="fn"><a name="sortIndicator-var" /><a href="qstyleoptionheader.html#SortIndicator-enum">SortIndicator</a> sortIndicator</h3><p>This variable holds the direction the sort indicator should be
drawn.</p>
<p>The default value is <a href="qstyleoptionheader.html#SortIndicator-enum">QStyleOptionHeader.None</a>.</p>
<h3 class="fn"><a name="text-var" />QString text</h3><p>This variable holds the text of the header.</p>
<p>The default value is an empty string.</p>
<h3 class="fn"><a name="textAlignment-var" /><a href="qt-alignment.html">Qt.Alignment</a> textAlignment</h3><p>This variable holds the alignment flags for the text of the
header.</p>
<p>The default value is <a href="qt.html#AlignmentFlag-enum">Qt.AlignLeft</a>.</p>
<address><hr /><div align="center"><table border="0" cellspacing="0" width="100%"><tr class="address"><td align="left" width="25%">PyQt 4.10.3 for X11</td><td align="center" width="50%">Copyright © <a href="http://www.riverbankcomputing.com">Riverbank Computing Ltd</a> and <a href="http://www.qtsoftware.com">Nokia</a> 2012</td><td align="right" width="25%">Qt 4.8.5</td></tr></table></div></address></body></html>
