Contents

• Public Types
• Properties
• Public Functions
• Reimplemented Public Functions
• Public Slots
• Signals
• Reimplemented Protected Functions
• Protected Slots
• Related Non-Members
• Detailed Description

Detailed Description

TheQ3MainWindow class provides a main application window, with a menu bar, dock windows (e.g. for toolbars), and a status bar.

Main windows are most often used to provide menus, toolbars and a status bar around a large central widget, such as a text edit, drawing canvas orQWorkspace (for MDI applications).Q3MainWindow is usually subclassed since this makes it easier to encapsulate the central widget, menus and toolbars as well as the window's state. Subclassing makes it possible to create the slots that are called when the user clicks menu items or toolbar buttons.

We'll briefly review adding menu items and toolbar buttons then describe the facilities ofQ3MainWindow itself.

Q3MainWindow*mw=newQ3MainWindow;QTextEdit*edit=newQTextEdit(mw,"editor");edit->setFocus();mw->setWindowTitle("Main Window");mw->setCentralWidget(edit);mw->show();

Q3MainWindows may be created in their own right as shown above. The central widget is set withsetCentralWidget(). Popup menus can be added to the default menu bar, widgets can be added to the status bar, toolbars and dock windows can be added to any of the dock areas.

The main window will take care of the dock areas, and the geometry of the central widget, but all other aspects of the central widget are left to you.Q3MainWindow automatically detects the creation of a menu bar or status bar if you specify theQ3MainWindow as parent, or you can use the providedmenuBar() andstatusBar() functions. The functionsmenuBar() andstatusBar() create a suitable widget if one doesn't exist, and update the window's layout to make space.

New dock windows and toolbars can be added to aQ3MainWindow usingaddDockWindow().Qt::Dock windows can be moved usingmoveDockWindow() and removed withremoveDockWindow().Q3MainWindow allows default dock window (toolbar) docking in all its dock areas (Top,Left,Right,Bottom). You can usesetDockEnabled() to enable and disable docking areas for dock windows. When adding or moving dock windows you can specify their 'edge' (dock area). The currently available edges are:Top,Left,Right,Bottom,Minimized (effectively a 'hidden' dock area) andTornOff (floating). SeeQt::Dock for an explanation of these areas. Note that the *ToolBar functions are included for backward compatibility; all new code should use the *DockWindow functions.QToolbar is a subclass ofQ3DockWindow so all functions that work with dock windows work on toolbars in the same way.

If the user clicks the close button, then the dock window is hidden. A dock window can be hidden or unhidden by the user by right clicking a dock area and clicking the name of the relevant dock window on the pop up dock window menu. This menu lists the names of every dock window; visible dock windows have a tick beside their names. The dock window menu is created automatically as required bycreateDockWindowMenu(). Since it may not always be appropriate for a dock window to appear on this menu thesetAppropriate() function is used to inform the main window whether or not the dock window menu should include a particular dock window. Double clicking a dock window handle (usually on the left-hand side of the dock window) undocks (floats) the dock window. Double clicking a floating dock window's title bar will dock the floating dock window. (See alsoQ3MainWindow::DockWindows.)

Some functions change the appearance of aQ3MainWindow globally:

• Q3DockWindow::setHorizontalStretchable() andQ3DockWindow::setVerticalStretchable() are used to make specific dock windows or toolbars stretchable.
• setUsesBigPixmaps() is used to set whether tool buttons should draw small or large pixmaps (seeQIcon for more information).
• setUsesTextLabel() is used to set whether tool buttons should display a textual label in addition to pixmaps (seeQToolButton for more information).

The user can drag dock windows into any enabled docking area.Qt::Dock windows can also be draggedwithin a docking area, for example to rearrange the order of some toolbars.Qt::Dock windows can also be dragged outside any docking area (undocked or 'floated'). Being able to drag dock windows can be enabled (the default) and disabled usingsetDockWindowsMovable().

TheMinimized edge is a hidden dock area. If this dock area is enabled the user can hide (minimize) a dock window or show (restore) a minimized dock window by clicking the dock window handle. If the user hovers the mouse cursor over one of the handles, the caption of the dock window is displayed in a tool tip (seeQ3DockWindow::windowTitle() orQ3ToolBar::label()), so if you enable theMinimized dock area, it is best to specify a meaningful caption or label for each dock window. To minimize a dock window programmatically usemoveDockWindow() with an edge ofMinimized.

