<?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" />
<!-- q3dockarea.cpp -->
<title>Qt 4.8: Q3DockArea Class Reference</title>
<link rel="stylesheet" type="text/css" href="style/style.css" />
<script src="scripts/jquery.js" type="text/javascript"></script>
<script src="scripts/functions.js" type="text/javascript"></script>
<link rel="stylesheet" type="text/css" href="style/superfish.css" />
<link rel="stylesheet" type="text/css" href="style/narrow.css" />
<!--[if IE]>
<meta name="MSSmartTagsPreventParsing" content="true">
<meta http-equiv="imagetoolbar" content="no">
<![endif]-->
<!--[if lt IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie6.css">
<![endif]-->
<!--[if IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie7.css">
<![endif]-->
<!--[if IE 8]>
<link rel="stylesheet" type="text/css" href="style/style_ie8.css">
<![endif]-->
<script src="scripts/superfish.js" type="text/javascript"></script>
<script src="scripts/narrow.js" type="text/javascript"></script>
</head>
<body class="" onload="CheckEmptyAndLoadList();">
<div class="header" id="qtdocheader">
<div class="content">
<div id="nav-logo">
<a href="index.html">Home</a></div>
<a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a>
<div id="narrowsearch"></div>
<div id="nav-topright">
<ul>
<li class="nav-topright-home"><a href="http://qt.digia.com/">Qt HOME</a></li>
<li class="nav-topright-dev"><a href="http://qt-project.org/">DEV</a></li>
<li class="nav-topright-doc nav-topright-doc-active"><a href="http://qt-project.org/doc/">
DOC</a></li>
<li class="nav-topright-blog"><a href="http://blog.qt.digia.com/">BLOG</a></li>
</ul>
</div>
<div id="shortCut">
<ul>
<li class="shortCut-topleft-inactive"><span><a href="index.html">Qt 4.8</a></span></li>
<li class="shortCut-topleft-active"><a href="http://qt-project.org/doc/">ALL VERSIONS </a></li>
</ul>
</div>
<ul class="sf-menu" id="narrowmenu">
<li><a href="#">API Lookup</a>
<ul>
<li><a href="classes.html">Class index</a></li>
<li><a href="functions.html">Function index</a></li>
<li><a href="modules.html">Modules</a></li>
<li><a href="namespaces.html">Namespaces</a></li>
<li><a href="qtglobal.html">Global Declarations</a></li>
<li><a href="qdeclarativeelements.html">QML elements</a></li>
</ul>
</li>
<li><a href="#">Qt Topics</a>
<ul>
<li><a href="qt-basic-concepts.html">Programming with Qt</a></li>
<li><a href="qtquick.html">Device UIs & Qt Quick</a></li>
<li><a href="qt-gui-concepts.html">UI Design with Qt</a></li>
<li><a href="supported-platforms.html">Supported Platforms</a></li>
<li><a href="technology-apis.html">Qt and Key Technologies</a></li>
<li><a href="best-practices.html">How-To's and Best Practices</a></li>
</ul>
</li>
<li><a href="#">Examples</a>
<ul>
<li><a href="all-examples.html">Examples</a></li>
<li><a href="tutorials.html">Tutorials</a></li>
<li><a href="demos.html">Demos</a></li>
<li><a href="qdeclarativeexamples.html">QML Examples</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="wrapper">
<div class="hd">
<span></span>
</div>
<div class="bd group">
<div class="sidebar">
<div class="searchlabel">
Search index:</div>
<div class="search" id="sidebarsearch">
<form id="qtdocsearch" action="" onsubmit="return false;">
<fieldset>
<input type="text" name="searchstring" id="pageType" value="" />
<div id="resultdialog">
<a href="#" id="resultclose">Close</a>
<p id="resultlinks" class="all"><a href="#" id="showallresults">All</a> | <a href="#" id="showapiresults">API</a> | <a href="#" id="showarticleresults">Articles</a> | <a href="#" id="showexampleresults">Examples</a></p>
<p id="searchcount" class="all"><span id="resultcount"></span><span id="apicount"></span><span id="articlecount"></span><span id="examplecount"></span> results:</p>
<ul id="resultlist" class="all">
</ul>
</div>
</fieldset>
</form>
</div>
<div class="box first bottombar" id="lookup">
<h2 title="API Lookup"><span></span>
API Lookup</h2>
<div id="list001" class="list">
<ul id="ul001" >
<li class="defaultLink"><a href="classes.html">Class index</a></li>
<li class="defaultLink"><a href="functions.html">Function index</a></li>
<li class="defaultLink"><a href="modules.html">Modules</a></li>
<li class="defaultLink"><a href="namespaces.html">Namespaces</a></li>
<li class="defaultLink"><a href="qtglobal.html">Global Declarations</a></li>
<li class="defaultLink"><a href="qdeclarativeelements.html">QML elements</a></li>
</ul>
</div>
</div>
<div class="box bottombar" id="topics">
<h2 title="Qt Topics"><span></span>
Qt Topics</h2>
<div id="list002" class="list">
<ul id="ul002" >
<li class="defaultLink"><a href="qt-basic-concepts.html">Programming with Qt</a></li>
<li class="defaultLink"><a href="qtquick.html">Device UIs & Qt Quick</a></li>
<li class="defaultLink"><a href="qt-gui-concepts.html">UI Design with Qt</a></li>
<li class="defaultLink"><a href="supported-platforms.html">Supported Platforms</a></li>
<li class="defaultLink"><a href="technology-apis.html">Qt and Key Technologies</a></li>
<li class="defaultLink"><a href="best-practices.html">How-To's and Best Practices</a></li>
</ul>
</div>
</div>
<div class="box" id="examples">
<h2 title="Examples"><span></span>
Examples</h2>
<div id="list003" class="list">
<ul id="ul003">
<li class="defaultLink"><a href="all-examples.html">Examples</a></li>
<li class="defaultLink"><a href="tutorials.html">Tutorials</a></li>
<li class="defaultLink"><a href="demos.html">Demos</a></li>
<li class="defaultLink"><a href="qdeclarativeexamples.html">QML Examples</a></li>
</ul>
</div>
</div>
</div>
<div class="wrap">
<div class="toolbar">
<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>Q3DockArea</li>
</ul>
</div>
<div class="toolbuttons toolblock">
<ul>
<li id="smallA" class="t_button">A</li>
<li id="medA" class="t_button active">A</li>
<li id="bigA" class="t_button">A</li>
<li id="print" class="t_button"><a href="javascript:this.print();">
<span>Print</span></a></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="#related-non-members">Related Non-Members</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
<li class="level2"><a href="#lines">Lines.</a></li>
</ul>
</div>
<h1 class="title">Q3DockArea Class Reference</h1>
<!-- $$$Q3DockArea-brief -->
<p>The Q3DockArea class manages and lays out Q3DockWindows. <a href="#details">More...</a></p>
<!-- @@@Q3DockArea -->
<pre class="cpp"> <span class="preprocessor">#include <Q3DockArea></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#qdockarea">Porting to Qt 4</a> for more information.</p>
<p><b>Inherits: </b><a href="qwidget.html">QWidget</a>.</p>
<ul>
<li><a href="q3dockarea-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="q3dockarea.html#HandlePosition-enum">HandlePosition</a></b> { Normal, Reverse }</td></tr>
</table>
<a name="properties"></a>
<h2>Properties</h2>
<ul>
<li class="fn"><b><a href="q3dockarea.html#count-prop">count</a></b> : const int</li>
<li class="fn"><b><a href="q3dockarea.html#empty-prop">empty</a></b> : const bool</li>
<li class="fn"><b><a href="q3dockarea.html#handlePosition-prop">handlePosition</a></b> : const HandlePosition</li>
<li class="fn"><b><a href="q3dockarea.html#orientation-prop">orientation</a></b> : const Qt::Orientation</li>
</ul>
<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>
</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="q3dockarea.html#Q3DockArea">Q3DockArea</a></b> ( Qt::Orientation <i>o</i>, HandlePosition <i>h</i> = Normal, QWidget * <i>parent</i> = 0, const char * <i>name</i> = 0 )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="q3dockarea.html#dtor.Q3DockArea">~Q3DockArea</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="q3dockarea.html#count-prop">count</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QList<Q3DockWindow *> </td><td class="memItemRight bottomAlign"><b><a href="q3dockarea.html#dockWindowList">dockWindowList</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> HandlePosition </td><td class="memItemRight bottomAlign"><b><a href="q3dockarea.html#handlePosition-prop">handlePosition</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="q3dockarea.html#hasDockWindow">hasDockWindow</a></b> ( Q3DockWindow * <i>w</i>, int * <i>index</i> = 0 )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="q3dockarea.html#isDockWindowAccepted">isDockWindowAccepted</a></b> ( Q3DockWindow * <i>dw</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="q3dockarea.html#empty-prop">isEmpty</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3dockarea.html#moveDockWindow">moveDockWindow</a></b> ( Q3DockWindow * <i>w</i>, int <i>index</i> = -1 )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3dockarea.html#moveDockWindow-2">moveDockWindow</a></b> ( Q3DockWindow * <i>w</i>, const QPoint & <i>p</i>, const QRect & <i>r</i>, bool <i>swap</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Qt::Orientation </td><td class="memItemRight bottomAlign"><b><a href="q3dockarea.html#orientation-prop">orientation</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3dockarea.html#removeDockWindow">removeDockWindow</a></b> ( Q3DockWindow * <i>w</i>, bool <i>makeFloating</i>, bool <i>swap</i>, bool <i>fixNewLines</i> = true )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3dockarea.html#setAcceptDockWindow">setAcceptDockWindow</a></b> ( Q3DockWindow * <i>dw</i>, bool <i>accept</i> )</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="q3dockarea.html#eventFilter">eventFilter</a></b> ( QObject * <i>o</i>, QEvent * <i>e</i> )</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="public-slots"></a>
<h2>Public Slots</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3dockarea.html#lineUp">lineUp</a></b> ( bool <i>keepNewLines</i> )</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="related-non-members"></a>
<h2>Related Non-Members</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> QTextStream & </td><td class="memItemRight bottomAlign"><b><a href="q3dockarea.html#operator-lt-lt-42">operator<<</a></b> ( QTextStream & <i>ts</i>, const Q3DockArea & <i>dockArea</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QTextStream & </td><td class="memItemRight bottomAlign"><b><a href="q3dockarea.html#operator-gt-gt-28">operator>></a></b> ( QTextStream & <i>ts</i>, Q3DockArea & <i>dockArea</i> )</td></tr>
</table>
<h3>Additional Inherited Members</h3>
<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>
<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">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>
<!-- $$$Q3DockArea-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The Q3DockArea class manages and lays out Q3DockWindows.</p>
<p>A Q3DockArea is a container which manages a list of <a href="q3dockwindow.html">Q3DockWindow</a>s which it lays out within its area. In cooperation with the <a href="q3dockwindow.html">Q3DockWindow</a>s it is responsible for the docking and undocking of <a href="q3dockwindow.html">Q3DockWindow</a>s and moving them inside the dock area. Q3DockAreas also handle the wrapping of <a href="q3dockwindow.html">Q3DockWindow</a>s to fill the available space as compactly as possible. Q3DockAreas can contain Q3ToolBars since <a href="q3toolbar.html">Q3ToolBar</a> is a <a href="q3dockwindow.html">Q3DockWindow</a> subclass.</p>
<p><a href="qmainwindow.html">QMainWindow</a> contains four Q3DockAreas which you can use for your Q3ToolBars and Q3DockWindows, so in most situations you do not need to use the Q3DockArea class directly. Although <a href="qmainwindow.html">QMainWindow</a> contains support for its own dock areas, you can't add new ones. You also can't add a Q3DockArea to your own subclass of <a href="qwidget.html">QWidget</a>. It won't be shown.</p>
<p class="centerAlign"><img src="images/qmainwindow-qdockareas.png" alt="QMainWindow's Q3DockAreas" /></p><a name="lines"></a><a name="lines"></a>
<h3>Lines.</h3>
<p>Q3DockArea uses the concept of lines. A line is a horizontal region which may contain dock windows side-by-side. A dock area may have room for more than one line. When dock windows are docked into a dock area they are usually added at the right hand side of the top-most line that has room (unless manually placed by the user). When users move dock windows they may leave empty lines or gaps in non-empty lines. <a href="qt-qt3.html#Dock-enum">Qt::Dock</a> windows can be lined up to minimize wasted space using the <a href="q3dockarea.html#lineUp">lineUp</a>() function.</p>
<p>The Q3DockArea class maintains a position list of all its child dock windows. <a href="qt-qt3.html#Dock-enum">Qt::Dock</a> windows are added to a dock area from position 0 onwards. <a href="qt-qt3.html#Dock-enum">Qt::Dock</a> windows are laid out sequentially in position order from left to right, and in the case of multiple lines of dock windows, from top to bottom. If a dock window is floated it still retains its position since this is where the window will return if the user double clicks its caption. A dock window's position can be determined with <a href="q3dockarea.html#hasDockWindow">hasDockWindow</a>(). The position can be changed with <a href="q3dockarea.html#moveDockWindow">moveDockWindow</a>().</p>
<p>To dock or undock a dock window use <a href="q3dockwindow.html#dock">Q3DockWindow::dock</a>() and <a href="q3dockwindow.html#undock">Q3DockWindow::undock</a>() respectively. If you want to control which dock windows can dock in a dock area use <a href="q3dockarea.html#setAcceptDockWindow">setAcceptDockWindow</a>(). To see if a dock area contains a particular dock window use <a href="q3dockarea.html#hasDockWindow">hasDockWindow</a>(); to see how many dock windows a dock area contains use <a href="q3dockarea.html#count-prop">count</a>().</p>
<p>The streaming operators can write the positions of the dock windows in the dock area to a <a href="qtextstream.html">QTextStream</a>. The positions can be read back later to restore the saved positions.</p>
<p>Save the positions to a <a href="qtextstream.html">QTextStream</a>:</p>
<pre class="cpp"> ts <span class="operator"><</span><span class="operator"><</span> <span class="operator">*</span>myDockArea;</pre>
<p>Restore the positions from a <a href="qtextstream.html">QTextStream</a>:</p>
<pre class="cpp"> ts <span class="operator">></span><span class="operator">></span> <span class="operator">*</span>myDockArea;</pre>
</div>
<!-- @@@Q3DockArea -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$HandlePosition$$$Normal$$$Reverse -->
<h3 class="fn"><a name="HandlePosition-enum"></a>enum Q3DockArea::<span class="name">HandlePosition</span></h3>
<p>A dock window has two kinds of handles, the dock window handle used for dragging the dock window, and the splitter handle used to resize the dock window in relation to other dock windows using a splitter. (The splitter handle is only visible for docked windows.)</p>
<p>This enum specifies where the dock window splitter handle is placed in the dock area.</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>Q3DockArea::Normal</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">The splitter handles of dock windows are placed at the right or bottom.</td></tr>
<tr><td class="topAlign"><tt>Q3DockArea::Reverse</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign">The splitter handles of dock windows are placed at the left or top.</td></tr>
</table>
<!-- @@@HandlePosition -->
</div>
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$count-prop$$$count -->
<h3 class="fn"><a name="count-prop"></a><span class="name">count</span> : const <span class="type">int</span></h3>
<p>This property holds the number of dock windows in the dock area.</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>count</b></span> () const</td></tr>
</table>
<!-- @@@count -->
<!-- $$$empty-prop$$$isEmpty -->
<h3 class="fn"><a name="empty-prop"></a><span class="name">empty</span> : const <span class="type">bool</span></h3>
<p>This property holds whether the dock area is empty.</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>isEmpty</b></span> () const</td></tr>
</table>
<!-- @@@empty -->
<!-- $$$handlePosition-prop$$$handlePosition -->
<h3 class="fn"><a name="handlePosition-prop"></a><span class="name">handlePosition</span> : const <span class="type"><a href="q3dockarea.html#HandlePosition-enum">HandlePosition</a></span></h3>
<p>This property holds where the dock window splitter handle is placed in the dock area.</p>
<p>The default position is <tt>Normal</tt>.</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> HandlePosition </td><td class="memItemRight bottomAlign"><span class="name"><b>handlePosition</b></span> () const</td></tr>
</table>
<!-- @@@handlePosition -->
<!-- $$$orientation-prop$$$orientation -->
<h3 class="fn"><a name="orientation-prop"></a><span class="name">orientation</span> : const <span class="type"><a href="qt.html#Orientation-enum">Qt::Orientation</a></span></h3>
<p>This property holds the dock area's orientation.</p>
<p>There is no default value; the orientation is specified in the constructor.</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> Qt::Orientation </td><td class="memItemRight bottomAlign"><span class="name"><b>orientation</b></span> () const</td></tr>
</table>
<!-- @@@orientation -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$Q3DockArea[overload1]$$$Q3DockAreaQt::OrientationHandlePositionQWidget*constchar* -->
<h3 class="fn"><a name="Q3DockArea"></a>Q3DockArea::<span class="name">Q3DockArea</span> ( <span class="type"><a href="qt.html#Orientation-enum">Qt::Orientation</a></span> <i>o</i>, <span class="type"><a href="q3dockarea.html#HandlePosition-enum">HandlePosition</a></span> <i>h</i> = Normal, <span class="type"><a href="qwidget.html">QWidget</a></span> * <i>parent</i> = 0, const <span class="type">char</span> * <i>name</i> = 0 )</h3>
<p>Constructs a <a href="q3dockarea.html" class="compat">Q3DockArea</a> with orientation <i>o</i>, <a href="q3dockarea.html#HandlePosition-enum">HandlePosition</a> <i>h</i>, parent <i>parent</i> and called <i>name</i>.</p>
<!-- @@@Q3DockArea -->
<!-- $$$~Q3DockArea[overload1]$$$~Q3DockArea -->
<h3 class="fn"><a name="dtor.Q3DockArea"></a>Q3DockArea::<span class="name">~Q3DockArea</span> ()</h3>
<p>Destroys the dock area and all the dock windows docked in the dock area.</p>
<p>Does not affect any floating dock windows or dock windows in other dock areas, even if they first appeared in this dock area. Floating dock windows are effectively top level windows and are not child windows of the dock area. When a floating dock window is docked (dragged into a dock area) its parent becomes the dock area.</p>
<!-- @@@~Q3DockArea -->
<!-- $$$dockWindowList[overload1]$$$dockWindowList -->
<h3 class="fn"><a name="dockWindowList"></a><span class="type"><a href="qlist.html">QList</a></span><<span class="type"><a href="q3dockwindow.html">Q3DockWindow</a></span> *> Q3DockArea::<span class="name">dockWindowList</span> () const</h3>
<p>Returns a list of the dock windows in the dock area.</p>
<!-- @@@dockWindowList -->
<!-- $$$eventFilter[overload1]$$$eventFilterQObject*QEvent* -->
<h3 class="fn"><a name="eventFilter"></a><span class="type">bool</span> Q3DockArea::<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 -->
<!-- $$$hasDockWindow[overload1]$$$hasDockWindowQ3DockWindow*int* -->
<h3 class="fn"><a name="hasDockWindow"></a><span class="type">bool</span> Q3DockArea::<span class="name">hasDockWindow</span> ( <span class="type"><a href="q3dockwindow.html">Q3DockWindow</a></span> * <i>w</i>, <span class="type">int</span> * <i>index</i> = 0 )</h3>
<p>Returns true if the dock area contains the dock window <i>w</i>; otherwise returns false. If <i>index</i> is not 0 it will be set as follows: if the dock area contains the dock window *<i>index</i> is set to <i>w</i>'s index position; otherwise *<i>index</i> is set to -1.</p>
<!-- @@@hasDockWindow -->
<!-- $$$isDockWindowAccepted[overload1]$$$isDockWindowAcceptedQ3DockWindow* -->
<h3 class="fn"><a name="isDockWindowAccepted"></a><span class="type">bool</span> Q3DockArea::<span class="name">isDockWindowAccepted</span> ( <span class="type"><a href="q3dockwindow.html">Q3DockWindow</a></span> * <i>dw</i> )</h3>
<p>Returns true if dock window <i>dw</i> could be docked into the dock area; otherwise returns false.</p>
<p><b>See also </b><a href="q3dockarea.html#setAcceptDockWindow">setAcceptDockWindow</a>().</p>
<!-- @@@isDockWindowAccepted -->
<!-- $$$lineUp[overload1]$$$lineUpbool -->
<h3 class="fn"><a name="lineUp"></a><span class="type">void</span> Q3DockArea::<span class="name">lineUp</span> ( <span class="type">bool</span> <i>keepNewLines</i> )<tt> [slot]</tt></h3>
<p>Lines up the dock windows in this dock area to minimize wasted space. If <i>keepNewLines</i> is true, only space within lines is cleaned up. If <i>keepNewLines</i> is false the number of lines might be changed.</p>
<!-- @@@lineUp -->
<!-- $$$moveDockWindow[overload1]$$$moveDockWindowQ3DockWindow*int -->
<h3 class="fn"><a name="moveDockWindow"></a><span class="type">void</span> Q3DockArea::<span class="name">moveDockWindow</span> ( <span class="type"><a href="q3dockwindow.html">Q3DockWindow</a></span> * <i>w</i>, <span class="type">int</span> <i>index</i> = -1 )</h3>
<p>Moves the <a href="q3dockwindow.html" class="compat">Q3DockWindow</a> <i>w</i> within the dock area. If <i>w</i> is not already docked in this area, <i>w</i> is docked first. If <i>index</i> is -1 or larger than the number of docked widgets, <i>w</i> is appended at the end, otherwise it is inserted at the position <i>index</i>.</p>
<!-- @@@moveDockWindow -->
<!-- $$$moveDockWindow$$$moveDockWindowQ3DockWindow*constQPoint&constQRect&bool -->
<h3 class="fn"><a name="moveDockWindow-2"></a><span class="type">void</span> Q3DockArea::<span class="name">moveDockWindow</span> ( <span class="type"><a href="q3dockwindow.html">Q3DockWindow</a></span> * <i>w</i>, const <span class="type"><a href="qpoint.html">QPoint</a></span> & <i>p</i>, const <span class="type"><a href="qrect.html">QRect</a></span> & <i>r</i>, <span class="type">bool</span> <i>swap</i> )</h3>
<p>This is an overloaded function.</p>
<p>Moves the dock window <i>w</i> inside the dock area where <i>p</i> is the new position (in global screen coordinates), <i>r</i> is the suggested rectangle of the dock window and <i>swap</i> specifies whether or not the orientation of the docked widget needs to be changed.</p>
<p>This function is used internally by <a href="q3dockwindow.html" class="compat">Q3DockWindow</a>. You shouldn't need to call it yourself.</p>
<!-- @@@moveDockWindow -->
<!-- $$$removeDockWindow[overload1]$$$removeDockWindowQ3DockWindow*boolboolbool -->
<h3 class="fn"><a name="removeDockWindow"></a><span class="type">void</span> Q3DockArea::<span class="name">removeDockWindow</span> ( <span class="type"><a href="q3dockwindow.html">Q3DockWindow</a></span> * <i>w</i>, <span class="type">bool</span> <i>makeFloating</i>, <span class="type">bool</span> <i>swap</i>, <span class="type">bool</span> <i>fixNewLines</i> = true )</h3>
<p>Removes the dock window <i>w</i> from the dock area. If <i>makeFloating</i> is true, <i>w</i> gets floated, and if <i>swap</i> is true, the orientation of <i>w</i> gets swapped. If <i>fixNewLines</i> is true (the default) newlines in the area will be fixed.</p>
<p>You should never need to call this function yourself. Use <a href="q3dockwindow.html#dock">Q3DockWindow::dock</a>() and <a href="q3dockwindow.html#undock">Q3DockWindow::undock</a>() instead.</p>
<!-- @@@removeDockWindow -->
<!-- $$$setAcceptDockWindow[overload1]$$$setAcceptDockWindowQ3DockWindow*bool -->
<h3 class="fn"><a name="setAcceptDockWindow"></a><span class="type">void</span> Q3DockArea::<span class="name">setAcceptDockWindow</span> ( <span class="type"><a href="q3dockwindow.html">Q3DockWindow</a></span> * <i>dw</i>, <span class="type">bool</span> <i>accept</i> )</h3>
<p>If <i>accept</i> is true, dock window <i>dw</i> can be docked in the dock area. If <i>accept</i> is false, dock window <i>dw</i> cannot be docked in the dock area.</p>
<p><b>See also </b><a href="q3dockarea.html#isDockWindowAccepted">isDockWindowAccepted</a>().</p>
<!-- @@@setAcceptDockWindow -->
</div>
<div class="relnonmem">
<h2>Related Non-Members</h2>
<!-- $$$operator<<$$$operator<<QTextStream&constQ3DockArea& -->
<h3 class="fn"><a name="operator-lt-lt-42"></a><span class="type"><a href="qtextstream.html">QTextStream</a></span> & <span class="name">operator<<</span> ( <span class="type"><a href="qtextstream.html">QTextStream</a></span> & <i>ts</i>, const <span class="type">Q3DockArea</span> & <i>dockArea</i> )</h3>
<p>Writes the layout of the dock windows in dock area <i>dockArea</i> to the text stream <i>ts</i>.</p>
<!-- @@@operator<< -->
<!-- $$$operator>>$$$operator>>QTextStream&Q3DockArea& -->
<h3 class="fn"><a name="operator-gt-gt-28"></a><span class="type"><a href="qtextstream.html">QTextStream</a></span> & <span class="name">operator>></span> ( <span class="type"><a href="qtextstream.html">QTextStream</a></span> & <i>ts</i>, <span class="type">Q3DockArea</span> & <i>dockArea</i> )</h3>
<p>Reads the layout description of the dock windows in dock area <i>dockArea</i> from the text stream <i>ts</i> and restores it. The layout description must have been previously written by the operator<<() function.</p>
<!-- @@@operator>> -->
</div>
</div>
</div>
</div>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2013 Digia Plc 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>
Digia, Qt and their respective logos are trademarks of Digia Plc
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>
<script src="scripts/functions.js" type="text/javascript"></script>
</body>
</html>
