iprm::CSelectionParamComp Class Reference

Component level implementation of selection parameter. More...

#include <CSelectionParamComp.h>

Inheritance diagram for iprm::CSelectionParamComp:

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...
typedef QMultiMap< QByteArray, QVariant >	ChangeInfoMap

Public Member Functions
virtual ISelectionParam *	GetSubselection (int index) const override
	Get sub-selection for specified option.
Public Member Functions inherited from icomp::CComponentBase
	CComponentBase ()
	Create component and assign it to specific context.
virtual const icomp::IComponent *	GetParentComponent (bool ownerOnly=false) const override
	Get parent of this component.
virtual void *	GetInterface (const istd::CClassInfo &interfaceType, const QByteArray &subId="") override
	Get access to specified component interface.
virtual IComponentContextSharedPtr	GetComponentContext () const override
	Get access to component context describing all application-specified component information loaded from components registry.
virtual void	SetComponentContext (const IComponentContextSharedPtr &contextPtr, const icomp::IComponent *parentPtr, bool isParentOwner) override
	Set component context of this component.
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.
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 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.

Protected Member Functions
virtual void	OnComponentCreated () override
Protected Member Functions inherited from icomp::CComponentBase
bool	IsComponentActive () const
	Check if component is active.
virtual void	OnComponentDestroyed ()
virtual const icomp::IRealComponentStaticInfo &	GetComponentStaticInfo () const =0
	Get access to static info of this component.
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.
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
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.
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

BaseClass

typedef icomp::CComponentBase iprm::CSelectionParamComp::BaseClass

Definition at line 24 of file CSelectionParamComp.h.

Member Function Documentation

GetSubselection()

virtual ISelectionParam * iprm::CSelectionParamComp::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";
    }
}

Reimplemented from iprm::CSelectionParam.

OnComponentCreated()

virtual void iprm::CSelectionParamComp::OnComponentCreated ( )

overrideprotectedvirtual

Reimplemented from icomp::CComponentBase.

---

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

• Acf/Include/iprm/CSelectionParamComp.h