Qt::Dock windows are moved transparently by default, i.e. during the drag an outline rectangle is drawn on the screen representing the position of the dock window as it moves. If you want the dock window to be shown normally whilst it is moved usesetOpaqueMoving().

The location of a dock window, i.e. its dock area and position within the dock area, can be determined by callinggetLocation(). Movable dock windows can be lined up to minimize wasted space withlineUpDockWindows(). Pointers to the dock areas are available fromtopDock(),leftDock(),rightDock() andbottomDock(). A customize menu item is added to the pop up dock window menu ifisCustomizable() returns true; it returns false by default. ReimplementisCustomizable() andcustomize() if you want to offer this extra menu item, for example, to allow the user to change settings relating to the main window and its toolbars and dock windows.

The main window's menu bar is fixed (at the top) by default. If you want a movable menu bar, create aQMenuBar as a stretchable widget inside its own movable dock window and restrict this dock window to only live within theTop orBottom dock:

Q3ToolBar*tb=newQ3ToolBar(this);addDockWindow(tb, tr("Menubar"), Top,false);QMenuBar*mb=newQMenuBar(tb);mb->setFrameStyle(QFrame::NoFrame);tb->setStretchableWidget(mb);setDockEnabled(tb, Left,false);setDockEnabled(tb, Right,false);

An application with multiple dock windows can choose to save the current dock window layout in order to restore it later, e.g. in the next session. You can do this by using the streaming operators forQ3MainWindow.

To save the layout and positions of all the dock windows do this:

QFile file(filename);if (file.open(IO_WriteOnly)) {QTextStream stream(&file);    stream<<*mainWindow;    file.close();}

To restore the dock window positions and sizes (normally when the application is next started), do the following:

QFile file(filename);if (file.open(IO_ReadOnly)) {QTextStream stream(&file);    stream>>*mainWindow;    file.close();}

TheQSettings class can be used in conjunction with the streaming operators to store the application's settings.

Q3MainWindow's management of dock windows and toolbars is done transparently behind-the-scenes byQ3DockArea.

For multi-document interfaces (MDI), use aQWorkspace as the central widget.

Adding dock windows, e.g. toolbars, toQ3MainWindow's dock areas is straightforward. If the supplied dock areas are not sufficient for your application we suggest that you create aQWidget subclass and add your own dock areas (seeQ3DockArea) to the subclass sinceQ3MainWindow provides functionality specific to the standard dock areas it provides.

Member Type Documentation

enum Q3MainWindow::DockWindows

Right-clicking a dock area will pop-up the dock window menu (createDockWindowMenu() is called automatically). When called in code you can specify what items should appear on the menu with this enum.

Property Documentation

dockWindowsMovable :bool

This property holds whether the dock windows are movable.

