#include <berryNamedHandleObjectWithState.h>

Inheritance diagram for berry::NamedHandleObjectWithState:

Collaboration diagram for berry::NamedHandleObjectWithState:

Public Member Functions
	berryObjectMacro (berry::NamedHandleObjectWithState) void AddState(const QString &stateId

QString	GetDescription () const override

QString	GetName () const override

SmartPointer< State >	GetState (const QString &stateId) const override

QList< QString >	GetStateIds () const override

void	RemoveState (const QString &id) override

Public Member Functions inherited from berry::NamedHandleObject
	berryObjectMacro (NamedHandleObject)

Public Member Functions inherited from berry::HandleObject
	berryObjectMacro (HandleObject)

bool	operator== (const Object *object) const override

QString	GetId () const

virtual uint	HashCode () const override

bool	IsDefined () const

virtual void	Undefine ()=0

Public Member Functions inherited from berry::Object
virtual QString	GetClassName () const

virtual Reflection::TypeInfo	GetTypeInfo () const

virtual QList< Reflection::TypeInfo >	GetSuperclasses () const

virtual void	Delete ()

QDebug	Print (QDebug os, Indent Indent=0) const

virtual QString	ToString () const

virtual bool	operator< (const Object *) const

void	Register () const

void	UnRegister (bool del=true) const

int	GetReferenceCount () const

void	SetReferenceCount (int)

void	AddDestroyListener (const MessageAbstractDelegate<> &delegate) const

void	RemoveDestroyListener (const MessageAbstractDelegate<> &delegate) const

Public Member Functions inherited from berry::IObjectWithState
	berryObjectMacro (berry::IObjectWithState) virtual void AddState(const QString &id

Public Attributes
const SmartPointer< State > &state	override

Public Attributes inherited from berry::IObjectWithState
const SmartPointer< State > &	state

Protected Member Functions
	NamedHandleObjectWithState (const QString &id)

Protected Member Functions inherited from berry::NamedHandleObject
	NamedHandleObject (const QString &id)

Protected Member Functions inherited from berry::HandleObject
	HandleObject (const QString &id)

Protected Member Functions inherited from berry::Object
	Object ()

virtual	~Object ()

virtual QDebug	PrintSelf (QDebug os, Indent indent) const

virtual QDebug	PrintHeader (QDebug os, Indent indent) const

virtual QDebug	PrintTrailer (QDebug os, Indent indent) const

Additional Inherited Members
Public Types inherited from berry::Object
typedef Object	Self

typedef berry::SmartPointer< Self >	Pointer

typedef berry::SmartPointer< const Self >	ConstPointer

typedef berry::WeakPointer< Self >	WeakPtr

typedef berry::WeakPointer< const Self >	ConstWeakPtr

Static Public Member Functions inherited from berry::Object
static const char *	GetStaticClassName ()

static Reflection::TypeInfo	GetStaticTypeInfo ()

static QList< Reflection::TypeInfo >	GetStaticSuperclasses ()

Protected Attributes inherited from berry::NamedHandleObject
QString	description

QString	name

Protected Attributes inherited from berry::HandleObject
bool	defined

const QString	id

QString	str

Protected Attributes inherited from berry::Object
QAtomicInt	m_ReferenceCount

QMutex	m_ReferenceCountLock

Detailed Description

A named handle object that can carry state with it. This state can be used to override the name or description.

Clients may neither instantiate nor extend this class.

Definition at line 36 of file berryNamedHandleObjectWithState.h.

Constructor & Destructor Documentation

berry::NamedHandleObjectWithState::NamedHandleObjectWithState ( const QString & id )

protected

Constructs a new instance of NamedHandleObject<WithState/code>.

Parameters


  
    id The identifier for this handle; must not be empty.

Definition at line 110 of file berryNamedHandleObjectWithState.cpp.

Member Function Documentation

berry::NamedHandleObjectWithState::berryObjectMacro ( berry::NamedHandleObjectWithState ) const

QString berry::NamedHandleObjectWithState::GetDescription ( void ) const

overridevirtual

Returns the description for this handle.

Returns: The description; may be null if there is no description.

Exceptions

NotDefinedException If the handle is not currently defined.

Reimplemented from berry::NamedHandleObject.

Definition at line 36 of file berryNamedHandleObjectWithState.cpp.

References berry::INamedHandleStateIds::DESCRIPTION, berry::NamedHandleObject::description, berry::NamedHandleObject::GetDescription(), GetState(), and berry::SmartPointer< TObjectType >::IsNotNull().

QString berry::NamedHandleObjectWithState::GetName ( ) const

overridevirtual

Returns the name for this handle.

Returns: The name for this handle; never null.

Exceptions

NotDefinedException If the handle is not currently defined.

Reimplemented from berry::NamedHandleObject.

Definition at line 54 of file berryNamedHandleObjectWithState.cpp.

References berry::NamedHandleObject::GetName(), GetState(), berry::SmartPointer< TObjectType >::IsNotNull(), berry::INamedHandleStateIds::NAME, and berry::NamedHandleObject::name.

State::Pointer berry::NamedHandleObjectWithState::GetState ( const QString & stateId ) const

overridevirtual

Gets the state with the given id.

Parameters

stateId The identifier of the state to retrieve; must not be null.

Returns: The state; may be null if there is no state with the given id.

Implements berry::IObjectWithState.

Definition at line 72 of file berryNamedHandleObjectWithState.cpp.

Referenced by GetDescription(), GetName(), berry::Command::SetHandler(), and berry::Command::Undefine().

QList< QString > berry::NamedHandleObjectWithState::GetStateIds ( ) const

overridevirtual

Gets the identifiers for all of the state associated with this object.

Returns: All of the state identifiers; may be empty, but never null.

Implements berry::IObjectWithState.

Definition at line 84 of file berryNamedHandleObjectWithState.cpp.

Referenced by berry::Command::SetHandler(), and berry::Command::Undefine().

void berry::NamedHandleObjectWithState::RemoveState ( const QString & stateId )

overridevirtual

Removes state from this object.

Parameters

stateId The id of the state to remove from this object; must not be null.

Implements berry::IObjectWithState.

Definition at line 100 of file berryNamedHandleObjectWithState.cpp.

Referenced by berry::Command::RemoveState().

Member Data Documentation

const SmartPointer<State>& state berry::NamedHandleObjectWithState::override

Definition at line 42 of file berryNamedHandleObjectWithState.h.

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

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation