<HTML>
<HEAD>
<TITLE>class KDockWidget</TITLE>
<META NAME="Generator" CONTENT="KDOC ">
</HEAD>
<BODY bgcolor="#ffffff" text="#000000" link="#0000ff" vlink="#000099" alink= "#ffffff">
<TABLE WIDTH="100%" BORDER="0">
<TR>
<TD>
<TABLE BORDER="0">
<TR><TD valign="top" align="left" cellspacing="10">
<h1>class KDockWidget</h1>
</TD>
<TD valign="top" align="right" colspan="1">
Floatable widget that can be dragged around with the mouse and
encapsulate the actual widgets (and member of the dockwidget class
set). <small><A HREF="#longdesc">More...</A></small></TD></TR>
</TABLE>
<HR>
<TABLE BORDER="0">
<TR><TH>Definition</TH><TD><code>#include <<A HREF="kdockwidget_h.html">kdockwidget.h</A>></code></TD></TR>
<TR><TH>Inherits</TH><TD><A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qwidget.html">QWidget</A> <small>(qt)</small> <small>[public ]</small></TD></TR>
<TR><TH><A HREF="full-list-KDockWidget.html">List of all Methods</A></TH></TR>
</TABLE>
</TD>
<TD align="right"><TABLE BORDER="0"><TR><TD><small><A HREF="index-long.html">Annotated List</A></small></TD></TR>
<TR><TD><small><A HREF="header-list.html">Files</A></small></TD></TR>
<TR><TD><small><A HREF="all-globals.html">Globals</A></small></TD></TR>
<TR><TD><small><A HREF="hier.html">Hierarchy</A></small></TD></TR>
<TR><TD><small><A HREF="index.html">Index</A></small></TD></TR>
</TABLE></TD></TR></TABLE>
<h4>Public Types</h4><ul><LI>enum <A HREF="#ref7">DockPosition</A> { DockNone = 0,
DockTop = 0x0001,
DockLeft = 0x0002,
DockRight = 0x0004,
DockBottom = 0x0008,
DockCenter = 0x0010,
DockDesktop= 0x0020,
DockCorner = DockTop | DockLeft | DockRight | DockBottom,
DockFullSite = DockCorner | DockCenter,
DockFullDocking = DockFullSite | DockDesktop
}
</LI>
</ul><h4>Public Methods</h4><ul><LI> <b><A HREF="#ref5">KDockWidget</A></b> ( <A HREF="KDockManager.html">KDockManager</A>* dockManager, const char* name,
const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qpixmap.html">QPixmap</A> &pixmap, <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qwidget.html">QWidget</A>* parent = 0L, const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A>& strCaption = 0L,
const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A>& strTabPageLabel = " ", WFlags f = 0)
</LI>
<LI>virtual <b><A HREF="#ref6">~KDockWidget</A></b> ()
</LI>
<LI><A HREF="KDockWidget.html">KDockWidget</A>* <b><A HREF="#ref8">manualDock</A></b> ( <A HREF="KDockWidget.html">KDockWidget</A>* target, DockPosition dockPos, int spliPos = 50, <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qpoint.html">QPoint</A> pos = <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qpoint.html">QPoint</A>(0,0), bool check = false, int tabIndex = -1)
</LI>
<LI>void <b><A HREF="#ref9">setEnableDocking</A></b> ( int pos )
</LI>
<LI>int <b><A HREF="#ref10">enableDocking</A></b> ()
</LI>
<LI>void <b><A HREF="#ref11">setDockSite</A></b> ( int pos )
</LI>
<LI>int <b><A HREF="#ref12">dockSite</A></b> ()
</LI>
<LI>void <b><A HREF="#ref13">setWidget</A></b> ( <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qwidget.html">QWidget</A>* w)
</LI>
<LI><A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qwidget.html">QWidget</A>* <b><A HREF="#ref14">getWidget</A></b> ()
</LI>
<LI>void <b><A HREF="#ref15">setHeader</A></b> ( <A HREF="KDockWidgetAbstractHeader.html">KDockWidgetAbstractHeader</A>* ah)
</LI>
<LI>void <b><A HREF="#ref16">makeDockVisible</A></b> ()
</LI>
<LI>bool <b><A HREF="#ref17">mayBeHide</A></b> ()
</LI>
<LI>bool <b><A HREF="#ref18">mayBeShow</A></b> ()
</LI>
<LI><A HREF="KDockManager.html">KDockManager</A>* <b><A HREF="#ref19">dockManager</A></b> ()
</LI>
<LI>void <b><A HREF="#ref20">setToolTipString</A></b> (const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A>& ttStr)
</LI>
<LI>const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A>& <b><A HREF="#ref21">toolTipString</A></b> ()
</LI>
<LI>bool <b><A HREF="#ref22">isDockBackPossible</A></b> ()
</LI>
<LI>void <b><A HREF="#ref23">setTabPageLabel</A></b> ( const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A>& label)
</LI>
<LI>const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A>& <b><A HREF="#ref24">tabPageLabel</A></b> ()
</LI>
<LI>virtual bool <b><A HREF="#ref25">event</A></b> ( <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qevent.html">QEvent</A> * )
</LI>
<LI>virtual void <b><A HREF="#ref26">show</A></b> ()
</LI>
<LI><A HREF="KDockTabGroup.html">KDockTabGroup</A>* <b><A HREF="#ref27">parentDockTabGroup</A></b> ()
</LI>
<LI>void <b><A HREF="#ref28">setDockWindowType</A></b> (NET::WindowType windowType)
</LI>
<LI>void <b><A HREF="#ref29">setDockWindowTransient</A></b> (<A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qwidget.html">QWidget</A> *parent, bool transientEnabled)
</LI>
</ul><h4>Public Slots</h4><ul><LI>void <b><A HREF="#ref30">dockBack</A></b> ()
</LI>
<LI>void <b><A HREF="#ref31">changeHideShowState</A></b> ()
</LI>
<LI>void <b><A HREF="#ref32">undock</A></b> ()
</LI>
</ul><h4>Signals</h4><ul><LI>void <b><A HREF="#ref35">docking</A></b> ( <A HREF="KDockWidget.html">KDockWidget</A>* dw, <A HREF="KDockWidget.html#DockPosition">KDockWidget::DockPosition</A> dp)
</LI>
<LI>void <b><A HREF="#ref36">setDockDefaultPos</A></b> ()
</LI>
<LI>void <b><A HREF="#ref37">headerCloseButtonClicked</A></b> ()
</LI>
<LI>void <b><A HREF="#ref38">headerDockbackButtonClicked</A></b> ()
</LI>
<LI>void <b><A HREF="#ref39">iMBeingClosed</A></b> ()
</LI>
<LI>void <b><A HREF="#ref40">hasUndocked</A></b> ()
</LI>
</ul><h4>Protected Methods</h4><ul><LI><A HREF="KDockTabGroup.html">KDockTabGroup</A>* <b><A HREF="#ref33">parentTabGroup</A></b> ()
</LI>
<LI>void <b><A HREF="#ref34">updateHeader</A></b> ()
</LI>
</ul><h4>Protected Slots</h4><ul><LI>void <b><A HREF="#ref41">loseFormerBrotherDockWidget</A></b> ()
</LI>
</ul><h4>Protected Members</h4><ul><LI>KDockWidget* <b><A HREF="#ref42">formerBrotherDockWidget</A></b></LI>
<LI>DockPosition <b><A HREF="#ref43">currentDockPos</A></b></LI>
<LI>DockPosition <b><A HREF="#ref44">formerDockPos</A></b></LI>
<LI>QString <b><A HREF="#ref45">toolTipStr</A></b></LI>
<LI>QString <b><A HREF="#ref46">tabPageTitle</A></b></LI>
</ul><HR><H2><A NAME="longdesc">Detailed Description</A></H2><p>
Floatable widget that can be dragged around with the mouse and
encapsulate the actual widgets (and member of the dockwidget class
set).
</p>
<p> You just grip the double-lined panel, tear it off its parent
widget, drag it somewhere and let it loose. Depending on the
position where you leave it, the dockwidget becomes a toplevel
window on the desktop (floating mode) or docks to a new widget
(dock mode). + Note: A <A HREF="KDockWidget.html#KDockWidget">KDockWidget</A> can only be docked to a
<A HREF="KDockWidget.html#KDockWidget">KDockWidget</A>.
</p>
<p> If you want to use this kind of widget, your main application
window has to be a <A HREF="KDockWidget.html#KDockMainWindow">KDockMainWindow</A>. That is because it has
got several additional dock management features, for instance a
<A HREF="KDockWidget.html#KDockManager">KDockManager</A> that has an overview over all dockwidgets and and
a dockmovemanager (internal class) that handles the dock process.
</p>
<p> Usually you create an <A HREF="KDockWidget.html#KDockWidget">KDockWidget</A> that covers the actual widget in this way:
</p><table border="0" width="100%">
<tr>
<td bgcolor="#BEEAE0">
<pre>
...
<A HREF="KDockWidget.html#KDockMainWindow">KDockMainWindow</A>* mainWidget;
...
<A HREF="KDockWidget.html#KDockWidget">KDockWidget</A>* dock = 0L;
dock = mainWidget->createDockWidget( "Any window caption", nicePixmap, 0L, <A HREF="../kdecore/.html#i18n">i18n</A>("window caption")); // 0L==no parent
<A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qwidget.html">QWidget</A>* actualWidget = new <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qwidget.html">QWidget</A>( dock);
dock-><A HREF="KDockWidget.html#setWidget">setWidget</A>( actualWidget); // embed it
dock-><A HREF="KDockWidget.html#setToolTipString">setToolTipString</A>(<A HREF="../kdecore/.html#i18n">i18n</A>("That's me")); // available when appearing as tab page
...
</pre>
</td></tr>
</table> <p>
</p>
<p> See <A HREF="KDockWidget.html#KDockMainWindow">KDockMainWindow</A> how a dockwidget is docked in.
</p>
<p></p>
<p></p>
<A NAME="KDockWidget"></A><A NAME="ref5"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>KDockWidget</strong> ( <A HREF="KDockManager.html">KDockManager</A>* dockManager, const char* name,
const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qpixmap.html">QPixmap</A> &pixmap, <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qwidget.html">QWidget</A>* parent = 0L, const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A>& strCaption = 0L,
const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A>& strTabPageLabel = " ", WFlags f = 0)
<br></td><td align="right"><h3><strong>KDockWidget</strong></h3></td></tr></table><p></p><p>
Construct a dockwidget.
</p>
<p> Initially, docking to another and docking to this is allowed for
every <code>DockPosition</code>. It is supposed to be no (tab) group. It will
taken under control of its dockmanager.
</p>
<p></p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>dockManager</i></TD><TD align="left" valign="top">The responsible manager (dock helper)
</TD></TR>
<TR><TD align="left" valign="top"><i>name</i></TD><TD align="left" valign="top">Object instance name
</TD></TR>
<TR><TD align="left" valign="top"><i>pixmap</i></TD><TD align="left" valign="top">An icon (for instance shown when docked centered)
</TD></TR>
<TR><TD align="left" valign="top"><i>parent</i></TD><TD align="left" valign="top">Parent widget
</TD></TR>
<TR><TD align="left" valign="top"><i>strCaption</i></TD><TD align="left" valign="top">Title of the dockwidget window (shown when toplevel)
</TD></TR>
<TR><TD align="left" valign="top"><i>strTabPageLabel</i></TD><TD align="left" valign="top">The title of the tab page (shown when in tab page mode), if it is "", only the icon will be shown, if it is 0L, the label is set to strCaption
</TD></TR>
</TABLE></P>
<A NAME="~KDockWidget"></A><A NAME="ref6"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>~KDockWidget</strong> ()
<br></td><td align="right"><h3><strong>~KDockWidget</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Destructs a dockwidget.
</p>
<A NAME="DockPosition"></A><A NAME="ref7"></A><table width="100%"><tr bgcolor="#eeeeee"><td>enum <strong>DockPosition</strong> { DockNone = 0,
DockTop = 0x0001,
DockLeft = 0x0002,
DockRight = 0x0004,
DockBottom = 0x0008,
DockCenter = 0x0010,
DockDesktop= 0x0020,
DockCorner = DockTop | DockLeft | DockRight | DockBottom,
DockFullSite = DockCorner | DockCenter,
DockFullDocking = DockFullSite | DockDesktop
}
</td><td align="right"><h3><strong>DockPosition</strong></h3></td></tr></table><p></p><p>
The possible positions where a dockwidget can dock to another dockwidget
</p>
<A NAME="manualDock"></A><A NAME="ref8"></A><table width="100%"><tr bgcolor="#eeeeee"><td><A HREF="KDockWidget.html">KDockWidget</A>* <strong>manualDock</strong> ( <A HREF="KDockWidget.html">KDockWidget</A>* target, DockPosition dockPos, int spliPos = 50, <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qpoint.html">QPoint</A> pos = <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qpoint.html">QPoint</A>(0,0), bool check = false, int tabIndex = -1)
<br></td><td align="right"><h3><strong>manualDock</strong></h3></td></tr></table><p></p><p>
This is a key method of this class! Use it to dock dockwidgets to
another dockwidget at the right position within its
<A HREF="KDockWidget.html#KDockMainWindow">KDockMainWindow</A> or a toplevel dockwidget.
</p>
<p></p>
<p> If the target is null, it will become a toplevel dockwidget at position pos;
Note: Docking to another dockwidget means exactly:
A new parent dockwidget will be created, that replaces the target dockwidget and contains another single helper widget (tab widget or panner)
which contains both dockwidgets, this and the target dockwidget. So consider parent<->child relationships change completely during such actions.
</p>
<p></p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>target</i></TD><TD align="left" valign="top">The dockwidget to dock to
</TD></TR>
<TR><TD align="left" valign="top"><i>dockPos</i></TD><TD align="left" valign="top">One of the DockPositions this is going to dock to
</TD></TR>
<TR><TD align="left" valign="top"><i>spliPos</i></TD><TD align="left" valign="top">The split relation (in percent, or percent*100 in high resolution) between both dockwidgets, target and this
</TD></TR>
<TR><TD align="left" valign="top"><i>pos</i></TD><TD align="left" valign="top">The dock position, mainly of interest for docking to the desktop (as toplevel dockwidget)
</TD></TR>
<TR><TD align="left" valign="top"><i>check</i></TD><TD align="left" valign="top">Only for internal use;
</TD></TR>
<TR><TD align="left" valign="top"><i>tabIndex</i></TD><TD align="left" valign="top">The position index of the tab widget (when in tab page mode), -1 (default) means append
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: result The group dockwidget that replaces the target dockwidget and will be grandparent of target and <code>this</code>.
</p>
<A NAME="setEnableDocking"></A><A NAME="ref9"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>setEnableDocking</strong> ( int pos )
<br></td><td align="right"><h3><strong>setEnableDocking</strong></h3></td></tr></table><p></p><p>
Specify where it is either possible or impossible for this to dock to another dockwidget.
</p>
<p></p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>pos</i></TD><TD align="left" valign="top">An OR'ed set of <code>DockPositions</code>
</TD></TR>
</TABLE></P>
<A NAME="enableDocking"></A><A NAME="ref10"></A><table width="100%"><tr bgcolor="#eeeeee"><td>int <strong>enableDocking</strong> ()
<br></td><td align="right"><h3><strong>enableDocking</strong></h3></td></tr></table><p></p><p>
</p>
<p><b>Returns</b>: Where it is either possible or impossible for this to dock to another dockwidget (an OR'ed set of DockPositions).
</p>
<A NAME="setDockSite"></A><A NAME="ref11"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>setDockSite</strong> ( int pos )
<br></td><td align="right"><h3><strong>setDockSite</strong></h3></td></tr></table><p></p><p>
Specify where it is either possible or impossible for another dockwidget to dock to this.
</p>
<p></p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>pos</i></TD><TD align="left" valign="top">An OR'ed set of <code>DockPositions</code>
</TD></TR>
</TABLE></P>
<A NAME="dockSite"></A><A NAME="ref12"></A><table width="100%"><tr bgcolor="#eeeeee"><td>int <strong>dockSite</strong> ()
<br></td><td align="right"><h3><strong>dockSite</strong></h3></td></tr></table><p></p><p>
</p>
<p><b>Returns</b>: There it is either possible or impossible for another dockwidget to dock to this (an OR'ed set of <code>DockPositions</code>).
</p>
<A NAME="setWidget"></A><A NAME="ref13"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>setWidget</strong> ( <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qwidget.html">QWidget</A>* w)
<br></td><td align="right"><h3><strong>setWidget</strong></h3></td></tr></table><p></p><p>
Set the embedded widget.
</p>
<p> A QLayout takes care about proper resizing, automatically.
</p>
<p></p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>w</i></TD><TD align="left" valign="top">The pointer to the dockwidget's child widget.
</TD></TR>
</TABLE></P>
<A NAME="getWidget"></A><A NAME="ref14"></A><table width="100%"><tr bgcolor="#eeeeee"><td><A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qwidget.html">QWidget</A>* <strong>getWidget</strong> ()
<br></td><td align="right"><h3><strong>getWidget</strong></h3></td></tr></table><p></p><p>
Get the embedded widget.
</p>
<p></p>
<p><b>Returns</b>: The pointer to the dockwidget's child widget, 0L if there's no such child.
</p>
<A NAME="setHeader"></A><A NAME="ref15"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>setHeader</strong> ( <A HREF="KDockWidgetAbstractHeader.html">KDockWidgetAbstractHeader</A>* ah)
<br></td><td align="right"><h3><strong>setHeader</strong></h3></td></tr></table><p></p><p>
Set the header of this dockwidget.
</p>
<p> A <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qlayout.html">QLayout</A> takes care about proper resizing, automatically.
The header contains the drag panel, the close button and the stay button.
</p>
<p></p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>ah</i></TD><TD align="left" valign="top">A base class pointer to the dockwidget header
</TD></TR>
</TABLE></P>
<A NAME="makeDockVisible"></A><A NAME="ref16"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>makeDockVisible</strong> ()
<br></td><td align="right"><h3><strong>makeDockVisible</strong></h3></td></tr></table><p></p><p>
Normally it simply shows the dockwidget.
</p>
<p> But additionally, if it is docked to a tab widget (<code>DockCenter</code>), it is set as the active (visible) tab page.
</p>
<A NAME="mayBeHide"></A><A NAME="ref17"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>mayBeHide</strong> ()
<br></td><td align="right"><h3><strong>mayBeHide</strong></h3></td></tr></table><p></p><p>
</p>
<p> There are reasons that it's impossible:
</p>
<ul>
<li>It is a (tab) group.
</li>
<li>It is already invisible ;-)
</li>
<li>The parent of this is the <A HREF="KDockWidget.html#KDockMainWindow">KDockMainWindow</A>.
</li>
<li>It isn't able to dock to another widget.
</li>
</ul>
<p>
</p>
<p><b>Returns</b>: If it may be possible to hide this.
</p>
<A NAME="mayBeShow"></A><A NAME="ref18"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>mayBeShow</strong> ()
<br></td><td align="right"><h3><strong>mayBeShow</strong></h3></td></tr></table><p></p><p>
</p>
<ul>
<li>It is a (tab) group.
</li>
<li>It is already visible ;-)
</li>
<li>The parent of this is the <code>KDockMainWindow</code>.
</li>
</ul>
<p>
</p>
<p><b>Returns</b>: If it may be possible to show this.
There are reasons that it's impossible:
</p>
<A NAME="dockManager"></A><A NAME="ref19"></A><table width="100%"><tr bgcolor="#eeeeee"><td><A HREF="KDockManager.html">KDockManager</A>* <strong>dockManager</strong> ()
<br></td><td align="right"><h3><strong>dockManager</strong></h3></td></tr></table><p></p><p>
</p>
<p><b>Returns</b>: The dockmanager that is responsible for this.
</p>
<A NAME="setToolTipString"></A><A NAME="ref20"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>setToolTipString</strong> (const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A>& ttStr)
<br></td><td align="right"><h3><strong>setToolTipString</strong></h3></td></tr></table><p></p><p>
Stores a string for a tooltip.
</p>
<p> That tooltip string has only a meaning when this dockwidget is shown as tab page.
In this case the tooltip is shown when one holds the mouse cursor on the tab page header.
Such tooltip will for instance be useful, if you use only icons there.
Note: Setting an empty string switches the tooltip off.
</p>
<p></p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>ttStr</i></TD><TD align="left" valign="top">A string for the tooltip on the tab.
</TD></TR>
</TABLE></P>
<A NAME="toolTipString"></A><A NAME="ref21"></A><table width="100%"><tr bgcolor="#eeeeee"><td>const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A>& <strong>toolTipString</strong> ()
<br></td><td align="right"><h3><strong>toolTipString</strong></h3></td></tr></table><p></p><p>
</p>
<p><b>Returns</b>: The tooltip string being shown on the appropriate tab page header when in dock-centered mode.
</p>
<A NAME="isDockBackPossible"></A><A NAME="ref22"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>isDockBackPossible</strong> ()
<br></td><td align="right"><h3><strong>isDockBackPossible</strong></h3></td></tr></table><p></p><p>
</p>
<p><b>Returns</b>: result <code>true</code>, if a dockback is possible, otherwise <code>false</code>.
</p>
<A NAME="setTabPageLabel"></A><A NAME="ref23"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>setTabPageLabel</strong> ( const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A>& label)
<br></td><td align="right"><h3><strong>setTabPageLabel</strong></h3></td></tr></table><p></p><p>
Set a string that is used for the label of the tab page when in tab page mode
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>label</i></TD><TD align="left" valign="top">The new tab page label.
</TD></TR>
</TABLE></P>
<A NAME="tabPageLabel"></A><A NAME="ref24"></A><table width="100%"><tr bgcolor="#eeeeee"><td>const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A>& <strong>tabPageLabel</strong> ()
<br></td><td align="right"><h3><strong>tabPageLabel</strong></h3></td></tr></table><p></p><p>
</p>
<p><b>Returns</b>: A string that is used for the label of the tab page when in tab page mode.
</p>
<A NAME="event"></A><A NAME="ref25"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>event</strong> ( <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qevent.html">QEvent</A> * )
<br></td><td align="right"><h3><strong>event</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Catches and processes some <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qwidget.html">QWidget</A> events that are interesting for dockwidgets.
</p>
<p>Reimplemented from <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qwidget.html#f30772">QWidget</A>.</p>
<A NAME="show"></A><A NAME="ref26"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>show</strong> ()
<br></td><td align="right"><h3><strong>show</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Add dockwidget management actions to <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qwidget.html#ccc8f7">QWidget::show</A>.
</p>
<p>Reimplemented from <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qwidget.html#ccc8f7">QWidget</A>.</p>
<A NAME="parentDockTabGroup"></A><A NAME="ref27"></A><table width="100%"><tr bgcolor="#eeeeee"><td><A HREF="KDockTabGroup.html">KDockTabGroup</A>* <strong>parentDockTabGroup</strong> ()
<br></td><td align="right"><h3><strong>parentDockTabGroup</strong></h3></td></tr></table><p></p><p>
</p>
<p><b>Returns</b>: the parent widget of this if it inherits class KDockTabGroup
</p>
<A NAME="setDockWindowType"></A><A NAME="ref28"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>setDockWindowType</strong> (NET::WindowType windowType)
<br></td><td align="right"><h3><strong>setDockWindowType</strong></h3></td></tr></table><p></p><p>
Sets the type of the dock window
</p>
<p></p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>windowType</i></TD><TD align="left" valign="top">is type of dock window
</TD></TR>
</TABLE></P>
<A NAME="setDockWindowTransient"></A><A NAME="ref29"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>setDockWindowTransient</strong> (<A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qwidget.html">QWidget</A> *parent, bool transientEnabled)
<br></td><td align="right"><h3><strong>setDockWindowTransient</strong></h3></td></tr></table><p></p><p>
Sets the type of the dock window
</p>
<p></p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>windowType</i></TD><TD align="left" valign="top">is type of dock window
</TD></TR>
</TABLE></P>
<A NAME="dockBack"></A><A NAME="ref30"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>dockBack</strong> ()
<br></td><td align="right"><h3><strong>dockBack</strong></h3></td></tr></table><p> <small>[slot]</small></p><A NAME="changeHideShowState"></A><A NAME="ref31"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>changeHideShowState</strong> ()
<br></td><td align="right"><h3><strong>changeHideShowState</strong></h3></td></tr></table><p> <small>[slot]</small></p><p>
Toggles the visibility state of the dockwidget if it is able to be shown or to be hidden.
</p>
<p> </p>
<A NAME="undock"></A><A NAME="ref32"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>undock</strong> ()
<br></td><td align="right"><h3><strong>undock</strong></h3></td></tr></table><p> <small>[slot]</small></p><p>
Undocks this. It means it becomes a toplevel widget framed by the system window manager.
A small panel at the top of this undocked widget gives the possibility to drag it into
another dockwidget by mouse (docking).
</p>
<A NAME="parentTabGroup"></A><A NAME="ref33"></A><table width="100%"><tr bgcolor="#eeeeee"><td><A HREF="KDockTabGroup.html">KDockTabGroup</A>* <strong>parentTabGroup</strong> ()
<br></td><td align="right"><h3><strong>parentTabGroup</strong></h3></td></tr></table><p> <small>[protected]</small></p><p>
</p>
<p><b>Returns</b>: the parent widget of this if it inherits class KDockTabGroup
Warning: This will be removed in KDE-3.0. Use parentDockTabGroup instead.
</p>
<A NAME="updateHeader"></A><A NAME="ref34"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>updateHeader</strong> ()
<br></td><td align="right"><h3><strong>updateHeader</strong></h3></td></tr></table><p> <small>[protected]</small></p><p>
Check some conditions and show or hide the dockwidget header (drag panel).
The header is hidden if:
</p>
<ul>
<li>the parent widget is the KDockMainWindow
</li>
<li>this is a (tab) group dockwidget
</li>
<li>it is not able to dock to another dockwidget
</li>
</ul>
<p>
</p>
<A NAME="docking"></A><A NAME="ref35"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>docking</strong> ( <A HREF="KDockWidget.html">KDockWidget</A>* dw, <A HREF="KDockWidget.html#DockPosition">KDockWidget::DockPosition</A> dp)
<br></td><td align="right"><h3><strong>docking</strong></h3></td></tr></table><p> <small>[signal]</small></p><p>
Emits that another dockwidget is docking to this.
</p>
<p></p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>dw</i></TD><TD align="left" valign="top">the dockwidget that is docking to this
</TD></TR>
<TR><TD align="left" valign="top"><i>dp</i></TD><TD align="left" valign="top">the DockPosition where it wants to dock to
</TD></TR>
</TABLE></P>
<A NAME="setDockDefaultPos"></A><A NAME="ref36"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>setDockDefaultPos</strong> ()
<br></td><td align="right"><h3><strong>setDockDefaultPos</strong></h3></td></tr></table><p> <small>[signal]</small></p><p>
Signals that the dock default position is set.
</p>
<A NAME="headerCloseButtonClicked"></A><A NAME="ref37"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>headerCloseButtonClicked</strong> ()
<br></td><td align="right"><h3><strong>headerCloseButtonClicked</strong></h3></td></tr></table><p> <small>[signal]</small></p><p>
Signals that the close button of the panel (<A HREF="KDockWidgetHeader.html">KDockWidgetHeader</A>) has been clicked.
</p>
<A NAME="headerDockbackButtonClicked"></A><A NAME="ref38"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>headerDockbackButtonClicked</strong> ()
<br></td><td align="right"><h3><strong>headerDockbackButtonClicked</strong></h3></td></tr></table><p> <small>[signal]</small></p><p>
Signals that the dockback button of the panel (<A HREF="KDockWidgetHeader.html">KDockWidgetHeader</A>) has been clicked.
</p>
<A NAME="iMBeingClosed"></A><A NAME="ref39"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>iMBeingClosed</strong> ()
<br></td><td align="right"><h3><strong>iMBeingClosed</strong></h3></td></tr></table><p> <small>[signal]</small></p><p>
Signals that the widget processes a close event.
</p>
<A NAME="hasUndocked"></A><A NAME="ref40"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>hasUndocked</strong> ()
<br></td><td align="right"><h3><strong>hasUndocked</strong></h3></td></tr></table><p> <small>[signal]</small></p><p>
Signals that the widget is undocked now.
</p>
<A NAME="loseFormerBrotherDockWidget"></A><A NAME="ref41"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>loseFormerBrotherDockWidget</strong> ()
<br></td><td align="right"><h3><strong>loseFormerBrotherDockWidget</strong></h3></td></tr></table><p> <small>[protected slots slot]</small></p><p> Does several things here when it has noticed that the former brother widget (closest neighbor) gets lost.
The former brother widget is needed for a possible dockback action, to speak with the Beatles:
"To get back to where you once belonged" ;-)
</p>
<A NAME="formerBrotherDockWidget"></A><A NAME="ref42"></A><table width="100%"><tr bgcolor="#eeeeee"><td><A HREF="KDockWidget.html">KDockWidget</A>* <strong>formerBrotherDockWidget</strong>
</td><td align="right"><h3><strong>formerBrotherDockWidget</strong></h3></td></tr></table><p> <small>[protected]</small></p><A NAME="currentDockPos"></A><A NAME="ref43"></A><table width="100%"><tr bgcolor="#eeeeee"><td>DockPosition <strong>currentDockPos</strong>
</td><td align="right"><h3><strong>currentDockPos</strong></h3></td></tr></table><p> <small>[protected]</small></p><A NAME="formerDockPos"></A><A NAME="ref44"></A><table width="100%"><tr bgcolor="#eeeeee"><td>DockPosition <strong>formerDockPos</strong>
</td><td align="right"><h3><strong>formerDockPos</strong></h3></td></tr></table><p> <small>[protected]</small></p><A NAME="toolTipStr"></A><A NAME="ref45"></A><table width="100%"><tr bgcolor="#eeeeee"><td><A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A> <strong>toolTipStr</strong>
</td><td align="right"><h3><strong>toolTipStr</strong></h3></td></tr></table><p> <small>[protected]</small></p><A NAME="tabPageTitle"></A><A NAME="ref46"></A><table width="100%"><tr bgcolor="#eeeeee"><td><A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A> <strong>tabPageTitle</strong>
</td><td align="right"><h3><strong>tabPageTitle</strong></h3></td></tr></table><p> <small>[protected]</small></p><HR><UL><LI><i>Author</i>: Max Judin (documentation: Falk Brettschneider).
</LI><LI><i>Generated</i>: qateam on updates.mandrakesoft.com on Mon Dec 30 16:09:05 2002, using kdoc 2.0a53.</LI></UL></BODY></HTML>
