umbrello API Documentation

ToolBarStatePool Class Reference

Base class for tools that can use the same state but with different button. More...

#include <toolbarstatepool.h>

Inheritance diagram for ToolBarStatePool:

ToolBarState ToolBarStateAssociation ToolBarStateMessages ToolBarStateOther List of all members.

Public Member Functions

virtual ~ToolBarStatePool ()
 Destroys this ToolBarStatePool.
void setButton (const WorkToolBar::ToolBar_Buttons &button)
 Sets the current button and inits the tool.
WorkToolBar::ToolBar_Buttons getButton () const
 Returns the current button.

Protected Member Functions

 ToolBarStatePool (UMLView *umlView)
 Creates a new ToolBarStatePool.

Detailed Description

Base class for tools that can use the same state but with different button.

This class only adds support to specify the button currently in use for a tool bar state.

Definition at line 24 of file toolbarstatepool.h.


Constructor & Destructor Documentation

ToolBarStatePool::~ToolBarStatePool  )  [virtual]
 

Destroys this ToolBarStatePool.

Definition at line 15 of file toolbarstatepool.cpp.

ToolBarStatePool::ToolBarStatePool UMLView umlView  )  [protected]
 

Creates a new ToolBarStatePool.

Protected to avoid classes other than derived to create objects of this class.

Parameters:
umlView The UMLView to use.

Definition at line 26 of file toolbarstatepool.cpp.


Member Function Documentation

void ToolBarStatePool::setButton const WorkToolBar::ToolBar_Buttons button  ) 
 

Sets the current button and inits the tool.

If the current button is the same to the button to set, the tool isn't initialized.

Parameters:
button The button to set.

Definition at line 18 of file toolbarstatepool.cpp.

References ToolBarState::init().

WorkToolBar::ToolBar_Buttons ToolBarStatePool::getButton  )  const [inline]
 

Returns the current button.

Returns:
The current button.

Definition at line 47 of file toolbarstatepool.h.

Referenced by ToolBarStateMessages::getMessageType().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for umbrello Version 3.1.0.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Tue Jun 26 08:08:06 2007 by doxygen 1.4.1 written by Dimitri van Heesch, © 1997-2003