Command-based selection parameter (iprm::ISelectionParam) controller. More...

#include <CCommandBasedSelectionControllerComp.h>

Inheritance diagram for istdgui::CCommandBasedSelectionControllerComp:

Collaboration diagram for istdgui::CCommandBasedSelectionControllerComp:

Public Types
typedef ibase::TVisualChangesHandlerWrap< icomp::CComponentBase >	BaseClass

typedef imod::TSingleModelObserverBase< iprm::ISelectionParam >	BaseClass2

Public Types inherited from ibase::TVisualChangesHandlerWrap< icomp::CComponentBase >
typedef icomp::CComponentBase	BaseClass

Public Types inherited from ibase::ICommandsProvider
enum	ChangeFlags { CF_COMMANDS = 0x62b7e8 }

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
	CCommandBasedSelectionControllerComp ()

const ibase::IHierarchicalCommand *	GetCommands () const override
	Get list of menu commands.

Public Member Functions inherited from ibase::TVisualChangesHandlerWrap< icomp::CComponentBase >
	TVisualChangesHandlerWrap (Args &&... args)

virtual void	EnableVisualChangesHandler (bool enableLocalization=true)
	If enabled, listen to the language change event from the application context.

Public Member Functions inherited from icomp::CComponentBase
	CComponentBase ()
	Create component and assign it to specific context.

	CComponentBase (const CComponentBase &)=delete

CComponentBase &	operator= (const CComponentBase &)=delete

virtual const ICompositeComponent *	GetParentComponent (bool ownerOnly=false) const
	Get parent of this component.

virtual void *	GetInterface (const istd::CClassInfo &interfaceType, const QByteArray &subId="")
	Get access to specified component interface.

virtual const IComponentContext *	GetComponentContext () const
	Get access to component context describing all application-specified component information loaded from components registry.

virtual void	SetComponentContext (const IComponentContext contextPtr, const ICompositeComponent parentPtr, bool isParentOwner)
	Set component context of this component.

Public Member Functions inherited from icomp::IComponent
Public Member Functions inherited from ibase::ICommandsProvider
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.

Protected Member Functions
void	OnLanguageChanged () override

void	OnUpdate (const istd::IChangeable::ChangeSet &changeSet) override
	Called on update of observed model.

void	OnComponentCreated () override

void	OnComponentDestroyed () override

Protected Member Functions inherited from ibase::TVisualChangesHandlerWrap< icomp::CComponentBase >
virtual void	OnDesignSchemaChanged ()

Protected Member Functions inherited from icomp::CComponentBase
bool	IsComponentActive () const
	Check if component is active.

virtual const IRealComponentStaticInfo &	GetComponentStaticInfo () const =0
	Get access to static info of this component.

Protected Member Functions inherited from imod::TSingleModelObserverBase< iprm::ISelectionParam >
virtual iprm::ISelectionParam *	CastFromModel (imod::IModel *modelPtr) const

	TSingleModelObserverBase ()

iprm::ISelectionParam *	GetObservedObject () const
	Get instance of observed object.

iprm::ISelectionParam *	GetObjectPtr () const
	Get instance of observed object.

bool	AttachOrSetObject (iprm::ISelectionParam *objectPtr)
	Attach to model of object or set object pointer, if no connection is possible.

bool	OnModelAttached (imod::IModel *modelPtr, istd::IChangeable::ChangeSet &changeMask) override
	This call back function will be called, if an observable object is about to be attached.

bool	OnModelDetached (imod::IModel *modelPtr) override
	This call back function will be called, if an observable object is about to be detached.

Protected Member Functions inherited from imod::CSingleModelObserverBase
void	SetModelPtr (imod::IModel *modelPtr)
	Set internal model pointer to specified value.

	CSingleModelObserverBase ()

virtual	~CSingleModelObserverBase ()

imod::IModel *	GetObservedModel () const
	Get access to observed model.

imod::IModel *	GetModelPtr () const
	Get access to observed model.

void	EnsureModelDetached ()
	Make sure this observer is detached.

void	SetObservedIds (const istd::IChangeable::ChangeSet &changeMask)
	Set list of ID's beeing observed.

bool	IsModelAttached (const imod::IModel *modelPtr=nullptr) const override
	Check if specified model is attached.

void	BeforeModelChange (imod::IModel *modelPtr) override
	This function will be called before update of the observer contents occures.

void	AfterModelChange (imod::IModel *modelPtr, const istd::IChangeable::ChangeSet &changeSet) override
	This function will be called after update of the observer contents occures.

Protected Member Functions inherited from imod::IObserver
Protected Member Functions inherited from ibase::ICommandsProvider
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.

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.

Protected Attributes
istdgui::CHierarchicalCommand	m_rootMenuCommand

istdgui::CHierarchicalCommand	m_mainMenuCommand

istdgui::CHierarchicalCommand	m_commandsList

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 Types inherited from imod::TSingleModelObserverBase< iprm::ISelectionParam >
typedef CSingleModelObserverBase	BaseClass

typedef iprm::ISelectionParam	ModelType

Protected Types inherited from imod::CSingleModelObserverBase
typedef imod::IModel	ModelType

Protected Types inherited from ibase::ICommandsProvider
enum	ChangeFlags { CF_COMMANDS = 0x62b7e8 }

Protected 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...

Static Protected Member Functions inherited from icomp::CComponentBase
static const IRealComponentStaticInfo &	InitStaticInfo (IComponent *componentPtr)

static QByteArray	GetComponentId (const IComponentContext *componentContextPtr, const QByteArray &contextId=QByteArray())

Static Protected 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.

Detailed Description

Command-based selection parameter (iprm::ISelectionParam) controller.

Menu commands are generated from the selection constraints of the observered selection object.

Definition at line 28 of file CCommandBasedSelectionControllerComp.h.

Member Typedef Documentation

◆ BaseClass

ibase::TVisualChangesHandlerWrap<icomp::CComponentBase> istdgui::CCommandBasedSelectionControllerComp::BaseClass

Definition at line 36 of file CCommandBasedSelectionControllerComp.h.

◆ BaseClass2

imod::TSingleModelObserverBase<iprm::ISelectionParam> istdgui::CCommandBasedSelectionControllerComp::BaseClass2

Definition at line 37 of file CCommandBasedSelectionControllerComp.h.

Constructor & Destructor Documentation

◆ CCommandBasedSelectionControllerComp()

istdgui::CCommandBasedSelectionControllerComp::CCommandBasedSelectionControllerComp ( )

Member Function Documentation

◆ GetCommands()

const ibase::IHierarchicalCommand * istdgui::CCommandBasedSelectionControllerComp::GetCommands ( ) const

overridevirtual

Get list of menu commands.

These commands will be integrated in global menu system, independent from actual selected view. For support of normal pull down menu, depth of this tree structure should be at least 3.

Reimplemented from ibase::ICommandsProvider.