path: root/doc/man/man3/qworkspace.3qt

'\" t
.TH QWorkspace 3qt "2 February 2007" "Trolltech AS" \" -*- nroff -*-
.\" Copyright 1992-2007 Trolltech ASA.  All rights reserved.  See the
.\" license file included in the distribution for a complete license
.\" statement.
.\"
.ad l
.nh
.SH NAME
QWorkspace \- Workspace window that can contain decorated windows, e.g. for MDI
.SH SYNOPSIS
\fC#include <qworkspace.h>\fR
.PP
Inherits QWidget.
.PP
.SS "Public Members"
.in +1c
.ti -1c
.BI "\fBQWorkspace\fR ( QWidget * parent = 0, const char * name = 0 )"
.br
.ti -1c
.BI "\fB~QWorkspace\fR ()"
.br
.ti -1c
.BI "enum \fBWindowOrder\fR { CreationOrder, StackingOrder }"
.br
.ti -1c
.BI "QWidget * \fBactiveWindow\fR () const"
.br
.ti -1c
.BI "QWidgetList windowList () const  \fI(obsolete)\fR"
.br
.ti -1c
.BI "QWidgetList \fBwindowList\fR ( WindowOrder order ) const"
.br
.ti -1c
.BI "bool \fBscrollBarsEnabled\fR () const"
.br
.ti -1c
.BI "void \fBsetScrollBarsEnabled\fR ( bool enable )"
.br
.in -1c
.SS "Public Slots"
.in +1c
.ti -1c
.BI "void \fBcascade\fR ()"
.br
.ti -1c
.BI "void \fBtile\fR ()"
.br
.ti -1c
.BI "void \fBcloseActiveWindow\fR ()"
.br
.ti -1c
.BI "void \fBcloseAllWindows\fR ()"
.br
.ti -1c
.BI "void \fBactivateNextWindow\fR ()"
.br
.ti -1c
.BI "void \fBactivatePrevWindow\fR ()"
.br
.in -1c
.SS "Signals"
.in +1c
.ti -1c
.BI "void \fBwindowActivated\fR ( QWidget * w )"
.br
.in -1c
.SS "Properties"
.in +1c
.ti -1c
.BI "bool \fBscrollBarsEnabled\fR - whether the workspace provides scrollbars"
.br
.in -1c
.SH DESCRIPTION
The QWorkspace widget provides a workspace window that can contain decorated windows, e.g. for MDI.
.PP
MDI (multiple document interface) applications typically have one main window with a menu bar and toolbar, and a central widget that is a QWorkspace. The workspace itself contains zero, one or more document windows, each of which is a widget.
.PP
The workspace itself is an ordinary Qt widget. It has a standard constructor that takes a parent widget and an object name. The parent window is usually a QMainWindow, but it need not be.
.PP
Document windows (i.e. MDI windows) are also ordinary Qt widgets which have the workspace as their parent widget. When you call show(), hide(), showMaximized(), setCaption(), etc. on a document window, it is shown, hidden, etc. with a frame, caption, icon and icon text, just as you'd expect. You can provide widget flags which will be used for the layout of the decoration or the behaviour of the widget itself.
.PP
To change or retrieve the geometry of MDI windows you must operate on the MDI widget's parentWidget(). (The parentWidget() provides access to the decorated window in which the MDI window's widget is shown.)
.PP
A document window becomes active when it gets the keyboard focus. You can also activate a window in code using setFocus(). The user can activate a window by moving focus in the usual ways, for example by clicking a window or by pressing Tab. The workspace emits a signal windowActivated() when it detects the activation change, and the function activeWindow() always returns a pointer to the active document window.
.PP
The convenience function windowList() returns a list of all document windows. This is useful to create a popup menu" <u>W</u>indows" on the fly, for example.
.PP
QWorkspace provides two built-in layout strategies for child windows: cascade() and tile(). Both are slots so you can easily connect menu entries to them.
.PP
If you want your users to be able to work with document windows larger than the actual workspace, set the scrollBarsEnabled property to TRUE.
.PP
If the top-level window contains a menu bar and a document window is maximised, QWorkspace moves the document window's minimize, restore and close buttons from the document window's frame to the workspace window's menu bar. It then inserts a window operations menu at the far left of the menu bar.
.PP
See also Main Window and Related Classes and Organizers.
.SS "Member Type Documentation"
.SH "QWorkspace::WindowOrder"
Specifies the order in which windows are returned from windowList().
.TP
\fCQWorkspace::CreationOrder\fR - The windows are returned in the order of their creation
.TP
\fCQWorkspace::StackingOrder\fR - The windows are returned in the order of their stacking
.SH MEMBER FUNCTION DOCUMENTATION
.SH "QWorkspace::QWorkspace ( QWidget * parent = 0, const char * name = 0 )"
Constructs a workspace with a \fIparent\fR and a \fIname\fR.
.SH "QWorkspace::~QWorkspace ()"
Destroys the workspace and frees any allocated resources.
.SH "void QWorkspace::activateNextWindow ()\fC [slot]\fR"
Activates the next window in the child window chain.
.PP
See also activatePrevWindow().
.SH "void QWorkspace::activatePrevWindow ()\fC [slot]\fR"
Activates the previous window in the child window chain.
.PP
See also activateNextWindow().
.SH "QWidget * QWorkspace::activeWindow () const"
Returns the active window, or 0 if no window is active.
.PP
Example: mdi/application.cpp.
.SH "void QWorkspace::cascade ()\fC [slot]\fR"
Arranges all the child windows in a cascade pattern.
.PP
See also tile().
.PP
Example: mdi/application.cpp.
.SH "void QWorkspace::closeActiveWindow ()\fC [slot]\fR"
Closes the child window that is currently active.
.PP
See also closeAllWindows().
.SH "void QWorkspace::closeAllWindows ()\fC [slot]\fR"
Closes all child windows.
.PP
The windows are closed in random order. The operation stops if a window does not accept the close event.
.PP
See also closeActiveWindow().
.SH "bool QWorkspace::scrollBarsEnabled () const"
Returns TRUE if the workspace provides scrollbars; otherwise returns FALSE. See the "scrollBarsEnabled" property for details.
.SH "void QWorkspace::setScrollBarsEnabled ( bool enable )"
Sets whether the workspace provides scrollbars to \fIenable\fR. See the "scrollBarsEnabled" property for details.
.SH "void QWorkspace::tile ()\fC [slot]\fR"
Arranges all child windows in a tile pattern.
.PP
See also cascade().
.PP
Example: mdi/application.cpp.
.SH "void QWorkspace::windowActivated ( QWidget * w )\fC [signal]\fR"
This signal is emitted when the window widget \fIw\fR becomes active. Note that \fIw\fR can be null, and that more than one signal may be emitted for a single activation event.
.PP
See also activeWindow() and windowList().
.SH "QWidgetList QWorkspace::windowList ( WindowOrder order ) const"
Returns a list of all windows. If \fIorder\fR is CreationOrder (the default) the windows are listed in the order in which they had been inserted into the workspace. If \fIorder\fR is StackingOrder the windows are listed in their stacking order, with the topmost window being the last window in the list.
.PP
QWidgetList is the same as QPtrList<QWidget>.
.PP
See also QPtrList.
.PP
Example: mdi/application.cpp.
.SH "QWidgetList QWorkspace::windowList () const"
\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code.
.PP
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
.PP
.SS "Property Documentation"
.SH "bool scrollBarsEnabled"
This property holds whether the workspace provides scrollbars.
.PP
If this property is set to TRUE, it is possible to resize child windows over the right or the bottom edge out of the visible area of the workspace. The workspace shows scrollbars to make it possible for the user to access those windows. If this property is set to FALSE (the default), resizing windows out of the visible area of the workspace is not permitted.
.PP
Set this property's value with setScrollBarsEnabled() and get this property's value with scrollBarsEnabled().

.SH "SEE ALSO"
.BR http://doc.trolltech.com/qworkspace.html
.BR http://www.trolltech.com/faq/tech.html
.SH COPYRIGHT
Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com.  See the
license file included in the distribution for a complete license
statement.
.SH AUTHOR
Generated automatically from the source code.
.SH BUGS
If you find a bug in Qt, please report it as described in
.BR http://doc.trolltech.com/bughowto.html .
Good bug reports help us to help you. Thank you.
.P
The definitive Qt documentation is provided in HTML format; it is
located at $QTDIR/doc/html and can be read using Qt Assistant or with
a web browser. This man page is provided as a convenience for those
users who prefer man pages, although this format is not officially
supported by Trolltech. 
.P
If you find errors in this manual page, please report them to
.BR qt-bugs@trolltech.com .
Please include the name of the manual page (qworkspace.3qt) and the Qt
version (3.3.8).