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:


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) |
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 |
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) |
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
|
Constructs a dockmanager. Some initialization happen:
Definition at line 1601 of file kdockwidget.cpp. References KDockManager(), and KGlobalSettings::opaqueResize(). Referenced by KDockManager(). |
|
Destructs a dockmanager.
Definition at line 1656 of file kdockwidget.cpp. |
Member Function Documentation
|
|
|
Definition at line 1651 of file kdockwidget.cpp. References setMainDockWidget2(). Referenced by KDockMainWindow::setMainDockWidget(), and setMainDockWidget2(). |
|
Saves the current dock window layout into a DOM tree below the given element.
Definition at line 2183 of file kdockwidget.cpp. References KDockWidget::d, KDockWidgetHeader::dragEnabled(), KDockWidget::firstName, KDockWidget::formerBrotherDockWidget, KDockWidget::formerDockPos, getDockWidgetFromName(), KDockMainWindow::getMainDockWidget(), KDockWidget::header, KDockWidgetPrivate::isContainer, KDockWidget::isGroup, KDockWidget::isTabGroup, KDockWidget::lastName, KDockWidget::splitterOrientation, KDockWidget::tabPageLabel(), KDockWidget::toolTipString(), KDockWidget::widget, and writeConfig(). |
|
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(), KDockWidget::formerDockPos, getDockWidgetFromName(), KDockWidget::getWidget(), KDockWidget::header, KDockWidgetPrivate::isContainer, KDockWidget::isGroup, KDockWidget::isTabGroup, kdDebug(), KDockWidget::manualDock(), readConfig(), KDockWidgetHeader::setDragEnabled(), KDockWidget::setFormerBrotherDockWidget(), KDockMainWindow::setMainDockWidget(), KDockWidget::setTabPageLabel(), KDockWidget::setToolTipString(), KDockWidget::show(), KDockWidget::undock(), KDockWidget::updateHeader(), and KDockWidget::widget. |
|
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(), and KDockWidget::widget. Referenced by KDockMainWindow::activateDock(), and readConfig(). |
|
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.
Definition at line 1687 of file kdockwidget.cpp. References KDockWidget::currentDockPos, KDockWidget::dockBack(), KDockWidget::eDocking, eventFilter(), and KDockWidget::toDesktop(). Referenced by eventFilter(). |
|
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.
Definition at line 2934 of file kdockwidget.cpp. References findWidgetParentDock(), and KDockWidget::widget. Referenced by findWidgetParentDock(), and KDockMainWindow::makeWidgetDockVisible(). |
|
Works like makeDockVisible() but can be called for widgets that covered by a dockwidget.
Definition at line 1010 of file kdockwidget.h. References KDockWidget::makeDockVisible(). |
|
Definition at line 1015 of file kdockwidget.h. Referenced by KDockMainWindow::dockHideShowMenu(). |
|
Definition at line 2857 of file kdockwidget.cpp. References endl(), getDockWidgetFromName(), and kdDebug(). Referenced by getDockWidgetFromName(), readConfig(), and writeConfig(). |
|
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. References setSplitterOpaqueResize(). Referenced by setSplitterOpaqueResize(). |
|
Returns true if opaque resizing is enabled, false otherwise.
Definition at line 2879 of file kdockwidget.cpp. Referenced by KDockWidget::manualDock(). |
|
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. References setSplitterKeepSize(). Referenced by setSplitterKeepSize(). |
|
Returns true if the KeepSize is enabled, false otherwise.
Definition at line 2889 of file kdockwidget.cpp. Referenced by KDockWidget::manualDock(). |
|
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. References setSplitterHighResolution(). Referenced by setSplitterHighResolution(). |
|
Returns true if the splitter uses the high resolution, false otherwise.
Definition at line 2899 of file kdockwidget.cpp. Referenced by KDockWidget::manualDock(). |
|
Definition at line 3007 of file kdockwidget.cpp. References setSpecialLeftDockContainer(). Referenced by setSpecialLeftDockContainer(). |
|
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(). |
|
Signals a dockwidget is replaced with another one.
Referenced by KDockWidget::manualDock(), and KDockWidget::undock(). |
|
Signals a dockwidget without parent (toplevel) is shown.
Referenced by KDockWidget::show(). |
The documentation for this class was generated from the following files: