ICF 3.0.5.47
Technical documentation of ICF Libraries
icmpstr::CPackagesLoaderExtComp::ParamsManager Class Reference

#include <CPackagesLoaderExtComp.h>

Inheritance diagram for icmpstr::CPackagesLoaderExtComp::ParamsManager:
Collaboration diagram for icmpstr::CPackagesLoaderExtComp::ParamsManager:

Classes

struct  Entry
 

Public Member Functions

int GetIndexOperationFlags (int index=-1) const override
 Get operation control flags of some paramter set or whole manager.
 
bool SetIndexOperationFlags (int index, int flags) override
 Set operation control flags of some parameter-set.
 
int GetParamsSetsCount () const override
 Get number of managed set.
 
const IOptionsList * GetParamsTypeConstraints () const override
 Get selection contraints describing each supported type.
 
int InsertParamsSet (int typeIndex=-1, int index=-1) override
 Insert new parameters set at selected position.
 
bool RemoveParamsSet (int index) override
 Remove parameters set at selected position.
 
bool SwapParamsSet (int index1, int index2) override
 Swap two parameter sets.
 
iprm::IParamsSetGetParamsSet (int index) const override
 Get selected parameter set.
 
QString GetParamsSetName (int index) const override
 Get name of specified parameter set.
 
bool SetParamsSetName (int index, const QString &name) override
 Set name of specified parameter set.
 
QString GetParamsSetDescription (int index) const override
 Get the description of the specified parameter set.
 
void SetParamsSetDescription (int index, const QString &description) override
 Set the description of the specified parameter set.
 
int GetOptionsFlags () const override
 Get constraints flags.
 
int GetOptionsCount () const override
 Get number of managed options.
 
QString GetOptionName (int index) const override
 Get name of specified option.
 
QString GetOptionDescription (int index) const override
 Get human readable description for a option with the index index.
 
QByteArray GetOptionId (int index) const override
 Get option ID.
 
bool IsOptionEnabled (int index) const override
 Return true if the option is enabled and can be selected.
 
- Public Member Functions inherited from iprm::IParamsManager
- Public Member Functions inherited from iprm::IOptionsList
- 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 std::unique_ptr< 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 QMutex * GetChangesLock () const
 Get mutex beeing locked during changes, if available.
 
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 Attributes

std::vector< EntryrootRegistries
 

Additional Inherited Members

- Public Types inherited from iprm::IParamsManager
enum  ParamsOperationFlags {
  MF_COUNT_FIXED = 1 , MF_SUPPORT_RENAME = 2 , MF_SUPPORT_INSERT = 4 , MF_SUPPORT_DELETE = 8 ,
  MF_SUPPORT_SWAP = 16 , MF_DISABLE_ALLOWED = 32 , MF_SUPPORT_EDIT = 64 , MF_INACTIVE = 128
}
 Bitwise coded flags used to find out supported features. More...
 
enum  ChangeFlags { CF_SET_INSERTED = 0x5af60 , CF_SET_REMOVED , CF_SET_NAME_CHANGED , CF_SET_ENABLE_CHANGED }
 Possible changes of the manager's data model. More...
 
typedef QSet< QByteArray > TypeIds
 
- 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_ICF_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 , SO_CHANGE_LOCK = 1 << 5
}
 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...
 
- Static Public Member Functions inherited from iprm::IOptionsList
static int FindIndexById (const QByteArray &id, const iprm::IOptionsList &list)
 Helper function to find the option index by ID.
 
- 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.
 
- 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 50 of file CPackagesLoaderExtComp.h.

Member Function Documentation

◆ GetIndexOperationFlags()

int icmpstr::CPackagesLoaderExtComp::ParamsManager::GetIndexOperationFlags ( int index = -1) const
overridevirtual

Get operation control flags of some paramter set or whole manager.

See also
ManagerFlags.
Parameters
indexindex addressing position in parameter set list. For negative value general flags are returned. For example if you want to check if there is any renameable 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 number of parameter set.

Implements iprm::IParamsManager.

◆ GetOptionDescription()

QString icmpstr::CPackagesLoaderExtComp::ParamsManager::GetOptionDescription ( int index) const
overridevirtual

Get human readable description for a option with the index index.

Implements iprm::IOptionsList.

◆ GetOptionId()

QByteArray icmpstr::CPackagesLoaderExtComp::ParamsManager::GetOptionId ( int index) const
overridevirtual

Get option ID.

The option ID must be unique, if flag SCF_SUPPORT_UNIQUE_ID is set.

