Common interface for the management of dynamic selection constraints. More...

#include <IOptionsManager.h>

Inheritance diagram for iprm::IOptionsManager:

Public Types
enum	ChangeFlags { CF_OPTION_ADDED = 0x26be73a , CF_OPTION_REMOVED }
	Data model change notification flags. More...

enum	OptionOperationFlags { OOF_COUNT_FIXED = 1 , OOF_SUPPORT_RENAME = 2 , OOF_SUPPORT_INSERT = 4 , OOF_SUPPORT_DELETE = 8 , OOF_SUPPORT_SWAP = 16 , OOF_DISABLE_ALLOWED = 32 , OOF_SUPPORT_ENABLING = 64 }
	Bitwise coded flags used to find out supported features. More...

Public Types inherited from iprm::IOptionsList
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 Types inherited from iprm::ISelectionParam
enum	ChangeFlags { CF_SELECTION_CHANGED = 0x67364be }
	Data model change notification flags. More...

enum	{ NO_SELECTION = -1 }

Public Member Functions
virtual int	GetOptionOperationFlags (int index=-1) const =0
	Get operation control flags of some option or whole manager.

virtual bool	SetOptionEnabled (int index, bool isEnabled=true)=0
	Enables or disables a given option.

virtual bool	RemoveOption (int index)=0
	Remove an option at the given index.

virtual bool	InsertOption (const QString &optionName, const QByteArray &optionId, const QString &optionDescription=QString(), int index=-1)=0
	Insert an option at some position.

virtual bool	SwapOptions (int index1, int index2)=0
	Swap two options.

virtual bool	SetOptionName (int optionIndex, const QString &optionName)=0
	Set a new name for the option at the given index.

virtual bool	SetOptionDescription (int optionIndex, const QString &optionDescription)=0
	Set a new description for the option at the given index.

Public Member Functions inherited from iprm::IOptionsList
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 ()

Public Member Functions inherited from iprm::ISelectionParam
virtual const IOptionsList *	GetSelectionConstraints () const =0
	Get constraints of this parameter.

virtual int	GetSelectedOptionIndex () const =0
	Get selected index.

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

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

Public Member Functions inherited from iser::ISerializable
virtual bool	Serialize (IArchive &archive)=0
	Load or store state of this object as a archive stream.

virtual quint32	GetMinimalVersion (int versionId) const
	Get minimal needed version to correct storing of this data.

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

Common interface for the management of dynamic selection constraints.

IOptionsManager extends IOptionsList with capabilities to dynamically modify the options list. It allows adding, removing, renaming, enabling/disabling, and reordering options at runtime.

This interface also combines ISelectionParam functionality, allowing both management of options and selection of an active option.

Usage Example

#include <iprm/COptionsManager.h>
 
// Create options manager
iprm::COptionsManager manager;
 
// Check capabilities
int flags = manager.GetOptionOperationFlags(-1);
bool canInsert = (flags & iprm::IOptionsManager::OOF_SUPPORT_INSERT) != 0;
bool canDelete = (flags & iprm::IOptionsManager::OOF_SUPPORT_DELETE) != 0;
bool canRename = (flags & iprm::IOptionsManager::OOF_SUPPORT_RENAME) != 0;
 
// Insert options
if (canInsert)
{
    manager.InsertOption("Option A", "opt_a", "First option", -1);
    manager.InsertOption("Option B", "opt_b", "Second option", -1);
    manager.InsertOption("Option C", "opt_c", "Third option", -1);
}
 
// Get options count
int count = manager.GetOptionsCount();
qDebug() << "Total options:" << count;
 
// Modify an option
if (canRename)
{
    manager.SetOptionName(0, "Updated Option A");
    manager.SetOptionDescription(0, "Updated description");
}
 
// Enable/disable option
manager.SetOptionEnabled(1, false);  // Disable second option
 
// Select an option
manager.SetSelectedOptionIndex(0);
int selected = manager.GetSelectedOptionIndex();
 
// Remove an option
if (canDelete)
{
    manager.RemoveOption(2);
}
 
// Swap options
manager.SwapOptions(0, 1);

Iterating with State Check

for (int i = 0; i < manager.GetOptionsCount(); ++i)
{
    QString name = manager.GetOptionName(i);
    bool enabled = manager.IsOptionEnabled(i);
    bool selected = (i == manager.GetSelectedOptionIndex());
    
    qDebug() << name 
             << (enabled ? "[enabled]" : "[disabled]")
             << (selected ? "[SELECTED]" : "");
}

Note: Inherits from both IOptionsList (read) and ISelectionParam (selection).; Check operation flags before attempting modifications.

