KDockManager Class Reference

#include <kdockwidget.h>

Inheritance diagram for KDockManager:

QObject

List of all members.


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 907 of file kdockwidget.h.


Public Types

enum  EnReadDockConfigMode { Unknown, WrapExistingWidgetsOnly, RestoreAllDockwidgets }

Signals

void change ()
void replaceDock (KDockWidget *oldDock, KDockWidget *newDock)
void setDockDefaultPos (KDockWidget *)

Public Member Functions

 KDockManager (QWidget *mainWindow, const char *name=0L)
virtual ~KDockManager ()
void dumpDockWidgets ()
void writeConfig (KConfig *c=0L, QString group=QString::null)
void readConfig (KConfig *c=0L, QString group=QString::null)
void setMainDockWidget2 (KDockWidget *)
void writeConfig (QDomElement &base)
void readConfig (QDomElement &base)
void activate ()
virtual bool eventFilter (QObject *object, QEvent *event)
KDockWidgetfindWidgetParentDock (QWidget *w) const
void makeWidgetDockVisible (QWidget *w)
QPopupMenudockHideShowMenu () const
KDockWidgetgetDockWidgetFromName (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
void setSpecialLeftDockContainer (KDockWidget *container)
void setSpecialTopDockContainer (KDockWidget *container)
void setSpecialRightDockContainer (KDockWidget *container)
void setSpecialBottomDockContainer (KDockWidget *container)
void removeFromAutoCreateList (KDockWidget *pDockWidget)
void finishReadDockConfig ()
void setReadDockConfigMode (int mode)

Protected Member Functions

virtual void virtual_hook (int id, void *data)

Friends

class KDockWidget
class KDockMainWindow

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

Definition at line 1617 of file kdockwidget.cpp.

KDockManager::~KDockManager (  )  [virtual]

Destructs a dockmanager.

Definition at line 1670 of file kdockwidget.cpp.


Member Function Documentation

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

Definition at line 2527 of file kdockwidget.cpp.

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

Definition at line 2669 of file kdockwidget.cpp.

void KDockManager::setMainDockWidget2 ( KDockWidget w  ) 

Since:
3.1

Definition at line 1665 of file kdockwidget.cpp.

void KDockManager::writeConfig ( QDomElement base  ) 

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

Definition at line 2197 of file kdockwidget.cpp.

void KDockManager::readConfig ( QDomElement base  ) 

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

Definition at line 2309 of file kdockwidget.cpp.

void KDockManager::activate (  ) 

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

Definition at line 1686 of file kdockwidget.cpp.

bool KDockManager::eventFilter ( QObject object,
QEvent event 
) [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:
object the object that sends the event
event the event
Returns:
the return value of the method call of the base class method

Reimplemented from QObject.

Definition at line 1701 of file kdockwidget.cpp.

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

Definition at line 2953 of file kdockwidget.cpp.

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 1013 of file kdockwidget.h.

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

Returns:
the popupmenu for showing/hiding dockwidgets

Definition at line 1018 of file kdockwidget.h.

KDockWidget * KDockManager::getDockWidgetFromName ( const QString dockName  ) 

Parameters:
dockName an internal QObject name

Returns:
the dockwidget that has got that internal QObject name

Definition at line 2876 of file kdockwidget.cpp.

void KDockManager::setSplitterOpaqueResize ( bool  b = true  ) 

Enables opaque resizing.

Opaque resizing defaults to KGlobalSettings::opaqueResize(). Call this method before you create any dock widgets!

Definition at line 2893 of file kdockwidget.cpp.

bool KDockManager::splitterOpaqueResize (  )  const

Returns true if opaque resizing is enabled, false otherwise.

Definition at line 2898 of file kdockwidget.cpp.

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!

Definition at line 2903 of file kdockwidget.cpp.

bool KDockManager::splitterKeepSize (  )  const

Returns true if the KeepSize is enabled, false otherwise.

Definition at line 2908 of file kdockwidget.cpp.

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.

Note:
Since KDE 3.5 this is ignored. Internally the splitter always calcualtes in high resolution values. For KDE 4, this will be removed.

Definition at line 2913 of file kdockwidget.cpp.

bool KDockManager::splitterHighResolution (  )  const

Returns true if the splitter uses the high resolution, false otherwise.

Definition at line 2918 of file kdockwidget.cpp.

void KDockManager::setSpecialLeftDockContainer ( KDockWidget container  ) 

Since:
3.2

Definition at line 3026 of file kdockwidget.cpp.

void KDockManager::change (  )  [signal]

Signals changes of the docking state of a dockwidget.

Usually the dock-toolbar will be updated then.

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.


The documentation for this class was generated from the following files:
KDE Home | KDE Accessibility Home | Description of Access Keys