ToolWindowState Class Reference
The state of a single tool window (minor helper class). More...Public Member Functions | |
ToolWindowState (KDockWidget *pDockWidget) | |
Public Attributes | |
bool | hasDockWidget |
Is there a DockWidget (pDockWidget != 0). | |
KDockTabGroup * | pTabGroup |
Pointer to the parent tab group or 0. | |
bool | hasTabGroup |
true if there is a parent tab group | |
bool | mayBeShown |
true if there is a DockWidget and it may be shown | |
bool | mayBeHide |
true if there is a DockWidget and it may be hidden | |
KDockWidget * | pDockBaseWindow |
Pointer to the window which contains all tool windows (may be equal to pDockWidget). | |
bool | hasDockBaseWindow |
true, if there is a dockBaseWindow | |
bool | dockBaseMayBeShow |
true if thre is a dock base window and it may be shown | |
bool | dockBaseMayBeHide |
true if thre is a dock base window and it may be hidden | |
bool | dockBaseMayBeDockBack |
true if thre is a dock base window and it may be dock back | |
bool | dockBaseIsTopLevel |
QString | dockBaseName |
bool | viewMenuChecked |
true if the view menu item which belongs to pDockWidget should be checked | |
bool | viewMenuEnabled |
true if the view menu item which belongs to pDockWidget should be enabled | |
bool | dockBaseIsHidden |
bool | dockBaseIsVisible |
true if there is a dock base and it is visible |
Detailed Description
The state of a single tool window (minor helper class).If a tool window (type QWidget) has to be displayed, it is wrapped by a KMdiChildView which in turn is embedded into a KDockWidget.
This class works on the KDockWidget wrapper for the tool windows.
A tool window (type KDockWidget) is embedded into the main window in 2 ways depending on the number of tool windows:
- If there is just one tool window, the tool window is embedded into a KDockWidget which is docked directely to the main window or which is top level, depending on the mdi mode.
- If there is more than one tool window, the tool windows are put into a KDockTabWidget which is embedded into another KDockWidget which in turn is docked to the main window or which is top level, depending on the mdi mode. A tool windows parent can This class figures out how a single tool window is embedded. It determines the various states of the tool window, its parent tab group and its dock base if those exist.
Usage
if you have a KDockWidget which represents a tool window, just use
Making winState constant makes shure nobody changes its contents after it has been created. It would have also been possible to make all members private and use access functions, but I don't think it is worth the trouble.KDockWidget *pDockWidget = ... const ToolWindowState winState(pKDockWidget); // now you can use all of winState's contents, e. g. if (winState.hasDockBaseWindow) winState.pDockBaseWindow->... ...
Definition at line 115 of file mainwindow.cpp.
Constructor & Destructor Documentation
|
Member Data Documentation
|
Definition at line 133 of file mainwindow.cpp. Referenced by ToolDockBaseState::ToolDockBaseState(), and ToolWindowState(). |
|
Definition at line 129 of file mainwindow.cpp. Referenced by ToolWindowState(). |
|
true if there is a dock base and it is visible
Definition at line 134 of file mainwindow.cpp. Referenced by ToolDockBaseState::ToolDockBaseState(), and ToolWindowState(). |
|
true if thre is a dock base window and it may be dock back
Definition at line 128 of file mainwindow.cpp. Referenced by ToolDockBaseState::ToolDockBaseState(), and ToolWindowState(). |
|
true if thre is a dock base window and it may be hidden
Definition at line 127 of file mainwindow.cpp. Referenced by ToolWindowState(). |
|
true if thre is a dock base window and it may be shown
Definition at line 126 of file mainwindow.cpp. Referenced by ToolWindowState(). |
|
Definition at line 130 of file mainwindow.cpp. Referenced by ToolWindowState(). |
|
true, if there is a dockBaseWindow
Definition at line 125 of file mainwindow.cpp. Referenced by ToolDockBaseState::ToolDockBaseState(), and ToolWindowState(). |
|
Is there a DockWidget (pDockWidget != 0).
Definition at line 119 of file mainwindow.cpp. Referenced by MainWindow::toggleSingleToolWin(), and ToolWindowState(). |
|
true if there is a parent tab group
Definition at line 121 of file mainwindow.cpp. Referenced by MainWindow::toggleSingleToolWin(), and ToolWindowState(). |
|
true if there is a DockWidget and it may be hidden
Definition at line 123 of file mainwindow.cpp. Referenced by MainWindow::toggleSingleToolWin(), and ToolWindowState(). |
|
true if there is a DockWidget and it may be shown
Definition at line 122 of file mainwindow.cpp. Referenced by MainWindow::toggleSingleToolWin(), and ToolWindowState(). |
|
Pointer to the window which contains all tool windows (may be equal to pDockWidget).
Definition at line 124 of file mainwindow.cpp. Referenced by ToolDockBaseState::ToolDockBaseState(), and ToolWindowState(). |
|
Pointer to the parent tab group or 0.
Definition at line 120 of file mainwindow.cpp. Referenced by MainWindow::toggleSingleToolWin(), and ToolWindowState(). |
|
true if the view menu item which belongs to pDockWidget should be checked
Definition at line 131 of file mainwindow.cpp. Referenced by MainWindow::fillToolViewsMenu(), MainWindow::showAllToolWin(), ToolDockBaseState::ToolDockBaseState(), and ToolWindowState(). |
|
true if the view menu item which belongs to pDockWidget should be enabled
Definition at line 132 of file mainwindow.cpp. Referenced by ToolWindowState(). |
The documentation for this class was generated from the following file:
- src/mainwindow.cpp