kdeui Library API Documentation

KDockManager Class Reference

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

#include <kdockwidget.h>

Inheritance diagram for KDockManager:

QObject List of all members.

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

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 904 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

Definition at line 1601 of file kdockwidget.cpp.

References QObject::connect(), KGlobalSettings::opaqueResize(), and QPtrList::setAutoDelete().

KDockManager::~KDockManager  )  [virtual]
 

Destructs a dockmanager.

Definition at line 1656 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 2513 of file kdockwidget.cpp.

References QMainWindow::centralWidget(), KGlobal::config(), KDockWidget::d, KDockWidget::firstName, KDockWidget::formerBrotherDockWidget, KDockWidget::formerDockPos, QWidget::frameGeometry(), getDockWidgetFromName(), KDockMainWindow::getMainDockWidget(), KDockWidget::header, KDockWidgetPrivate::isContainer, QString::isEmpty(), KDockWidget::isGroup, KDockWidget::isTabGroup, QWidget::isVisible(), KDockWidget::lastName, QString::latin1(), KDockWidgetAbstractHeader::saveConfig(), KConfigBase::setGroup(), QWidget::size(), KDockWidget::splitterOrientation, KConfigBase::sync(), KDockWidget::tabPageLabel(), KDockWidget::toolTipString(), KDockWidget::widget, and KConfigBase::writeEntry().

Referenced by KDockArea::writeDockConfig(), and KDockMainWindow::writeDockConfig().

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 2655 of file kdockwidget.cpp.

References activate(), KDockWidget::applyToWidget(), KGlobal::config(), KDockWidget::d, finishReadDockConfig(), KDockWidget::formerDockPos, getDockWidgetFromName(), KDockWidget::header, QWidget::hide(), KDockWidgetPrivate::isContainer, QString::isEmpty(), KDockWidget::isGroup, KDockWidget::isTabGroup, QWidget::isVisible(), QString::latin1(), KDockWidgetAbstractHeader::loadConfig(), KDockWidget::manualDock(), QWidget::move(), QObject::name(), QTabWidget::page(), KConfigBase::readBoolEntry(), KConfigBase::readEntry(), KConfigBase::readListEntry(), KConfigBase::readNumEntry(), KConfigBase::readRectEntry(), removeFromAutoCreateList(), QWidget::resize(), KDockWidget::setFormerBrotherDockWidget(), QWidget::setGeometry(), KConfigBase::setGroup(), KDockMainWindow::setMainDockWidget(), KDockWidget::setTabPageLabel(), KDockWidget::setToolTipString(), KDockMainWindow::setView(), QWidget::show(), KDockWidget::show(), QTabWidget::showPage(), QRect::size(), QRect::topLeft(), KDockWidget::undock(), and KDockWidget::widget.

Referenced by KDockArea::readDockConfig(), and KDockMainWindow::readDockConfig().

void KDockManager::setMainDockWidget2 KDockWidget  ) 
 

Since:
3.1

Definition at line 1651 of file kdockwidget.cpp.

Referenced by KDockMainWindow::setMainDockWidget().

void KDockManager::writeConfig QDomElement base  ) 
 

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

Definition at line 2183 of file kdockwidget.cpp.

References QMainWindow::centralWidget(), QDomDocument::createElement(), KDockWidget::d, KDockWidgetHeader::dragEnabled(), KDockWidget::firstName, KDockWidget::formerBrotherDockWidget, KDockWidget::formerDockPos, QWidget::frameGeometry(), QString::fromLatin1(), getDockWidgetFromName(), KDockMainWindow::getMainDockWidget(), KDockWidget::header, KDockWidgetPrivate::isContainer, KDockWidget::isGroup, KDockWidget::isTabGroup, QWidget::isVisible(), KDockWidget::lastName, QString::latin1(), QWidget::size(), KDockWidget::splitterOrientation, KDockWidget::tabPageLabel(), KDockWidget::toolTipString(), and KDockWidget::widget.

void KDockManager::readConfig QDomElement base  ) 
 

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

Definition at line 2295 of file kdockwidget.cpp.

