KDevelop API Documentation

ToolDockBaseState Class Reference

The state of a tool window's dock base (minor helper class). More...

List of all members.

Public Member Functions

 ToolDockBaseState (const QPtrList< QWidget > *pViews)

Public Attributes

KDockWidgetpDockBaseWindow
 Pointer to the window which contains all tool windows (may be equal to pDockWidget).

QWidgetpFirstToolWindow
 The first tool window found.

bool hasDockBaseWindow
 true if there is at least one parent tool window

bool dockBaseIsHidden
 true if there is a parent and it is hidden

bool dockBaseIsVisible
 true if there is a parent and it is visible

bool dockBaseMayBeDockBack
 true if thre is a parent tool window and it may be dock back

int noViews
 number of single tool windows visible


Detailed Description

The state of a tool window's dock base (minor helper class).

For a description how tool windows are embedded into the main window see ToolWindowState.

This class takes a list of tool window , figures out who is the dock base window for them and determines various state flags for the dock base. Additionaly, it counts how many tool views of the list are visible (member noViews)

Usage

const ToolDockBaseState dockBaseState(m_outputViews); //MainWindow::m_outputViews // now you can use all of dockBaseState's contents, e. g. if (dockBaseState.hasDockBaseWindow) dockBaseState.pDockBaseWindow->... ...
Making dockBaseState 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.

Definition at line 185 of file mainwindow.cpp.


Constructor & Destructor Documentation

ToolDockBaseState::ToolDockBaseState const QPtrList< QWidget > *  pViews  ) 
 

Definition at line 198 of file mainwindow.cpp.

References dockBaseIsHidden, ToolWindowState::dockBaseIsHidden, ToolWindowState::dockBaseIsVisible, dockBaseIsVisible, ToolWindowState::dockBaseMayBeDockBack, dockBaseMayBeDockBack, hasDockBaseWindow, ToolWindowState::hasDockBaseWindow, noViews, ToolWindowState::pDockBaseWindow, pDockBaseWindow, pFirstToolWindow, ToolDockBaseState(), and ToolWindowState::viewMenuChecked.

Referenced by ToolDockBaseState().


Member Data Documentation

bool ToolDockBaseState::dockBaseIsHidden
 

true if there is a parent and it is hidden

Definition at line 192 of file mainwindow.cpp.

Referenced by MainWindow::fillToolViewsMenu(), MainWindow::showAllToolWin(), MainWindow::toggleToolDockBaseState(), and ToolDockBaseState().

bool ToolDockBaseState::dockBaseIsVisible
 

true if there is a parent and it is visible

Definition at line 193 of file mainwindow.cpp.

Referenced by MainWindow::toggleToolDockBaseState(), ToolDockBaseState(), and MainWindow::updateActionState().

bool ToolDockBaseState::dockBaseMayBeDockBack
 

true if thre is a parent tool window and it may be dock back

Definition at line 194 of file mainwindow.cpp.

Referenced by MainWindow::toggleToolDockBaseState(), and ToolDockBaseState().

bool ToolDockBaseState::hasDockBaseWindow
 

true if there is at least one parent tool window

Definition at line 191 of file mainwindow.cpp.

Referenced by MainWindow::fillToolViewsMenu(), and ToolDockBaseState().

int ToolDockBaseState::noViews
 

number of single tool windows visible

Definition at line 195 of file mainwindow.cpp.

Referenced by MainWindow::fillToolViewsMenu(), MainWindow::toggleSingleToolWin(), and ToolDockBaseState().

KDockWidget* ToolDockBaseState::pDockBaseWindow
 

Pointer to the window which contains all tool windows (may be equal to pDockWidget).

Definition at line 189 of file mainwindow.cpp.

Referenced by MainWindow::toggleToolDockBaseState(), and ToolDockBaseState().

QWidget* ToolDockBaseState::pFirstToolWindow
 

The first tool window found.

Definition at line 190 of file mainwindow.cpp.

Referenced by ToolDockBaseState().


The documentation for this class was generated from the following file:
KDE Logo
This file is part of the documentation for KDevelop Version 3.0.4.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Wed Oct 6 17:39:31 2004 by doxygen 1.3.7 written by Dimitri van Heesch, © 1997-2003