QWorkspace(3qt)QWorkspace(3qt)NAME
QWorkspace - Workspace window that can contain decorated
windows, e.g. for MDI
#include <qworkspace.h>
Inherits QWidget.
Public Members
QWorkspace ( QWidget * parent=0, const char * name=0 )
~QWorkspace ()
QWidget* activeWindow () const
QWidgetList windowList () const
Public Slots
void cascade ()
void tile ()
Signals
void windowActivated ( QWidget * w )
DESCRIPTION
The QWorkspace widget provides a workspace window that can
contain decorated windows, e.g. for MDI.
An MDI application has one main window with a menu bar.
The central widget of this window is a workspace. The
workspace itself contains zero, one or more document
windows, each of which displays a document.
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.
Document windows (alias MDI windows) are also ordinary Qt
widgets, that have the workspace as 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. To change the geometry of the MDI windows it is
necessary to make the necessary function calls to the
parentWidget() of the widget, as this will move or resize
the decorated window.
A document window becomes active when it gets the keyboard
focus. You can activate it using setFocus(), and the user
can activate it by moving focus in the normal ways. 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.
Trolltech AS 13 June 2001 1
QWorkspace(3qt)QWorkspace(3qt)
The convenience function windowList() returns a list of
all document windows. This is useful to create a popup
menu "&Windows" on the fly, for example.
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.
In case the toplevel window contains a menu bar and a
document window is maximized, QWorkspace moves the
document window's minimize, restore and close buttons from
the document window's frame to the workspace window's menu
bar, and inserts a window operations menu on the extreme
left of the menu bar.
Warning: User interface research indicates that most users
have problems with MDI applications. Use this class
cautiously.
MEMBER FUNCTION DOCUMENTATIONQWorkspace::QWorkspace ( QWidget * parent=0, const char * name=0
)
Constructs a workspace with a parent and a name
QWorkspace::~QWorkspace ()
Destroys the object and frees any allocated resources.
QWidget* QWorkspace::activeWindow () const
Returns the active window, or 0 if no window is active.
void QWorkspace::cascade () [slot]
Arranges all child windows in a cascade pattern
See also tile().
void QWorkspace::childEvent ( QChildEvent * e ) [virtual
protected]
Reimplemented for internal reasons; the API is not
affected.
Reimplemented from QObject.
bool QWorkspace::eventFilter ( QObject * o, QEvent * e ) [virtual
protected]
Reimplemented for internal reasons; the API is not
affected.
Reimplemented from QObject.
void QWorkspace::resizeEvent ( QResizeEvent * ) [virtual
protected]
Reimplemented for internal reasons; the API is not
affected.
Trolltech AS 13 June 2001 2
QWorkspace(3qt)QWorkspace(3qt)
Reimplemented from QWidget.
void QWorkspace::showEvent ( QShowEvent * e ) [virtual protected]
Reimplemented for internal reasons; the API is not
affected.
Reimplemented from QWidget.
QSize QWorkspace::sizeHint () const [virtual]
Reimplemented for internal reasons; the API is not
affected.
Reimplemented from QWidget.
QSizePolicy QWorkspace::sizePolicy () const [virtual]
Reimplemented for internal reasons; the API is not
affected.
Reimplemented from QWidget.
void QWorkspace::tile () [slot]
Arranges all child windows in a tile pattern
See also cascade().
void QWorkspace::windowActivated ( QWidget * w ) [signal]
This signal is emitted when the window widget w becomes
active. Note that w can be null, and that more than one
signal may be fired for one activation event.
See also activeWindow() and windowList().
QWidgetList QWorkspace::windowList () const
Returns a list of all windows.
SEE ALSO
http://doc.trolltech.com/qworkspace.html
http://www.trolltech.com/faq/tech.html
COPYRIGHT
Copyright 1992-2001 Trolltech AS,
http://www.trolltech.com. See the license file included
in the distribution for a complete license statement.
AUTHOR
Generated automatically from the source code.
BUGS
If you find a bug in Qt, please report it as described in
http://doc.trolltech.com/bughowto.html. Good bug reports
make our job much simpler. Thank you.
In case of content or formattting problems with this
manual page, please report them to qt-bugs@trolltech.com.
Trolltech AS 13 June 2001 3
QWorkspace(3qt)QWorkspace(3qt)
Please include the name of the manual page
(qworkspace.3qt) and the Qt version (2.3.1).
Trolltech AS 13 June 2001 4