If true (the default), the user will be able to move movable dock windows from oneQ3MainWindow dock area to another, including theTearOff area (i.e. where the dock window floats freely as a window in its own right), and theMinimized area (where only the dock window's handle is shown below the menu bar). Movable dock windows can also be moved withinQ3MainWindow dock areas, i.e. to rearrange them within a dock area.

If false the user will not be able to move any dock windows.

By default dock windows are moved transparently (i.e. only an outline rectangle is shown during the drag), but this setting can be changed withsetOpaqueMoving().

Access functions:

See alsosetDockEnabled() andsetOpaqueMoving().

opaqueMoving :bool

This property holds whether dock windows are moved opaquely.

If true the dock windows of the main window are shown opaquely (i.e. it shows the toolbar as it looks when docked) whilst it is being moved. If false (the default) they are shown transparently, (i.e. as an outline rectangle).

Warning: Opaque moving of toolbars and dockwindows is known to have several problems. We recommend avoiding the use of this feature for the time being. We intend fixing the problems in a future release.

Access functions:

rightJustification :bool

This property holds whether the main window right-justifies its dock windows.

If disabled (the default), stretchable dock windows are expanded, and non-stretchable dock windows are given the minimum space they need. Since most dock windows are not stretchable, this usually results in an unjustified right edge (or unjustified bottom edge for a vertical dock area). If enabled, the main window will right-justify its dock windows.

Access functions:

See alsoQ3DockWindow::setVerticalStretchable() andQ3DockWindow::setHorizontalStretchable().

usesBigPixmaps :bool

This property holds whether big pixmaps are enabled.

If false (the default), the tool buttons will use small pixmaps; otherwise big pixmaps will be used.

Tool buttons and other widgets that wish to respond to this setting are responsible for reading the correct state on startup, and for connecting to the main window's widget'spixmapSizeChanged() signal.

Access functions:

usesTextLabel :bool

This property holds whether text labels for toolbar buttons are enabled.

If disabled (the default), the tool buttons will not use text labels. If enabled, text labels will be used.

Tool buttons and other widgets that wish to respond to this setting are responsible for reading the correct state on startup, and for connecting to the main window's widget'susesTextLabelChanged() signal.

Access functions:

See alsoQToolButton::setUsesTextLabel().

Member Function Documentation

Q3MainWindow::Q3MainWindow(QWidget * parent = 0, constchar * name = 0,Qt::WindowFlags f = Qt::WType_TopLevel)

Constructs an empty main window. Theparent,name and widget flagsf, are passed on to theQWidget constructor.

By default, the widget flags are set toQt::WType_TopLevel rather than 0 as they are withQWidget. If you don't want yourQ3MainWindow to be a top level widget then you will need to setf to 0.

Q3MainWindow::~Q3MainWindow()

Destroys the object and frees any allocated resources.

[virtual]void Q3MainWindow::addDockWindow(Q3DockWindow * dockWindow,Qt::Dock edge = Qt::DockTop,bool newLine = false)

AddsdockWindow to theedge dock area.

IfnewLine is false (the default) then thedockWindow is added at the end of theedge. For vertical edges the end is at the bottom, for horizontal edges (includingMinimized) the end is at the right. IfnewLine is true a new line of dock windows is started withdockWindow as the first (left-most and top-most) dock window.

IfdockWindow is managed by another main window, it is first removed from that window.

[virtual]void Q3MainWindow::addDockWindow(Q3DockWindow * dockWindow, constQString & label,Qt::Dock edge = Qt::DockTop,bool newLine = false)

This is an overloaded function.

AddsdockWindow to the dock area with labellabel.

IfnewLine is false (the default) thedockWindow is added at the end of theedge. For vertical edges the end is at the bottom, for horizontal edges (includingMinimized) the end is at the right. IfnewLine is true a new line of dock windows is started withdockWindow as the first (left-most and top-most) dock window.

IfdockWindow is managed by another main window, it is first removed from that window.

void Q3MainWindow::addToolBar(Q3DockWindow * dockWindow,Qt::Dock position = Qt::DockTop,bool newLine = false)

Adds a new toolbar to thedockWindow. The toolbar is placed in the givenposition. IfnewLine is true the toolbar is put on a new line.

void Q3MainWindow::addToolBar(Q3DockWindow * dockWindow, constQString & label,Qt::Dock position = Qt::DockTop,bool newLine = false)

This is an overloaded function.

The toolbar has the captionlabel and is placed in the givenposition.

bool Q3MainWindow::appropriate(Q3DockWindow * dw) const

Returns true if it is appropriate to include a menu item for thedw dock window in the dock window menu; otherwise returns false.

The user is able to change the state (show or hide) a dock window that has a menu item by clicking the item.

CallsetAppropriate() to indicate whether or not a particular dock window should appear on the popup menu.

See alsosetAppropriate().

Q3DockArea * Q3MainWindow::bottomDock() const

Returns a pointer theBottom dock area

See alsotopDock(),leftDock(), andrightDock().

QWidget * Q3MainWindow::centralWidget() const

Returns a pointer to the main window's central widget.

The central widget is surrounded by the left, top, right and bottom dock areas. The menu bar is above the top dock area.

See alsosetCentralWidget().

[virtual protected]void Q3MainWindow::childEvent(QChildEvent * e)

Reimplemented fromQObject::childEvent().

Monitors events, received ine, to ensure the layout is updated.

[virtual]Q3PopupMenu * Q3MainWindow::createDockWindowMenu(DockWindows dockWindows = AllDockWindows) const

Creates the dock window menu which contains all toolbars (ifdockWindows isOnlyToolBars), all dock windows (ifdockWindows isNoToolBars) or all toolbars and dock windows (ifdockWindows isAllDockWindows - the default).

This function is called internally when necessary, e.g. when the user right clicks a dock area (providingisDockMenuEnabled() returns true). You can reimplement this function if you wish to customize the behavior.

The menu items representing the toolbars and dock windows are checkable. The visible dock windows are checked and the hidden dock windows are unchecked. The user can click a menu item to change its state (show or hide the dock window).

The list and the state are always kept up-to-date.

Toolbars and dock windows which are not appropriate in the current context (seesetAppropriate()) are not listed in the menu.

The menu also has a menu item for lining up the dock windows.

IfisCustomizable() returns true, a Customize menu item is added to the menu, which if clicked will callcustomize(). TheisCustomizable() function we provide returns false andcustomize() does nothing, so they must be reimplemented in a subclass to be useful.

[virtual slot]void Q3MainWindow::customize()

This function is called when the user clicks the Customize menu item on the dock window menu.

The customize menu item will only appear ifisCustomizable() returns true (it returns false by default).

The function is intended, for example, to provide the user with a means of telling the application that they wish to customize the main window, dock windows or dock areas.

The default implementation does nothing and the Customize menu item is not shown on the right-click menu by default. If you want the item to appear then reimplementisCustomizable() to return true, and reimplement this function to do whatever you want.

See alsoisCustomizable().

[signal]void Q3MainWindow::dockWindowPositionChanged(Q3DockWindow * dockWindow)

This signal is emitted when thedockWindow has changed its position. A change in position occurs when a dock window is moved within its dock area or moved to another dock area (including theMinimized andTearOff dock areas).

See alsogetLocation().

QList<Q3DockWindow *> Q3MainWindow::dockWindows(Qt::Dock dock) const

Returns a list of all the dock windows which are in thedock dock area, regardless of their state.

For example, theQt::DockTornOff dock area may contain closed dock windows but these are returned along with the visible dock windows.

QList<Q3DockWindow *> Q3MainWindow::dockWindows() const

This is an overloaded function.

Returns the list of dock windows which belong to this main window, regardless of which dock area they are in or what their state is, (e.g. irrespective of whether they are visible or not).

[virtual protected]bool Q3MainWindow::event(QEvent * e)

Reimplemented fromQObject::event().

[virtual]bool Q3MainWindow::eventFilter(QObject * o,QEvent * e)

Reimplemented fromQObject::eventFilter().

bool Q3MainWindow::getLocation(Q3DockWindow * dw,Qt::Dock & dock,int & index,bool & nl,int & extraOffset) const

Finds the location of the dock windowdw.

If thedw dock window is found in the main window the function returns true and populates thedock variable with the dw's dock area and theindex with the dw's position within the dock area. It also setsnl to true if thedw begins a new line (otherwise false), andextraOffset with the dock window's offset.

If thedw dock window is not found then the function returns false and the state ofdock,index,nl andextraOffset is undefined.

If you want to save and restore dock window positions then use operator>>() and operator<<().

bool Q3MainWindow::hasDockWindow(Q3DockWindow * dw)

Returns true ifdw is a dock window known to the main window; otherwise returns false.

[virtual]bool Q3MainWindow::isCustomizable() const

Returns true if the dock area dock window menu includes the Customize menu item (which callscustomize() when clicked). Returns false by default, i.e. the popup menu will not contain a Customize menu item. You will need to reimplement this function and set it to return true if you wish the user to be able to see the dock window menu.

See alsocustomize().

bool Q3MainWindow::isDockEnabled(Qt::Dock dock) const

Returns true if thedock dock area is enabled, i.e. it can accept user dragged dock windows; otherwise returns false.

See alsosetDockEnabled().

bool Q3MainWindow::isDockEnabled(Q3DockArea * area) const

This is an overloaded function.

Returns true if dock areaarea is enabled, i.e. it can accept user dragged dock windows; otherwise returns false.

See alsosetDockEnabled().

bool Q3MainWindow::isDockEnabled(Q3DockWindow * dw,Q3DockArea * area) const

This is an overloaded function.

Returns true if dock areaarea is enabled for the dock windowdw; otherwise returns false.

See alsosetDockEnabled().

bool Q3MainWindow::isDockEnabled(Q3DockWindow * tb,Qt::Dock dock) const

This is an overloaded function.

Returns true if dock areadock is enabled for the dock windowtb; otherwise returns false.

See alsosetDockEnabled().

bool Q3MainWindow::isDockMenuEnabled() const

Returns true, if the dock window menu is enabled; otherwise returns false.

The menu lists the (appropriate()) dock windows (which may be shown or hidden), and has a "Line Up Dock Windows" menu item. It will also have a "Customize" menu item ifisCustomizable() returns true.

setAppropriate()

See alsosetDockEnabled(),lineUpDockWindows(), andappropriate().

Q3DockArea * Q3MainWindow::leftDock() const

Returns theLeft dock area

See alsorightDock(),topDock(), andbottomDock().

void Q3MainWindow::lineUpDockWindows(bool keepNewLines = false)

This function will line up dock windows within the visible dock areas (Top,Left,Right andBottom) as compactly as possible.

IfkeepNewLines is true, all dock windows stay on their original lines. IfkeepNewLines is false then newlines may be removed to achieve the most compact layout possible.

The method only works ifdockWindowsMovable() returns true.

void Q3MainWindow::lineUpToolBars(bool keepNewLines = false)

Lines up the toolbars. Line breaks are preserved ifkeepNewLines is true.

[protected slot]void Q3MainWindow::menuAboutToShow()

This slot is called from the aboutToShow() signal of the default dock menu of the mainwindow. The default implementation initializes the menu with all dock windows and toolbars in this slot.

QMenuBar * Q3MainWindow::menuBar() const

Returns the menu bar for this window.

If there isn't one, then menuBar() creates an empty menu bar.

See alsostatusBar().

[virtual]QSize Q3MainWindow::minimumSizeHint() const

Reimplemented fromQWidget::minimumSizeHint().

[virtual]void Q3MainWindow::moveDockWindow(Q3DockWindow * dockWindow,Qt::Dock edge = Qt::DockTop)

MovesdockWindow to the end of theedge.

For vertical edges the end is at the bottom, for horizontal edges (includingMinimized) the end is at the right.

IfdockWindow is managed by another main window, it is first removed from that window.

[virtual]void Q3MainWindow::moveDockWindow(Q3DockWindow * dockWindow,Qt::Dock edge,bool nl,int index,int extraOffset = -1)

This is an overloaded function.

MovesdockWindow to positionindex within theedge dock area.

Any dock windows with positionsindex or higher have their position number incremented and any of these on the same line are moved right (down for vertical dock areas) to make room.

Ifnl is true, a new dock window line is created below the line in which the moved dock window appears and the moved dock window, with any others with higher positions on the same line, is moved to this new line.

TheextraOffset is the space to put between the left side of the dock area (top side for vertical dock areas) and the dock window. (This is mostly used for restoring dock windows to the positions the user has dragged them to.)

IfdockWindow is managed by another main window, it is first removed from that window.

void Q3MainWindow::moveToolBar(Q3DockWindow * dockWindow,Qt::Dock position = Qt::DockTop)

Moves the givendockWindow into the givenposition.

void Q3MainWindow::moveToolBar(Q3DockWindow * dockWindow,Qt::Dock position,bool nl,int index,int extraOffset = -1)

This is an overloaded function.

ThedockWindow is made theindex-th item in the toolbar, moved over byextraOffset. Ifnl is true, the dock window is put on a new line.

[virtual protected]void Q3MainWindow::paintEvent(QPaintEvent *)

Reimplemented fromQWidget::paintEvent().

[signal]void Q3MainWindow::pixmapSizeChanged(bool b)

This signal is emitted whenever thesetUsesBigPixmaps() is called with a value different to the current setting. The new value is passed inb. All widgets that should respond to such changes, e.g. toolbar buttons, must connect to this signal.

[virtual]void Q3MainWindow::removeDockWindow(Q3DockWindow * dockWindow)

RemovesdockWindow from the main window's docking area, provideddockWindow is non-null and managed by this main window.

void Q3MainWindow::removeToolBar(Q3DockWindow * dockWindow)

Removes the toolbar from the givendockWindow.

Q3DockArea * Q3MainWindow::rightDock() const

Returns theRight dock area

See alsoleftDock(),topDock(), andbottomDock().

[virtual slot]void Q3MainWindow::setAppropriate(Q3DockWindow * dw,bool a)

Use this function to control whether or not thedw dock window's caption should appear as a menu item on the dock window menu that lists the dock windows.

Ifa is true then thedw will appear as a menu item on the dock window menu. The user is able to change the state (show or hide) a dock window that has a menu item by clicking the item; depending on the state of your application, this may or may not be appropriate. Ifa is false thedw will not appear on the popup menu.

See alsoappropriate(),showDockMenu(),isCustomizable(), andcustomize().

[virtual]void Q3MainWindow::setCentralWidget(QWidget * w)

Sets the central widget for this main window tow.

The central widget is surrounded by the left, top, right and bottom dock areas. The menu bar is above the top dock area.

See alsocentralWidget().

[virtual]void Q3MainWindow::setDockEnabled(Qt::Dock dock,bool enable)

Ifenable is true then users can dock windows in thedock area. Ifenable is false users cannot dock windows in thedock dock area.

Users can dock (drag) dock windows into any enabled dock area.

See alsoisDockEnabled().

[virtual]void Q3MainWindow::setDockEnabled(Q3DockWindow * dw,Qt::Dock dock,bool enable)

This is an overloaded function.

Ifenable is true then users can dock thedw dock window in thedock area. Ifenable is false users cannot dock thedw dock window in thedock area.

In general users can dock (drag) dock windows into any enabled dock area. Using this function particular dock areas can be enabled (or disabled) as docking points for particular dock windows.

[virtual slot]void Q3MainWindow::setDockMenuEnabled(bool b)

Ifb is true, then right clicking on a dock window or dock area will pop up the dock window menu. Ifb is false, right clicking a dock window or dock area will not pop up the menu.

The menu lists the (appropriate()) dock windows (which may be shown or hidden), and has a "Line Up Dock Windows" item. It will also have a "Customize" menu item ifisCustomizable() returns true.

See alsolineUpDockWindows() andisDockMenuEnabled().

[slot]void Q3MainWindow::setToolBarsMovable(bool b)

Ifb is true the tool bars can be moved.

See alsotoolBarsMovable().

[virtual protected slot]void Q3MainWindow::setUpLayout()

Sets up the geometry management of the window. It is called automatically when needed, so you shouldn't need to call it.

[virtual]void Q3MainWindow::setVisible(bool visible)

Reimplemented fromQWidget::setVisible().

[virtual protected slot]bool Q3MainWindow::showDockMenu(constQPoint & globalPos)

Shows the dock menu at the positionglobalPos. The menu lists the dock windows so that they can be shown (or hidden), lined up, and possibly customized. Returns true if the menu is shown; otherwise returns false.

If you want a custom menu, reimplement this function. You can create the menu from scratch or callcreateDockWindowMenu() and modify the result.

The default implementation uses the dock window menu which gets created bycreateDockWindowMenu(). You can reimplementcreateDockWindowMenu() if you want to use your own specialized popup menu.

[virtual]QSize Q3MainWindow::sizeHint() const

Reimplemented fromQWidget::sizeHint().

QStatusBar * Q3MainWindow::statusBar() const

Returns this main window's status bar. If there isn't one, statusBar() creates an empty status bar, and if necessary a tool tip group too.

See alsomenuBar().

[signal]void Q3MainWindow::toolBarPositionChanged(Q3ToolBar * toolbar)

This signal is emitted when atoolbar is moved.

QList<Q3ToolBar *> Q3MainWindow::toolBars(Qt::Dock dock) const

Returns a list of all the toolbars which are in thedock dock area, regardless of their state.

For example, theTornOff dock area may contain closed toolbars but these are returned along with the visible toolbars.

See alsodockWindows().

bool Q3MainWindow::toolBarsMovable() const

Returns true if the window allows its toolbars to be moved; otherwise returns false.

See alsosetToolBarsMovable().

Q3DockArea * Q3MainWindow::topDock() const

Returns theTop dock area

See alsobottomDock(),leftDock(), andrightDock().

[signal]void Q3MainWindow::usesTextLabelChanged(bool b)

This signal is emitted whenever thesetUsesTextLabel() is called with a value different to the current setting. The new value is passed inb. All widgets that should respond to such changes, e.g. toolbar buttons, must connect to this signal.

[virtual slot]void Q3MainWindow::whatsThis()

Enters 'What's This?' mode and returns immediately.

This is the same asQWhatsThis::enterWhatsThisMode(), but implemented as a main window object's slot. This way it can easily be used for popup menus, for example:

Q3PopupMenu* help=newQ3PopupMenu(this);help->insertItem("What's &This",this, SLOT(enterWhatsThis()),Qt::SHIFT+Qt::Key_F1);

See alsoQ3WhatsThis::enterWhatsThisMode().

Related Non-Members

QTextStream &operator<<(QTextStream & ts, constQ3MainWindow & mainWindow)

Writes the layout (sizes and positions) of the dock windows in the dock areas of theQ3MainWindowmainWindow, includingMinimized andTornOff dock windows, to the text streamts.

This can be used, for example, in conjunction withQSettings to save the user's layout when themainWindow receives a close event.

See alsoQWidget::closeEvent().

QTextStream &operator>>(QTextStream & ts,Q3MainWindow & mainWindow)

Reads the layout (sizes and positions) of the dock windows in the dock areas of theQ3MainWindowmainWindow from the text stream,ts, includingMinimized andTornOff dock windows. Restores the dock windows and dock areas to these sizes and positions. The layout information must be in the format produced by operator<<().

This can be used, for example, in conjunction withQSettings to restore the user's layout.