See also
OptionsFlags

Implements iprm::IOptionsList.

◆ GetOptionName()

QString icmpstr::CPackagesLoaderExtComp::ParamsManager::GetOptionName ( int index) const
overridevirtual

Get name of specified option.

Implements iprm::IOptionsList.

◆ GetOptionsCount()

int icmpstr::CPackagesLoaderExtComp::ParamsManager::GetOptionsCount ( ) const
overridevirtual

Get number of managed options.

Implements iprm::IOptionsList.

◆ GetOptionsFlags()

int icmpstr::CPackagesLoaderExtComp::ParamsManager::GetOptionsFlags ( ) const
overridevirtual

Get constraints flags.

The flags describes how the constraints object mantainance

Implements iprm::IOptionsList.

◆ GetParamsSet()

iprm::IParamsSet * icmpstr::CPackagesLoaderExtComp::ParamsManager::GetParamsSet ( int index) const
overridevirtual

Get selected parameter set.

Implements iprm::IParamsManager.

◆ GetParamsSetDescription()

QString icmpstr::CPackagesLoaderExtComp::ParamsManager::GetParamsSetDescription ( int index) const
overridevirtual

Get the description of the specified parameter set.

Implements iprm::IParamsManager.

◆ GetParamsSetName()

QString icmpstr::CPackagesLoaderExtComp::ParamsManager::GetParamsSetName ( int index) const
overridevirtual

Get name of specified parameter set.

Implements iprm::IParamsManager.

◆ GetParamsSetsCount()

int icmpstr::CPackagesLoaderExtComp::ParamsManager::GetParamsSetsCount ( ) const
overridevirtual

Get number of managed set.

Implements iprm::IParamsManager.

◆ GetParamsTypeConstraints()

const IOptionsList * icmpstr::CPackagesLoaderExtComp::ParamsManager::GetParamsTypeConstraints ( ) const
overridevirtual

Get selection contraints describing each supported type.

Returns
nullptr, if only one annonymed type is supported.

Implements iprm::IParamsManager.

◆ InsertParamsSet()

int icmpstr::CPackagesLoaderExtComp::ParamsManager::InsertParamsSet ( int typeIndex = -1,
int index = -1 )
overridevirtual

Insert new parameters set at selected position.

Parameters
typeIndexIndex of parameter type. This index is context specified and is used to indicate type of parameters should be added. If equals negative value the type will be automatically selected.
indexPosition in list of parameters or negative value to use default position.
Returns
Position of inserted new entry or negative value if no insert was possible. For specified index positions (positive index value) it will return the same index or negative value.

Implements iprm::IParamsManager.

◆ IsOptionEnabled()

bool icmpstr::CPackagesLoaderExtComp::ParamsManager::IsOptionEnabled ( int index) const
overridevirtual

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

Implements iprm::IOptionsList.

◆ RemoveParamsSet()

bool icmpstr::CPackagesLoaderExtComp::ParamsManager::RemoveParamsSet ( int index)
overridevirtual

Remove parameters set at selected position.

Implements iprm::IParamsManager.

◆ SetIndexOperationFlags()

bool icmpstr::CPackagesLoaderExtComp::ParamsManager::SetIndexOperationFlags ( int index,
int flags )
overridevirtual

Set operation control flags of some parameter-set.

Only single parameter-set related flags can be set.

See also
ManagerFlags.
Parameters
flagsOperation flags to be used.
indexIndex addressing position in parameter set list.
Returns
Status of the operation.

Implements iprm::IParamsManager.

◆ SetParamsSetDescription()

void icmpstr::CPackagesLoaderExtComp::ParamsManager::SetParamsSetDescription ( int index,
const QString & description )
overridevirtual

Set the description of the specified parameter set.

Implements iprm::IParamsManager.

◆ SetParamsSetName()

bool icmpstr::CPackagesLoaderExtComp::ParamsManager::SetParamsSetName ( int index,
const QString & name )
overridevirtual

Set name of specified parameter set.

Implements iprm::IParamsManager.

◆ SwapParamsSet()

bool icmpstr::CPackagesLoaderExtComp::ParamsManager::SwapParamsSet ( int index1,
int index2 )
overridevirtual

Swap two parameter sets.

Implements iprm::IParamsManager.

Member Data Documentation

◆ rootRegistries

std::vector<Entry> icmpstr::CPackagesLoaderExtComp::ParamsManager::rootRegistries
mutable

Definition at line 81 of file CPackagesLoaderExtComp.h.


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

© Witold Gantzke and Kirill Lepskiy