class KDockMainWindow

A special kind of KMainWindow that is able to have dockwidget child widgets (and member of the dockwidget class set). More... (kparts)

Definition#include <include/kdockwidget.h>
InheritsKMainWindow [public ]
Inherited byDockMainWindow
List of all Methods
Annotated List

Public Methods


Protected Slots

Protected Members

Private Members

Detailed Description

A special kind of KMainWindow that is able to have dockwidget child widgets (and member of the dockwidget class set).

The main widget should be a KDockWidget where other KDockWidget can be docked to the left, right, top, bottom or to the middle. Note: dock to the middle means to drop on a dockwidget and to unite them to a new widget, a tab control. That tab widget is a KDockTabCtl .

Furthermore, the KDockMainWindow has got the KDocManager and some data about the dock states.

If you've got some dockwidgets, you can dock them to the dockmainwindow to initialize a start scene: Here an example:

 DockApplication::DockApplication( const char* name) : KDockMainWindow( name)
   KDockWidget* mainDock;
   mainDock = createDockWidget( "Falk's MainDockWidget", mainPixmap, 0L, "main_dock_widget");
   AnyContentsWidget* cw = new AnyContentsWidget( mainDock);
   mainDock->setWidget( cw);
   // allow others to dock to the 4 sides
   // forbit docking abilities of mainDock itself
   setView( mainDock); // central widget in a KDE mainwindow
   setMainDockWidget( mainDock); // master dockwidget
   KDockWidget* dockLeft;
   dockLeft = createDockWidget( "Intially left one", anyOtherPixmap, 0L, i18n("The left dockwidget"));
   AnotherWidget* aw = new AnotherWidget( dockLeft);
   dockLeft->setWidget( aw);
   dockLeft->manualDock( mainDock,              // dock target
                         KDockWidget::DockLeft, // dock site
                         20 );                  // relation target/this (in percent)

Docking is fully dynamical at runtime. That means you can always move dockwidgets via drag and drop.

And last but not least you can use the popupmenu for showing or hiding any controlled dockwidget of this class and insert it to your main menu bar or anywhere else.

friend class KDockManager



 KDockMainWindow ( QWidget* parent = 0L, const char *name = 0L, WFlags f = WType_TopLevel | WDestructiveClose )


Constructs a dockmainwindow. It calls its base class constructor and does additional things concerning to the dock stuff:

  • information about the dock state of this' children gets initialized
  • a dockmanager is created...
  • ...and gets initialized
  • the main dockwidget is set to 0

nameobject name

 ~KDockMainWindow ()



Destructs a dockmainwindow.

KDockManager*  manager ()


Returns the dockmanager of this. (see KDockManager)

Returns: pointer to the wanted dockmanager

void  setMainDockWidget ( KDockWidget* )


Sets a new main dockwidget. Additionally, the toolbar is re-initialized.

_dockwidget that become the new main dockwidget

KDockWidget*  getMainDockWidget ()


Returns the main dockwidget.

Returns: pointer to the main dockwidget

KDockWidget*  createDockWidget ( const QString& name, const QPixmap &pixmap, QWidget* parent = 0L, const QString& strCaption = 0L, const QString& strTabPageLabel = " ")


This is one of the most important methods! The KDockMainWindow creates a new dockwidget object here that usually should encapsulate the user's widget. The new dockwidget is automatically taken under control by the dockmanager of the dockmainwindow.

nameQObject name (default dockwidget caption)
pixmapwindow icon (for instance shown when docked as tabwidget entry)
parentparent widget for the new dockwidget
strCaptionwindow title (shown when toplevel)
strTabPageLabeltitle of the tab page (visible when in tab page mode), if it is "", only the icon will be shown; if it is 0L, the label is set to strCaption

Returns: a pointer to the new created dockwidget

void  writeDockConfig (QDomElement &base)


Saves the current dock window layout into a DOM tree below the given element.

void  readDockConfig (QDomElement &base)


Reads the current dock window layout from a DOM tree below the given element.

void  writeDockConfig ( KConfig* c = 0L, QString group = QString::null )


It writes the current dock state in the given section of KConfig.

cKDE class for saving configurations
groupname of section to write to

void  readDockConfig ( KConfig* c = 0L, QString group = QString::null )


It reads the current dock state from the given section of KConfig.

cKDE class for saving configurations
groupname of section to read from

void  activateDock ()


It runs through all dockwidgets which are under control of the dockmanager and calls show() for every encapsulated widget and show() for the dockwidget itself if it is not in tab mode. Additionally, if the main dockwidget is not a QDialog, it will be shown.

QPopupMenu*  dockHideShowMenu ()


Returns a popup menu that contains entries for all controlled dockwidgets making hiding and showing them possible.

Returns: the wanted popup menu

void  makeDockVisible ( KDockWidget* dock )


This method shows the given dockwidget. The clue is that it also considers the dockwidget could be a tab page and must set to be the activate one.

dockthe dockwidget that is to be shown

void  makeDockInvisible ( KDockWidget* dock )


This method hides the given dockwidget.

dockthe dockwidget that is to be shown

void  makeWidgetDockVisible ( QWidget* widget )


This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

void  setView ( QWidget* )


This method calls the base class method. If the given widget inherits KDockWidget, applyToWidget(this) is called.

_any widget that should become the main view

void  dockWidgetHasUndocked (KDockWidget*)



Signals a certain dockwidget is undocked now.

KDockWidget* mainDockWidget



KDockManager* dockManager



void  slotDockWidgetUndocked ()


[protected slots slot]

Called whenever one of the dockwidgets of this has been undocked.

KDockMainWindowPrivate * d



  • Author: Max Judin (documentation: Falk Brettschneider).