![]() |
ICF 3.0.5.47
Technical documentation of ICF Libraries
|
State component implementation based on underlaying rights provider. More...
#include <CRightsBasedEnablerComp.h>
Public Types | |
typedef icomp::CComponentBase | BaseClass |
typedef imod::TSingleModelObserverBase< iauth::IRightsProvider > | BaseClass2 |
![]() | |
enum | ChangeFlags { CF_ENABLED = 0x089347 } |
![]() | |
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 | |
CRightsBasedEnablerComp () | |
bool | IsEnabled () const override |
Return a true , if something is enabled. | |
bool | IsEnablingAllowed () const override |
Return a true , if something can be enabled. | |
bool | SetEnabled (bool isEnabled=true) override |
Set something to isEnabled state. | |
bool | Serialize (iser::IArchive &archive) override |
Load or store state of this object as a archive stream. | |
![]() | |
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. | |
![]() | |
![]() | |
![]() | |
virtual quint32 | GetMinimalVersion (int versionId) const |
Get minimal needed version to correct storing of this data. | |
![]() | |
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 | OnComponentCreated () override |
void | OnComponentDestroyed () override |
void | OnUpdate (const istd::IChangeable::ChangeSet &changeSet) override |
Called on update of observed model. | |
![]() | |
bool | IsComponentActive () const |
Check if component is active. | |
virtual const IRealComponentStaticInfo & | GetComponentStaticInfo () const =0 |
Get access to static info of this component. | |
![]() | |
virtual void | OnBeginChanges () |
Callback function for begin change event. | |
virtual void | OnEndChanges (const ChangeSet &changeSet) |
Callback function for end change event. | |
![]() | |
virtual iauth::IRightsProvider * | CastFromModel (imod::IModel *modelPtr) const |
TSingleModelObserverBase () | |
iauth::IRightsProvider * | GetObservedObject () const |
Get instance of observed object. | |
iauth::IRightsProvider * | GetObjectPtr () const |
Get instance of observed object. | |
bool | AttachOrSetObject (iauth::IRightsProvider *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. | |
![]() | |
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. | |
![]() |
Additional Inherited Members | |
![]() | |
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. | |
![]() | |
typedef CSingleModelObserverBase | BaseClass |
typedef iauth::IRightsProvider | ModelType |
![]() | |
typedef imod::IModel | ModelType |
![]() | |
static const IRealComponentStaticInfo & | InitStaticInfo (IComponent *componentPtr) |
static QByteArray | GetComponentId (const IComponentContext *componentContextPtr, const QByteArray &contextId=QByteArray()) |
State component implementation based on underlaying rights provider.
Definition at line 26 of file CRightsBasedEnablerComp.h.
Definition at line 32 of file CRightsBasedEnablerComp.h.
Definition at line 33 of file CRightsBasedEnablerComp.h.
iauth::CRightsBasedEnablerComp::CRightsBasedEnablerComp | ( | ) |
|
overridevirtual |
Return a true
, if something is enabled.
Implements iprm::IEnableableParam.
|
overridevirtual |
Return a true
, if something can be enabled.
Implements iprm::IEnableableParam.
|
overrideprotectedvirtual |
Reimplemented from icomp::CComponentBase.
|
overrideprotectedvirtual |
Reimplemented from icomp::CComponentBase.
|
overrideprotectedvirtual |
Called on update of observed model.
This method is designed to be overload by derrived classes.
Reimplemented from imod::CSingleModelObserverBase.
|
overridevirtual |
Load or store state of this object as a archive stream.
Type of operation is depending on archive type.
Implements iser::ISerializable.
|
overridevirtual |
Set something to isEnabled
state.
The method returns true
if the changing of the enabling status was allowed, otherwise false
.
Implements iprm::IEnableableParam.
© Witold Gantzke and Kirill Lepskiy