Contents

• Public Types
• Properties
• Public Functions
• Reimplemented Public Functions
• Public Slots
• Signals
• Reimplemented Protected Functions
• Detailed Description

Detailed Description

TheQ3DockWindow class provides a widget which can be docked inside aQ3DockArea or floated as a top level window on the desktop.

This class handles moving, resizing, docking and undocking dock windows.Q3ToolBar is a subclass ofQ3DockWindow so the functionality provided for dock windows is available with the same API for toolbars.

Two Q3DockWindows (Q3ToolBars) in aQ3DockArea

A FloatingQ3DockWindow

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 title bar 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 appears on floating dock windows by default) the dock window will disappear. You can control whether or not a dock window has a close button withsetCloseMode().

Q3MainWindow provides four dock areas (top, left, right and bottom) which can be used by dock windows. For many applications using the dock areas provided byQ3MainWindow is sufficient. (See theQ3DockArea documentation if you want to create your own dock areas.) InQ3MainWindow 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 acaption.)

When you construct a dock window youmust pass it aQ3DockArea or aQ3MainWindow as its parent if you want it docked. Pass 0 for the parent if you want it floated.

Q3ToolBar*fileTools=newQ3ToolBar(this,"File Actions");moveDockWindow(fileTools, Left);

In the example above we create a newQ3ToolBar in the constructor of aQ3MainWindow subclass (so that thethis pointer points to theQ3MainWindow). By default the toolbar will be added to theTop dock area, but we've moved it to theLeft dock area.

A dock window is often used to contain a single widget. In these cases the widget can be set by callingsetWidget(). 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 theboxLayout() function to get a pointer to the dock window's box layout, then add widgets to the layout using the box layout'sQBoxLayout::addWidget() 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 withsetOrientation().

Although a common use of dock windows is for toolbars, they can be used with any widgets. When using larger widgets it may make sense for the dock window to be resizable by callingsetResizeEnabled(). 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.

Qt::Dock windows can be docked and undocked usingdock() andundock(). A dock window's orientation can be set withsetOrientation(). You can also useQ3DockArea::moveDockWindow(). If you're using aQ3MainWindow,Q3MainWindow::moveDockWindow() andQ3MainWindow::removeDockWindow() are available.

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 usingsetOffset(). If you'd prefer a dock window to start on a new line when it is docked usesetNewLine(). ThesetFixedExtentWidth() andsetFixedExtentHeight() functions can be used to define the dock window's preferred size, and thesetHorizontallyStretchable() andsetVerticallyStretchable() functions set whether the dock window can be stretched or not. Dock windows can be moved by default, but this can be changed withsetMovingEnabled(). When a dock window is moved it is shown as a rectangular outline, but it can be shown normally usingsetOpaqueMoving().

When a dock window's visibility changes, i.e. it is shown or hidden, thevisibilityChanged() signal is emitted. When a dock window is docked, undocked or moved inside the dock area theplaceChanged() signal is emitted.

Member Type Documentation

enum Q3DockWindow::CloseMode

This enum type specifies when (if ever) a dock window has a close button.

enum Q3DockWindow::Place

This enum specifies the possible locations for aQ3DockWindow:

Property Documentation

closeMode :int

This property holds the close mode of a dock window.

Defines when (if ever) the dock window has a close button. The choices areNever,Docked (i.e. only when docked),Undocked (only when undocked, i.e. floated) orAlways.

The default isNever.

Access functions:

horizontallyStretchable :bool

This property holds whether the dock window is horizontally stretchable.

A dock window is horizontally stretchable if you call setHorizontallyStretchable(true) orsetResizeEnabled(true).

Warning: Stretchability is broken. You must callsetResizeEnabled(true) to get proper behavior and even thenQ3DockWindow does not limit stretchablilty.

Access functions:

See alsosetResizeEnabled().

movingEnabled :bool

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.

This property is true by default.

Access functions:

newLine :bool

This property holds whether the dock window prefers to start a new line in the dock area.

The default is false, i.e. the dock window doesn't require a new line in the dock area.

Access functions:

offset :int

This property holds the dock window's preferred offset from the dock area's left edge (top edge for vertical dock areas).

