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
|
<?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" />
<!-- qsplitter.cpp -->
<title>Qt 4.8: QSplitterHandle 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>QSplitterHandle</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-functions">Public Functions</a></li>
<li class="level1"><a href="#protected-functions">Protected Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QSplitterHandle Class Reference</h1>
<!-- $$$QSplitterHandle-brief -->
<p>The QSplitterHandle class provides handle functionality of the splitter. <a href="#details">More...</a></p>
<!-- @@@QSplitterHandle -->
<pre class="cpp"> <span class="preprocessor">#include <QSplitterHandle></span></pre><p><b>Inherits: </b><a href="qwidget.html">QWidget</a>.</p>
<ul>
<li><a href="qsplitterhandle-members.html">List of all members, including inherited members</a></li>
</ul>
<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="qsplitterhandle.html#QSplitterHandle">QSplitterHandle</a></b> ( Qt::Orientation <i>orientation</i>, QSplitter * <i>parent</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qsplitterhandle.html#opaqueResize">opaqueResize</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Qt::Orientation </td><td class="memItemRight bottomAlign"><b><a href="qsplitterhandle.html#orientation">orientation</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qsplitterhandle.html#setOrientation">setOrientation</a></b> ( Qt::Orientation <i>orientation</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QSplitter * </td><td class="memItemRight bottomAlign"><b><a href="qsplitterhandle.html#splitter">splitter</a></b> () const</td></tr>
</table>
<a name="reimplemented-public-functions"></a>
<h2>Reimplemented Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> virtual QSize </td><td class="memItemRight bottomAlign"><b><a href="qsplitterhandle.html#sizeHint">sizeHint</a></b> () const</td></tr>
</table>
<ul>
<li class="fn">221 public functions inherited from <a href="qwidget.html#public-functions">QWidget</a></li>
<li class="fn">29 public functions inherited from <a href="qobject.html#public-functions">QObject</a></li>
<li class="fn">13 public functions inherited from <a href="qpaintdevice.html#public-functions">QPaintDevice</a></li>
</ul>
<a name="protected-functions"></a>
<h2>Protected Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qsplitterhandle.html#closestLegalPosition">closestLegalPosition</a></b> ( int <i>pos</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qsplitterhandle.html#moveSplitter">moveSplitter</a></b> ( int <i>pos</i> )</td></tr>
</table>
<a name="reimplemented-protected-functions"></a>
<h2>Reimplemented Protected Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qsplitterhandle.html#event">event</a></b> ( QEvent * <i>event</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qsplitterhandle.html#mouseMoveEvent">mouseMoveEvent</a></b> ( QMouseEvent * <i>e</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qsplitterhandle.html#mousePressEvent">mousePressEvent</a></b> ( QMouseEvent * <i>e</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qsplitterhandle.html#mouseReleaseEvent">mouseReleaseEvent</a></b> ( QMouseEvent * <i>e</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qsplitterhandle.html#paintEvent">paintEvent</a></b> ( QPaintEvent * )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qsplitterhandle.html#resizeEvent">resizeEvent</a></b> ( QResizeEvent * <i>event</i> )</td></tr>
</table>
<ul>
<li class="fn">37 protected functions inherited from <a href="qwidget.html#protected-functions">QWidget</a></li>
<li class="fn">8 protected functions inherited from <a href="qobject.html#protected-functions">QObject</a></li>
<li class="fn">1 protected function inherited from <a href="qpaintdevice.html#protected-functions">QPaintDevice</a></li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">58 properties inherited from <a href="qwidget.html#properties">QWidget</a></li>
<li class="fn">1 property inherited from <a href="qobject.html#properties">QObject</a></li>
<li class="fn">19 public slots inherited from <a href="qwidget.html#public-slots">QWidget</a></li>
<li class="fn">1 public slot inherited from <a href="qobject.html#public-slots">QObject</a></li>
<li class="fn">1 signal inherited from <a href="qwidget.html#signals">QWidget</a></li>
<li class="fn">1 signal inherited from <a href="qobject.html#signals">QObject</a></li>
<li class="fn">4 static public members inherited from <a href="qwidget.html#static-public-members">QWidget</a></li>
<li class="fn">7 static public members inherited from <a href="qobject.html#static-public-members">QObject</a></li>
<li class="fn">1 protected slot inherited from <a href="qwidget.html#protected-slots">QWidget</a></li>
</ul>
<a name="details"></a>
<!-- $$$QSplitterHandle-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QSplitterHandle class provides handle functionality of the splitter.</p>
<p>QSplitterHandle is typically what people think about when they think about a splitter. It is the handle that is used to resize the widgets.</p>
<p>A typical developer using <a href="qsplitter.html">QSplitter</a> will never have to worry about QSplitterHandle. It is provided for developers who want splitter handles that provide extra features, such as popup menus.</p>
<p>The typical way one would create splitter handles is to subclass <a href="qsplitter.html">QSplitter</a> then reimplement <a href="qsplitter.html#createHandle">QSplitter::createHandle</a>() to instantiate the custom splitter handle. For example, a minimum <a href="qsplitter.html">QSplitter</a> subclass might look like this:</p>
<pre class="cpp"> <span class="keyword">class</span> Splitter : <span class="keyword">public</span> <span class="type"><a href="qsplitter.html">QSplitter</a></span>
{
<span class="keyword">public</span>:
Splitter(<span class="type"><a href="qt.html">Qt</a></span><span class="operator">::</span>Orientation orientation<span class="operator">,</span> <span class="type"><a href="qwidget.html">QWidget</a></span> <span class="operator">*</span>parent <span class="operator">=</span> <span class="number">0</span>);
<span class="keyword">protected</span>:
<span class="type">QSplitterHandle</span> <span class="operator">*</span>createHandle();
};</pre>
<p>The <a href="qsplitter.html#createHandle">createHandle()</a> implementation simply constructs a custom splitter handle, called <tt>Splitter</tt> in this example:</p>
<pre class="cpp"> <span class="type">QSplitterHandle</span> <span class="operator">*</span>Splitter<span class="operator">::</span>createHandle()
{
<span class="keyword">return</span> <span class="keyword">new</span> SplitterHandle(orientation()<span class="operator">,</span> <span class="keyword">this</span>);
}</pre>
<p>Information about a given handle can be obtained using functions like <a href="qsplitterhandle.html#orientation">orientation</a>() and <a href="qsplitterhandle.html#opaqueResize">opaqueResize</a>(), and is retrieved from its parent splitter. Details like these can be used to give custom handles different appearances depending on the splitter's orientation.</p>
<p>The complexity of a custom handle subclass depends on the tasks that it needs to perform. A simple subclass might only provide a <a href="qsplitterhandle.html#paintEvent">paintEvent</a>() implementation:</p>
<pre class="cpp"> <span class="type">void</span> SplitterHandle<span class="operator">::</span><a href="qsplitterhandle.html#paintEvent">paintEvent</a>(<span class="type"><a href="qpaintevent.html">QPaintEvent</a></span> <span class="operator">*</span>event)
{
<span class="type"><a href="qpainter.html">QPainter</a></span> painter(<span class="keyword">this</span>);
<span class="keyword">if</span> (orientation() <span class="operator">=</span><span class="operator">=</span> <span class="type"><a href="qt.html">Qt</a></span><span class="operator">::</span>Horizontal) {
gradient<span class="operator">.</span>setStart(rect()<span class="operator">.</span>left()<span class="operator">,</span> rect()<span class="operator">.</span>height()<span class="operator">/</span><span class="number">2</span>);
gradient<span class="operator">.</span>setFinalStop(rect()<span class="operator">.</span>right()<span class="operator">,</span> rect()<span class="operator">.</span>height()<span class="operator">/</span><span class="number">2</span>);
} <span class="keyword">else</span> {
gradient<span class="operator">.</span>setStart(rect()<span class="operator">.</span>width()<span class="operator">/</span><span class="number">2</span><span class="operator">,</span> rect()<span class="operator">.</span>top());
gradient<span class="operator">.</span>setFinalStop(rect()<span class="operator">.</span>width()<span class="operator">/</span><span class="number">2</span><span class="operator">,</span> rect()<span class="operator">.</span>bottom());
}
painter<span class="operator">.</span>fillRect(event<span class="operator">-</span><span class="operator">></span>rect()<span class="operator">,</span> <span class="type"><a href="qbrush.html">QBrush</a></span>(gradient));
}</pre>
<p>In this example, a predefined gradient is set up differently depending on the orientation of the handle. QSplitterHandle provides a reasonable size hint for the handle, so the subclass does not need to provide a reimplementation of <a href="qsplitterhandle.html#sizeHint">sizeHint</a>() unless the handle has special size requirements.</p>
</div>
<p><b>See also </b><a href="qsplitter.html">QSplitter</a>.</p>
<!-- @@@QSplitterHandle -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QSplitterHandle[overload1]$$$QSplitterHandleQt::OrientationQSplitter* -->
<h3 class="fn"><a name="QSplitterHandle"></a>QSplitterHandle::<span class="name">QSplitterHandle</span> ( <span class="type"><a href="qt.html#Orientation-enum">Qt::Orientation</a></span> <i>orientation</i>, <span class="type"><a href="qsplitter.html">QSplitter</a></span> * <i>parent</i> )</h3>
<p>Creates a <a href="qsplitter.html">QSplitter</a> handle with the given <i>orientation</i> and <a href="qsplitter.html">QSplitter</a> <i>parent</i>.</p>
<!-- @@@QSplitterHandle -->
<!-- $$$closestLegalPosition[overload1]$$$closestLegalPositionint -->
<h3 class="fn"><a name="closestLegalPosition"></a><span class="type">int</span> QSplitterHandle::<span class="name">closestLegalPosition</span> ( <span class="type">int</span> <i>pos</i> )<tt> [protected]</tt></h3>
<p>Returns the closest legal position to <i>pos</i> of the splitter handle. The positions are measured from the left or top edge of the splitter, even for right-to-left languages.</p>
<p><b>See also </b><a href="qsplitter.html#closestLegalPosition">QSplitter::closestLegalPosition</a>() and <a href="qsplitterhandle.html#moveSplitter">moveSplitter</a>().</p>
<!-- @@@closestLegalPosition -->
<!-- $$$event[overload1]$$$eventQEvent* -->
<h3 class="fn"><a name="event"></a><span class="type">bool</span> QSplitterHandle::<span class="name">event</span> ( <span class="type"><a href="qevent.html">QEvent</a></span> * <i>event</i> )<tt> [virtual protected]</tt></h3>
<p>Reimplemented from <a href="qobject.html#event">QObject::event</a>().</p>
<!-- @@@event -->
<!-- $$$mouseMoveEvent[overload1]$$$mouseMoveEventQMouseEvent* -->
<h3 class="fn"><a name="mouseMoveEvent"></a><span class="type">void</span> QSplitterHandle::<span class="name">mouseMoveEvent</span> ( <span class="type"><a href="qmouseevent.html">QMouseEvent</a></span> * <i>e</i> )<tt> [virtual protected]</tt></h3>
<p>Reimplemented from <a href="qwidget.html#mouseMoveEvent">QWidget::mouseMoveEvent</a>().</p>
<!-- @@@mouseMoveEvent -->
<!-- $$$mousePressEvent[overload1]$$$mousePressEventQMouseEvent* -->
<h3 class="fn"><a name="mousePressEvent"></a><span class="type">void</span> QSplitterHandle::<span class="name">mousePressEvent</span> ( <span class="type"><a href="qmouseevent.html">QMouseEvent</a></span> * <i>e</i> )<tt> [virtual protected]</tt></h3>
<p>Reimplemented from <a href="qwidget.html#mousePressEvent">QWidget::mousePressEvent</a>().</p>
<!-- @@@mousePressEvent -->
<!-- $$$mouseReleaseEvent[overload1]$$$mouseReleaseEventQMouseEvent* -->
<h3 class="fn"><a name="mouseReleaseEvent"></a><span class="type">void</span> QSplitterHandle::<span class="name">mouseReleaseEvent</span> ( <span class="type"><a href="qmouseevent.html">QMouseEvent</a></span> * <i>e</i> )<tt> [virtual protected]</tt></h3>
<p>Reimplemented from <a href="qwidget.html#mouseReleaseEvent">QWidget::mouseReleaseEvent</a>().</p>
<!-- @@@mouseReleaseEvent -->
<!-- $$$moveSplitter[overload1]$$$moveSplitterint -->
<h3 class="fn"><a name="moveSplitter"></a><span class="type">void</span> QSplitterHandle::<span class="name">moveSplitter</span> ( <span class="type">int</span> <i>pos</i> )<tt> [protected]</tt></h3>
<p>Tells the splitter to move this handle to position <i>pos</i>, which is the distance from the left or top edge of the widget.</p>
<p>Note that <i>pos</i> is also measured from the left (or top) for right-to-left languages. This function will map <i>pos</i> to the appropriate position before calling <a href="qsplitter.html#moveSplitter">QSplitter::moveSplitter</a>().</p>
<p><b>See also </b><a href="qsplitter.html#moveSplitter">QSplitter::moveSplitter</a>() and <a href="qsplitterhandle.html#closestLegalPosition">closestLegalPosition</a>().</p>
<!-- @@@moveSplitter -->
<!-- $$$opaqueResize[overload1]$$$opaqueResize -->
<h3 class="fn"><a name="opaqueResize"></a><span class="type">bool</span> QSplitterHandle::<span class="name">opaqueResize</span> () const</h3>
<p>Returns true if widgets are resized dynamically (opaquely), otherwise returns false. This value is controlled by the <a href="qsplitter.html">QSplitter</a>.</p>
<p><b>See also </b><a href="qsplitter.html#opaqueResize-prop">QSplitter::opaqueResize</a>().</p>
<!-- @@@opaqueResize -->
<!-- $$$orientation[overload1]$$$orientation -->
<h3 class="fn"><a name="orientation"></a><span class="type"><a href="qt.html#Orientation-enum">Qt::Orientation</a></span> QSplitterHandle::<span class="name">orientation</span> () const</h3>
<p>Returns the handle's orientation. This is usually propagated from the <a href="qsplitter.html">QSplitter</a>.</p>
<p><b>See also </b><a href="qsplitterhandle.html#setOrientation">setOrientation</a>() and <a href="qsplitter.html#orientation-prop">QSplitter::orientation</a>().</p>
<!-- @@@orientation -->
<!-- $$$paintEvent[overload1]$$$paintEventQPaintEvent* -->
<h3 class="fn"><a name="paintEvent"></a><span class="type">void</span> QSplitterHandle::<span class="name">paintEvent</span> ( <span class="type"><a href="qpaintevent.html">QPaintEvent</a></span> * )<tt> [virtual protected]</tt></h3>
<p>Reimplemented from <a href="qwidget.html#paintEvent">QWidget::paintEvent</a>().</p>
<!-- @@@paintEvent -->
<!-- $$$resizeEvent[overload1]$$$resizeEventQResizeEvent* -->
<h3 class="fn"><a name="resizeEvent"></a><span class="type">void</span> QSplitterHandle::<span class="name">resizeEvent</span> ( <span class="type"><a href="qresizeevent.html">QResizeEvent</a></span> * <i>event</i> )<tt> [virtual protected]</tt></h3>
<p>Reimplemented from <a href="qwidget.html#resizeEvent">QWidget::resizeEvent</a>().</p>
<!-- @@@resizeEvent -->
<!-- $$$setOrientation[overload1]$$$setOrientationQt::Orientation -->
<h3 class="fn"><a name="setOrientation"></a><span class="type">void</span> QSplitterHandle::<span class="name">setOrientation</span> ( <span class="type"><a href="qt.html#Orientation-enum">Qt::Orientation</a></span> <i>orientation</i> )</h3>
<p>Sets the orientation of the splitter handle to <i>orientation</i>. This is usually propagated from the <a href="qsplitter.html">QSplitter</a>.</p>
<p><b>See also </b><a href="qsplitterhandle.html#orientation">orientation</a>() and <a href="qsplitter.html#orientation-prop">QSplitter::setOrientation</a>().</p>
<!-- @@@setOrientation -->
<!-- $$$sizeHint[overload1]$$$sizeHint -->
<h3 class="fn"><a name="sizeHint"></a><span class="type"><a href="qsize.html">QSize</a></span> QSplitterHandle::<span class="name">sizeHint</span> () const<tt> [virtual]</tt></h3>
<p>Reimplemented from <a href="qwidget.html#sizeHint-prop">QWidget::sizeHint</a>().</p>
<!-- @@@sizeHint -->
<!-- $$$splitter[overload1]$$$splitter -->
<h3 class="fn"><a name="splitter"></a><span class="type"><a href="qsplitter.html">QSplitter</a></span> * QSplitterHandle::<span class="name">splitter</span> () const</h3>
<p>Returns the splitter associated with this splitter handle.</p>
<p><b>See also </b><a href="qsplitter.html#handle">QSplitter::handle</a>().</p>
<!-- @@@splitter -->
</div>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</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>
|
