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
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
|
<?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" />
<!-- q3dockwindow.cpp -->
<title>Qt 4.8: Q3DockWindow 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>Qt3SupportLight</li>
<li>Q3DockWindow</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="#properties">Properties</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#public-slots">Public Slots</a></li>
<li class="level1"><a href="#signals">Signals</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">Q3DockWindow Class Reference</h1>
<!-- $$$Q3DockWindow-brief -->
<p>The Q3DockWindow class provides a widget which can be docked inside a <a href="q3dockarea.html">Q3DockArea</a> or floated as a top level window on the desktop. <a href="#details">More...</a></p>
<!-- @@@Q3DockWindow -->
<pre class="cpp"> <span class="preprocessor">#include <Q3DockWindow></span></pre><p><b>This class is part of the Qt 3 support library.</b> It is provided to keep old source code working. We strongly advise against using it in new code. See <a href="porting4.html#qdockwindow">Porting to Qt 4</a> for more information.</p>
<p><b>Inherits: </b><a href="q3frame.html">Q3Frame</a>.</p>
<p><b>Inherited by: </b><a href="q3toolbar.html">Q3ToolBar</a>.</p>
<ul>
<li><a href="q3dockwindow-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="q3dockwindow.html#CloseMode-enum">CloseMode</a></b> { Never, Docked, Undocked, Always }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="q3dockwindow.html#Place-enum">Place</a></b> { InDock, OutsideDock }</td></tr>
</table>
<a name="properties"></a>
<h2>Properties</h2>
<table class="propsummary">
<tr><td class="topAlign"><ul>
<li class="fn"><b><a href="q3dockwindow.html#closeMode-prop">closeMode</a></b> : int</li>
<li class="fn"><b><a href="q3dockwindow.html#horizontallyStretchable-prop">horizontallyStretchable</a></b> : bool</li>
<li class="fn"><b><a href="q3dockwindow.html#movingEnabled-prop">movingEnabled</a></b> : bool</li>
<li class="fn"><b><a href="q3dockwindow.html#newLine-prop">newLine</a></b> : bool</li>
<li class="fn"><b><a href="q3dockwindow.html#offset-prop">offset</a></b> : int</li>
</ul></td><td class="topAlign"><ul>
<li class="fn"><b><a href="q3dockwindow.html#opaqueMoving-prop">opaqueMoving</a></b> : bool</li>
<li class="fn"><b><a href="q3dockwindow.html#place-prop">place</a></b> : const Place</li>
<li class="fn"><b><a href="q3dockwindow.html#resizeEnabled-prop">resizeEnabled</a></b> : bool</li>
<li class="fn"><b><a href="q3dockwindow.html#stretchable-prop">stretchable</a></b> : const bool</li>
<li class="fn"><b><a href="q3dockwindow.html#verticallyStretchable-prop">verticallyStretchable</a></b> : bool</li>
</ul>
</td></tr>
</table>
<ul>
<li class="fn">2 properties inherited from <a href="q3frame.html#properties">Q3Frame</a></li>
<li class="fn">6 properties inherited from <a href="qframe.html#properties">QFrame</a></li>
<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>
</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="q3dockwindow.html#Q3DockWindow">Q3DockWindow</a></b> ( Place <i>p</i> = InDock, QWidget * <i>parent</i> = 0, const char * <i>name</i> = 0, Qt::WindowFlags <i>f</i> = 0 )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="q3dockwindow.html#Q3DockWindow-2">Q3DockWindow</a></b> ( QWidget * <i>parent</i>, const char * <i>name</i> = 0, Qt::WindowFlags <i>f</i> = 0 )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="q3dockwindow.html#dtor.Q3DockWindow">~Q3DockWindow</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Q3DockArea * </td><td class="memItemRight bottomAlign"><b><a href="q3dockwindow.html#area">area</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QBoxLayout * </td><td class="memItemRight bottomAlign"><b><a href="q3dockwindow.html#boxLayout">boxLayout</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="q3dockwindow.html#closeMode-prop">closeMode</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QSize </td><td class="memItemRight bottomAlign"><b><a href="q3dockwindow.html#fixedExtent">fixedExtent</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="q3dockwindow.html#isCloseEnabled">isCloseEnabled</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="q3dockwindow.html#isHorizontalStretchable">isHorizontalStretchable</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="q3dockwindow.html#horizontallyStretchable-prop">isHorizontallyStretchable</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="q3dockwindow.html#movingEnabled-prop">isMovingEnabled</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="q3dockwindow.html#resizeEnabled-prop">isResizeEnabled</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="q3dockwindow.html#stretchable-prop">isStretchable</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="q3dockwindow.html#isVerticalStretchable">isVerticalStretchable</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="q3dockwindow.html#verticallyStretchable-prop">isVerticallyStretchable</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="q3dockwindow.html#newLine-prop">newLine</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="q3dockwindow.html#offset-prop">offset</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="q3dockwindow.html#opaqueMoving-prop">opaqueMoving</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Qt::Orientation </td><td class="memItemRight bottomAlign"><b><a href="q3dockwindow.html#orientation">orientation</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Place </td><td class="memItemRight bottomAlign"><b><a href="q3dockwindow.html#place-prop">place</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3dockwindow.html#closeMode-prop">setCloseMode</a></b> ( int <i>m</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3dockwindow.html#setFixedExtentHeight">setFixedExtentHeight</a></b> ( int <i>h</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3dockwindow.html#setFixedExtentWidth">setFixedExtentWidth</a></b> ( int <i>w</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3dockwindow.html#setHorizontalStretchable">setHorizontalStretchable</a></b> ( bool <i>b</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3dockwindow.html#horizontallyStretchable-prop">setHorizontallyStretchable</a></b> ( bool <i>b</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3dockwindow.html#movingEnabled-prop">setMovingEnabled</a></b> ( bool <i>b</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3dockwindow.html#newLine-prop">setNewLine</a></b> ( bool <i>b</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3dockwindow.html#offset-prop">setOffset</a></b> ( int <i>o</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3dockwindow.html#opaqueMoving-prop">setOpaqueMoving</a></b> ( bool <i>b</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3dockwindow.html#resizeEnabled-prop">setResizeEnabled</a></b> ( bool <i>b</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3dockwindow.html#setVerticalStretchable">setVerticalStretchable</a></b> ( bool <i>b</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3dockwindow.html#verticallyStretchable-prop">setVerticallyStretchable</a></b> ( bool <i>b</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3dockwindow.html#setWidget">setWidget</a></b> ( QWidget * <i>w</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QWidget * </td><td class="memItemRight bottomAlign"><b><a href="q3dockwindow.html#widget">widget</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="q3dockwindow.html#windowTitle">windowTitle</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 bool </td><td class="memItemRight bottomAlign"><b><a href="q3dockwindow.html#eventFilter">eventFilter</a></b> ( QObject * <i>o</i>, QEvent * <i>e</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QSize </td><td class="memItemRight bottomAlign"><b><a href="q3dockwindow.html#minimumSizeHint">minimumSizeHint</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QSize </td><td class="memItemRight bottomAlign"><b><a href="q3dockwindow.html#sizeHint">sizeHint</a></b> () const</td></tr>
</table>
<ul>
<li class="fn">4 public functions inherited from <a href="q3frame.html#public-functions">Q3Frame</a></li>
<li class="fn">14 public functions inherited from <a href="qframe.html#public-functions">QFrame</a></li>
<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="public-slots"></a>
<h2>Public Slots</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3dockwindow.html#dock">dock</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3dockwindow.html#setOrientation">setOrientation</a></b> ( Qt::Orientation <i>o</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3dockwindow.html#undock">undock</a></b> ( QWidget * <i>widget</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3dockwindow.html#undock-2">undock</a></b> ()</td></tr>
</table>
<ul>
<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>
</ul>
<a name="signals"></a>
<h2>Signals</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3dockwindow.html#orientationChanged">orientationChanged</a></b> ( Qt::Orientation <i>o</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3dockwindow.html#placeChanged">placeChanged</a></b> ( Q3DockWindow::Place <i>p</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3dockwindow.html#visibilityChanged">visibilityChanged</a></b> ( bool <i>visible</i> )</td></tr>
</table>
<ul>
<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>
</ul>
<a name="reimplemented-protected-functions"></a>
<h2>Reimplemented Protected Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3dockwindow.html#contextMenuEvent">contextMenuEvent</a></b> ( QContextMenuEvent * <i>e</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3dockwindow.html#drawContents">drawContents</a></b> ( QPainter * <i>p</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3dockwindow.html#drawFrame">drawFrame</a></b> ( QPainter * <i>p</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="q3dockwindow.html#event">event</a></b> ( QEvent * <i>e</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3dockwindow.html#hideEvent">hideEvent</a></b> ( QHideEvent * <i>e</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3dockwindow.html#resizeEvent">resizeEvent</a></b> ( QResizeEvent * <i>e</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3dockwindow.html#showEvent">showEvent</a></b> ( QShowEvent * <i>e</i> )</td></tr>
</table>
<ul>
<li class="fn">5 protected functions inherited from <a href="q3frame.html#protected-functions">Q3Frame</a></li>
<li class="fn">3 protected functions inherited from <a href="qframe.html#protected-functions">QFrame</a></li>
<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">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">5 protected functions inherited from <a href="q3frame.html#protected-functions">Q3Frame</a></li>
<li class="fn">3 protected functions inherited from <a href="qframe.html#protected-functions">QFrame</a></li>
<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>
<li class="fn">1 protected slot inherited from <a href="qwidget.html#protected-slots">QWidget</a></li>
</ul>
<a name="details"></a>
<!-- $$$Q3DockWindow-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The Q3DockWindow class provides a widget which can be docked inside a <a href="q3dockarea.html">Q3DockArea</a> or floated as a top level window on the desktop.</p>
<p>This class handles moving, resizing, docking and undocking dock windows. <a href="q3toolbar.html">Q3ToolBar</a> is a subclass of Q3DockWindow so the functionality provided for dock windows is available with the same API for toolbars.</p>
<p class="centerAlign"><img src="images/qmainwindow-qdockareas.png" alt="Q3DockWindows in a Q3DockArea" /></p><p class="figCaption">Two Q3DockWindows (<a href="q3toolbar.html">Q3ToolBar</a>s) in a <a href="q3dockarea.html">Q3DockArea</a></p>
<p class="centerAlign"><img src="images/qdockwindow.png" alt="A Q3DockWindow" /></p><p class="figCaption">A Floating Q3DockWindow</p>
<p>If the user drags the dock window into the dock area the dock window will be docked. If the user drags the dock area outside any dock areas the dock window will be undocked (floated) and will become a top level window. Double clicking a floating dock window's title bar will dock the dock window to the last dock area it was docked in. Double clicking a docked dock window's handle will undock (float) the dock window. If the user clicks the close button (which appears on floating dock windows by default) the dock window will disappear. You can control whether or not a dock window has a close button with <a href="q3dockwindow.html#closeMode-prop">setCloseMode</a>().</p>
<p><a href="q3mainwindow.html">Q3MainWindow</a> provides four dock areas (top, left, right and bottom) which can be used by dock windows. For many applications using the dock areas provided by <a href="q3mainwindow.html">Q3MainWindow</a> is sufficient. (See the <a href="q3dockarea.html">Q3DockArea</a> documentation if you want to create your own dock areas.) In <a href="q3mainwindow.html">Q3MainWindow</a> a right-click popup menu (the dock window menu) is available which lists dock windows and can be used to show or hide them. (The popup menu only lists dock windows that have a <a href="qwidget.html#windowTitle-prop">caption</a>.)</p>
<p>When you construct a dock window you <i>must</i> pass it a <a href="q3dockarea.html">Q3DockArea</a> or a <a href="q3mainwindow.html">Q3MainWindow</a> as its parent if you want it docked. Pass 0 for the parent if you want it floated.</p>
<pre class="cpp"> <span class="type"><a href="q3toolbar.html">Q3ToolBar</a></span> <span class="operator">*</span>fileTools <span class="operator">=</span> <span class="keyword">new</span> <span class="type"><a href="q3toolbar.html">Q3ToolBar</a></span>(<span class="keyword">this</span><span class="operator">,</span> <span class="string">"File Actions"</span>);
moveDockWindow(fileTools<span class="operator">,</span> Left);</pre>
<p>In the example above we create a new <a href="q3toolbar.html">Q3ToolBar</a> in the constructor of a <a href="q3mainwindow.html">Q3MainWindow</a> subclass (so that the <i>this</i> pointer points to the <a href="q3mainwindow.html">Q3MainWindow</a>). By default the toolbar will be added to the <tt>Top</tt> dock area, but we've moved it to the <tt>Left</tt> dock area.</p>
<p>A dock window is often used to contain a single widget. In these cases the widget can be set by calling <a href="q3dockwindow.html#setWidget">setWidget</a>(). If you're constructing a dock window that contains multiple widgets, e.g. a toolbar, arrange the widgets within a box layout inside the dock window. To do this use the <a href="q3dockwindow.html#boxLayout">boxLayout</a>() function to get a pointer to the dock window's box layout, then add widgets to the layout using the box layout's <a href="qboxlayout.html#addWidget">QBoxLayout::addWidget</a>() function. The dock window will dynamically set the orientation of the layout to be vertical or horizontal as necessary, although you can control this yourself with <a href="q3dockwindow.html#setOrientation">setOrientation</a>().</p>
<p>Although a common use of dock windows is for toolbars, they can be used with any widgets. When using larger widgets it may make sense for the dock window to be resizable by calling <a href="q3dockwindow.html#resizeEnabled-prop">setResizeEnabled</a>(). Resizable dock windows are given splitter-like handles to allow the user to resize them within their dock area. When resizable dock windows are undocked they become top level windows and can be resized like any other top level windows, e.g. by dragging a corner or edge.</p>
<p><a href="qt-qt3.html#Dock-enum">Qt::Dock</a> windows can be docked and undocked using <a href="q3dockwindow.html#dock">dock</a>() and <a href="q3dockwindow.html#undock">undock</a>(). A dock window's orientation can be set with <a href="q3dockwindow.html#setOrientation">setOrientation</a>(). You can also use <a href="q3dockarea.html#moveDockWindow">Q3DockArea::moveDockWindow</a>(). If you're using a <a href="q3mainwindow.html">Q3MainWindow</a>, <a href="q3mainwindow.html#moveDockWindow">Q3MainWindow::moveDockWindow</a>() and <a href="q3mainwindow.html#removeDockWindow">Q3MainWindow::removeDockWindow</a>() are available.</p>
<p>A dock window can have some preferred settings, for example, you can set a preferred offset from the left edge (or top edge for vertical dock areas) of the dock area using <a href="q3dockwindow.html#offset-prop">setOffset</a>(). If you'd prefer a dock window to start on a new line when it is docked use <a href="q3dockwindow.html#newLine-prop">setNewLine</a>(). The <a href="q3dockwindow.html#setFixedExtentWidth">setFixedExtentWidth</a>() and <a href="q3dockwindow.html#setFixedExtentHeight">setFixedExtentHeight</a>() functions can be used to define the dock window's preferred size, and the <a href="q3dockwindow.html#horizontallyStretchable-prop">setHorizontallyStretchable</a>() and <a href="q3dockwindow.html#verticallyStretchable-prop">setVerticallyStretchable</a>() functions set whether the dock window can be stretched or not. Dock windows can be moved by default, but this can be changed with <a href="q3dockwindow.html#movingEnabled-prop">setMovingEnabled</a>(). When a dock window is moved it is shown as a rectangular outline, but it can be shown normally using <a href="q3dockwindow.html#opaqueMoving-prop">setOpaqueMoving</a>().</p>
<p>When a dock window's visibility changes, i.e. it is shown or hidden, the <a href="q3dockwindow.html#visibilityChanged">visibilityChanged</a>() signal is emitted. When a dock window is docked, undocked or moved inside the dock area the <a href="q3dockwindow.html#placeChanged">placeChanged</a>() signal is emitted.</p>
</div>
<!-- @@@Q3DockWindow -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$CloseMode$$$Never$$$Docked$$$Undocked$$$Always -->
<h3 class="fn"><a name="CloseMode-enum"></a>enum Q3DockWindow::<span class="name">CloseMode</span></h3>
<p>This enum type specifies when (if ever) a dock window has a close button.</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>Q3DockWindow::Never</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">The dock window never has a close button and cannot be closed by the user.</td></tr>
<tr><td class="topAlign"><tt>Q3DockWindow::Docked</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign">The dock window has a close button only when docked.</td></tr>
<tr><td class="topAlign"><tt>Q3DockWindow::Undocked</tt></td><td class="topAlign"><tt>2</tt></td><td class="topAlign">The dock window has a close button only when floating.</td></tr>
<tr><td class="topAlign"><tt>Q3DockWindow::Always</tt></td><td class="topAlign"><tt>Docked | Undocked</tt></td><td class="topAlign">The dock window always has a close button.</td></tr>
</table>
<!-- @@@CloseMode -->
<!-- $$$Place$$$InDock$$$OutsideDock -->
<h3 class="fn"><a name="Place-enum"></a>enum Q3DockWindow::<span class="name">Place</span></h3>
<p>This enum specifies the possible locations for a <a href="q3dockwindow.html" class="compat">Q3DockWindow</a>:</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>Q3DockWindow::InDock</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">Inside a <a href="q3dockarea.html" class="compat">Q3DockArea</a>.</td></tr>
<tr><td class="topAlign"><tt>Q3DockWindow::OutsideDock</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign">Floating as a top level window on the desktop.</td></tr>
</table>
<!-- @@@Place -->
</div>
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$closeMode-prop$$$closeMode$$$setCloseModeint -->
<h3 class="fn"><a name="closeMode-prop"></a><span class="name">closeMode</span> : <span class="type">int</span></h3>
<p>This property holds the close mode of a dock window.</p>
<p>Defines when (if ever) the dock window has a close button. The choices are <tt>Never</tt>, <tt>Docked</tt> (i.e. only when docked), <tt>Undocked</tt> (only when undocked, i.e. floated) or <tt>Always</tt>.</p>
<p>The default is <tt>Never</tt>.</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> int </td><td class="memItemRight bottomAlign"><span class="name"><b>closeMode</b></span> () const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> virtual void </td><td class="memItemRight bottomAlign"><span class="name"><b>setCloseMode</b></span> ( int <i>m</i> )</td></tr>
</table>
<!-- @@@closeMode -->
<!-- $$$horizontallyStretchable-prop$$$isHorizontallyStretchable$$$setHorizontallyStretchablebool -->
<h3 class="fn"><a name="horizontallyStretchable-prop"></a><span class="name">horizontallyStretchable</span> : <span class="type">bool</span></h3>
<p>This property holds whether the dock window is horizontally stretchable.</p>
<p>A dock window is horizontally stretchable if you call setHorizontallyStretchable(true) or setResizeEnabled(true).</p>
<p><b>Warning:</b> Stretchability is broken. You must call setResizeEnabled(true) to get proper behavior and even then <a href="q3dockwindow.html" class="compat">Q3DockWindow</a> does not limit stretchablilty.</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> bool </td><td class="memItemRight bottomAlign"><span class="name"><b>isHorizontallyStretchable</b></span> () const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> virtual void </td><td class="memItemRight bottomAlign"><span class="name"><b>setHorizontallyStretchable</b></span> ( bool <i>b</i> )</td></tr>
</table>
<p><b>See also </b><a href="q3dockwindow.html#resizeEnabled-prop">setResizeEnabled</a>().</p>
<!-- @@@horizontallyStretchable -->
<!-- $$$movingEnabled-prop$$$isMovingEnabled$$$setMovingEnabledbool -->
<h3 class="fn"><a name="movingEnabled-prop"></a><span class="name">movingEnabled</span> : <span class="type">bool</span></h3>
<p>This property holds whether the user can move the dock window within the dock area, move the dock window to another dock area, or float the dock window.</p>
<p>This property is true by default.</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> bool </td><td class="memItemRight bottomAlign"><span class="name"><b>isMovingEnabled</b></span> () const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> virtual void </td><td class="memItemRight bottomAlign"><span class="name"><b>setMovingEnabled</b></span> ( bool <i>b</i> )</td></tr>
</table>
<!-- @@@movingEnabled -->
<!-- $$$newLine-prop$$$newLine$$$setNewLinebool -->
<h3 class="fn"><a name="newLine-prop"></a><span class="name">newLine</span> : <span class="type">bool</span></h3>
<p>This property holds whether the dock window prefers to start a new line in the dock area.</p>
<p>The default is false, i.e. the dock window doesn't require a new line in the dock area.</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> bool </td><td class="memItemRight bottomAlign"><span class="name"><b>newLine</b></span> () const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> virtual void </td><td class="memItemRight bottomAlign"><span class="name"><b>setNewLine</b></span> ( bool <i>b</i> )</td></tr>
</table>
<!-- @@@newLine -->
<!-- $$$offset-prop$$$offset$$$setOffsetint -->
<h3 class="fn"><a name="offset-prop"></a><span class="name">offset</span> : <span class="type">int</span></h3>
<p>This property holds the dock window's preferred offset from the dock area's left edge (top edge for vertical dock areas).</p>
<p>The default is 0.</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> int </td><td class="memItemRight bottomAlign"><span class="name"><b>offset</b></span> () const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> virtual void </td><td class="memItemRight bottomAlign"><span class="name"><b>setOffset</b></span> ( int <i>o</i> )</td></tr>
</table>
<!-- @@@offset -->
<!-- $$$opaqueMoving-prop$$$opaqueMoving$$$setOpaqueMovingbool -->
<h3 class="fn"><a name="opaqueMoving-prop"></a><span class="name">opaqueMoving</span> : <span class="type">bool</span></h3>
<p>This property holds whether the dock window will be shown normally whilst it is being moved.</p>
<p>If this property is false, (the default), the dock window will be represented by an outline rectangle whilst it is being moved.</p>
<p><b>Warning:</b> Currently opaque moving has some problems and we do not recommend using it at this time. We expect to fix these problems in a future release.</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> bool </td><td class="memItemRight bottomAlign"><span class="name"><b>opaqueMoving</b></span> () const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> virtual void </td><td class="memItemRight bottomAlign"><span class="name"><b>setOpaqueMoving</b></span> ( bool <i>b</i> )</td></tr>
</table>
<!-- @@@opaqueMoving -->
<!-- $$$place-prop$$$place -->
<h3 class="fn"><a name="place-prop"></a><span class="name">place</span> : const <span class="type"><a href="q3dockwindow.html#Place-enum">Place</a></span></h3>
<p>This property holds the location where the dock window is placed.</p>
<p>This is either <tt>InDock</tt> or <tt>OutsideDock</tt>.</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> Place </td><td class="memItemRight bottomAlign"><span class="name"><b>place</b></span> () const</td></tr>
</table>
<p><b>See also </b><a href="q3dockarea.html#moveDockWindow">Q3DockArea::moveDockWindow</a>(), <a href="q3dockarea.html#removeDockWindow">Q3DockArea::removeDockWindow</a>(), <a href="q3mainwindow.html#moveDockWindow">Q3MainWindow::moveDockWindow</a>(), and <a href="q3mainwindow.html#removeDockWindow">Q3MainWindow::removeDockWindow</a>().</p>
<!-- @@@place -->
<!-- $$$resizeEnabled-prop$$$isResizeEnabled$$$setResizeEnabledbool -->
<h3 class="fn"><a name="resizeEnabled-prop"></a><span class="name">resizeEnabled</span> : <span class="type">bool</span></h3>
<p>This property holds whether the dock window is resizeable.</p>
<p>A resizeable dock window can be resized using splitter-like handles inside a dock area and like every other top level window when floating.</p>
<p>A dock window is both horizontally and vertically stretchable if you call setResizeEnabled(true).</p>
<p>This property is false by default.</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> bool </td><td class="memItemRight bottomAlign"><span class="name"><b>isResizeEnabled</b></span> () const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> virtual void </td><td class="memItemRight bottomAlign"><span class="name"><b>setResizeEnabled</b></span> ( bool <i>b</i> )</td></tr>
</table>
<p><b>See also </b><a href="q3dockwindow.html#verticallyStretchable-prop">setVerticallyStretchable</a>() and <a href="q3dockwindow.html#horizontallyStretchable-prop">setHorizontallyStretchable</a>().</p>
<!-- @@@resizeEnabled -->
<!-- $$$stretchable-prop$$$isStretchable -->
<h3 class="fn"><a name="stretchable-prop"></a><span class="name">stretchable</span> : const <span class="type">bool</span></h3>
<p>This property holds whether the dock window is stretchable in the current orientation().</p>
<p>This property can be set using <a href="q3dockwindow.html#horizontallyStretchable-prop">setHorizontallyStretchable</a>() and <a href="q3dockwindow.html#verticallyStretchable-prop">setVerticallyStretchable</a>(), or with <a href="q3dockwindow.html#resizeEnabled-prop">setResizeEnabled</a>().</p>
<p><b>Warning:</b> Stretchability is broken. You must call setResizeEnabled(true) to get proper behavior and even then <a href="q3dockwindow.html" class="compat">Q3DockWindow</a> does not limit stretchablilty.</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> bool </td><td class="memItemRight bottomAlign"><span class="name"><b>isStretchable</b></span> () const</td></tr>
</table>
<p><b>See also </b><a href="q3dockwindow.html#resizeEnabled-prop">setResizeEnabled</a>().</p>
<!-- @@@stretchable -->
<!-- $$$verticallyStretchable-prop$$$isVerticallyStretchable$$$setVerticallyStretchablebool -->
<h3 class="fn"><a name="verticallyStretchable-prop"></a><span class="name">verticallyStretchable</span> : <span class="type">bool</span></h3>
<p>This property holds whether the dock window is vertically stretchable.</p>
<p>A dock window is vertically stretchable if you call setVerticallyStretchable(true) or setResizeEnabled(true).</p>
<p><b>Warning:</b> Stretchability is broken. You must call setResizeEnabled(true) to get proper behavior and even then <a href="q3dockwindow.html" class="compat">Q3DockWindow</a> does not limit stretchablilty.</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> bool </td><td class="memItemRight bottomAlign"><span class="name"><b>isVerticallyStretchable</b></span> () const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> virtual void </td><td class="memItemRight bottomAlign"><span class="name"><b>setVerticallyStretchable</b></span> ( bool <i>b</i> )</td></tr>
</table>
<p><b>See also </b><a href="q3dockwindow.html#resizeEnabled-prop">setResizeEnabled</a>().</p>
<!-- @@@verticallyStretchable -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$Q3DockWindow[overload1]$$$Q3DockWindowPlaceQWidget*constchar*Qt::WindowFlags -->
<h3 class="fn"><a name="Q3DockWindow"></a>Q3DockWindow::<span class="name">Q3DockWindow</span> ( <span class="type"><a href="q3dockwindow.html#Place-enum">Place</a></span> <i>p</i> = InDock, <span class="type"><a href="qwidget.html">QWidget</a></span> * <i>parent</i> = 0, const <span class="type">char</span> * <i>name</i> = 0, <span class="type"><a href="qt.html#WindowType-enum">Qt::WindowFlags</a></span> <i>f</i> = 0 )</h3>
<p>Constructs a <a href="q3dockwindow.html" class="compat">Q3DockWindow</a> with parent <i>parent</i>, called <i>name</i> and with widget flags <i>f</i>.</p>
<p>If <i>p</i> is <tt>InDock</tt>, the dock window is docked into a dock area and <i>parent</i> <i>must</i> be a <a href="q3dockarea.html" class="compat">Q3DockArea</a> or a <a href="q3mainwindow.html" class="compat">Q3MainWindow</a>. If the <i>parent</i> is a <a href="q3mainwindow.html" class="compat">Q3MainWindow</a> the dock window will be docked in the main window's <tt>Top</tt> dock area.</p>
<p>If <i>p</i> is <tt>OutsideDock</tt>, the dock window is created as a floating window.</p>
<p>We recommend creating the dock area <tt>InDock</tt> with a <a href="q3mainwindow.html" class="compat">Q3MainWindow</a> as parent then calling <a href="q3mainwindow.html#moveDockWindow">Q3MainWindow::moveDockWindow</a>() to move the dock window where you want it.</p>
<!-- @@@Q3DockWindow -->
<!-- $$$Q3DockWindow$$$Q3DockWindowQWidget*constchar*Qt::WindowFlags -->
<h3 class="fn"><a name="Q3DockWindow-2"></a>Q3DockWindow::<span class="name">Q3DockWindow</span> ( <span class="type"><a href="qwidget.html">QWidget</a></span> * <i>parent</i>, const <span class="type">char</span> * <i>name</i> = 0, <span class="type"><a href="qt.html#WindowType-enum">Qt::WindowFlags</a></span> <i>f</i> = 0 )</h3>
<p>Constructs a <a href="q3dockwindow.html" class="compat">Q3DockWindow</a> with parent <i>parent</i>, called <i>name</i> and with widget flags <i>f</i>.</p>
<!-- @@@Q3DockWindow -->
<!-- $$$~Q3DockWindow[overload1]$$$~Q3DockWindow -->
<h3 class="fn"><a name="dtor.Q3DockWindow"></a>Q3DockWindow::<span class="name">~Q3DockWindow</span> ()</h3>
<p>Destroys the dock window and its child widgets.</p>
<!-- @@@~Q3DockWindow -->
<!-- $$$area[overload1]$$$area -->
<h3 class="fn"><a name="area"></a><span class="type"><a href="q3dockarea.html">Q3DockArea</a></span> * Q3DockWindow::<span class="name">area</span> () const</h3>
<p>Returns the dock area in which this dock window is docked, or 0 if the dock window is floating.</p>
<!-- @@@area -->
<!-- $$$boxLayout[overload1]$$$boxLayout -->
<h3 class="fn"><a name="boxLayout"></a><span class="type"><a href="qboxlayout.html">QBoxLayout</a></span> * Q3DockWindow::<span class="name">boxLayout</span> ()</h3>
<p>Returns the layout which is used for adding widgets to the dock window. The layout's orientation is set automatically to match the orientation of the dock window. You can add widgets to the layout using the box layout's <a href="qboxlayout.html#addWidget">QBoxLayout::addWidget</a>() function.</p>
<p>If the dock window only needs to contain a single widget use <a href="q3dockwindow.html#setWidget">setWidget</a>() instead.</p>
<p><b>See also </b><a href="q3dockwindow.html#setWidget">setWidget</a>() and <a href="q3dockwindow.html#setOrientation">setOrientation</a>().</p>
<!-- @@@boxLayout -->
<!-- $$$contextMenuEvent[overload1]$$$contextMenuEventQContextMenuEvent* -->
<h3 class="fn"><a name="contextMenuEvent"></a><span class="type">void</span> Q3DockWindow::<span class="name">contextMenuEvent</span> ( <span class="type"><a href="qcontextmenuevent.html">QContextMenuEvent</a></span> * <i>e</i> )<tt> [virtual protected]</tt></h3>
<p>Reimplemented from <a href="qwidget.html#contextMenuEvent">QWidget::contextMenuEvent</a>().</p>
<!-- @@@contextMenuEvent -->
<!-- $$$dock[overload1]$$$dock -->
<h3 class="fn"><a name="dock"></a><span class="type">void</span> Q3DockWindow::<span class="name">dock</span> ()<tt> [virtual slot]</tt></h3>
<p>Docks the dock window into the last dock area in which it was docked.</p>
<p>If the dock window has no last dock area (e.g. it was created as a floating window and has never been docked), or if the last dock area it was docked in does not exist (e.g. the dock area has been deleted), nothing happens.</p>
<p>The dock window will dock with the dock area regardless of the return value of <a href="q3dockarea.html#isDockWindowAccepted">Q3DockArea::isDockWindowAccepted</a>().</p>
<p><b>See also </b><a href="q3dockwindow.html#undock">undock</a>(), <a href="q3dockarea.html#moveDockWindow">Q3DockArea::moveDockWindow</a>(), <a href="q3dockarea.html#removeDockWindow">Q3DockArea::removeDockWindow</a>(), <a href="q3mainwindow.html#moveDockWindow">Q3MainWindow::moveDockWindow</a>(), <a href="q3mainwindow.html#removeDockWindow">Q3MainWindow::removeDockWindow</a>(), and <a href="q3dockarea.html#isDockWindowAccepted">Q3DockArea::isDockWindowAccepted</a>().</p>
<!-- @@@dock -->
<!-- $$$drawContents[overload1]$$$drawContentsQPainter* -->
<h3 class="fn"><a name="drawContents"></a><span class="type">void</span> Q3DockWindow::<span class="name">drawContents</span> ( <span class="type"><a href="qpainter.html">QPainter</a></span> * <i>p</i> )<tt> [virtual protected]</tt></h3>
<p>Reimplemented from <a href="q3frame.html#drawContents">Q3Frame::drawContents</a>().</p>
<!-- @@@drawContents -->
<!-- $$$drawFrame[overload1]$$$drawFrameQPainter* -->
<h3 class="fn"><a name="drawFrame"></a><span class="type">void</span> Q3DockWindow::<span class="name">drawFrame</span> ( <span class="type"><a href="qpainter.html">QPainter</a></span> * <i>p</i> )<tt> [virtual protected]</tt></h3>
<p>Reimplemented from <a href="q3frame.html#drawFrame">Q3Frame::drawFrame</a>().</p>
<!-- @@@drawFrame -->
<!-- $$$event[overload1]$$$eventQEvent* -->
<h3 class="fn"><a name="event"></a><span class="type">bool</span> Q3DockWindow::<span class="name">event</span> ( <span class="type"><a href="qevent.html">QEvent</a></span> * <i>e</i> )<tt> [virtual protected]</tt></h3>
<p>Reimplemented from <a href="qobject.html#event">QObject::event</a>().</p>
<!-- @@@event -->
<!-- $$$eventFilter[overload1]$$$eventFilterQObject*QEvent* -->
<h3 class="fn"><a name="eventFilter"></a><span class="type">bool</span> Q3DockWindow::<span class="name">eventFilter</span> ( <span class="type"><a href="qobject.html">QObject</a></span> * <i>o</i>, <span class="type"><a href="qevent.html">QEvent</a></span> * <i>e</i> )<tt> [virtual]</tt></h3>
<p>Reimplemented from <a href="qobject.html#eventFilter">QObject::eventFilter</a>().</p>
<!-- @@@eventFilter -->
<!-- $$$fixedExtent[overload1]$$$fixedExtent -->
<h3 class="fn"><a name="fixedExtent"></a><span class="type"><a href="qsize.html">QSize</a></span> Q3DockWindow::<span class="name">fixedExtent</span> () const</h3>
<p>Returns the dock window's preferred size (fixed extent).</p>
<p><b>See also </b><a href="q3dockwindow.html#setFixedExtentWidth">setFixedExtentWidth</a>() and <a href="q3dockwindow.html#setFixedExtentHeight">setFixedExtentHeight</a>().</p>
<!-- @@@fixedExtent -->
<!-- $$$hideEvent[overload1]$$$hideEventQHideEvent* -->
<h3 class="fn"><a name="hideEvent"></a><span class="type">void</span> Q3DockWindow::<span class="name">hideEvent</span> ( <span class="type"><a href="qhideevent.html">QHideEvent</a></span> * <i>e</i> )<tt> [virtual protected]</tt></h3>
<p>Reimplemented from <a href="qwidget.html#hideEvent">QWidget::hideEvent</a>().</p>
<!-- @@@hideEvent -->
<!-- $$$isCloseEnabled[overload1]$$$isCloseEnabled -->
<h3 class="fn"><a name="isCloseEnabled"></a><span class="type">bool</span> Q3DockWindow::<span class="name">isCloseEnabled</span> () const</h3>
<p>Returns true if the dock window has a close button; otherwise returns false. The result depends on the dock window's <a href="q3dockwindow.html#Place-enum">Place</a> and its <a href="q3dockwindow.html#CloseMode-enum">CloseMode</a>.</p>
<p><b>See also </b><a href="q3dockwindow.html#closeMode-prop">setCloseMode</a>().</p>
<!-- @@@isCloseEnabled -->
<!-- $$$isHorizontalStretchable[overload1]$$$isHorizontalStretchable -->
<h3 class="fn"><a name="isHorizontalStretchable"></a><span class="type">bool</span> Q3DockWindow::<span class="name">isHorizontalStretchable</span> () const</h3>
<p>Returns true if the dock window can be stretched horizontally; otherwise returns false.</p>
<!-- @@@isHorizontalStretchable -->
<!-- $$$isVerticalStretchable[overload1]$$$isVerticalStretchable -->
<h3 class="fn"><a name="isVerticalStretchable"></a><span class="type">bool</span> Q3DockWindow::<span class="name">isVerticalStretchable</span> () const</h3>
<p>Returns true if the dock window can be stretched vertically; otherwise returns false.</p>
<!-- @@@isVerticalStretchable -->
<!-- $$$minimumSizeHint[overload1]$$$minimumSizeHint -->
<h3 class="fn"><a name="minimumSizeHint"></a><span class="type"><a href="qsize.html">QSize</a></span> Q3DockWindow::<span class="name">minimumSizeHint</span> () const<tt> [virtual]</tt></h3>
<p>Reimplemented from <a href="qwidget.html#minimumSizeHint-prop">QWidget::minimumSizeHint</a>().</p>
<!-- @@@minimumSizeHint -->
<!-- $$$orientation[overload1]$$$orientation -->
<h3 class="fn"><a name="orientation"></a><span class="type"><a href="qt.html#Orientation-enum">Qt::Orientation</a></span> Q3DockWindow::<span class="name">orientation</span> () const</h3>
<p>Returns the orientation of the dock window.</p>
<p><b>See also </b><a href="q3dockwindow.html#setOrientation">setOrientation</a>() and <a href="q3dockwindow.html#orientationChanged">orientationChanged</a>().</p>
<!-- @@@orientation -->
<!-- $$$orientationChanged[overload1]$$$orientationChangedQt::Orientation -->
<h3 class="fn"><a name="orientationChanged"></a><span class="type">void</span> Q3DockWindow::<span class="name">orientationChanged</span> ( <span class="type"><a href="qt.html#Orientation-enum">Qt::Orientation</a></span> <i>o</i> )<tt> [signal]</tt></h3>
<p>This signal is emitted when the orientation of the dock window is changed. The new orientation is <i>o</i>.</p>
<!-- @@@orientationChanged -->
<!-- $$$placeChanged[overload1]$$$placeChangedQ3DockWindow::Place -->
<h3 class="fn"><a name="placeChanged"></a><span class="type">void</span> Q3DockWindow::<span class="name">placeChanged</span> ( <span class="type"><a href="q3dockwindow.html#Place-enum">Q3DockWindow::Place</a></span> <i>p</i> )<tt> [signal]</tt></h3>
<p>This signal is emitted when the dock window is docked (<i>p</i> is <tt>InDock</tt>), undocked (<i>p</i> is <tt>OutsideDock</tt>) or moved inside the the dock area.</p>
<p><b>See also </b><a href="q3dockarea.html#moveDockWindow">Q3DockArea::moveDockWindow</a>(), <a href="q3dockarea.html#removeDockWindow">Q3DockArea::removeDockWindow</a>(), <a href="q3mainwindow.html#moveDockWindow">Q3MainWindow::moveDockWindow</a>(), and <a href="q3mainwindow.html#removeDockWindow">Q3MainWindow::removeDockWindow</a>().</p>
<!-- @@@placeChanged -->
<!-- $$$resizeEvent[overload1]$$$resizeEventQResizeEvent* -->
<h3 class="fn"><a name="resizeEvent"></a><span class="type">void</span> Q3DockWindow::<span class="name">resizeEvent</span> ( <span class="type"><a href="qresizeevent.html">QResizeEvent</a></span> * <i>e</i> )<tt> [virtual protected]</tt></h3>
<p>Reimplemented from <a href="qwidget.html#resizeEvent">QWidget::resizeEvent</a>().</p>
<!-- @@@resizeEvent -->
<!-- $$$setFixedExtentHeight[overload1]$$$setFixedExtentHeightint -->
<h3 class="fn"><a name="setFixedExtentHeight"></a><span class="type">void</span> Q3DockWindow::<span class="name">setFixedExtentHeight</span> ( <span class="type">int</span> <i>h</i> )<tt> [virtual]</tt></h3>
<p>Sets the dock window's preferred height for its fixed extent (size) to <i>h</i>.</p>
<p><b>See also </b><a href="q3dockwindow.html#setFixedExtentWidth">setFixedExtentWidth</a>().</p>
<!-- @@@setFixedExtentHeight -->
<!-- $$$setFixedExtentWidth[overload1]$$$setFixedExtentWidthint -->
<h3 class="fn"><a name="setFixedExtentWidth"></a><span class="type">void</span> Q3DockWindow::<span class="name">setFixedExtentWidth</span> ( <span class="type">int</span> <i>w</i> )<tt> [virtual]</tt></h3>
<p>Sets the dock window's preferred width for its fixed extent (size) to <i>w</i>.</p>
<p><b>See also </b><a href="q3dockwindow.html#setFixedExtentHeight">setFixedExtentHeight</a>().</p>
<!-- @@@setFixedExtentWidth -->
<!-- $$$setHorizontalStretchable[overload1]$$$setHorizontalStretchablebool -->
<h3 class="fn"><a name="setHorizontalStretchable"></a><span class="type">void</span> Q3DockWindow::<span class="name">setHorizontalStretchable</span> ( <span class="type">bool</span> <i>b</i> )</h3>
<p>If <i>b</i> is true the dock window is set to be horizontally stretchable.</p>
<p><b>See also </b><a href="q3dockwindow.html#isHorizontalStretchable">isHorizontalStretchable</a>().</p>
<!-- @@@setHorizontalStretchable -->
<!-- $$$setOrientation[overload1]$$$setOrientationQt::Orientation -->
<h3 class="fn"><a name="setOrientation"></a><span class="type">void</span> Q3DockWindow::<span class="name">setOrientation</span> ( <span class="type"><a href="qt.html#Orientation-enum">Qt::Orientation</a></span> <i>o</i> )<tt> [virtual slot]</tt></h3>
<p>Sets the orientation of the dock window to <i>o</i>. The orientation is propagated to the layout <a href="q3dockwindow.html#boxLayout">boxLayout</a>().</p>
<p><b>Warning:</b> All undocked Q3ToolBars will always have a horizontal orientation.</p>
<p><b>See also </b><a href="q3dockwindow.html#orientation">orientation</a>().</p>
<!-- @@@setOrientation -->
<!-- $$$setVerticalStretchable[overload1]$$$setVerticalStretchablebool -->
<h3 class="fn"><a name="setVerticalStretchable"></a><span class="type">void</span> Q3DockWindow::<span class="name">setVerticalStretchable</span> ( <span class="type">bool</span> <i>b</i> )</h3>
<p>If <i>b</i> is true the dock window is set to be vertically stretchable.</p>
<p><b>See also </b><a href="q3dockwindow.html#isVerticalStretchable">isVerticalStretchable</a>().</p>
<!-- @@@setVerticalStretchable -->
<!-- $$$setWidget[overload1]$$$setWidgetQWidget* -->
<h3 class="fn"><a name="setWidget"></a><span class="type">void</span> Q3DockWindow::<span class="name">setWidget</span> ( <span class="type"><a href="qwidget.html">QWidget</a></span> * <i>w</i> )<tt> [virtual]</tt></h3>
<p>Sets the dock window's main widget to <i>w</i>.</p>
<p><b>See also </b><a href="q3dockwindow.html#widget">widget</a>() and <a href="q3dockwindow.html#boxLayout">boxLayout</a>().</p>
<!-- @@@setWidget -->
<!-- $$$showEvent[overload1]$$$showEventQShowEvent* -->
<h3 class="fn"><a name="showEvent"></a><span class="type">void</span> Q3DockWindow::<span class="name">showEvent</span> ( <span class="type"><a href="qshowevent.html">QShowEvent</a></span> * <i>e</i> )<tt> [virtual protected]</tt></h3>
<p>Reimplemented from <a href="qwidget.html#showEvent">QWidget::showEvent</a>().</p>
<!-- @@@showEvent -->
<!-- $$$sizeHint[overload1]$$$sizeHint -->
<h3 class="fn"><a name="sizeHint"></a><span class="type"><a href="qsize.html">QSize</a></span> Q3DockWindow::<span class="name">sizeHint</span> () const<tt> [virtual]</tt></h3>
<p>Reimplemented from <a href="qwidget.html#sizeHint-prop">QWidget::sizeHint</a>().</p>
<!-- @@@sizeHint -->
<!-- $$$undock[overload1]$$$undockQWidget* -->
<h3 class="fn"><a name="undock"></a><span class="type">void</span> Q3DockWindow::<span class="name">undock</span> ( <span class="type"><a href="qwidget.html">QWidget</a></span> * <i>widget</i> )<tt> [virtual slot]</tt></h3>
<p>Undocks the specified <i>widget</i> from its current dock area if it is docked; otherwise does nothing.</p>
<p><b>See also </b><a href="q3dockwindow.html#dock">dock</a>(), <a href="q3dockarea.html#moveDockWindow">Q3DockArea::moveDockWindow</a>(), <a href="q3dockarea.html#removeDockWindow">Q3DockArea::removeDockWindow</a>(), <a href="q3mainwindow.html#moveDockWindow">Q3MainWindow::moveDockWindow</a>(), and <a href="q3mainwindow.html#removeDockWindow">Q3MainWindow::removeDockWindow</a>().</p>
<!-- @@@undock -->
<!-- $$$undock$$$undock -->
<h3 class="fn"><a name="undock-2"></a><span class="type">void</span> Q3DockWindow::<span class="name">undock</span> ()<tt> [virtual slot]</tt></h3>
<p>Undocks the <a href="q3dockwindow.html" class="compat">Q3DockWindow</a> from its current dock area if it is docked; otherwise does nothing.</p>
<p><b>See also </b><a href="q3dockwindow.html#dock">dock</a>(), <a href="q3dockarea.html#moveDockWindow">Q3DockArea::moveDockWindow</a>(), <a href="q3dockarea.html#removeDockWindow">Q3DockArea::removeDockWindow</a>(), <a href="q3mainwindow.html#moveDockWindow">Q3MainWindow::moveDockWindow</a>(), and <a href="q3mainwindow.html#removeDockWindow">Q3MainWindow::removeDockWindow</a>().</p>
<!-- @@@undock -->
<!-- $$$visibilityChanged[overload1]$$$visibilityChangedbool -->
<h3 class="fn"><a name="visibilityChanged"></a><span class="type">void</span> Q3DockWindow::<span class="name">visibilityChanged</span> ( <span class="type">bool</span> <i>visible</i> )<tt> [signal]</tt></h3>
<p>This signal is emitted when the visibility of the dock window relatively to its dock area is changed. If <i>visible</i> is true, the <a href="q3dockwindow.html" class="compat">Q3DockWindow</a> is now visible to the dock area, otherwise it has been hidden.</p>
<p>A dock window can be hidden if it has a close button which the user has clicked. In the case of a <a href="q3mainwindow.html" class="compat">Q3MainWindow</a> a dock window can have its visibility changed (hidden or shown) by clicking its name in the dock window menu that lists the <a href="q3mainwindow.html" class="compat">Q3MainWindow</a>'s dock windows.</p>
<!-- @@@visibilityChanged -->
<!-- $$$widget[overload1]$$$widget -->
<h3 class="fn"><a name="widget"></a><span class="type"><a href="qwidget.html">QWidget</a></span> * Q3DockWindow::<span class="name">widget</span> () const</h3>
<p>Returns the dock window's main widget.</p>
<p><b>See also </b><a href="q3dockwindow.html#setWidget">setWidget</a>().</p>
<!-- @@@widget -->
<!-- $$$windowTitle[overload1]$$$windowTitle -->
<h3 class="fn"><a name="windowTitle"></a><span class="type"><a href="qstring.html">QString</a></span> Q3DockWindow::<span class="name">windowTitle</span> () const</h3>
<p>Returns the dock window's title.</p>
<!-- @@@windowTitle -->
</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>
|
