iprm::IEnableableParam Class Reference

Interface for objects which can be enabled/disabled. More...

#include <IEnableableParam.h>

Inheritance diagram for iprm::IEnableableParam:

Collaboration diagram for iprm::IEnableableParam:

Public Types
enum	ChangeFlags { CF_ENABLED = 0x089347 }
Public Types inherited from istd::IChangeable
enum	ChangeFlags {   CF_ICF_INTERNAL = 0 , CF_ALL_DATA , CF_ANY , CF_DESTROYING ,   CF_DELEGATED , CF_NO_UNDO }
	Data model change notification flags. More...
enum	SupportedOperations {   SO_NONE = 0 , SO_OBSERVE = 1 << 0 , SO_COPY = 1 << 1 , SO_CLONE = 1 << 2 ,   SO_COMPARE = 1 << 3 , SO_RESET = 1 << 4 , SO_CHANGE_LOCK = 1 << 5 }
	Flags for supported operations. More...
enum	CompatibilityMode { CM_STRICT , CM_WITHOUT_REFS , CM_WITH_REFS , CM_CONVERT }
	Control how relationship betweeen objects are interpreted. More...

Public Member Functions
virtual bool	IsEnabled () const =0
	Return a true, if something is enabled.
virtual bool	IsEnablingAllowed () const =0
	Return a true, if something can be enabled.
virtual bool	SetEnabled (bool isEnabled=true)=0
	Set something to isEnabled state.
Public Member Functions inherited from iser::ISerializable
virtual bool	Serialize (IArchive &archive)=0
	Load or store state of this object as a archive stream.
virtual quint32	GetMinimalVersion (int versionId) const
	Get minimal needed version to correct storing of this data.
Public Member Functions inherited from istd::IChangeable
virtual int	GetSupportedOperations () const
	Get set of flags for supported operations.
virtual bool	CopyFrom (const IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS)
	Copy this object from another one.
virtual bool	IsEqual (const IChangeable &object) const
	Compare this object with another object.
virtual std::unique_ptr< IChangeable >	CloneMe (CompatibilityMode mode=CM_WITHOUT_REFS) const
	Make a copy of this object.
virtual bool	ResetData (CompatibilityMode mode=CM_WITHOUT_REFS)
	Reset data to its default state.
virtual QMutex *	GetChangesLock () const
	Get mutex beeing locked during changes, if available.
virtual void	BeginChanges (const ChangeSet &changeSet)
	Starts the change transaction.
virtual void	EndChanges (const ChangeSet &changeSet)
	Ends the change transaction.
virtual void	BeginChangeGroup (const ChangeSet &changeSet)
	Starts group of changes.
virtual void	EndChangeGroup (const ChangeSet &changeSet)
	Ends group of changes.

Additional Inherited Members
Static Public Member Functions inherited from istd::IChangeable
static const ChangeSet &	GetNoChanges ()
	Get empty set of changes.
static const ChangeSet &	GetAnyChange ()
	Get anonymous change set.
static const ChangeSet &	GetAllChanges ()
	Get anonymous change set.
static const ChangeSet &	GetDelegatedChanges ()
	Get delegated change set.
Protected Member Functions inherited from istd::IChangeable
virtual void	OnBeginChanges ()
	Callback function for begin change event.
virtual void	OnEndChanges (const ChangeSet &changeSet)
	Callback function for end change event.

Detailed Description

Interface for objects which can be enabled/disabled.

Definition at line 20 of file IEnableableParam.h.

Member Enumeration Documentation

ChangeFlags

enum iprm::IEnableableParam::ChangeFlags

Enumerator
CF_ENABLED

Definition at line 24 of file IEnableableParam.h.

Member Function Documentation

IsEnabled()

virtual bool iprm::IEnableableParam::IsEnabled ( ) const

pure virtual

Return a true, if something is enabled.

Implemented in iauth::CRightsBasedEnablerComp, and iprm::CEnableableParam.

IsEnablingAllowed()

virtual bool iprm::IEnableableParam::IsEnablingAllowed ( ) const

pure virtual

Return a true, if something can be enabled.

Implemented in iauth::CRightsBasedEnablerComp, and iprm::CEnableableParam.

SetEnabled()

virtual bool iprm::IEnableableParam::SetEnabled ( bool isEnabled = true )

pure virtual

Set something to isEnabled state.

The method returns true if the changing of the enabling status was allowed, otherwise false.

Implemented in iauth::CRightsBasedEnablerComp, iprm::CEnableableParam, and istdgui::CHierarchicalCommand.

---

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

• iprm/IEnableableParam.h