Public Types | Public Member Functions | List of all members
iprm::IOptionsManager Class Referenceabstract

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

#include <IOptionsManager.h>

Inheritance diagram for iprm::IOptionsManager:
iprm::IOptionsList iprm::ISelectionParam istd::IChangeable iser::ISerializable istd::IPolymorphic istd::IChangeable istd::IPolymorphic iprm::COptionsManager iprm::CParamsManagerCompBase iimg::CComposedBitmapProviderComp iprm::COptionsManagerComp iprm::CMultiParamsManagerComp iprm::CParamsManagerComp

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 control 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...
 
- 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. More...
 
virtual bool SetOptionEnabled (int index, bool isEnabled=true)=0
 Enables a given option. More...
 
virtual bool RemoveOption (int index)=0
 Remove an option at the given index. More...
 
virtual bool InsertOption (const QString &optionName, const QByteArray &optionId, const QString &optionDescription=QString(), int index=-1)=0
 Insert an option at some position. More...
 
virtual bool SwapOptions (int index1, int index2)=0
 Swap two options. More...
 
virtual bool SetOptionName (int optionIndex, const QString &optionName)=0
 Set a new name for the option at the given index optionIndex. More...
 
virtual bool SetOptionDescription (int optionIndex, const QString &optionDescription)=0
 Set a new description for the option at the given index optionIndex. More...
 
- Public Member Functions inherited from iprm::IOptionsList
virtual int GetOptionsFlags () const =0
 Get constraints flags. More...
 
virtual int GetOptionsCount () const =0
 Get number of managed options. More...
 
virtual QString GetOptionName (int index) const =0
 Get name of specified option. More...
 
virtual QString GetOptionDescription (int index) const =0
 Get human readable description for a option with the index index. More...
 
virtual QByteArray GetOptionId (int index) const =0
 Get option ID. More...
 
virtual bool IsOptionEnabled (int index) const =0
 Return true if the option is enabled and can be selected. More...
 
- Public Member Functions inherited from istd::IChangeable
virtual int GetSupportedOperations () const
 Get set of flags for supported operations. More...
 
virtual bool CopyFrom (const IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS)
 Copy this object from another one. More...
 
virtual bool IsEqual (const IChangeable &object) const
 Compare this object with another object. More...
 
virtual IChangeableCloneMe (CompatibilityMode mode=CM_WITHOUT_REFS) const
 Make a copy of this object. More...
 
virtual bool ResetData (CompatibilityMode mode=CM_WITHOUT_REFS)
 Reset data to its default state. More...
 
virtual void BeginChanges (const ChangeSet &changeSet)
 Starts the change transaction. More...
 
virtual void EndChanges (const ChangeSet &changeSet)
 Ends the change transaction. More...
 
virtual void BeginChangeGroup (const ChangeSet &changeSet)
 Starts group of changes. More...
 
virtual void EndChangeGroup (const ChangeSet &changeSet)
 Ends group of changes. More...
 
- Public Member Functions inherited from istd::IPolymorphic
virtual ~IPolymorphic ()
 
- Public Member Functions inherited from iprm::ISelectionParam
virtual const IOptionsListGetSelectionConstraints () const =0
 Get constraints of this parameter. More...
 
virtual int GetSelectedOptionIndex () const =0
 Get selected index. More...
 
virtual bool SetSelectedOptionIndex (int index)=0
 Set index of selected option. More...
 
virtual ISelectionParamGetSubselection (int index) const =0
 Get subselection for specified option. More...
 
- Public Member Functions inherited from iser::ISerializable
virtual bool Serialize (IArchive &archive)=0
 Load or store state of this object as a archive stream. More...
 
virtual quint32 GetMinimalVersion (int versionId) const
 Get minimal needed version to correct storing of this data. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from istd::IChangeable
static const ChangeSetGetNoChanges ()
 Get empty set of changes. More...
 
static const ChangeSetGetAnyChange ()
 Get anonymous change set. More...
 
static const ChangeSetGetAllChanges ()
 Get anonymous change set. More...
 
static const ChangeSetGetDelegatedChanges ()
 Get delegated change set. More...
 
- Protected Member Functions inherited from istd::IChangeable
virtual void OnBeginChanges ()
 Callback function for begin change event. More...
 
virtual void OnEndChanges (const ChangeSet &changeSet)
 Callback function for end change event. More...
 

Detailed Description

Common interface for the management of the dynamic selection constraints.

Definition at line 17 of file IOptionsManager.h.

Member Enumeration Documentation

Data model change notification flags.

Enumerator
CF_OPTION_ADDED 
CF_OPTION_REMOVED 

Definition at line 23 of file IOptionsManager.h.

Bitwise coded flags used to find out supported features.

Enumerator
OOF_COUNT_FIXED 

Active if number of parameters is fixed.

OOF_SUPPORT_RENAME 

Active if rename of parameters is supported.

OOF_SUPPORT_INSERT 

Active if insert of parameters is possible.

OOF_SUPPORT_DELETE 

Active if delete of parameters is possible.

OOF_SUPPORT_SWAP 

Active if swap of parameters with the other one is possible.

OOF_DISABLE_ALLOWED 

Active if it is possible to get the disabled option.

OOF_SUPPORT_ENABLING 

Active if enabling and disabling of the parameters is possible.

Definition at line 32 of file IOptionsManager.h.

Member Function Documentation

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

Get operation control flags of some option or whole manager.

Parameters
indexindex addressing position in the option list. For negative value general flags are returned. For example if you want to check if there is any re-nameable element you should call it with negative index value. To check if first element can be renamed call it with index value 0. To check if you can insert at the last position please use index value equal to current options count.

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

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.

Parameters
optionNameName of the option
optionIdID of the option, according to data model constraints needs to be unique
optionDescriptionDescription of the option
indexPosition in the list, where the new option will be inserted. Negative value means that the option will be added to the end of the list. Returns true if the operation was successful.

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

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

Remove an option at the given index.

Returns true if the operation was successful.

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

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

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

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

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

Enables a given option.

Only enabled options can be selected.

See Also
GetOptionEnabled

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

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

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

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

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

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

© 2007-2017 Witold Gantzke and Kirill Lepskiy