ACF $AcfVersion:0$
Public Types | Public Member Functions | Static Public Member Functions | List of all members
iimg::CPixelFormatList Class Reference

#include <CPixelFormatList.h>

Inheritance diagram for iimg::CPixelFormatList:
iprm::IOptionsList istd::IChangeable istd::IPolymorphic

Public Types

typedef QSet< int > ActiveFormats
 
- 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 Member Functions

 CPixelFormatList ()
 
ActiveFormats GetActiveFormats () const
 
void SetActiveFormats (const ActiveFormats &formats)
 
virtual int GetOptionsFlags () const override
 Get constraints flags.
 
virtual int GetOptionsCount () const override
 Get number of managed options.
 
virtual QString GetOptionName (int index) const override
 Get name of specified option.
 
virtual QString GetOptionDescription (int index) const override
 Get human-readable description for an option.
 
virtual QByteArray GetOptionId (int index) const override
 Get option ID.
 
virtual bool IsOptionEnabled (int index) const override
 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::IChangeableCloneMe (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 ()
 

Static Public Member Functions

static const CPixelFormatListGetInstance ()
 
- Static Public Member Functions inherited from istd::IChangeable
static const ChangeSetGetNoChanges ()
 Get empty set of changes.
 
static const ChangeSetGetAnyChange ()
 Get anonymous change set.
 
static const ChangeSetGetAllChanges ()
 Get anonymous change set.
 
static const ChangeSetGetDelegatedChanges ()
 Get delegated change set.
 

Additional Inherited Members

- 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

Definition at line 14 of file CPixelFormatList.h.

Member Typedef Documentation

◆ ActiveFormats

Definition at line 17 of file CPixelFormatList.h.

Constructor & Destructor Documentation

◆ CPixelFormatList()

iimg::CPixelFormatList::CPixelFormatList ( )

Member Function Documentation

◆ GetActiveFormats()

ActiveFormats iimg::CPixelFormatList::GetActiveFormats ( ) const

◆ GetInstance()

static const CPixelFormatList & iimg::CPixelFormatList::GetInstance ( )
static

◆ GetOptionDescription()

virtual QString iimg::CPixelFormatList::GetOptionDescription ( int  index) const
overridevirtual

Get human-readable description for an option.

Returns detailed description or tooltip text for an option.

Parameters
indexOption 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

Implements iprm::IOptionsList.

◆ GetOptionId()

virtual QByteArray iimg::CPixelFormatList::GetOptionId ( int  index) const
overridevirtual

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
indexOption 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);
int FindOptionIndexById(const QByteArray &id, const iprm::IOptionsList &list)
Find the option index by the given ID.
See also
OptionsFlags, FindOptionIndexById

Implements iprm::IOptionsList.

◆ GetOptionName()

virtual QString iimg::CPixelFormatList::GetOptionName ( int  index) const
overridevirtual

Get name of specified option.

Returns the display name for an option.

Parameters
indexOption 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

Implements iprm::IOptionsList.

◆ GetOptionsCount()

virtual int iimg::CPixelFormatList::GetOptionsCount ( ) const
overridevirtual

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

Implements iprm::IOptionsList.

◆ GetOptionsFlags()

virtual int iimg::CPixelFormatList::GetOptionsFlags ( ) const
overridevirtual

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();
{
qDebug() << "Options have unique IDs";
}
{
qDebug() << "Options can be disabled";
}
@ SFC_DISABLE_ALLOWED
If set, some options can be disabled.
@ SCF_SUPPORT_UNIQUE_ID
If set, every option must have a unique ID.
See also
OptionsFlags

Implements iprm::IOptionsList.

◆ IsOptionEnabled()

virtual bool iimg::CPixelFormatList::IsOptionEnabled ( int  index) const
overridevirtual

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

Implements iprm::IOptionsList.

◆ SetActiveFormats()

void iimg::CPixelFormatList::SetActiveFormats ( const ActiveFormats formats)

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