Constraints of selection from set of possibilities. More...

#include <IOptionsList.h>

Inheritance diagram for iprm::IOptionsList:

Public Types
enum	ChangeFlags { CF_OPTIONS_CHANGED = 0x8263d86 , CF_OPTION_RENAMED }
	Flags for changes related to this interface. More...

enum	OptionsFlags { SCF_NONE = 0 , SCF_SUPPORT_UNIQUE_ID = 256 , SFC_DISABLE_ALLOWED = 32 }
	Flags for controlling constraints behavior. More...

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 int	GetOptionsFlags () const =0
	Get constraints flags.

virtual int	GetOptionsCount () const =0
	Get number of managed options.

virtual QString	GetOptionName (int index) const =0
	Get name of specified option.

virtual QString	GetOptionDescription (int index) const =0
	Get human-readable description for an option.

virtual QByteArray	GetOptionId (int index) const =0
	Get option ID.

virtual bool	IsOptionEnabled (int index) const =0
	Return true if the option is enabled and can be selected.

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

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

virtual bool	IsEqual (const IChangeable &object) const
	Compare this object with another object.

virtual istd::TUniqueInterfacePtr< istd::IChangeable >	CloneMe (CompatibilityMode mode=CM_WITHOUT_REFS) const
	Make a copy of this 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 ()

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.

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.

Detailed Description

Constraints of selection from set of possibilities.

IOptionsList provides a read-only interface to a list of options that can be used as constraints for selection parameters. Each option has a name, optional description, and optional unique ID.

This interface is used by ISelectionParam to define available choices. The list supports change notifications so observers can react to option list modifications.

Usage Example

// Assuming optionsList is obtained from a selection parameter
const iprm::IOptionsList* options = selectionParam.GetSelectionConstraints();
 
if (options)
{
    // Get flags
    int flags = options->GetOptionsFlags();
    bool hasUniqueIds = (flags & iprm::IOptionsList::SCF_SUPPORT_UNIQUE_ID) != 0;
    bool canDisable = (flags & iprm::IOptionsList::SFC_DISABLE_ALLOWED) != 0;
    
    // Get number of options
    int count = options->GetOptionsCount();
    qDebug() << "Available options:" << count;
    
    // Iterate through options
    for (int i = 0; i < count; ++i)
    {
        QString name = options->GetOptionName(i);
        QString desc = options->GetOptionDescription(i);
        QByteArray id = options->GetOptionId(i);
        bool enabled = options->IsOptionEnabled(i);
        
        qDebug() << i << ":" << name;
        qDebug() << "   ID:" << id;
        qDebug() << "   Description:" << desc;
        qDebug() << "   Enabled:" << enabled;
    }
}

Helper Functions

The iprm namespace provides helper functions for working with options lists:

// Find option index by ID
int index = iprm::FindOptionIndexById("option_id", *options);
if (index >= 0)
{
    QString name = options->GetOptionName(index);
    qDebug() << "Found option:" << name;
}
else
{
    qDebug() << "Option not found";
}

Note: This is a read-only interface. For dynamic option management, see IOptionsManager.; Inherits from istd::IChangeable for change notification support.

See also: IOptionsManager, ISelectionParam, FindOptionIndexById

Definition at line 85 of file IOptionsList.h.

Member Enumeration Documentation

◆ ChangeFlags

enum iprm::IOptionsList::ChangeFlags

Flags for changes related to this interface.

Used with change notification to detect modifications to the options list.

See also: istd::IChangeable::ChangeSet

Enumerator
CF_OPTIONS_CHANGED	Option list updated (options added, removed, or reordered).
CF_OPTION_RENAMED	One or more options were renamed.

Definition at line 95 of file IOptionsList.h.

◆ OptionsFlags

enum iprm::IOptionsList::OptionsFlags

Flags for controlling constraints behavior.

These flags describe capabilities and requirements of the options list.

See also: GetOptionsFlags

Enumerator

SCF_NONE

No special flags.

SCF_SUPPORT_UNIQUE_ID

If set, every option must have a unique ID.

Option IDs can be used for stable references to options.

SFC_DISABLE_ALLOWED

If set, some options can be disabled.

Disabled options cannot be selected but remain in the list.

Definition at line 115 of file IOptionsList.h.

Member Function Documentation

◆ GetOptionDescription()

virtual QString iprm::IOptionsList::GetOptionDescription ( int index ) const

pure virtual

Get human-readable description for an option.

Returns detailed description or tooltip text for an option.

Parameters

index Option index (0-based).

Returns: Option description as QString, or empty string if no description exists or index is out of range.

QString description = options->GetOptionDescription(2);
if (!description.isEmpty())
{
    qDebug() << "Description:" << description;
}

See also: GetOptionName

Implemented in idoc::TMultiPageDocumentWrap< Base >, idoc::TMultiPageDocumentWrap< idoc::IMultiPageDocument >, ifile::CFileSystemInfoProviderComp, iimg::CPixelFormatList, iprm::CFilteredOptionsListComp, iprm::CMultiParamsManagerComp::TypeInfoList, iprm::COptionsManager, iprm::CParamsManagerCompBase, iprm::CSelectionConstraintsComp, and iqt::CTranslationManagerComp.

◆ GetOptionId()

virtual QByteArray iprm::IOptionsList::GetOptionId ( int index ) const

pure virtual

Get option ID.