See also: IOptionsList, ISelectionParam, COptionsManager

Definition at line 94 of file IOptionsManager.h.

Member Enumeration Documentation

◆ ChangeFlags

enum iprm::IOptionsManager::ChangeFlags

Data model change notification flags.

Used with change notification to detect when options are added or removed.

See also: istd::IChangeable::ChangeSet, IOptionsList::ChangeFlags

Enumerator
CF_OPTION_ADDED	An option was added to the list.
CF_OPTION_REMOVED	An option was removed from the list.

Definition at line 104 of file IOptionsManager.h.

◆ OptionOperationFlags

enum iprm::IOptionsManager::OptionOperationFlags

Bitwise coded flags used to find out supported features.

These flags indicate what operations are supported by the options manager or individual options.

See also: GetOptionOperationFlags

Enumerator
OOF_COUNT_FIXED	Active if number of options is fixed. When set, insert and delete operations are not allowed.
OOF_SUPPORT_RENAME	Active if rename of options is supported. When set, SetOptionName() can be used to rename options.
OOF_SUPPORT_INSERT	Active if insert of options is possible. When set, InsertOption() can add new options.
OOF_SUPPORT_DELETE	Active if delete of options is possible. When set, RemoveOption() can delete options.
OOF_SUPPORT_SWAP	Active if swap of options is possible. When set, SwapOptions() can reorder options.
OOF_DISABLE_ALLOWED	Active if it is possible to have disabled options. When set, options can be in disabled state.
OOF_SUPPORT_ENABLING	Active if enabling and disabling of options is possible. When set, SetOptionEnabled() can change option enable state.

Definition at line 118 of file IOptionsManager.h.

Member Function Documentation

◆ GetOptionOperationFlags()

virtual int iprm::IOptionsManager::GetOptionOperationFlags ( int index = -1 ) const

pure virtual

Get operation control flags of some option or whole manager.

Returns flags indicating which operations are supported, either for the entire manager (index < 0) or for a specific option.

Parameters

index

Index addressing position in the option list.

Negative value: Returns general manager-level flags.
Zero or positive: Returns flags for specific option at that position.
Value equal to count: Returns flags for potential insert at end.

Returns: Bitwise OR combination of OptionOperationFlags values.

Note: TODO: Consider merging this with IOptionsList::GetOptionsFlags().

// Check general manager capabilities
int flags = manager.GetOptionOperationFlags(-1);
if (flags & iprm::IOptionsManager::OOF_SUPPORT_INSERT)
{
    qDebug() << "Can insert new options";
}
 
// Check if first option can be renamed
int firstFlags = manager.GetOptionOperationFlags(0);
if (firstFlags & iprm::IOptionsManager::OOF_SUPPORT_RENAME)
{
    manager.SetOptionName(0, "New Name");
}

See also: OptionOperationFlags

Implemented in iprm::CMultiParamsManagerComp, iprm::COptionsManager, and iprm::CParamsManagerComp.

◆ InsertOption()

virtual bool iprm::IOptionsManager::InsertOption	(	const QString &	optionName,
		const QByteArray &	optionId,
		const QString &	optionDescription = `QString()`,
		int	index = `-1`
	)

pure virtual

Insert an option at some position.

Adds a new option to the list at the specified position.

Parameters

optionName	Name of the option (display text).
optionId	ID of the option. According to data model constraints, this needs to be unique if SCF_SUPPORT_UNIQUE_ID flag is set.
optionDescription	Description/tooltip text for the option (optional).
index	Position where the new option will be inserted. Negative value: Option will be added to the end of the list. Zero or positive: Insert at specified position.

Returns: true if the operation was successful, false otherwise.

Note: Check OOF_SUPPORT_INSERT flag before calling.; Triggers CF_OPTION_ADDED notification on success.

int flags = manager.GetOptionOperationFlags(-1);
if (flags & iprm::IOptionsManager::OOF_SUPPORT_INSERT)
{
    // Add to end
    bool added = manager.InsertOption(
        "New Option",
        "opt_new",
        "Description of new option",
        -1);
    
    if (added)
    {
        qDebug() << "Option added";
    }
    
    // Insert at specific position
    manager.InsertOption("First Option", "opt_first", "", 0);
}

See also: RemoveOption, OOF_SUPPORT_INSERT, CF_OPTION_ADDED

Implemented in iprm::CMultiParamsManagerComp, iprm::CParamsManagerComp, and iprm::COptionsManager.

◆ RemoveOption()

virtual bool iprm::IOptionsManager::RemoveOption ( int index )

pure virtual

Remove an option at the given index.

Deletes the option at the specified position from the list.

Parameters

