diff options
Diffstat (limited to 'doc/html/qdoctwindow.html')
| -rw-r--r-- | doc/html/qdoctwindow.html | 509 |
1 files changed, 509 insertions, 0 deletions
diff --git a/doc/html/qdoctwindow.html b/doc/html/qdoctwindow.html new file mode 100644 index 0000000..091f4a0 --- /dev/null +++ b/doc/html/qdoctwindow.html @@ -0,0 +1,509 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<!-- /home/espenr/tmp/qt-3.3.8-espenr-2499/qt-x11-free-3.3.8/src/widgets/qdoctwindow.cpp:701 --> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title>QDockWindow Class</title> +<style type="text/css"><!-- +fn { margin-left: 1cm; text-indent: -1cm; } +a:link { color: #004faf; text-decoration: none } +a:visited { color: #672967; text-decoration: none } +body { background: #ffffff; color: black; } +--></style> +</head> +<body> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> +<tr bgcolor="#E5E5E5"> +<td valign=center> + <a href="index.html"> +<font color="#004faf">Home</font></a> + | <a href="classes.html"> +<font color="#004faf">All Classes</font></a> + | <a href="mainclasses.html"> +<font color="#004faf">Main Classes</font></a> + | <a href="annotated.html"> +<font color="#004faf">Annotated</font></a> + | <a href="groups.html"> +<font color="#004faf">Grouped Classes</font></a> + | <a href="functions.html"> +<font color="#004faf">Functions</font></a> +</td> +<td align="right" valign="center"><img src="logo32.png" align="right" width="64" height="32" border="0"></td></tr></table><h1 align=center>QDockWindow Class Reference</h1> + +<p>The QDockWindow class provides a widget which can be docked +inside a QDockArea or floated as a top level window on the +desktop. +<a href="#details">More...</a> +<p><tt>#include <<a href="qdoctwindow-h.html">qdoctwindow.h</a>></tt> +<p>Inherits <a href="qframe.html">QFrame</a>. +<p>Inherited by <a href="qtoolbar.html">QToolBar</a>. +<p><a href="qdoctwindow-members.html">List of all member functions.</a> +<h2>Public Members</h2> +<ul> +<li class=fn>enum <a href="#Place-enum"><b>Place</b></a> { InDock, OutsideDock }</li> +<li class=fn>enum <a href="#CloseMode-enum"><b>CloseMode</b></a> { Never = 0, Docked = 1, Undocked = 2, Always = Docked | Undocked }</li> +<li class=fn><a href="#QDockWindow"><b>QDockWindow</b></a> ( Place p = InDock, QWidget * parent = 0, const char * name = 0, WFlags f = 0 )</li> +<li class=fn><a href="#QDockWindow-2"><b>QDockWindow</b></a> ( QWidget * parent, const char * name = 0, WFlags f = 0 )</li> +<li class=fn>virtual void <a href="#setWidget"><b>setWidget</b></a> ( QWidget * w )</li> +<li class=fn>QWidget * <a href="#widget"><b>widget</b></a> () const</li> +<li class=fn>Place <a href="#place"><b>place</b></a> () const</li> +<li class=fn>QDockArea * <a href="#area"><b>area</b></a> () const</li> +<li class=fn>virtual void <a href="#setCloseMode"><b>setCloseMode</b></a> ( int m )</li> +<li class=fn>bool <a href="#isCloseEnabled"><b>isCloseEnabled</b></a> () const</li> +<li class=fn>int <a href="#closeMode"><b>closeMode</b></a> () const</li> +<li class=fn>virtual void <a href="#setResizeEnabled"><b>setResizeEnabled</b></a> ( bool b )</li> +<li class=fn>virtual void <a href="#setMovingEnabled"><b>setMovingEnabled</b></a> ( bool b )</li> +<li class=fn>bool <a href="#isResizeEnabled"><b>isResizeEnabled</b></a> () const</li> +<li class=fn>bool <a href="#isMovingEnabled"><b>isMovingEnabled</b></a> () const</li> +<li class=fn>virtual void <a href="#setHorizontallyStretchable"><b>setHorizontallyStretchable</b></a> ( bool b )</li> +<li class=fn>virtual void <a href="#setVerticallyStretchable"><b>setVerticallyStretchable</b></a> ( bool b )</li> +<li class=fn>bool <a href="#isHorizontallyStretchable"><b>isHorizontallyStretchable</b></a> () const</li> +<li class=fn>bool <a href="#isVerticallyStretchable"><b>isVerticallyStretchable</b></a> () const</li> +<li class=fn>void setHorizontalStretchable ( bool b ) <em>(obsolete)</em></li> +<li class=fn>void setVerticalStretchable ( bool b ) <em>(obsolete)</em></li> +<li class=fn>bool isHorizontalStretchable () const <em>(obsolete)</em></li> +<li class=fn>bool isVerticalStretchable () const <em>(obsolete)</em></li> +<li class=fn>bool <a href="#isStretchable"><b>isStretchable</b></a> () const</li> +<li class=fn>virtual void <a href="#setOffset"><b>setOffset</b></a> ( int o )</li> +<li class=fn>int <a href="#offset"><b>offset</b></a> () const</li> +<li class=fn>virtual void <a href="#setFixedExtentWidth"><b>setFixedExtentWidth</b></a> ( int w )</li> +<li class=fn>virtual void <a href="#setFixedExtentHeight"><b>setFixedExtentHeight</b></a> ( int h )</li> +<li class=fn>QSize <a href="#fixedExtent"><b>fixedExtent</b></a> () const</li> +<li class=fn>virtual void <a href="#setNewLine"><b>setNewLine</b></a> ( bool b )</li> +<li class=fn>bool <a href="#newLine"><b>newLine</b></a> () const</li> +<li class=fn>Qt::Orientation <a href="#orientation"><b>orientation</b></a> () const</li> +<li class=fn>QBoxLayout * <a href="#boxLayout"><b>boxLayout</b></a> ()</li> +<li class=fn>virtual void <a href="#setOpaqueMoving"><b>setOpaqueMoving</b></a> ( bool b )</li> +<li class=fn>bool <a href="#opaqueMoving"><b>opaqueMoving</b></a> () const</li> +</ul> +<h2>Public Slots</h2> +<ul> +<li class=fn>virtual void <a href="#undock"><b>undock</b></a> ()</li> +<li class=fn>virtual void <a href="#dock"><b>dock</b></a> ()</li> +<li class=fn>virtual void <a href="#setOrientation"><b>setOrientation</b></a> ( Orientation o )</li> +</ul> +<h2>Signals</h2> +<ul> +<li class=fn>void <a href="#orientationChanged"><b>orientationChanged</b></a> ( Orientation o )</li> +<li class=fn>void <a href="#placeChanged"><b>placeChanged</b></a> ( QDockWindow::Place p )</li> +<li class=fn>void <a href="#visibilityChanged"><b>visibilityChanged</b></a> ( bool visible )</li> +</ul> +<h2>Properties</h2> +<ul> +<li class=fn>int <a href="#closeMode-prop"><b>closeMode</b></a> - the close mode of a dock window</li> +<li class=fn>bool <a href="#horizontallyStretchable-prop"><b>horizontallyStretchable</b></a> - whether the dock window is horizontally stretchable</li> +<li class=fn>bool <a href="#movingEnabled-prop"><b>movingEnabled</b></a> - 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</li> +<li class=fn>bool <a href="#newLine-prop"><b>newLine</b></a> - whether the dock window prefers to start a new line in the dock area</li> +<li class=fn>int <a href="#offset-prop"><b>offset</b></a> - the dock window's preferred offset from the dock area's left edge (top edge for vertical dock areas)</li> +<li class=fn>bool <a href="#opaqueMoving-prop"><b>opaqueMoving</b></a> - whether the dock window will be shown normally whilst it is being moved</li> +<li class=fn>Place <b>place</b> <em>(read only)</em></li> +<li class=fn>bool <a href="#resizeEnabled-prop"><b>resizeEnabled</b></a> - whether the dock window is resizeable</li> +<li class=fn>bool <a href="#stretchable-prop"><b>stretchable</b></a> - whether the dock window is stretchable in the current orientation() <em>(read only)</em></li> +<li class=fn>bool <a href="#verticallyStretchable-prop"><b>verticallyStretchable</b></a> - whether the dock window is vertically stretchable</li> +</ul> +<hr><a name="details"></a><h2>Detailed Description</h2> + + +The QDockWindow class provides a widget which can be docked +inside a <a href="qdockarea.html">QDockArea</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="qtoolbar.html">QToolBar</a> is a subclass of QDockWindow so the +functionality provided for dock windows is available with the same +API for toolbars. +<p> <center><img src="qmainwindow-qdockareas.png" alt="QDockWindows in a QDockArea"></center> <blockquote><p align="center"><em> Two QDockWindows (<a href="qtoolbar.html">QToolBar</a>s) in a <a href="qdockarea.html">QDockArea</a> +</em></p> +</blockquote><p> <center><img src="qdoctwindow.png" alt="A QDockWindow"></center> <blockquote><p align="center"><em> A Floating QDockWindow +</em></p> +</blockquote><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 titlebar 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 does not appear on +dock windows by default - see <a href="#closeMode-prop">closeMode</a>) the dock window will +disappear. You can control whether or not a dock window has a +close button with <a href="#setCloseMode">setCloseMode</a>(). +<p> <a href="qmainwindow.html">QMainWindow</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 QMainWindow is sufficient. (See the <a href="qdockarea.html">QDockArea</a> documentation if you want to create your own dock +areas.) In QMainWindow 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#setCaption">caption</a>.) +<p> When you construct a dock window you <em>must</em> pass it a <a href="qdockarea.html">QDockArea</a> +or a QMainWindow as its parent if you want it docked. Pass 0 for +the parent if you want it floated. +<p> <pre> + <a href="qtoolbar.html">QToolBar</a> *fileTools = new <a href="qtoolbar.html">QToolBar</a>( this, "File Actions" ); + moveDockWindow( fileTools, Left ); + </pre> + +<p> In the example above we create a new <a href="qtoolbar.html">QToolBar</a> in the constructor +of a <a href="qmainwindow.html">QMainWindow</a> subclass (so that the <em>this</em> pointer points to +the QMainWindow). By default the toolbar will be added to the <a href="qt.html#Dock-enum">Top</a> dock area, but we've moved it to the <a href="qt.html#Dock-enum">Left</a> dock area. +<p> A dock window is often used to contain a single widget. In these +cases the widget can be set by calling <a href="#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="#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="#setOrientation">setOrientation</a>(). +<p> Although a common use of dock windows is for toolbars, they can be +used with any widgets. (See the <a href="designer-manual.html">Qt + Designer</a> and <a href="linguist-manual.html">Qt + Linguist</a> applications, for example.) When using larger +widgets it may make sense for the dock window to be resizable by +calling <a href="#setResizeEnabled">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> Dock windows can be docked and undocked using <a href="#dock">dock</a>() and <a href="#undock">undock</a>(). +A dock window's orientation can be set with setOrientation(). You +can also use <a href="qdockarea.html#moveDockWindow">QDockArea::moveDockWindow</a>(). If you're using a +<a href="qmainwindow.html">QMainWindow</a>, <a href="qmainwindow.html#moveDockWindow">QMainWindow::moveDockWindow</a>() and +<a href="qmainwindow.html#removeDockWindow">QMainWindow::removeDockWindow</a>() are available. +<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="#setOffset">setOffset</a>(). If you'd +prefer a dock window to start on a new <a href="qdockarea.html#lines">line</a> when it is docked use <a href="#setNewLine">setNewLine</a>(). The +<a href="#setFixedExtentWidth">setFixedExtentWidth</a>() and <a href="#setFixedExtentHeight">setFixedExtentHeight</a>() functions can be +used to define the dock window's preferred size, and the +<a href="#setHorizontallyStretchable">setHorizontallyStretchable</a>() and <a href="#setVerticallyStretchable">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="#setMovingEnabled">setMovingEnabled</a>(). When a dock window is moved it is shown as a +rectangular outline, but it can be shown normally using +<a href="#setOpaqueMoving">setOpaqueMoving</a>(). +<p> When a dock window's visibility changes, i.e. it is shown or +hidden, the <a href="#visibilityChanged">visibilityChanged</a>() signal is emitted. When a dock +window is docked, undocked or moved inside the dock area the +<a href="#placeChanged">placeChanged</a>() signal is emitted. +<p>See also <a href="application.html">Main Window and Related Classes</a>. + +<hr><h2>Member Type Documentation</h2> +<h3 class=fn><a name="CloseMode-enum"></a>QDockWindow::CloseMode</h3> + +<p> This enum type specifies when (if ever) a dock window has a close +button. +<ul> +<li><tt>QDockWindow::Never</tt> - The dock window never has a close button and cannot +be closed by the user. +<li><tt>QDockWindow::Docked</tt> - The dock window has a close button only when +docked. +<li><tt>QDockWindow::Undocked</tt> - The dock window has a close button only when +floating. +<li><tt>QDockWindow::Always</tt> - The dock window always has a close button. + +</ul> +<h3 class=fn><a name="Place-enum"></a>QDockWindow::Place</h3> + +<p> This enum specifies the possible locations for a QDockWindow: +<ul> +<li><tt>QDockWindow::InDock</tt> - Inside a <a href="qdockarea.html">QDockArea</a>. +<li><tt>QDockWindow::OutsideDock</tt> - Floating as a top level window on the desktop. +</ul> +<hr><h2>Member Function Documentation</h2> +<h3 class=fn><a name="QDockWindow"></a>QDockWindow::QDockWindow ( <a href="qdoctwindow.html#Place-enum">Place</a> p = InDock, <a href="qwidget.html">QWidget</a> * parent = 0, const char * name = 0, WFlags f = 0 ) +</h3> +Constructs a QDockWindow with parent <em>parent</em>, called <em>name</em> and +with widget flags <em>f</em>. +<p> If <em>p</em> is <a href="#Place-enum">InDock</a>, the dock window is docked into a dock area +and <em>parent</em> <em>must</em> be a <a href="qdockarea.html">QDockArea</a> or a <a href="qmainwindow.html">QMainWindow</a>. If the <em>parent</em> is a QMainWindow the dock window will be docked in the main +window's <a href="qt.html#Dock-enum">Top</a> dock area. +<p> If <em>p</em> is <a href="#Place-enum">OutsideDock</a>, the dock window is created as a floating +window. +<p> We recommend creating the dock area <a href="#Place-enum">InDock</a> with a QMainWindow +as parent then calling <a href="qmainwindow.html#moveDockWindow">QMainWindow::moveDockWindow</a>() to move the +dock window where you want it. + +<h3 class=fn><a name="QDockWindow-2"></a>QDockWindow::QDockWindow ( <a href="qwidget.html">QWidget</a> * parent, const char * name = 0, WFlags f = 0 ) +</h3> +Constructs a QDockWindow with parent <em>parent</em>, called <em>name</em> and +with widget flags <em>f</em>. + +<h3 class=fn><a href="qdockarea.html">QDockArea</a> * <a name="area"></a>QDockWindow::area () const +</h3> + +<p> Returns the dock area in which this dock window is docked, or 0 if +the dock window is floating. + +<h3 class=fn><a href="qboxlayout.html">QBoxLayout</a> * <a name="boxLayout"></a>QDockWindow::boxLayout () +</h3> +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> If the dock window only needs to contain a single widget use +<a href="#setWidget">setWidget</a>() instead. +<p> <p>See also <a href="#setWidget">setWidget</a>() and <a href="#setOrientation">setOrientation</a>(). + +<h3 class=fn>int <a name="closeMode"></a>QDockWindow::closeMode () const +</h3><p>Returns the close mode of a dock window. +See the <a href="qdoctwindow.html#closeMode-prop">"closeMode"</a> property for details. +<h3 class=fn>void <a name="dock"></a>QDockWindow::dock ()<tt> [virtual slot]</tt> +</h3> +Docks the dock window into the last dock area in which it was +docked. +<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> The dock window will dock with the dock area regardless of the return value +of <a href="qdockarea.html#isDockWindowAccepted">QDockArea::isDockWindowAccepted</a>(). +<p> <p>See also <a href="#undock">undock</a>(), <a href="qdockarea.html#moveDockWindow">QDockArea::moveDockWindow</a>(), <a href="qdockarea.html#removeDockWindow">QDockArea::removeDockWindow</a>(), <a href="qmainwindow.html#moveDockWindow">QMainWindow::moveDockWindow</a>(), <a href="qmainwindow.html#removeDockWindow">QMainWindow::removeDockWindow</a>(), and <a href="qdockarea.html#isDockWindowAccepted">QDockArea::isDockWindowAccepted</a>(). + +<p> +<h3 class=fn><a href="qsize.html">QSize</a> <a name="fixedExtent"></a>QDockWindow::fixedExtent () const +</h3> +Returns the dock window's preferred size (fixed extent). +<p> <p>See also <a href="#setFixedExtentWidth">setFixedExtentWidth</a>() and <a href="#setFixedExtentHeight">setFixedExtentHeight</a>(). + +<h3 class=fn>bool <a name="isCloseEnabled"></a>QDockWindow::isCloseEnabled () const +</h3> +Returns TRUE if the dock window has a close button; otherwise +returns FALSE. The result depends on the dock window's <a href="#Place-enum">Place</a> +and its <a href="#CloseMode-enum">CloseMode</a>. +<p> <p>See also <a href="#closeMode-prop">closeMode</a>. + +<h3 class=fn>bool <a name="isHorizontalStretchable"></a>QDockWindow::isHorizontalStretchable () const +</h3> + +<b>This function is obsolete.</b> It is provided to keep old source working. We strongly advise against using it in new code. +<p> +<h3 class=fn>bool <a name="isHorizontallyStretchable"></a>QDockWindow::isHorizontallyStretchable () const +</h3><p>Returns TRUE if the dock window is horizontally stretchable; otherwise returns FALSE. +See the <a href="qdoctwindow.html#horizontallyStretchable-prop">"horizontallyStretchable"</a> property for details. +<h3 class=fn>bool <a name="isMovingEnabled"></a>QDockWindow::isMovingEnabled () const +</h3><p>Returns TRUE if the user can move the dock window within the dock area, move the dock window to another dock area, or float the dock window; otherwise returns FALSE. +See the <a href="qdoctwindow.html#movingEnabled-prop">"movingEnabled"</a> property for details. +<h3 class=fn>bool <a name="isResizeEnabled"></a>QDockWindow::isResizeEnabled () const +</h3><p>Returns TRUE if the dock window is resizeable; otherwise returns FALSE. +See the <a href="qdoctwindow.html#resizeEnabled-prop">"resizeEnabled"</a> property for details. +<h3 class=fn>bool <a name="isStretchable"></a>QDockWindow::isStretchable () const +</h3><p>Returns TRUE if the dock window is stretchable in the current <a href="#orientation">orientation</a>(); otherwise returns FALSE. +See the <a href="qdoctwindow.html#stretchable-prop">"stretchable"</a> property for details. +<h3 class=fn>bool <a name="isVerticalStretchable"></a>QDockWindow::isVerticalStretchable () const +</h3> + +<b>This function is obsolete.</b> It is provided to keep old source working. We strongly advise against using it in new code. +<p> +<h3 class=fn>bool <a name="isVerticallyStretchable"></a>QDockWindow::isVerticallyStretchable () const +</h3><p>Returns TRUE if the dock window is vertically stretchable; otherwise returns FALSE. +See the <a href="qdoctwindow.html#verticallyStretchable-prop">"verticallyStretchable"</a> property for details. +<h3 class=fn>bool <a name="newLine"></a>QDockWindow::newLine () const +</h3><p>Returns TRUE if the dock window prefers to start a new line in the dock area; otherwise returns FALSE. +See the <a href="qdoctwindow.html#newLine-prop">"newLine"</a> property for details. +<h3 class=fn>int <a name="offset"></a>QDockWindow::offset () const +</h3><p>Returns the dock window's preferred offset from the dock area's left edge (top edge for vertical dock areas). +See the <a href="qdoctwindow.html#offset-prop">"offset"</a> property for details. +<h3 class=fn>bool <a name="opaqueMoving"></a>QDockWindow::opaqueMoving () const +</h3><p>Returns TRUE if the dock window will be shown normally whilst it is being moved; otherwise returns FALSE. +See the <a href="qdoctwindow.html#opaqueMoving-prop">"opaqueMoving"</a> property for details. +<h3 class=fn><a href="qt.html#Orientation-enum">Qt::Orientation</a> <a name="orientation"></a>QDockWindow::orientation () const +</h3> +Returns the orientation of the dock window. +<p> <p>See also <a href="#orientationChanged">orientationChanged</a>(). + +<h3 class=fn>void <a name="orientationChanged"></a>QDockWindow::orientationChanged ( <a href="qt.html#Orientation-enum">Orientation</a> o )<tt> [signal]</tt> +</h3> + +<p> This signal is emitted when the orientation of the dock window is +changed. The new orientation is <em>o</em>. + +<h3 class=fn><a href="qdoctwindow.html#Place-enum">Place</a> <a name="place"></a>QDockWindow::place () const +</h3> + +<p> This function returns where the dock window is placed. This is +either <a href="#Place-enum">InDock</a> or <a href="#Place-enum">OutsideDock</a>. +<p> <p>See also <a href="qdockarea.html#moveDockWindow">QDockArea::moveDockWindow</a>(), <a href="qdockarea.html#removeDockWindow">QDockArea::removeDockWindow</a>(), <a href="qmainwindow.html#moveDockWindow">QMainWindow::moveDockWindow</a>(), and <a href="qmainwindow.html#removeDockWindow">QMainWindow::removeDockWindow</a>(). + +<h3 class=fn>void <a name="placeChanged"></a>QDockWindow::placeChanged ( <a href="qdoctwindow.html#Place-enum">QDockWindow::Place</a> p )<tt> [signal]</tt> +</h3> + +<p> This signal is emitted when the dock window is docked (<em>p</em> is <a href="#Place-enum">InDock</a>), undocked (<em>p</em> is <a href="#Place-enum">OutsideDock</a>) or moved inside the +the dock area. +<p> <p>See also <a href="qdockarea.html#moveDockWindow">QDockArea::moveDockWindow</a>(), <a href="qdockarea.html#removeDockWindow">QDockArea::removeDockWindow</a>(), <a href="qmainwindow.html#moveDockWindow">QMainWindow::moveDockWindow</a>(), and <a href="qmainwindow.html#removeDockWindow">QMainWindow::removeDockWindow</a>(). + +<h3 class=fn>void <a name="setCloseMode"></a>QDockWindow::setCloseMode ( int m )<tt> [virtual]</tt> +</h3><p>Sets the close mode of a dock window to <em>m</em>. +See the <a href="qdoctwindow.html#closeMode-prop">"closeMode"</a> property for details. +<h3 class=fn>void <a name="setFixedExtentHeight"></a>QDockWindow::setFixedExtentHeight ( int h )<tt> [virtual]</tt> +</h3> +Sets the dock window's preferred height for its fixed extent +(size) to <em>h</em>. +<p> <p>See also <a href="#setFixedExtentWidth">setFixedExtentWidth</a>(). + +<h3 class=fn>void <a name="setFixedExtentWidth"></a>QDockWindow::setFixedExtentWidth ( int w )<tt> [virtual]</tt> +</h3> +Sets the dock window's preferred width for its fixed extent (size) +to <em>w</em>. +<p> <p>See also <a href="#setFixedExtentHeight">setFixedExtentHeight</a>(). + +<h3 class=fn>void <a name="setHorizontalStretchable"></a>QDockWindow::setHorizontalStretchable ( bool b ) +</h3> + +<b>This function is obsolete.</b> It is provided to keep old source working. We strongly advise against using it in new code. +<p> +<h3 class=fn>void <a name="setHorizontallyStretchable"></a>QDockWindow::setHorizontallyStretchable ( bool b )<tt> [virtual]</tt> +</h3><p>Sets whether the dock window is horizontally stretchable to <em>b</em>. +See the <a href="qdoctwindow.html#horizontallyStretchable-prop">"horizontallyStretchable"</a> property for details. +<h3 class=fn>void <a name="setMovingEnabled"></a>QDockWindow::setMovingEnabled ( bool b )<tt> [virtual]</tt> +</h3><p>Sets 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 to <em>b</em>. +See the <a href="qdoctwindow.html#movingEnabled-prop">"movingEnabled"</a> property for details. +<h3 class=fn>void <a name="setNewLine"></a>QDockWindow::setNewLine ( bool b )<tt> [virtual]</tt> +</h3><p>Sets whether the dock window prefers to start a new line in the dock area to <em>b</em>. +See the <a href="qdoctwindow.html#newLine-prop">"newLine"</a> property for details. +<h3 class=fn>void <a name="setOffset"></a>QDockWindow::setOffset ( int o )<tt> [virtual]</tt> +</h3><p>Sets the dock window's preferred offset from the dock area's left edge (top edge for vertical dock areas) to <em>o</em>. +See the <a href="qdoctwindow.html#offset-prop">"offset"</a> property for details. +<h3 class=fn>void <a name="setOpaqueMoving"></a>QDockWindow::setOpaqueMoving ( bool b )<tt> [virtual]</tt> +</h3><p>Sets whether the dock window will be shown normally whilst it is being moved to <em>b</em>. +See the <a href="qdoctwindow.html#opaqueMoving-prop">"opaqueMoving"</a> property for details. +<h3 class=fn>void <a name="setOrientation"></a>QDockWindow::setOrientation ( <a href="qt.html#Orientation-enum">Orientation</a> o )<tt> [virtual slot]</tt> +</h3> +Sets the orientation of the dock window to <em>o</em>. The orientation +is propagated to the layout <a href="#boxLayout">boxLayout</a>(). +<p> <b>Warning:</b> All undocked QToolBars will always have a horizontal orientation. + +<h3 class=fn>void <a name="setResizeEnabled"></a>QDockWindow::setResizeEnabled ( bool b )<tt> [virtual]</tt> +</h3><p>Sets whether the dock window is resizeable to <em>b</em>. +See the <a href="qdoctwindow.html#resizeEnabled-prop">"resizeEnabled"</a> property for details. +<h3 class=fn>void <a name="setVerticalStretchable"></a>QDockWindow::setVerticalStretchable ( bool b ) +</h3> + +<b>This function is obsolete.</b> It is provided to keep old source working. We strongly advise against using it in new code. +<p> +<h3 class=fn>void <a name="setVerticallyStretchable"></a>QDockWindow::setVerticallyStretchable ( bool b )<tt> [virtual]</tt> +</h3><p>Sets whether the dock window is vertically stretchable to <em>b</em>. +See the <a href="qdoctwindow.html#verticallyStretchable-prop">"verticallyStretchable"</a> property for details. +<h3 class=fn>void <a name="setWidget"></a>QDockWindow::setWidget ( <a href="qwidget.html">QWidget</a> * w )<tt> [virtual]</tt> +</h3> +Sets the dock window's main widget to <em>w</em>. +<p> <p>See also <a href="#boxLayout">boxLayout</a>(). + +<h3 class=fn>void <a name="undock"></a>QDockWindow::undock ()<tt> [virtual slot]</tt> +</h3> + +<p> Undocks the QDockWindow from its current dock area if it is +docked; otherwise does nothing. +<p> <p>See also <a href="#dock">dock</a>(), <a href="qdockarea.html#moveDockWindow">QDockArea::moveDockWindow</a>(), <a href="qdockarea.html#removeDockWindow">QDockArea::removeDockWindow</a>(), <a href="qmainwindow.html#moveDockWindow">QMainWindow::moveDockWindow</a>(), and <a href="qmainwindow.html#removeDockWindow">QMainWindow::removeDockWindow</a>(). + +<h3 class=fn>void <a name="visibilityChanged"></a>QDockWindow::visibilityChanged ( bool visible )<tt> [signal]</tt> +</h3> + +<p> This signal is emitted when the visibility of the dock window +relatively to its dock area is changed. If <em>visible</em> is TRUE, the +QDockWindow is now visible to the dock area, otherwise it has been +hidden. +<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="qmainwindow.html">QMainWindow</a> a dock window can +have its visibility changed (hidden or shown) by clicking its name +in the dock window menu that lists the QMainWindow's dock windows. + +<h3 class=fn><a href="qwidget.html">QWidget</a> * <a name="widget"></a>QDockWindow::widget () const +</h3> +Returns the dock window's main widget. +<p> <p>See also <a href="#setWidget">setWidget</a>(). + +<hr><h2>Property Documentation</h2> +<h3 class=fn>int <a name="closeMode-prop"></a>closeMode</h3> +<p>This property holds the close mode of a dock window. +<p>Defines when (if ever) the dock window has a close button. The +choices are <a href="#CloseMode-enum">Never</a>, <a href="#CloseMode-enum">Docked</a> (i.e. only when docked), <a href="#CloseMode-enum">Undocked</a> (only when undocked, i.e. floated) or <a href="#CloseMode-enum">Always</a>. +<p> The default is <a href="#CloseMode-enum">Never</a>. + +<p>Set this property's value with <a href="#setCloseMode">setCloseMode</a>() and get this property's value with <a href="#closeMode">closeMode</a>(). +<h3 class=fn>bool <a name="horizontallyStretchable-prop"></a>horizontallyStretchable</h3> +<p>This property holds whether the dock window is horizontally stretchable. +<p>A dock window is horizontally stretchable if you call +<a href="#setHorizontallyStretchable">setHorizontallyStretchable</a>(TRUE) or <a href="#setResizeEnabled">setResizeEnabled</a>(TRUE). +<p> <p>See also <a href="#resizeEnabled-prop">resizeEnabled</a>. + +<p>Bugs and limitations: +<ul> +<li> Strecthability is broken. You must call setResizeEnabled(TRUE) to get +proper behavior and even then QDockWindow does not limit stretchablilty. +</ul> +<p>Set this property's value with <a href="#setHorizontallyStretchable">setHorizontallyStretchable</a>() and get this property's value with <a href="#isHorizontallyStretchable">isHorizontallyStretchable</a>(). +<h3 class=fn>bool <a name="movingEnabled-prop"></a>movingEnabled</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>This property is TRUE by default. + +<p>Set this property's value with <a href="#setMovingEnabled">setMovingEnabled</a>() and get this property's value with <a href="#isMovingEnabled">isMovingEnabled</a>(). +<h3 class=fn>bool <a name="newLine-prop"></a>newLine</h3> +<p>This property holds whether the dock window prefers to start a new line in the dock area. +<p>The default is FALSE, i.e. the dock window doesn't require a new +line in the dock area. + +<p>Set this property's value with <a href="#setNewLine">setNewLine</a>() and get this property's value with <a href="#newLine">newLine</a>(). +<h3 class=fn>int <a name="offset-prop"></a>offset</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>The default is 0. + +<p>Set this property's value with <a href="#setOffset">setOffset</a>() and get this property's value with <a href="#offset">offset</a>(). +<h3 class=fn>bool <a name="opaqueMoving-prop"></a>opaqueMoving</h3> +<p>This property holds whether the dock window will be shown normally whilst it is being moved. +<p>If this property is FALSE, (the default), the dock window will be +represented by an outline rectangle whilst it is being moved. +<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>Set this property's value with <a href="#setOpaqueMoving">setOpaqueMoving</a>() and get this property's value with <a href="#opaqueMoving">opaqueMoving</a>(). +<h3 class=fn>bool <a name="resizeEnabled-prop"></a>resizeEnabled</h3> +<p>This property holds whether the dock window is resizeable. +<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> A dock window is both horizontally and vertically stretchable if +you call <a href="#setResizeEnabled">setResizeEnabled</a>(TRUE). +<p> This property is FALSE by default. +<p> <p>See also <a href="#verticallyStretchable-prop">verticallyStretchable</a> and <a href="#horizontallyStretchable-prop">horizontallyStretchable</a>. + +<p>Set this property's value with <a href="#setResizeEnabled">setResizeEnabled</a>() and get this property's value with <a href="#isResizeEnabled">isResizeEnabled</a>(). +<h3 class=fn>bool <a name="stretchable-prop"></a>stretchable</h3> +<p>This property holds whether the dock window is stretchable in the current <a href="#orientation">orientation</a>(). +<p>This property can be set using <a href="#setHorizontallyStretchable">setHorizontallyStretchable</a>() and +<a href="#setVerticallyStretchable">setVerticallyStretchable</a>(), or with <a href="#setResizeEnabled">setResizeEnabled</a>(). +<p> <p>See also <a href="#resizeEnabled-prop">resizeEnabled</a>. + +<p>Bugs and limitations: +<ul> +<li> Strecthability is broken. You must call setResizeEnabled(TRUE) to get +proper behavior and even then QDockWindow does not limit stretchablilty. +</ul> +<p>Get this property's value with <a href="#isStretchable">isStretchable</a>(). +<h3 class=fn>bool <a name="verticallyStretchable-prop"></a>verticallyStretchable</h3> +<p>This property holds whether the dock window is vertically stretchable. +<p>A dock window is vertically stretchable if you call +<a href="#setVerticallyStretchable">setVerticallyStretchable</a>(TRUE) or <a href="#setResizeEnabled">setResizeEnabled</a>(TRUE). +<p> <p>See also <a href="#resizeEnabled-prop">resizeEnabled</a>. + +<p>Bugs and limitations: +<ul> +<li> Strecthability is broken. You must call setResizeEnabled(TRUE) to get +proper behavior and even then QDockWindow does not limit stretchablilty. +</ul> +<p>Set this property's value with <a href="#setVerticallyStretchable">setVerticallyStretchable</a>() and get this property's value with <a href="#isVerticallyStretchable">isVerticallyStretchable</a>(). +<!-- eof --> +<hr><p> +This file is part of the <a href="index.html">Qt toolkit</a>. +Copyright © 1995-2007 +<a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center> +<table width=100% cellspacing=0 border=0><tr> +<td>Copyright © 2007 +<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a> +<td align=right><div align=right>Qt 3.3.8</div> +</table></div></address></body> +</html> |