The default is 0.

Access functions:

opaqueMoving :bool

This property holds whether the dock window will be shown normally whilst it is being moved.

If this property is false, (the default), the dock window will be represented by an outline rectangle whilst it is being moved.

Warning: 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.

Access functions:

place : constPlace

This property holds the location where the dock window is placed.

This is eitherInDock orOutsideDock.

Access functions:

See alsoQ3DockArea::moveDockWindow(),Q3DockArea::removeDockWindow(),Q3MainWindow::moveDockWindow(), andQ3MainWindow::removeDockWindow().

resizeEnabled :bool

This property holds whether the dock window is resizeable.

A resizeable dock window can be resized using splitter-like handles inside a dock area and like every other top level window when floating.

A dock window is both horizontally and vertically stretchable if you call setResizeEnabled(true).

This property is false by default.

Access functions:

See alsosetVerticallyStretchable() andsetHorizontallyStretchable().

stretchable : constbool

This property holds whether the dock window is stretchable in the current orientation().

This property can be set usingsetHorizontallyStretchable() andsetVerticallyStretchable(), or withsetResizeEnabled().

Warning: Stretchability is broken. You must callsetResizeEnabled(true) to get proper behavior and even thenQ3DockWindow does not limit stretchablilty.

Access functions:

See alsosetResizeEnabled().

verticallyStretchable :bool

This property holds whether the dock window is vertically stretchable.

A dock window is vertically stretchable if you call setVerticallyStretchable(true) orsetResizeEnabled(true).

Warning: Stretchability is broken. You must callsetResizeEnabled(true) to get proper behavior and even thenQ3DockWindow does not limit stretchablilty.

Access functions:

See alsosetResizeEnabled().

Member Function Documentation

Q3DockWindow::Q3DockWindow(Place p = InDock,QWidget * parent = 0, constchar * name = 0,Qt::WindowFlags f = 0)

Constructs aQ3DockWindow with parentparent, calledname and with widget flagsf.

Ifp isInDock, the dock window is docked into a dock area andparentmust be aQ3DockArea or aQ3MainWindow. If theparent is aQ3MainWindow the dock window will be docked in the main window'sTop dock area.

Ifp isOutsideDock, the dock window is created as a floating window.

We recommend creating the dock areaInDock with aQ3MainWindow as parent then callingQ3MainWindow::moveDockWindow() to move the dock window where you want it.

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

Constructs aQ3DockWindow with parentparent, calledname and with widget flagsf.

Q3DockWindow::~Q3DockWindow()

Destroys the dock window and its child widgets.

Q3DockArea * Q3DockWindow::area() const

Returns the dock area in which this dock window is docked, or 0 if the dock window is floating.

QBoxLayout * Q3DockWindow::boxLayout()

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'sQBoxLayout::addWidget() function.

If the dock window only needs to contain a single widget usesetWidget() instead.

See alsosetWidget() andsetOrientation().

[virtual protected]void Q3DockWindow::contextMenuEvent(QContextMenuEvent * e)

Reimplemented fromQWidget::contextMenuEvent().

[virtual slot]void Q3DockWindow::dock()

Docks the dock window into the last dock area in which it was docked.

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.

The dock window will dock with the dock area regardless of the return value ofQ3DockArea::isDockWindowAccepted().

See alsoundock(),Q3DockArea::moveDockWindow(),Q3DockArea::removeDockWindow(),Q3MainWindow::moveDockWindow(),Q3MainWindow::removeDockWindow(), andQ3DockArea::isDockWindowAccepted().

[virtual protected]void Q3DockWindow::drawContents(QPainter * p)

Reimplemented fromQ3Frame::drawContents().

[virtual protected]void Q3DockWindow::drawFrame(QPainter * p)

Reimplemented fromQ3Frame::drawFrame().

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

Reimplemented fromQObject::event().

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

Reimplemented fromQObject::eventFilter().

QSize Q3DockWindow::fixedExtent() const

Returns the dock window's preferred size (fixed extent).

See alsosetFixedExtentWidth() andsetFixedExtentHeight().

[virtual protected]void Q3DockWindow::hideEvent(QHideEvent * e)

