Classes | Public Member Functions | Protected Member Functions | List of all members
iprm::CSelectionParam Class Reference

Basic implementation of selection parameter. More...

#include <CSelectionParam.h>

Inheritance diagram for iprm::CSelectionParam:
iprm::ISelectionParam iser::ISerializable istd::IChangeable istd::IPolymorphic iprm::COptionsManager iprm::CSelectionParamComp iimg::CComposedBitmapProviderComp iprm::COptionsManagerComp

Classes

class  ConstraintsObserver
 

Public Member Functions

 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 ISelectionParamGetSubselection (int index) const
 Get subselection for specified 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...
 
- Public Member Functions inherited from istd::IPolymorphic
virtual ~IPolymorphic ()
 

Protected Member Functions

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

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

Detailed Description

Basic implementation of selection parameter.

Definition at line 22 of file CSelectionParam.h.

Constructor & Destructor Documentation

iprm::CSelectionParam::CSelectionParam ( )

Member Function Documentation

int iprm::CSelectionParam::CalcIndexFromId ( const QByteArray &  optionId,
int  suggestedIndex = NO_SELECTION 
) const
protected

Calculate optimal index based on current selected index and ID.

virtual istd::IChangeable* iprm::CSelectionParam::CloneMe ( CompatibilityMode  mode = CM_WITHOUT_REFS) const
virtual

Make a copy of this object.

Returns
new instance or NULL, if this operation is not supported.

Reimplemented from istd::IChangeable.

virtual bool iprm::CSelectionParam::CopyFrom ( const istd::IChangeable object,
CompatibilityMode  mode = CM_WITHOUT_REFS 
)
virtual

Copy this object from another one.

Default implementation in istd::IChangeable does nothing.

Reimplemented from istd::IChangeable.

ISelectionParam* iprm::CSelectionParam::GetActiveSubselection ( ) const

Get sub-selection for the currently selected option.

int iprm::CSelectionParam::GetOptionIndexById ( const QByteArray &  optionId) const

Get index of an option by ID.

virtual int iprm::CSelectionParam::GetSelectedOptionIndex ( ) const
virtual

Get selected index.

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

Implements iprm::ISelectionParam.

virtual const IOptionsList* iprm::CSelectionParam::GetSelectionConstraints ( ) const
virtual

Get constraints of this parameter.

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

Implements iprm::ISelectionParam.

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

Get subselection for specified option.

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

Implements iprm::ISelectionParam.

Reimplemented in iprm::CSelectionParamComp.

virtual bool iprm::CSelectionParam::Serialize ( iser::IArchive archive)
virtual

Load or store state of this object as a archive stream.

Type of operation is depending on archive type.

See Also
iser::IArchive

Implements iser::ISerializable.

Reimplemented in iprm::COptionsManager.

bool iprm::CSelectionParam::SetSelectedOptionById ( const QByteArray &  selectedOptionId)

Set selection index according to a given option ID.

virtual bool iprm::CSelectionParam::SetSelectedOptionIndex ( int  index)
virtual

Set index of selected option.

Returns
true if selection change was possible.

Implements iprm::ISelectionParam.

void iprm::CSelectionParam::SetSelectionConstraints ( const IOptionsList constraintsPtr)

Set selection constraints for this selection object.

void iprm::CSelectionParam::SetSubselection ( int  selectionIndex,
ISelectionParam selectionPtr 
)

Set sub-selection for a given option index.

bool iprm::CSelectionParam::SyncIndexWithId ( )
protected

Synchronize current index to optimal one.


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

© 2007-2017 Witold Gantzke and Kirill Lepskiy