class KDockMainWindow

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

Definition#include <kdockwidget.h>
InheritsKTMainWindow
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Methods

Protected Types

Protected Methods

Protected Slots

Protected Members


Detailed Description

A special kind of KTMainWindow 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);
   AnyContentsWidget* cw( mainDock);
   setView( mainDock);
   setMainDockWidget( mainDock);
   ...
   KDockWidget* dockLeft;
   dockLeft = createDockWiget( "Intially left one", anyOtherPixmap, 0L, i18n("The left dockwidget"));
   AnotherWidget* aw( dockLeft);
   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.

Additionally, you get a toolbar for showing and hiding the 4 main dockwidgets which are docked to the actual mainwidget (that is usually a dockwidget as well).

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.

 KDockMainWindow ( const char *name = 0L )

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

Parameters:
nameobject name

KDockMainWindow ()

[virtual]

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.

Parameters:
_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.

Parameters:
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 ( KConfig* c = 0L, QString group = QString::null )

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

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

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

Parameters:
dockthe dockwidget that is to be shown

void  makeDockInvisible ( KDockWidget* dock )

This method hides the given dockwidget.

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

Parameters:
_any widget that should become the main view

Reimplemented from KTMainWindow.

void  slotDockChange ()

[protected slot]

Updates the dock-toolbar buttons and the internal information about the 4 dockwidgets that are directly docked to the main widget.

void  slotToggled ( int )

[protected slot]

Inverts the state of the appropriate toggle-toolbutton of the dock-toolbar.

Parameters:
_index of the toolbutton

void  slotReplaceDock ( KDockWidget* oldDock, KDockWidget* newDock )

[protected slot]

Using the given parameters it updates the information about the 4 dockwidgets that are directly docked to the main widget.

Parameters:
oldDocknew main dockwidget
newDockold main dockwidget

DockPosData (struct)

[protected]

Used as container for information about one of the 4 dockwidgets that are directly docked to the main dockwidget.

void  toolBarManager ( bool toggled, DockPosData &data )

[protected]

This method docks as given in the position data, if toggled is true. Otherwise the dockwidget given with the position data will be undocked.

Parameters:
toggledspecifies if the dockwidget gets docked or undocked
datareference to the struct containing information about the appropriate dockwidget

KDockWidget* mainDockWidget

[protected]

A pointer to the main dockwidget (where one can manualDock() to

KDockManager* dockManager

[protected]

A pointer to the manager for the dock process

DockPosData DockL

[protected]

Contains information about which dockwidget is docked on the left.

DockPosData DockR

[protected]

Contains information about which dockwidget is docked on the right.

DockPosData DockT

[protected]

Contains information about which dockwidget is docked at the top.

DockPosData DockB

[protected]

Contains information about which dockwidget is docked at the bottom.

KToolBar* toolbar

[protected]

A pointer to the dock toolbar (for showing or hiding the 4 docked dockwidgets that are docked to the main dockwidget).