index Option index (0-based).

Returns: true if the operation was successful, false otherwise.

Note: Check OOF_SUPPORT_DELETE flag before calling.; If the removed option was selected, selection may be cleared or moved.; Triggers CF_OPTION_REMOVED notification on success.

int flags = manager.GetOptionOperationFlags(-1);
if (flags & iprm::IOptionsManager::OOF_SUPPORT_DELETE)
{
    bool removed = manager.RemoveOption(2);
    if (removed)
    {
        qDebug() << "Option removed successfully";
    }
}

See also: InsertOption, OOF_SUPPORT_DELETE, CF_OPTION_REMOVED

Implemented in iprm::CMultiParamsManagerComp, iprm::COptionsManager, and iprm::CParamsManagerComp.

◆ SetOptionDescription()

virtual bool iprm::IOptionsManager::SetOptionDescription	(	int	optionIndex,
		const QString &	optionDescription
	)

pure virtual

Set a new description for the option at the given index.

Changes the description/tooltip text of an option.

Parameters

optionIndex	Option index (0-based).
optionDescription	New description for the option.

Returns: true if operation succeeded, false otherwise.

bool success = manager.SetOptionDescription(0, "Updated description text");
if (success)
{
    qDebug() << "Description updated";
}

See also: GetOptionDescription

Implemented in iprm::COptionsManager, iprm::CMultiParamsManagerComp, and iprm::CParamsManagerComp.

◆ SetOptionEnabled()

virtual bool iprm::IOptionsManager::SetOptionEnabled	(	int	index,
		bool	isEnabled = `true`
	)

pure virtual

Enables or disables a given option.

Changes the enabled state of an option. Only enabled options can be selected.

Parameters

index	Option index (0-based).
isEnabled	true to enable, false to disable.

Returns: true if operation succeeded, false otherwise.

Note: Check OOF_SUPPORT_ENABLING flag before calling.; Triggers change notification on success.

// Disable second option
bool success = manager.SetOptionEnabled(1, false);
if (success)
{
    qDebug() << "Option disabled";
}
 
// Re-enable it
manager.SetOptionEnabled(1, true);

See also: IsOptionEnabled, OOF_SUPPORT_ENABLING

Implemented in iprm::CMultiParamsManagerComp, iprm::COptionsManager, and iprm::CParamsManagerComp.

◆ SetOptionName()

virtual bool iprm::IOptionsManager::SetOptionName	(	int	optionIndex,
		const QString &	optionName
	)

pure virtual

Set a new name for the option at the given index.

Changes the display name of an option.

Parameters

optionIndex	Option index (0-based).
optionName	New name for the option.

Returns: true if rename succeeded, false otherwise.

Note: Check OOF_SUPPORT_RENAME flag before calling.; Triggers CF_OPTION_RENAMED notification on success.

int flags = manager.GetOptionOperationFlags(0);
if (flags & iprm::IOptionsManager::OOF_SUPPORT_RENAME)
{
    bool renamed = manager.SetOptionName(0, "Updated Name");
    if (renamed)
    {
        qDebug() << "Option renamed";
    }
}

See also: GetOptionName, OOF_SUPPORT_RENAME, CF_OPTION_RENAMED

Implemented in iprm::COptionsManager, iprm::CMultiParamsManagerComp, and iprm::CParamsManagerComp.

◆ SwapOptions()

virtual bool iprm::IOptionsManager::SwapOptions	(	int	index1,
		int	index2
	)

pure virtual

Swap two options.

Exchanges the positions of two options in the list.

Parameters

index1	Index of first option.
index2	Index of second option.

Returns: true if swap succeeded, false otherwise.

Note: Check OOF_SUPPORT_SWAP flag before calling.; Option IDs remain stable; only list positions change.

// Swap first and third options
int flags = manager.GetOptionOperationFlags(-1);
if (flags & iprm::IOptionsManager::OOF_SUPPORT_SWAP)
{
    bool swapped = manager.SwapOptions(0, 2);
    if (swapped)
    {
        qDebug() << "Options swapped";
    }
}

See also: OOF_SUPPORT_SWAP

Implemented in iprm::CMultiParamsManagerComp, iprm::COptionsManager, and iprm::CParamsManagerComp.

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

Acf/Include/iprm/IOptionsManager.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Usage Example

Iterating with State Check

Member Enumeration Documentation

◆ ChangeFlags

◆ OptionOperationFlags

Member Function Documentation

◆ GetOptionOperationFlags()

◆ InsertOption()

◆ RemoveOption()

◆ SetOptionDescription()

◆ SetOptionEnabled()

◆ SetOptionName()

◆ SwapOptions()