Returns the unique identifier for an option. The ID is stable and doesn't change when options are reordered, making it suitable for persistent references.

Parameters

index Option index (0-based).

Returns: Option ID as QByteArray, or empty array if index is out of range.

Note: The ID must be unique if SCF_SUPPORT_UNIQUE_ID flag is set.; Use FindOptionIndexById() to find an option by its ID.

QByteArray id = options->GetOptionId(1);
qDebug() << "Option ID:" << id;
 
// Later, find the option by ID
int index = iprm::FindOptionIndexById(id, *options);

See also: OptionsFlags, FindOptionIndexById

Implemented in idoc::TMultiPageDocumentWrap< Base >, idoc::TMultiPageDocumentWrap< idoc::IMultiPageDocument >, ifile::CFileSystemInfoProviderComp, iimg::CPixelFormatList, iprm::CFilteredOptionsListComp, iprm::CMultiParamsManagerComp::TypeInfoList, iprm::COptionsManager, iprm::CParamsManagerCompBase, iprm::CSelectionConstraintsComp, and iqt::CTranslationManagerComp.

◆ GetOptionName()

virtual QString iprm::IOptionsList::GetOptionName ( int index ) const

pure virtual

Get name of specified option.

Returns the display name for an option.

Parameters

index Option index (0-based).

Returns: Option name as QString, or empty string if index is out of range.

QString name = options->GetOptionName(0);

qDebug() << "First option:" << name;

See also: GetOptionDescription, GetOptionId

Implemented in idoc::TMultiPageDocumentWrap< Base >, idoc::TMultiPageDocumentWrap< idoc::IMultiPageDocument >, ifile::CFileSystemInfoProviderComp, iimg::CPixelFormatList, iprm::CFilteredOptionsListComp, iprm::CMultiParamsManagerComp::TypeInfoList, iprm::COptionsManager, iprm::CParamsManagerCompBase, iprm::CSelectionConstraintsComp, and iqt::CTranslationManagerComp.

◆ GetOptionsCount()

virtual int iprm::IOptionsList::GetOptionsCount ( ) const

pure virtual

Get number of managed options.

Returns: Total count of options in the list (including disabled options).

int count = options->GetOptionsCount();
for (int i = 0; i < count; ++i)
{
    // Process each option
}

See also: GetOptionName

Implemented in idoc::TMultiPageDocumentWrap< Base >, idoc::TMultiPageDocumentWrap< idoc::IMultiPageDocument >, ifile::CFileSystemInfoProviderComp, iimg::CPixelFormatList, iprm::CFilteredOptionsListComp, iprm::CMultiParamsManagerComp::TypeInfoList, iprm::COptionsManager, iprm::CParamsManagerCompBase, iprm::CSelectionConstraintsComp, and iqt::CTranslationManagerComp.

◆ GetOptionsFlags()

virtual int iprm::IOptionsList::GetOptionsFlags ( ) const

pure virtual

Get constraints flags.

Returns flags that describe how the constraints object behaves and what features it supports.

Returns: Bitwise OR combination of OptionsFlags values.

int flags = options->GetOptionsFlags();
 
if (flags & iprm::IOptionsList::SCF_SUPPORT_UNIQUE_ID)
{
    qDebug() << "Options have unique IDs";
}
 
if (flags & iprm::IOptionsList::SFC_DISABLE_ALLOWED)
{
    qDebug() << "Options can be disabled";
}

See also: OptionsFlags

Implemented in idoc::TMultiPageDocumentWrap< Base >, idoc::TMultiPageDocumentWrap< idoc::IMultiPageDocument >, ifile::CFileSystemInfoProviderComp, iimg::CPixelFormatList, iprm::CFilteredOptionsListComp, iprm::CMultiParamsManagerComp::TypeInfoList, iprm::COptionsManager, iprm::CParamsManagerCompBase, iprm::CSelectionConstraintsComp, and iqt::CTranslationManagerComp.

◆ IsOptionEnabled()

virtual bool iprm::IOptionsList::IsOptionEnabled ( int index ) const

pure virtual

Return true if the option is enabled and can be selected.

Checks whether an option is currently enabled. Disabled options cannot be selected but remain visible in the list.

Parameters

index Option index (0-based).

Returns: true if option is enabled and can be selected, false if disabled or index is out of range.

for (int i = 0; i < options->GetOptionsCount(); ++i)
{
    if (options->IsOptionEnabled(i))
    {
        QString name = options->GetOptionName(i);
        qDebug() << "Enabled option:" << name;
    }
}

See also: SFC_DISABLE_ALLOWED

Implemented in idoc::TMultiPageDocumentWrap< Base >, idoc::TMultiPageDocumentWrap< idoc::IMultiPageDocument >, ifile::CFileSystemInfoProviderComp, iimg::CPixelFormatList, iprm::CFilteredOptionsListComp, iprm::CMultiParamsManagerComp::TypeInfoList, iprm::COptionsManager, iprm::CParamsManagerCompBase, iprm::CSelectionConstraintsComp, and iqt::CTranslationManagerComp.

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

Acf/Include/iprm/IOptionsList.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Usage Example

Helper Functions

Member Enumeration Documentation

◆ ChangeFlags

◆ OptionsFlags

Member Function Documentation

◆ GetOptionDescription()

◆ GetOptionId()

◆ GetOptionName()

◆ GetOptionsCount()

◆ GetOptionsFlags()

◆ IsOptionEnabled()