Basic implementation of selection parameter. More...

#include <CSelectionParam.h>

Inheritance diagram for iprm::CSelectionParam:

Collaboration diagram for iprm::CSelectionParam:

Classes
class	ConstraintsObserver

Public Member Functions
	CSelectionParam ()

void	SetSelectionConstraints (const IOptionsList *constraintsPtr)
	Set selection constraints for this selection object.

void	SetSubselection (int selectionIndex, ISelectionParam *selectionPtr)
	Set sub-selection for a given option index.

bool	SetSelectedOptionById (const QByteArray &selectedOptionId)
	Set selection index according to a given option ID.

int	GetOptionIndexById (const QByteArray &optionId) const
	Get index of an option by ID.

ISelectionParam *	GetActiveSubselection () const
	Get sub-selection for the currently selected option.

const IOptionsList *	GetSelectionConstraints () const override
	Get constraints of this parameter.

QByteArray	GetSelectedOptionId () const override
	Get selected ID.

int	GetSelectedOptionIndex () const override
	Get selected index.

bool	SetSelectedOptionIndex (int index) override
	Set index of selected option.

ISelectionParam *	GetSubselection (int index) const override
	Get subselection for specified option.

bool	Serialize (iser::IArchive &archive) override
	Load or store state of this object as a archive stream.

bool	CopyFrom (const istd::IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS) override
	Copy this object from another one.

std::unique_ptr< istd::IChangeable >	CloneMe (CompatibilityMode mode=CM_WITHOUT_REFS) const override
	Make a copy of this object.

Public Member Functions inherited from iprm::ISelectionParam
Public Member Functions inherited from iser::ISerializable
virtual quint32	GetMinimalVersion (int versionId) const
	Get minimal needed version to correct storing of this data.

Public Member Functions inherited from istd::IChangeable
virtual int	GetSupportedOperations () const
	Get set of flags for supported operations.

virtual bool	IsEqual (const IChangeable &object) const
	Compare this object with another 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
int	CalcIndexFromId (const QByteArray &optionId, int suggestedIndex=NO_SELECTION) const
	Calculate optimal index based on current selected index and ID.

bool	SyncIndexWithId ()
	Synchronize current index to optimal one.

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.

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

Detailed Description

Basic implementation of selection parameter.

Definition at line 27 of file CSelectionParam.h.

Constructor & Destructor Documentation

◆ CSelectionParam()

iprm::CSelectionParam::CSelectionParam ( )

Member Function Documentation

◆ CalcIndexFromId()

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

protected

Calculate optimal index based on current selected index and ID.

◆ CloneMe()

std::unique_ptr< istd::IChangeable > iprm::CSelectionParam::CloneMe ( CompatibilityMode mode = CM_WITHOUT_REFS ) const

overridevirtual

Make a copy of this object.

You may check, if this functionality is supported over GetSupportedOperations().

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

Reimplemented from istd::IChangeable.

Reimplemented in imod::TModelWrap< iprm::COptionsManager >.

◆ CopyFrom()

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

overridevirtual

Copy this object from another one.

Default implementation in istd::IChangeable does nothing. You may check, if this functionality is supported over GetSupportedOperations().

Reimplemented from istd::IChangeable.

Reimplemented in iser::TCopySerializedWrap< iprm::COptionsManager >.

◆ GetActiveSubselection()

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

Get sub-selection for the currently selected option.

◆ GetOptionIndexById()

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

Get index of an option by ID.

◆ GetSelectedOptionId()

QByteArray iprm::CSelectionParam::GetSelectedOptionId ( ) const

overridevirtual

Get selected ID.

Returns: ID of selected option.

Implements iprm::ISelectionParam.

◆ GetSelectedOptionIndex()

int iprm::CSelectionParam::GetSelectedOptionIndex ( ) const

overridevirtual

Get selected index.

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

Implements iprm::ISelectionParam.

◆ GetSelectionConstraints()

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

overridevirtual

Get constraints of this parameter.

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

Implements iprm::ISelectionParam.

◆ GetSubselection()

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

overridevirtual

Get subselection for specified option.

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

Implements iprm::ISelectionParam.

Reimplemented in iprm::CSelectionParamComp.

◆ Serialize()

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

overridevirtual

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.

◆ SetSelectedOptionById()

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

Set selection index according to a given option ID.

◆ SetSelectedOptionIndex()

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

overridevirtual

Set index of selected option.

Returns: true if selection change was possible.

Implements iprm::ISelectionParam.

◆ SetSelectionConstraints()

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

Set selection constraints for this selection object.

◆ SetSubselection()

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

Set sub-selection for a given option index.

◆ SyncIndexWithId()

bool iprm::CSelectionParam::SyncIndexWithId ( )

protected

Synchronize current index to optimal one.

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

iprm/CSelectionParam.h

Classes

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CSelectionParam()

Member Function Documentation

◆ CalcIndexFromId()

◆ CloneMe()

◆ CopyFrom()

◆ GetActiveSubselection()

◆ GetOptionIndexById()

◆ GetSelectedOptionId()

◆ GetSelectedOptionIndex()

◆ GetSelectionConstraints()

◆ GetSubselection()

◆ Serialize()

◆ SetSelectedOptionById()

◆ SetSelectedOptionIndex()

◆ SetSelectionConstraints()

◆ SetSubselection()

◆ SyncIndexWithId()