berry::HandleObjectManager Class Reference

#include <berryHandleObjectManager.h>

Inheritance diagram for berry::HandleObjectManager:

Protected Types
typedef QSet< SmartPointer< HandleObject > >	HandleObjectsSet
typedef QHash< QString, SmartPointer< HandleObject > >	HandleObjectsByIdMap

Protected Member Functions
void	CheckId (const QString &id) const
QSet< QString >	GetDefinedHandleObjectIds () const

Protected Attributes
HandleObjectsSet	definedHandleObjects
HandleObjectsByIdMap	handleObjectsById

Detailed Description

A manager of HandleObject instances. This has some common behaviour which is shared between all such managers.

Clients may extend.

Definition at line 41 of file berryHandleObjectManager.h.

Member Typedef Documentation

typedef QHash<QString, SmartPointer<HandleObject> > berry::HandleObjectManager::HandleObjectsByIdMap

protected

Definition at line 47 of file berryHandleObjectManager.h.

typedef QSet<SmartPointer<HandleObject> > berry::HandleObjectManager::HandleObjectsSet

protected

Definition at line 46 of file berryHandleObjectManager.h.

Member Function Documentation

void berry::HandleObjectManager::CheckId ( const QString &  id ) const

protected

Verifies that the identifier is valid. Exceptions will be thrown if the identifier is invalid in some way.

Parameters

id	The identifier to validate; may be anything.

Definition at line 24 of file berryHandleObjectManager.cpp.

Referenced by berry::CommandManager::GetCategory(), berry::CommandManager::GetCommand(), and berry::CommandManager::GetParameterType().

QSet< QString > berry::HandleObjectManager::GetDefinedHandleObjectIds ( ) const

protected

Returns the set of identifiers for those handle objects that are defined.

Returns

The set of defined handle object identifiers; this value may be empty, but it is never null.

Definition at line 33 of file berryHandleObjectManager.cpp.

References definedHandleObjects.

Referenced by berry::CommandManager::GetDefinedCommandIds().

Member Data Documentation

HandleObjectsSet berry::HandleObjectManager::definedHandleObjects

protected

The set of handle objects that are defined. This value may be empty, but it is never null.

Definition at line 53 of file berryHandleObjectManager.h.

Referenced by berry::CommandManager::GetDefinedCommands(), and GetDefinedHandleObjectIds().

HandleObjectsByIdMap berry::HandleObjectManager::handleObjectsById

protected

The map of identifiers (String) to handle objects ( HandleObject). This collection may be empty, but it is never null.

Definition at line 60 of file berryHandleObjectManager.h.

Referenced by berry::CommandManager::AddExecutionListener(), berry::CommandManager::GetAllCommands(), berry::CommandManager::GetCommand(), berry::CommandManager::RemoveExecutionListener(), and berry::CommandManager::SetHandlersByCommandId().

---

The documentation for this class was generated from the following files:

• berryHandleObjectManager.h
• berryHandleObjectManager.cpp