---

KDockManager Class Reference

#include <kdockwidget.h>

List of all members.

Signals
void	change ()
void	replaceDock (KDockWidget *oldDock, KDockWidget *newDock)
void	setDockDefaultPos (KDockWidget *)
Public Methods
	KDockManager (QWidget *mainWindow, const char *name=0L)
virtual	~KDockManager ()
void	writeConfig (KConfig *c=0L, QString group=QString::null)
void	readConfig (KConfig *c=0L, QString group=QString::null)
void	setMainDockWidget2 (KDockWidget *)
	Since: 3.1
void	writeConfig (QDomElement &base)
void	readConfig (QDomElement &base)
void	activate ()
virtual bool	eventFilter (QObject *, QEvent *)
KDockWidget *	findWidgetParentDock (QWidget *w) const
void	makeWidgetDockVisible (QWidget *w)
QPopupMenu *	dockHideShowMenu () const
KDockWidget *	getDockWidgetFromName (const QString &dockName)
void	setSplitterOpaqueResize (bool b=true)
bool	splitterOpaqueResize () const
void	setSplitterKeepSize (bool b=true)
bool	splitterKeepSize () const
void	setSplitterHighResolution (bool b=true)
bool	splitterHighResolution () const

---

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.

Author:

Max Judin (documentation: Falk Brettschneider).

Definition at line 834 of file kdockwidget.h.

---

Constructor & Destructor Documentation

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

Constructs a dockmanager. Some initialization happen: It installs an event filter for the main window, a control list for dock objects a control list for menu items concerning to menus provided by the dockmanager Some state variables are set Parameters: mainWindow  the main window controlled by this name  the internal QOject name

virtual KDockManager::~KDockManager (    )  [virtual]

Destructs a dockmanager.

---

Member Function Documentation

void KDockManager::activate (    )

Shows all encapsulated widgets of all controlled dockwidgets and shows all dockwidgets which are parent of a dockwidget tab group. Referenced by KDockMainWindow::activateDock().

void KDockManager::change (    )  [signal]

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

QPopupMenu* KDockManager::dockHideShowMenu (    )  const [inline]

Returns: the popupmenu for showing/hiding dockwidgets Definition at line 936 of file kdockwidget.h. Referenced by KDockMainWindow::dockHideShowMenu().

virtual bool KDockManager::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: _  the object that sends the event _  the event Returns: the return value of the method call of the base class method

KDockWidget* KDockManager::findWidgetParentDock (  QWidget *    w )  const

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: w  any widget that is supposed to be encapsulated by one of the controlled dockwidgets Returns: the dockwidget that encapsulates that widget, otherwise 0

KDockWidget* KDockManager::getDockWidgetFromName (  const QString &    dockName )

Parameters: dockName  an internal QObject name Returns: the dockwidget that has got that internal QObject name

void KDockManager::makeWidgetDockVisible (  QWidget *    w )  [inline]

Works like makeDockVisible() but can be called for widgets that covered by a dockwidget. Parameters: w  the widget that is encapsulated by a dockwidget that turns to visible. Definition at line 931 of file kdockwidget.h. References KDockWidget::makeDockVisible().

void KDockManager::readConfig (  QDomElement &    base )

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

void KDockManager::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: c  the KDE configuration saver group  the name of the section in KConfig

void KDockManager::replaceDock (  KDockWidget *    oldDock, KDockWidget *    newDock )  [signal]

Signals a dockwidget is replaced with another one.

void KDockManager::setDockDefaultPos (  KDockWidget *    )  [signal]

Signals a dockwidget without parent (toplevel) is shown.

void KDockManager::setSplitterHighResolution (  bool    b = true )

Operate the splitter with a higher resolution. Off by default. Call this method before you create any dock widgets! If high resolution is used all splitter position parameters are percent*100 instead of percent.

void KDockManager::setSplitterKeepSize (  bool    b = true )

Try to preserve the widget's size. Works like KeepSize resize mode of QSplitter. Off by default. Call this method before you create any dock widgets!

void KDockManager::setSplitterOpaqueResize (  bool    b = true )

Enables opaque resizing. Opaque resizing is initially turned off. Call this method before you create any dock widgets!

bool KDockManager::splitterHighResolution (    )

Returns TRUE if the splitter uses the high resolution, FALSE otherwise.

bool KDockManager::splitterKeepSize (    )

Returns TRUE if the KeepSize is enabled, FALSE otherwise.

bool KDockManager::splitterOpaqueResize (    )

Returns TRUE if opaque resizing is enabled, FALSE otherwise.

void KDockManager::writeConfig (  QDomElement &    base )

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

void KDockManager::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: c  the KDE configuration saver group  the name of the section in KConfig

---

The documentation for this class was generated from the following file:

• kdockwidget.h

---