File: qstyleoptionheader.html

package info (click to toggle)
qt4-x11 4%3A4.8.2%2Bdfsg-11
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 701,696 kB
  • sloc: cpp: 2,686,179; ansic: 375,485; python: 25,859; sh: 19,349; xml: 17,091; perl: 14,765; yacc: 5,383; asm: 5,038; makefile: 1,259; lex: 555; ruby: 526; objc: 347; cs: 112; pascal: 112; php: 54; sed: 34
file content (225 lines) | stat: -rw-r--r-- 17,680 bytes parent folder | download 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qstyleoption.cpp -->
  <title>Qt 4.8: QStyleOptionHeader Class Reference</title>
  <link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
  <div class="content"> 
    <a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a>
  </div>
  <div class="breadcrumb toolblock">
    <ul>
      <li class="first"><a href="index.html">Home</a></li>
      <!--  Breadcrumbs go here -->
<li><a href="modules.html">Modules</a></li>
<li><a href="qtgui.html">QtGui</a></li>
<li>QStyleOptionHeader</li>
    </ul>
  </div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-types">Public Types</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#public-variables">Public Variables</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QStyleOptionHeader Class Reference</h1>
<!-- $$$QStyleOptionHeader-brief -->
<p>The QStyleOptionHeader class is used to describe the parameters for drawing a header. <a href="#details">More...</a></p>
<!-- @@@QStyleOptionHeader -->
<pre class="cpp"> <span class="preprocessor">#include &lt;QStyleOptionHeader&gt;</span></pre><p><b>Inherits: </b><a href="qstyleoption.html">QStyleOption</a>.</p>
<ul>
<li><a href="qstyleoptionheader-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-types"></a>
<h2>Public Types</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qstyleoptionheader.html#SectionPosition-enum">SectionPosition</a></b> { Beginning, Middle, End, OnlyOneSection }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qstyleoptionheader.html#SelectedPosition-enum">SelectedPosition</a></b> { NotAdjacent, NextIsSelected, PreviousIsSelected, NextAndPreviousAreSelected }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qstyleoptionheader.html#SortIndicator-enum">SortIndicator</a></b> { None, SortUp, SortDown }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qstyleoptionheader.html#StyleOptionType-enum">StyleOptionType</a></b> { Type }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qstyleoptionheader.html#StyleOptionVersion-enum">StyleOptionVersion</a></b> { Version }</td></tr>
</table>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qstyleoptionheader.html#QStyleOptionHeader">QStyleOptionHeader</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qstyleoptionheader.html#QStyleOptionHeader-2">QStyleOptionHeader</a></b> ( const QStyleOptionHeader &amp; <i>other</i> )</td></tr>
</table>
<ul>
<li class="fn">2 public functions inherited from <a href="qstyleoption.html#public-functions">QStyleOption</a></li>
</ul>
<a name="public-variables"></a>
<h2>Public Variables</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> QIcon </td><td class="memItemRight bottomAlign"><b><a href="qstyleoptionheader.html#icon-var">icon</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Qt::Alignment </td><td class="memItemRight bottomAlign"><b><a href="qstyleoptionheader.html#iconAlignment-var">iconAlignment</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Qt::Orientation </td><td class="memItemRight bottomAlign"><b><a href="qstyleoptionheader.html#orientation-var">orientation</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> SectionPosition </td><td class="memItemRight bottomAlign"><b><a href="qstyleoptionheader.html#position-var">position</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qstyleoptionheader.html#section-var">section</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> SelectedPosition </td><td class="memItemRight bottomAlign"><b><a href="qstyleoptionheader.html#selectedPosition-var">selectedPosition</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> SortIndicator </td><td class="memItemRight bottomAlign"><b><a href="qstyleoptionheader.html#sortIndicator-var">sortIndicator</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qstyleoptionheader.html#text-var">text</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Qt::Alignment </td><td class="memItemRight bottomAlign"><b><a href="qstyleoptionheader.html#textAlignment-var">textAlignment</a></b></td></tr>
</table>
<ul>
<li class="fn">7 public variables inherited from <a href="qstyleoption.html#public-variables">QStyleOption</a></li>
</ul>
<a name="details"></a>
<!-- $$$QStyleOptionHeader-description -->
<div class="descr">
<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&#x2e;, using the <tt>.</tt> or <tt>-&gt;</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>
</div>
<p><b>See also </b><a href="qstyleoption.html">QStyleOption</a>.</p>
<!-- @@@QStyleOptionHeader -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$SectionPosition$$$Beginning$$$Middle$$$End$$$OnlyOneSection -->
<h3 class="fn"><a name="SectionPosition-enum"></a>enum QStyleOptionHeader::<span class="name">SectionPosition</span></h3>
<p>This enum lets you know where the section's position is in relation to the other sections.</p>
<table class="valuelist"><tr valign="top" class="odd"><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>
<!-- @@@SectionPosition -->
<!-- $$$SelectedPosition$$$NotAdjacent$$$NextIsSelected$$$PreviousIsSelected$$$NextAndPreviousAreSelected -->
<h3 class="fn"><a name="SelectedPosition-enum"></a>enum QStyleOptionHeader::<span class="name">SelectedPosition</span></h3>
<p>This enum lets you know where the section's position is in relation to the selected section.</p>
<table class="valuelist"><tr valign="top" class="odd"><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>
<!-- @@@SelectedPosition -->
<!-- $$$SortIndicator$$$None$$$SortUp$$$SortDown -->
<h3 class="fn"><a name="SortIndicator-enum"></a>enum QStyleOptionHeader::<span class="name">SortIndicator</span></h3>
<p>Indicates which direction the sort indicator should be drawn</p>
<table class="valuelist"><tr valign="top" class="odd"><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>
<!-- @@@SortIndicator -->
<!-- $$$StyleOptionType$$$Type -->
<h3 class="fn"><a name="StyleOptionType-enum"></a>enum QStyleOptionHeader::<span class="name">StyleOptionType</span></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 valign="top" class="odd"><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>
<!-- @@@StyleOptionType -->
<!-- $$$StyleOptionVersion$$$Version -->
<h3 class="fn"><a name="StyleOptionVersion-enum"></a>enum QStyleOptionHeader::<span class="name">StyleOptionVersion</span></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 valign="top" class="odd"><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>
<!-- @@@StyleOptionVersion -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QStyleOptionHeader[overload1]$$$QStyleOptionHeader -->
<h3 class="fn"><a name="QStyleOptionHeader"></a>QStyleOptionHeader::<span class="name">QStyleOptionHeader</span> ()</h3>
<p>Constructs a <a href="qstyleoptionheader.html">QStyleOptionHeader</a>, initializing the members variables to their default values.</p>
<!-- @@@QStyleOptionHeader -->
<!-- $$$QStyleOptionHeader$$$QStyleOptionHeaderconstQStyleOptionHeader& -->
<h3 class="fn"><a name="QStyleOptionHeader-2"></a>QStyleOptionHeader::<span class="name">QStyleOptionHeader</span> ( const <span class="type">QStyleOptionHeader</span> &amp; <i>other</i> )</h3>
<p>Constructs a copy of the <i>other</i> style option.</p>
<!-- @@@QStyleOptionHeader -->
</div>
<div class="vars">
<h2>Member Variable Documentation</h2>
<!-- $$$icon -->
<h3 class="fn"><a name="icon-var"></a><span class="type"><a href="qicon.html">QIcon</a></span> QStyleOptionHeader::<span class="name">icon</span></h3>
<p>This variable holds the icon of the header.</p>
<p>The default value is an empty icon, i.e&#x2e; an icon with neither a pixmap nor a filename.</p>
<!-- @@@icon -->
<!-- $$$iconAlignment -->
<h3 class="fn"><a name="iconAlignment-var"></a><span class="type"><a href="qt.html#AlignmentFlag-enum">Qt::Alignment</a></span> QStyleOptionHeader::<span class="name">iconAlignment</span></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>
<!-- @@@iconAlignment -->
<!-- $$$orientation -->
<h3 class="fn"><a name="orientation-var"></a><span class="type"><a href="qt.html#Orientation-enum">Qt::Orientation</a></span> QStyleOptionHeader::<span class="name">orientation</span></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>
<!-- @@@orientation -->
<!-- $$$position -->
<h3 class="fn"><a name="position-var"></a><span class="type"><a href="qstyleoptionheader.html#SectionPosition-enum">SectionPosition</a></span> QStyleOptionHeader::<span class="name">position</span></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>
<!-- @@@position -->
<!-- $$$section -->
<h3 class="fn"><a name="section-var"></a><span class="type">int</span> QStyleOptionHeader::<span class="name">section</span></h3>
<p>This variable holds which section of the header is being painted.</p>
<p>The default value is 0.</p>
<!-- @@@section -->
<!-- $$$selectedPosition -->
<h3 class="fn"><a name="selectedPosition-var"></a><span class="type"><a href="qstyleoptionheader.html#SelectedPosition-enum">SelectedPosition</a></span> QStyleOptionHeader::<span class="name">selectedPosition</span></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>
<!-- @@@selectedPosition -->
<!-- $$$sortIndicator -->
<h3 class="fn"><a name="sortIndicator-var"></a><span class="type"><a href="qstyleoptionheader.html#SortIndicator-enum">SortIndicator</a></span> QStyleOptionHeader::<span class="name">sortIndicator</span></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>
<!-- @@@sortIndicator -->
<!-- $$$text -->
<h3 class="fn"><a name="text-var"></a><span class="type"><a href="qstring.html">QString</a></span> QStyleOptionHeader::<span class="name">text</span></h3>
<p>This variable holds the text of the header.</p>
<p>The default value is an empty string.</p>
<!-- @@@text -->
<!-- $$$textAlignment -->
<h3 class="fn"><a name="textAlignment-var"></a><span class="type"><a href="qt.html#AlignmentFlag-enum">Qt::Alignment</a></span> QStyleOptionHeader::<span class="name">textAlignment</span></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>
<!-- @@@textAlignment -->
</div>
  <div class="ft">
    <span></span>
  </div>
</div> 
<div class="footer">
    <p>
      <acronym title="Copyright">&copy;</acronym> 2012 Nokia Corporation and/or its
      subsidiaries. Documentation contributions included herein are the copyrights of
      their respective owners.</p>
    <br />
    <p>
      The documentation provided herein is licensed under the terms of the
      <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation
      License version 1.3</a> as published by the Free Software Foundation.</p>
    <p>
      Documentation sources may be obtained from <a href="http://www.qt-project.org">
      www.qt-project.org</a>.</p>
    <br />
    <p>
      Nokia, Qt and their respective logos are trademarks of Nokia Corporation 
      in Finland and/or other countries worldwide. All other trademarks are property
      of their respective owners. <a title="Privacy Policy"
      href="http://en.gitorious.org/privacy_policy/">Privacy Policy</a></p>
</div>
</body>
</html>