A TQDockArea is a container which manages a list of TQDockWindows which it lays out within its area. In cooperation with the TQDockWindows it is responsible for the docking and undocking of TQDockWindows and moving them inside the dock area. TQDockAreas also handle the wrapping of TQDockWindows to fill the available space as compactly as possible. TQDockAreas can contain TQToolBars since TQToolBar is a TQDockWindow subclass.
TQMainWindow contains four TQDockAreas which you can use for your TQToolBars and TQDockWindows, so in most situations you do not need to use the TQDockArea class directly. Although TQMainWindow contains support for its own dock areas it isn't convenient for adding new TQDockAreas. If you need to create your own dock areas we suggest that you create a subclass of TQWidget and add your TQDockAreas to your subclass.
\fILines\fR. TQDockArea 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. Dock windows can be lined up to minimize wasted space using the lineUp() function.
The TQDockArea class maintains a position list of all its child dock windows. Dock windows are added to a dock area from position 0 onwards. Dock 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 hasDockWindow(). The position can be changed with moveDockWindow().
To dock or undock a dock window use TQDockWindow::dock() and TQDockWindow::undock() respectively. If you want to control which dock windows can dock in a dock area use setAcceptDockWindow(). To see if a dock area contains a particular dock window use hasDockWindow(); to see how many dock windows a dock area contains use count().
The streaming operators can write the positions of the dock windows in the dock area to a TQTextStream. The positions can be read back later to restore the saved positions.
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.)
.PP
This enum specifies where the dock window splitter handle is placed in the dock area.
Destroys the dock area and all the dock windows docked in the dock area.
.PP
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.
Returns TRUE if the dock area contains the dock window \fIw\fR; otherwise returns FALSE. If \fIindex\fR is not 0 it will be set as follows: if the dock area contains the dock window \fI*index\fR is set to \fIw\fR's index position; otherwise \fI*index\fR is set to -1.
Lines up the dock windows in this dock area to minimize wasted space. If \fIkeepNewLines\fR is TRUE, only space within lines is cleaned up. If \fIkeepNewLines\fR is FALSE the number of lines might be changed.
.SH "void TQDockArea::moveDockWindow ( TQDockWindow * w, int index = -1 )"
Moves the TQDockWindow \fIw\fR within the dock area. If \fIw\fR is not already docked in this area, \fIw\fR is docked first. If \fIindex\fR is -1 or larger than the number of docked widgets, \fIw\fR is appended at the end, otherwise it is inserted at the position \fIindex\fR.
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
.PP
Moves the dock window \fIw\fR inside the dock area where \fIp\fR is the new position (in global screen coordinates), \fIr\fR is the suggested rectangle of the dock window and \fIswap\fR specifies whether or not the orientation of the docked widget needs to be changed.
Removes the dock window \fIw\fR from the dock area. If \fImakeFloating\fR is TRUE, \fIw\fR gets floated, and if \fIswap\fR is TRUE, the orientation of \fIw\fR gets swapped. If \fIfixNewLines\fR is TRUE (the default) newlines in the area will be fixed.
If \fIaccept\fR is TRUE, dock window \fIdw\fR can be docked in the dock area. If \fIaccept\fR is FALSE, dock window \fIdw\fR cannot be docked in the dock area.
.PP
See also isDockWindowAccepted().
.SS "Property Documentation"
.SH "int count"
This property holds the number of dock windows in the dock area.
.PP
Get this property's value with count().
.SH "bool empty"
This property holds whether the dock area is empty.
.PP
Get this property's value with isEmpty().
.SH "HandlePosition handlePosition"
This property holds where the dock window splitter handle is placed in the dock area.
.PP
The default position is Normal.
.PP
Get this property's value with handlePosition().
.SH "Orientation orientation"
This property holds the dock area's orientation.
.PP
There is no default value; the orientation is specified in the constructor.
Reads the layout description of the dock windows in dock area \fIdockArea\fR from the text stream \fIts\fR and restores it. The layout description must have been previously written by the operator<<() function.
