File: qstyleoptiontoolbar.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 (201 lines) | stat: -rw-r--r-- 16,973 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
 
<?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: QStyleOptionToolBar 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>QStyleOptionToolBar</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">QStyleOptionToolBar Class Reference</h1>
<!-- $$$QStyleOptionToolBar-brief -->
<p>The QStyleOptionToolBar class is used to describe the parameters for drawing a toolbar. <a href="#details">More...</a></p>
<!-- @@@QStyleOptionToolBar -->
<pre class="cpp"> <span class="preprocessor">#include &lt;QStyleOptionToolBar&gt;</span></pre><p><b>Inherits: </b><a href="qstyleoption.html">QStyleOption</a>.</p>
<p>This class was introduced in Qt 4.1.</p>
<ul>
<li><a href="qstyleoptiontoolbar-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="qstyleoptiontoolbar.html#StyleOptionType-enum">StyleOptionType</a></b> { Type }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qstyleoptiontoolbar.html#StyleOptionVersion-enum">StyleOptionVersion</a></b> { Version }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qstyleoptiontoolbar.html#ToolBarFeature-enum">ToolBarFeature</a></b> { None, Movable }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> flags </td><td class="memItemRight bottomAlign"><b><a href="qstyleoptiontoolbar.html#ToolBarFeature-enum">ToolBarFeatures</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qstyleoptiontoolbar.html#ToolBarPosition-enum">ToolBarPosition</a></b> { Beginning, Middle, End, OnlyOne }</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="qstyleoptiontoolbar.html#QStyleOptionToolBar">QStyleOptionToolBar</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qstyleoptiontoolbar.html#QStyleOptionToolBar-2">QStyleOptionToolBar</a></b> ( const QStyleOptionToolBar &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"> ToolBarFeatures </td><td class="memItemRight bottomAlign"><b><a href="qstyleoptiontoolbar.html#features-var">features</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qstyleoptiontoolbar.html#lineWidth-var">lineWidth</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qstyleoptiontoolbar.html#midLineWidth-var">midLineWidth</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> ToolBarPosition </td><td class="memItemRight bottomAlign"><b><a href="qstyleoptiontoolbar.html#positionOfLine-var">positionOfLine</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> ToolBarPosition </td><td class="memItemRight bottomAlign"><b><a href="qstyleoptiontoolbar.html#positionWithinLine-var">positionWithinLine</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Qt::ToolBarArea </td><td class="memItemRight bottomAlign"><b><a href="qstyleoptiontoolbar.html#toolBarArea-var">toolBarArea</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>
<!-- $$$QStyleOptionToolBar-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QStyleOptionToolBar class is used to describe the parameters for drawing a toolbar.</p>
<p>QStyleOptionToolBar contains all the information that <a href="qstyle.html">QStyle</a> functions need to draw <a href="qtoolbar.html">QToolBar</a>.</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>The QStyleOptionToolBar class holds the <a href="qstyleoptiontoolbar.html#lineWidth-var">lineWidth</a> and the <a href="qstyleoptiontoolbar.html#midLineWidth-var">midLineWidth</a> for drawing the widget. It also stores information about which <a href="qstyleoptiontoolbar.html#toolBarArea-var">area</a> the toolbar should be located in, whether it is movable or not, which position the toolbar line should have (<a href="qstyleoptiontoolbar.html#positionOfLine-var">positionOfLine</a>), and the toolbar's position within the line (<a href="qstyleoptiontoolbar.html#positionWithinLine-var">positionWithinLine</a>).</p>
<p>In addition, the class provides a couple of enums: The <a href="qstyleoptiontoolbar.html#ToolBarFeature-enum">ToolBarFeature</a> enum is used to describe whether a toolbar is movable or not, and the <a href="qstyleoptiontoolbar.html#ToolBarPosition-enum">ToolBarPosition</a> enum is used to describe the position of a toolbar line, as well as the toolbar's position within the line.</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>
<!-- @@@QStyleOptionToolBar -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$StyleOptionType$$$Type -->
<h3 class="fn"><a name="StyleOptionType-enum"></a>enum QStyleOptionToolBar::<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>QStyleOptionToolBar::Type</tt></td><td class="topAlign"><tt>SO_ToolBar</tt></td><td class="topAlign">The type of style option provided (<a href="qstyleoption.html#OptionType-enum">SO_ToolBar</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="qstyleoptiontoolbar.html#StyleOptionVersion-enum">StyleOptionVersion</a>.</p>
<!-- @@@StyleOptionType -->
<!-- $$$StyleOptionVersion$$$Version -->
<h3 class="fn"><a name="StyleOptionVersion-enum"></a>enum QStyleOptionToolBar::<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>QStyleOptionToolBar::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="qstyleoptiontoolbar.html#StyleOptionType-enum">StyleOptionType</a>.</p>
<!-- @@@StyleOptionVersion -->
<!-- $$$ToolBarFeature$$$None$$$Movable -->
<h3 class="flags"><a name="ToolBarFeature-enum"></a>enum QStyleOptionToolBar::<span class="name">ToolBarFeature</span><br/>flags QStyleOptionToolBar::<span class="name">ToolBarFeatures</span></h3>
<p>This enum is used to describe whether a toolbar is movable or not.</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>QStyleOptionToolBar::None</tt></td><td class="topAlign"><tt>0x0</tt></td><td class="topAlign">The toolbar cannot be moved. The default value.</td></tr>
<tr><td class="topAlign"><tt>QStyleOptionToolBar::Movable</tt></td><td class="topAlign"><tt>0x1</tt></td><td class="topAlign">The toolbar is movable, and a handle will appear when holding the cursor over the toolbar's boundary.</td></tr>
</table>
<p>The ToolBarFeatures type is a typedef for <a href="qflags.html">QFlags</a>&lt;ToolBarFeature&gt;. It stores an OR combination of ToolBarFeature values.</p>
<p><b>See also </b><a href="qstyleoptiontoolbar.html#features-var">features</a> and <a href="qtoolbar.html#movable-prop">QToolBar::isMovable</a>().</p>
<!-- @@@ToolBarFeature -->
<!-- $$$ToolBarPosition$$$Beginning$$$Middle$$$End$$$OnlyOne -->
<h3 class="fn"><a name="ToolBarPosition-enum"></a>enum QStyleOptionToolBar::<span class="name">ToolBarPosition</span></h3>
<p class="centerAlign"><img src="images/qstyleoptiontoolbar-position.png" alt="" /></p><p>This enum is used to describe the position of a toolbar line, as well as the toolbar's position within the line.</p>
<p>The order of the positions within a line starts at the top of a vertical line, and from the left within a horizontal line. The order of the positions for the lines is always from the the parent widget's boundary edges.</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>QStyleOptionToolBar::Beginning</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">The toolbar is located at the beginning of the line, or the toolbar line is the first of several lines. There can only be one toolbar (and only one line) with this position.</td></tr>
<tr><td class="topAlign"><tt>QStyleOptionToolBar::Middle</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign">The toolbar is located in the middle of the line, or the toolbar line is in the middle of several lines. There can several toolbars (and lines) with this position.</td></tr>
<tr><td class="topAlign"><tt>QStyleOptionToolBar::End</tt></td><td class="topAlign"><tt>2</tt></td><td class="topAlign">The toolbar is located at the end of the line, or the toolbar line is the last of several lines. There can only be one toolbar (and only one line) with this position.</td></tr>
<tr><td class="topAlign"><tt>QStyleOptionToolBar::OnlyOne</tt></td><td class="topAlign"><tt>3</tt></td><td class="topAlign">There is only one toolbar or line. This is the default value of the <a href="qstyleoptiontoolbar.html#positionOfLine-var">positionOfLine</a> and <a href="qstyleoptiontoolbar.html#positionWithinLine-var">positionWithinLine</a> variables.</td></tr>
</table>
<p><b>See also </b><a href="qstyleoptiontoolbar.html#positionWithinLine-var">positionWithinLine</a> and <a href="qstyleoptiontoolbar.html#positionOfLine-var">positionOfLine</a>.</p>
<!-- @@@ToolBarPosition -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QStyleOptionToolBar[overload1]$$$QStyleOptionToolBar -->
<h3 class="fn"><a name="QStyleOptionToolBar"></a>QStyleOptionToolBar::<span class="name">QStyleOptionToolBar</span> ()</h3>
<p>Constructs a <a href="qstyleoptiontoolbar.html">QStyleOptionToolBar</a>, initializing the members variables to their default values.</p>
<!-- @@@QStyleOptionToolBar -->
<!-- $$$QStyleOptionToolBar$$$QStyleOptionToolBarconstQStyleOptionToolBar& -->
<h3 class="fn"><a name="QStyleOptionToolBar-2"></a>QStyleOptionToolBar::<span class="name">QStyleOptionToolBar</span> ( const <span class="type">QStyleOptionToolBar</span> &amp; <i>other</i> )</h3>
<p>Constructs a copy of the <i>other</i> style option.</p>
<!-- @@@QStyleOptionToolBar -->
</div>
<div class="vars">
<h2>Member Variable Documentation</h2>
<!-- $$$features -->
<h3 class="fn"><a name="features-var"></a><span class="type"><a href="qstyleoptiontoolbar.html#ToolBarFeature-enum">ToolBarFeatures</a></span> QStyleOptionToolBar::<span class="name">features</span></h3>
<p>This variable holds whether the toolbar is movable or not.</p>
<p>The default value is <a href="qstyleoptiontoolbar.html#ToolBarFeature-enum">None</a>.</p>
<!-- @@@features -->
<!-- $$$lineWidth -->
<h3 class="fn"><a name="lineWidth-var"></a><span class="type">int</span> QStyleOptionToolBar::<span class="name">lineWidth</span></h3>
<p>This variable holds the line width for drawing the toolbar.</p>
<p>The default value is 0.</p>
<!-- @@@lineWidth -->
<!-- $$$midLineWidth -->
<h3 class="fn"><a name="midLineWidth-var"></a><span class="type">int</span> QStyleOptionToolBar::<span class="name">midLineWidth</span></h3>
<p>This variable holds the mid-line width for drawing the toolbar.</p>
<p>The default value is 0.</p>
<!-- @@@midLineWidth -->
<!-- $$$positionOfLine -->
<h3 class="fn"><a name="positionOfLine-var"></a><span class="type"><a href="qstyleoptiontoolbar.html#ToolBarPosition-enum">ToolBarPosition</a></span> QStyleOptionToolBar::<span class="name">positionOfLine</span></h3>
<p>This variable holds the position of the toolbar line.</p>
<p>The default value is <a href="qstyleoptiontoolbar.html#ToolBarPosition-enum">QStyleOptionToolBar::OnlyOne</a>.</p>
<!-- @@@positionOfLine -->
<!-- $$$positionWithinLine -->
<h3 class="fn"><a name="positionWithinLine-var"></a><span class="type"><a href="qstyleoptiontoolbar.html#ToolBarPosition-enum">ToolBarPosition</a></span> QStyleOptionToolBar::<span class="name">positionWithinLine</span></h3>
<p>This variable holds the position of the toolbar within a line.</p>
<p>The default value is <a href="qstyleoptiontoolbar.html#ToolBarPosition-enum">QStyleOptionToolBar::OnlyOne</a>.</p>
<!-- @@@positionWithinLine -->
<!-- $$$toolBarArea -->
<h3 class="fn"><a name="toolBarArea-var"></a><span class="type"><a href="qt.html#ToolBarArea-enum">Qt::ToolBarArea</a></span> QStyleOptionToolBar::<span class="name">toolBarArea</span></h3>
<p>This variable holds the location for drawing the toolbar.</p>
<p>The default value is <a href="qt.html#ToolBarArea-enum">Qt::TopToolBarArea</a>.</p>
<p><b>See also </b><a href="qt.html#ToolBarArea-enum">Qt::ToolBarArea</a>.</p>
<!-- @@@toolBarArea -->
</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>