Public Types | Public Member Functions | Protected Member Functions | List of all members
iprm::CSelectionParamComp Class Reference

Component level implementation of selection parameter. More...

#include <CSelectionParamComp.h>

Inheritance diagram for iprm::CSelectionParamComp:
icomp::CComponentBase iprm::CSelectionParam icomp::IComponent iprm::ISelectionParam istd::IPolymorphic iser::ISerializable istd::IChangeable istd::IPolymorphic

Public Types

typedef icomp::CComponentBase BaseClass
 
- Public Types inherited from iprm::ISelectionParam
enum  ChangeFlags { CF_SELECTION_CHANGED = 0x67364be }
 Data model change notification flags. More...
 
enum  { NO_SELECTION = -1 }
 
- Public Types inherited from istd::IChangeable
enum  ChangeFlags {
  CF_ACF_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
}
 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 ISelectionParamGetSubselection (int index) const
 Get subselection for specified option. More...
 
- Public Member Functions inherited from icomp::CComponentBase
 CComponentBase ()
 Create component and assign it to specific context. More...
 
virtual const ICompositeComponentGetParentComponent (bool ownerOnly=false) const
 Get parent of this component. More...
 
virtual void * GetInterface (const istd::CClassInfo &interfaceType, const QByteArray &subId="")
 Get access to specified component interface. More...
 
virtual const IComponentContextGetComponentContext () const
 Get access to component context describing all application-specified component information loaded from components registry. More...
 
virtual void SetComponentContext (const icomp::IComponentContext *contextPtr, const ICompositeComponent *parentPtr, bool isParentOwner)
 Set component context of this component. More...
 
- Public Member Functions inherited from istd::IPolymorphic
virtual ~IPolymorphic ()
 
- Public Member Functions inherited from iprm::CSelectionParam
 CSelectionParam ()
 
void SetSelectionConstraints (const IOptionsList *constraintsPtr)
 Set selection constraints for this selection object. More...
 
void SetSubselection (int selectionIndex, ISelectionParam *selectionPtr)
 Set sub-selection for a given option index. More...
 
bool SetSelectedOptionById (const QByteArray &selectedOptionId)
 Set selection index according to a given option ID. More...
 
int GetOptionIndexById (const QByteArray &optionId) const
 Get index of an option by ID. More...
 
ISelectionParamGetActiveSubselection () const
 Get sub-selection for the currently selected option. More...
 
virtual const IOptionsListGetSelectionConstraints () const
 Get constraints of this parameter. More...
 
virtual int GetSelectedOptionIndex () const
 Get selected index. More...
 
virtual bool SetSelectedOptionIndex (int index)
 Set index of selected option. More...
 
virtual bool Serialize (iser::IArchive &archive)
 Load or store state of this object as a archive stream. More...
 
virtual bool CopyFrom (const istd::IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS)
 Copy this object from another one. More...
 
virtual istd::IChangeableCloneMe (CompatibilityMode mode=CM_WITHOUT_REFS) const
 Make a copy of this object. More...
 
- Public Member Functions inherited from iser::ISerializable
virtual quint32 GetMinimalVersion (int versionId) const
 Get minimal needed version to correct storing of this data. More...
 
- Public Member Functions inherited from istd::IChangeable
virtual int GetSupportedOperations () const
 Get set of flags for supported operations. More...
 
virtual bool IsEqual (const IChangeable &object) const
 Compare this object with another object. More...
 
virtual bool ResetData (CompatibilityMode mode=CM_WITHOUT_REFS)
 Reset data to its default state. More...
 
virtual void BeginChanges (const ChangeSet &changeSet)
 Starts the change transaction. More...
 
virtual void EndChanges (const ChangeSet &changeSet)
 Ends the change transaction. More...
 
virtual void BeginChangeGroup (const ChangeSet &changeSet)
 Starts group of changes. More...
 
virtual void EndChangeGroup (const ChangeSet &changeSet)
 Ends group of changes. More...
 

Protected Member Functions

virtual void OnComponentCreated ()
 
- Protected Member Functions inherited from icomp::CComponentBase
bool IsComponentActive () const
 Check if component is active. More...
 
virtual void OnComponentDestroyed ()
 
virtual const
icomp::IRealComponentStaticInfo
GetComponentStaticInfo () const =0
 Get access to static info of this component. More...
 
- Protected Member Functions inherited from iprm::CSelectionParam
int CalcIndexFromId (const QByteArray &optionId, int suggestedIndex=NO_SELECTION) const
 Calculate optimal index based on current selected index and ID. More...
 
bool SyncIndexWithId ()
 Synchronize current index to optimal one. More...
 
- Protected Member Functions inherited from istd::IChangeable
virtual void OnBeginChanges ()
 Callback function for begin change event. More...
 
virtual void OnEndChanges (const ChangeSet &changeSet)
 Callback function for end change event. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from istd::IChangeable
static const ChangeSetGetNoChanges ()
 Get empty set of changes. More...
 
static const ChangeSetGetAnyChange ()
 Get anonymous change set. More...
 
static const ChangeSetGetAllChanges ()
 Get anonymous change set. More...
 
static const ChangeSetGetDelegatedChanges ()
 Get delegated change set. More...
 
- Static Protected Member Functions inherited from icomp::CComponentBase
static const
icomp::IRealComponentStaticInfo
InitStaticInfo (IComponent *componentPtr)
 
static QByteArray GetComponentId (const icomp::IComponentContext *componentContextPtr, const QByteArray &contextId=QByteArray())
 

Detailed Description

Component level implementation of selection parameter.

Definition at line 19 of file CSelectionParamComp.h.

Member Typedef Documentation

Definition at line 24 of file CSelectionParamComp.h.

Member Function Documentation

virtual ISelectionParam* iprm::CSelectionParamComp::GetSubselection ( int  index) const
virtual

Get subselection for specified option.

Please note, that returned options tree belongs to selection data model.

Reimplemented from iprm::CSelectionParam.

virtual void iprm::CSelectionParamComp::OnComponentCreated ( )
protectedvirtual

Reimplemented from icomp::CComponentBase.


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

© 2007-2017 Witold Gantzke and Kirill Lepskiy