References activate(), KDockWidget::applyToWidget(), KDockWidget::d, endl(), finishReadDockConfig(), KDockWidget::formerDockPos, getDockWidgetFromName(), KDockWidget::getWidget(), KDockWidget::header, QWidget::hide(), KDockWidgetPrivate::isContainer, QString::isEmpty(), KDockWidget::isGroup, QDomNode::isNull(), KDockWidget::isTabGroup, QWidget::isVisible(), kdDebug(), QString::latin1(), KDockWidget::manualDock(), QWidget::move(), QObject::name(), QDomNode::nextSibling(), QTabWidget::page(), removeFromAutoCreateList(), QWidget::resize(), QMainWindow::setCentralWidget(), KDockWidgetHeader::setDragEnabled(), KDockWidget::setFormerBrotherDockWidget(), QWidget::setGeometry(), KDockMainWindow::setMainDockWidget(), KDockWidget::setTabPageLabel(), KDockWidget::setToolTipString(), QWidget::show(), KDockWidget::show(), QTabWidget::showPage(), QRect::size(), QDomElement::tagName(), QDomNode::toElement(), QRect::topLeft(), KDockWidget::undock(), KDockWidget::updateHeader(), and KDockWidget::widget.

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 1672 of file kdockwidget.cpp.

References KDockWidget::parentDockTabGroup(), KDockWidget::show(), QWidget::show(), and KDockWidget::widget.

Referenced by KDockArea::activateDock(), KDockMainWindow::activateDock(), and readConfig().

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 1687 of file kdockwidget.cpp.

References KDockWidget::currentDockPos, KDockWidget::dockBack(), KDockWidget::eDocking, QObject::eventFilter(), QWidget::geometry(), QObject::inherits(), QWidget::mapFromGlobal(), QWidget::mapToGlobal(), QWidget::move(), QCursor::pos(), QWidget::setFocus(), KDockWidget::toDesktop(), and QEvent::type().

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 2934 of file kdockwidget.cpp.

References KDockWidget::widget.

Referenced by KDockArea::makeWidgetDockVisible(), and KDockMainWindow::makeWidgetDockVisible().

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

QPopupMenu* KDockManager::dockHideShowMenu  )  const [inline]
 

Returns:
the popupmenu for showing/hiding dockwidgets

Definition at line 1015 of file kdockwidget.h.

Referenced by KDockArea::dockHideShowMenu(), and KDockMainWindow::dockHideShowMenu().

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 2857 of file kdockwidget.cpp.

References endl(), kdDebug(), KDockWidget, and QString::latin1().

Referenced by readConfig(), and writeConfig().

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 2874 of file kdockwidget.cpp.

bool KDockManager::splitterOpaqueResize  )  const
 

Returns true if opaque resizing is enabled, false otherwise.

Definition at line 2879 of file kdockwidget.cpp.

Referenced by KDockWidget::manualDock().

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 2884 of file kdockwidget.cpp.

bool KDockManager::splitterKeepSize  )  const
 

Returns true if the KeepSize is enabled, false otherwise.

Definition at line 2889 of file kdockwidget.cpp.

Referenced by KDockWidget::manualDock().

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.

Definition at line 2894 of file kdockwidget.cpp.

bool KDockManager::splitterHighResolution  )  const
 

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

Definition at line 2899 of file kdockwidget.cpp.

Referenced by KDockWidget::manualDock().

void KDockManager::setSpecialLeftDockContainer KDockWidget container  ) 
 

Since:
3.2

Definition at line 3007 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.

Referenced by KDockWidget::event(), KDockWidget::manualDock(), and KDockWidget::undock().

void KDockManager::replaceDock KDockWidget oldDock,
KDockWidget newDock
[signal]
 

Signals a dockwidget is replaced with another one.

Referenced by KDockWidget::manualDock(), and KDockWidget::undock().

void KDockManager::setDockDefaultPos KDockWidget  )  [signal]
 

Signals a dockwidget without parent (toplevel) is shown.

Referenced by KDockWidget::show().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kdeui Library Version 3.4.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Mon Jun 12 11:31:31 2006 by doxygen 1.4.4 written by Dimitri van Heesch, © 1997-2003