Q3DockWindow Class Reference

 #include <Q3DockWindow>

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

Member Function Documentation

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

Constructs a Q3DockWindow with parent parent, called name and with widget flags f.

If p is InDock, the dock window is docked into a dock area and parent must be a Q3DockArea or a Q3MainWindow. If the parent is a Q3MainWindow the dock window will be docked in the main window's Top dock area.

If p is OutsideDock, the dock window is created as a floating window.

We recommend creating the dock area InDock with a Q3MainWindow as parent then calling Q3MainWindow::moveDockWindow() to move the dock window where you want it.

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

Constructs a Q3DockWindow with parent parent, called name and with widget flags f.

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

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

See also setWidget() and setOrientation().

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

Reimplemented from QWidget::contextMenuEvent().

void Q3DockWindow::dock () [virtual slot]

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 of Q3DockArea::isDockWindowAccepted().

See also undock(), Q3DockArea::moveDockWindow(), Q3DockArea::removeDockWindow(), Q3MainWindow::moveDockWindow(), Q3MainWindow::removeDockWindow(), and Q3DockArea::isDockWindowAccepted().

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

Reimplemented from Q3Frame::drawContents().

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

Reimplemented from Q3Frame::drawFrame().

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

Reimplemented from QObject::event().

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

Reimplemented from QObject::eventFilter().

QSize Q3DockWindow::fixedExtent () const

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

See also setFixedExtentWidth() and setFixedExtentHeight().

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

Reimplemented from QWidget::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's Place and its CloseMode.

See also setCloseMode().

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.

QSize Q3DockWindow::minimumSizeHint () const [virtual]

Reimplemented from QWidget::minimumSizeHint().

Qt::Orientation Q3DockWindow::orientation () const

Returns the orientation of the dock window.

See also setOrientation() and orientationChanged().

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

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

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

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

See also Q3DockArea::moveDockWindow(), Q3DockArea::removeDockWindow(), Q3MainWindow::moveDockWindow(), and Q3MainWindow::removeDockWindow().

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

Reimplemented from QWidget::resizeEvent().

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

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

See also setFixedExtentWidth().

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

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

See also setFixedExtentHeight().

void Q3DockWindow::setHorizontalStretchable ( bool b )

If b is true the dock window is set to be horizontally stretchable.

See also isHorizontalStretchable().

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

Sets the orientation of the dock window to o. The orientation is propagated to the layout boxLayout().

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

See also orientation().

void Q3DockWindow::setVerticalStretchable ( bool b )

If b is true the dock window is set to be vertically stretchable.

See also isVerticalStretchable().

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

Sets the dock window's main widget to w.

See also widget() and boxLayout().

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

Reimplemented from QWidget::showEvent().

QSize Q3DockWindow::sizeHint () const [virtual]

Reimplemented from QWidget::sizeHint().

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

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

See also dock(), Q3DockArea::moveDockWindow(), Q3DockArea::removeDockWindow(), Q3MainWindow::moveDockWindow(), and Q3MainWindow::removeDockWindow().

void Q3DockWindow::undock () [virtual slot]

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

See also dock(), Q3DockArea::moveDockWindow(), Q3DockArea::removeDockWindow(), Q3MainWindow::moveDockWindow(), and Q3MainWindow::removeDockWindow().

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

This signal is emitted when the visibility of the dock window relatively to its dock area is changed. If visible is true, the Q3DockWindow 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 a Q3MainWindow a dock window can have its visibility changed (hidden or shown) by clicking its name in the dock window menu that lists the Q3MainWindow's dock windows.

QWidget * Q3DockWindow::widget () const

Returns the dock window's main widget.

See also setWidget().

QString Q3DockWindow::windowTitle () const

Returns the dock window's title.