Reimplemented fromQWidget::hideEvent().

bool Q3DockWindow::isCloseEnabled() const

Returns true if the dock window has a close button; otherwise returns false. The result depends on the dock window'sPlace and itsCloseMode.

See alsosetCloseMode().

bool Q3DockWindow::isHorizontalStretchable() const

Returns true if the dock window can be stretched horizontally; otherwise returns false.

bool Q3DockWindow::isVerticalStretchable() const

Returns true if the dock window can be stretched vertically; otherwise returns false.

[virtual]QSize Q3DockWindow::minimumSizeHint() const

Reimplemented fromQWidget::minimumSizeHint().

Qt::Orientation Q3DockWindow::orientation() const

Returns the orientation of the dock window.

See alsosetOrientation() andorientationChanged().

[signal]void Q3DockWindow::orientationChanged(Qt::Orientation o)

This signal is emitted when the orientation of the dock window is changed. The new orientation iso.

[signal]void Q3DockWindow::placeChanged(Q3DockWindow::Place p)

This signal is emitted when the dock window is docked (p isInDock), undocked (p isOutsideDock) or moved inside the the dock area.

See alsoQ3DockArea::moveDockWindow(),Q3DockArea::removeDockWindow(),Q3MainWindow::moveDockWindow(), andQ3MainWindow::removeDockWindow().

[virtual protected]void Q3DockWindow::resizeEvent(QResizeEvent * e)

Reimplemented fromQWidget::resizeEvent().

[virtual]void Q3DockWindow::setFixedExtentHeight(int h)

Sets the dock window's preferred height for its fixed extent (size) toh.

See alsosetFixedExtentWidth().

[virtual]void Q3DockWindow::setFixedExtentWidth(int w)

Sets the dock window's preferred width for its fixed extent (size) tow.

See alsosetFixedExtentHeight().

void Q3DockWindow::setHorizontalStretchable(bool b)

Ifb is true the dock window is set to be horizontally stretchable.

See alsoisHorizontalStretchable().

[virtual slot]void Q3DockWindow::setOrientation(Qt::Orientation o)

Sets the orientation of the dock window too. The orientation is propagated to the layoutboxLayout().

Warning: All undocked Q3ToolBars will always have a horizontal orientation.

See alsoorientation().

void Q3DockWindow::setVerticalStretchable(bool b)

Ifb is true the dock window is set to be vertically stretchable.

See alsoisVerticalStretchable().

[virtual]void Q3DockWindow::setWidget(QWidget * w)

Sets the dock window's main widget tow.

See alsowidget() andboxLayout().

[virtual protected]void Q3DockWindow::showEvent(QShowEvent * e)

Reimplemented fromQWidget::showEvent().

[virtual]QSize Q3DockWindow::sizeHint() const

Reimplemented fromQWidget::sizeHint().

[virtual slot]void Q3DockWindow::undock(QWidget * widget)

Undocks the specifiedwidget from its current dock area if it is docked; otherwise does nothing.

See alsodock(),Q3DockArea::moveDockWindow(),Q3DockArea::removeDockWindow(),Q3MainWindow::moveDockWindow(), andQ3MainWindow::removeDockWindow().

[virtual slot]void Q3DockWindow::undock()

Undocks theQ3DockWindow from its current dock area if it is docked; otherwise does nothing.

See alsodock(),Q3DockArea::moveDockWindow(),Q3DockArea::removeDockWindow(),Q3MainWindow::moveDockWindow(), andQ3MainWindow::removeDockWindow().

[signal]void Q3DockWindow::visibilityChanged(bool visible)

This signal is emitted when the visibility of the dock window relatively to its dock area is changed. Ifvisible is true, theQ3DockWindow is now visible to the dock area, otherwise it has been hidden.

A dock window can be hidden if it has a close button which the user has clicked. In the case of aQ3MainWindow a dock window can have its visibility changed (hidden or shown) by clicking its name in the dock window menu that lists theQ3MainWindow's dock windows.

QWidget * Q3DockWindow::widget() const

Returns the dock window's main widget.

See alsosetWidget().

QString Q3DockWindow::windowTitle() const

Returns the dock window's title.