Basic implementation of selection parameter. More...

#include <CSelectionParam.h>

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

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

virtual int	GetSelectedOptionIndex () const override
	Get selected index.

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

virtual ISelectionParam *	GetSubselection (int index) const override
	Get sub-selection for specified option.

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

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

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

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

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.

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

typedef QMultiMap< QByteArray, QVariant >	ChangeInfoMap

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 22 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()

virtual istd::TUniqueInterfacePtr< istd::IChangeable > iprm::CSelectionParam::CloneMe ( CompatibilityMode mode = CM_WITHOUT_REFS ) const

overridevirtual

Make a copy of this object.

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

Reimplemented from istd::IChangeable.

◆ CopyFrom()

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

Reimplemented from istd::IChangeable.

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

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

◆ GetSelectedOptionIndex()

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

overridevirtual

Get selected index.

Returns the index of the currently selected option.

Returns: Index of selected option (0-based), or NO_SELECTION (-1) if no option is selected.

int index = selection.GetSelectedOptionIndex();
if (index == iprm::ISelectionParam::NO_SELECTION)
{
    qDebug() << "No selection";
}
else
{
    qDebug() << "Selected index:" << index;
}

See also: SetSelectedOptionIndex, NO_SELECTION

Implements iprm::ISelectionParam.

◆ GetSelectionConstraints()

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

overridevirtual

Get constraints of this parameter.

Returns the options list that defines available choices for this selection. Constraints describe allowed parameter ranges and related information.

Returns: Pointer to IOptionsList defining available options, owned by the parameter or external manager. Do not delete.

const iprm::IOptionsList* options = selection.GetSelectionConstraints();
if (options)
{
    int count = options->GetOptionsCount();
    for (int i = 0; i < count; ++i)
    {
        QString name = options->GetOptionName(i);
        qDebug() << "Option" << i << ":" << name;
    }
}

See also: IOptionsList

Implements iprm::ISelectionParam.

◆ GetSubselection()

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

overridevirtual

Get sub-selection for specified option.

Retrieves the hierarchical sub-selection associated with a specific option. This enables multi-level selection structures (e.g., Category -> Subcategory).

Parameters

index Index of the option whose sub-selection to retrieve.

Returns: Pointer to sub-selection parameter, or NULL if no sub-selection exists for this option.

Note: The returned pointer belongs to the selection's data model. Do not delete.; Sub-selections are independent selection parameters that can have their own constraints and further sub-selections.

// Get sub-selection for currently selected option
int selectedIndex = selection.GetSelectedOptionIndex();
if (selectedIndex >= 0)
{
    iprm::ISelectionParam* subSelection = selection.GetSubselection(selectedIndex);
    if (subSelection)
    {
        // Work with sub-selection
        subSelection->SetSelectedOptionIndex(0);
    }
}
 
// Check all options for sub-selections
const iprm::IOptionsList* options = selection.GetSelectionConstraints();
int count = options->GetOptionsCount();
for (int i = 0; i < count; ++i)
{
    iprm::ISelectionParam* sub = selection.GetSubselection(i);
    if (sub)
    {
        qDebug() << "Option" << i << "has a sub-selection";
    }
}

Implements iprm::ISelectionParam.

Reimplemented in iprm::CSelectionParamComp.

◆ Serialize()

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

Reimplemented in iprm::COptionsManager.

◆ SetSelectedOptionById()

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

Set selection index according to a given option ID.

◆ SetSelectedOptionIndex()

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

overridevirtual

Set index of selected option.

Changes the selected option to the specified index.

Parameters

index Index of the option to select (0-based), or NO_SELECTION to clear the selection.

Returns: true if selection change was possible and successful, false otherwise.

Note: Returns false if index is out of range or the option is disabled.; Triggers CF_SELECTION_CHANGED notification on success.

// Select third option
bool success = selection.SetSelectedOptionIndex(2);
if (success)
{
    qDebug() << "Selection changed";
}
 
// Clear selection
selection.SetSelectedOptionIndex(iprm::ISelectionParam::NO_SELECTION);

See also: GetSelectedOptionIndex, CF_SELECTION_CHANGED

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:

Acf/Include/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()

◆ GetSelectedOptionIndex()

◆ GetSelectionConstraints()

◆ GetSubselection()

◆ Serialize()

◆ SetSelectedOptionById()

◆ SetSelectedOptionIndex()

◆ SetSelectionConstraints()

◆ SetSubselection()

◆ SyncIndexWithId()