class KDockManager

The manager that knows all dockwidgets and handles the dock process (and member of the dockwidget class set). More...

Definition#include <kdockwidget.h>
InheritsQObject (kdecore)
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Methods

Signals


Detailed Description

The manager that knows all dockwidgets and handles the dock process (and member of the dockwidget class set). More or less a helper class for the KDockWidget class set but of interest for some functionality that can be called within a KDockMainWindow or a KDockWidget .

An important feature is the ability to read or save the current state of all things concerning to dockwidgets to KConfig .

The dockmanager is also often used when a certain dockwidget or a child of such dockwidget must be found.

Note: the docking itself is handled by another private class (KDockMoveManager).

 KDockManager ( QWidget* mainWindow, const char* name = 0L )

Constructs a dockmanager. Some initialization happen:

Parameters:

KDockManager ()

[virtual]

Destructs a dockmanager.

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

Saves the current state of the dockmanager and of all controlled widgets. State means here to save the geometry, visibility, parents, internal object names, orientation, separator positions, dockwidget-group information, tab widget states (if it is a tab group) and last but not least some necessary things for recovering the dockmainwindow state.

Parameters:

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

Like writeConfig but reads the whole stuff in.

In order to restore a window configuration from a config file, it looks up widgets by name (QObject::name) in the childDock variable of KDockManager. This list in turn contains all KDockWidgets (according to the KDockWidget constructor). So in principle, in order to restore a window layout, one must first construct all widgets, put each of them in a KDockWidget and then call readConfig(). And for all that to work, each widget must have a unique name.

Parameters:

void  activate ()

Shows all encapsulated widgets of all controlled dockwidgets and shows all dockwidgets which are parent of a dockwidget tab group.

bool  eventFilter ( QObject *, QEvent * )

[virtual]

It's more or less a method that catches several events which are interesting for the dockmanager. Mainly mouse events during the drag process of a dockwidgets are of interest here.

Parameters:

Returns: the return value of the method call of the base class method

KDockWidget*  findWidgetParentDock ( QWidget* w)

This method finds out what a widgets' dockwidget is. That means the dockmanager has a look at all dockwidgets it knows and tells you when one of those dockwidgets covers the given widget.

Parameters:

Returns: the dockwidget that encapsulates that widget, otherwise 0

void  makeWidgetDockVisible ( QWidget* w )

Works like makeDockVisible() but can be called for widgets that covered by a dockwidget.

Parameters:

QPopupMenu*  dockHideShowMenu ()

Returns: the popupmenu for showing/hiding dockwidgets

KDockWidget*  getDockWidgetFromName ( const QString& dockName )

Parameters:

Returns: the dockwidget that has got that internal QObject name

void  change ()

[signal]

Signals changes of the docking state of a dockwidget. Usually the dock-toolbar will be updated then.

void  replaceDock ( KDockWidget* oldDock, KDockWidget* newDock )

[signal]

Signals a dockwidget is replaced with another one.

void  setDockDefaultPos ( KDockWidget* )

[signal]

Signals a dockwidget without parent (toplevel) is shown.