Public Types | Public Member Functions | List of all members
iprm::ISelectionParam Class Referenceabstract

Interface allowing to select single option from list of options. More...

#include <ISelectionParam.h>

Inheritance diagram for iprm::ISelectionParam:
iser::ISerializable istd::IChangeable istd::IPolymorphic iprm::CParamsManagerCompBase::ParamSet iprm::CSelectionParam iprm::IOptionsManager iprm::IParamsManager iprm::COptionsManager iprm::CSelectionParamComp iprm::COptionsManager iprm::CParamsManagerCompBase iprm::CParamsManagerCompBase iimg::CComposedBitmapProviderComp iprm::COptionsManagerComp iimg::CComposedBitmapProviderComp iprm::COptionsManagerComp iprm::CMultiParamsManagerComp iprm::CParamsManagerComp iprm::CMultiParamsManagerComp iprm::CParamsManagerComp

Public Types

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 const IOptionsListGetSelectionConstraints () const =0
 Get constraints of this parameter. More...
 
virtual int GetSelectedOptionIndex () const =0
 Get selected index. More...
 
virtual bool SetSelectedOptionIndex (int index)=0
 Set index of selected option. More...
 
virtual ISelectionParamGetSubselection (int index) const =0
 Get subselection for specified option. More...
 
- Public Member Functions inherited from iser::ISerializable
virtual bool Serialize (IArchive &archive)=0
 Load or store state of this object as a archive stream. More...
 
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 CopyFrom (const IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS)
 Copy this object from another one. More...
 
virtual bool IsEqual (const IChangeable &object) const
 Compare this object with another object. More...
 
virtual IChangeableCloneMe (CompatibilityMode mode=CM_WITHOUT_REFS) const
 Make a copy of this 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...
 
- Public Member Functions inherited from istd::IPolymorphic
virtual ~IPolymorphic ()
 

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

Detailed Description

Interface allowing to select single option from list of options.

Definition at line 23 of file ISelectionParam.h.

Member Enumeration Documentation

anonymous enum
Enumerator
NO_SELECTION 

Definition at line 34 of file ISelectionParam.h.

Data model change notification flags.

Enumerator
CF_SELECTION_CHANGED 

Definition at line 29 of file ISelectionParam.h.

Member Function Documentation

virtual int iprm::ISelectionParam::GetSelectedOptionIndex ( ) const
pure virtual

Get selected index.

Returns
index of selected option or negative value if no option is selected.

Implemented in iprm::CParamsManagerCompBase::ParamSet, iprm::CParamsManagerCompBase, and iprm::CSelectionParam.

virtual const IOptionsList* iprm::ISelectionParam::GetSelectionConstraints ( ) const
pure virtual

Get constraints of this parameter.

Constraints describes some additional information about allowed parameter ranges and related informations.

Implemented in iprm::CParamsManagerCompBase::ParamSet, iprm::CParamsManagerCompBase, and iprm::CSelectionParam.

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

Get subselection for specified option.

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

Implemented in iprm::CParamsManagerCompBase::ParamSet, iprm::CParamsManagerCompBase, iprm::CSelectionParam, and iprm::CSelectionParamComp.

virtual bool iprm::ISelectionParam::SetSelectedOptionIndex ( int  index)
pure virtual

Set index of selected option.

Returns
true if selection change was possible.

Implemented in iprm::CParamsManagerCompBase::ParamSet, iprm::CParamsManagerCompBase, and iprm::CSelectionParam.


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

© 2007-2017 Witold Gantzke and Kirill Lepskiy