Interface for objects which can be enabled/disabled. More...

#include <IEnableableParam.h>

Inheritance diagram for iprm::IEnableableParam:

Public Types
enum	ChangeFlags { CF_ENABLED = 0x089347 }
	Change notification flags. 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 bool	IsEnabled () const =0
	Return true if something is enabled.

virtual bool	IsEnablingAllowed () const =0
	Return true if enabling/disabling is allowed.

virtual bool	SetEnabled (bool isEnabled=true)=0
	Set the enabled state.

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.

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

Interface for objects which can be enabled/disabled.

IEnableableParam provides enable/disable functionality for parameters or features. This is commonly used for optional features, conditional parameters, or togglable settings in user interfaces.

Usage Example

#include <iprm/CEnableableParam.h>
 
// Create an enableable parameter
iprm::CEnableableParam param;
 
// Check if enabled
bool isEnabled = param.IsEnabled();
qDebug() << "Enabled:" << isEnabled;
 
// Check if enabling is allowed
bool canEnable = param.IsEnablingAllowed();
if (canEnable)
{
    // Enable the parameter
    bool success = param.SetEnabled(true);
    if (success)
    {
        qDebug() << "Parameter enabled";
    }
    
    // Disable the parameter
    param.SetEnabled(false);
}

Conditional Parameter Example

// Use with other parameters to create conditional logic
iprm::CEnableableParam useAdvancedMode;
iprm::CTextParam advancedOption;
 
// Only process advanced option if enabled
if (useAdvancedMode.IsEnabled())
{
    QString option = advancedOption.GetText();
    // Process advanced option...
}

Change Notification Example

// Monitoring enable state changes
// (Requires observer implementation)
 
if (changeSet.Contains(iprm::IEnableableParam::CF_ENABLED))
{
    bool newState = param.IsEnabled();
    qDebug() << "Enable state changed to:" << newState;
}

Note: Inherits from iser::ISerializable for persistence support.; Some implementations may restrict enabling/disabling based on context.

See also: CEnableableParam

Definition at line 80 of file IEnableableParam.h.

Member Enumeration Documentation

◆ ChangeFlags

enum iprm::IEnableableParam::ChangeFlags

Change notification flags.

Used with the observer pattern to detect enable state changes.

See also: istd::IChangeable::ChangeSet

Enumerator
CF_ENABLED	Enable state has changed.

Definition at line 91 of file IEnableableParam.h.

Member Function Documentation

◆ IsEnabled()

virtual bool iprm::IEnableableParam::IsEnabled ( ) const

pure virtual

Return true if something is enabled.

Returns: true if currently enabled, false if disabled.

if (param.IsEnabled())
{
    // Perform action that requires enabled state
}

See also: SetEnabled, IsEnablingAllowed

Implemented in iprm::CDelegatedEnableableParamComp, and iprm::CEnableableParam.

◆ IsEnablingAllowed()

virtual bool iprm::IEnableableParam::IsEnablingAllowed ( ) const

pure virtual

Return true if enabling/disabling is allowed.

Indicates whether the enable state can be changed. Some parameters may have fixed enable states based on system constraints or dependencies.

Returns: true if SetEnabled() can change the state, false if state is fixed.

if (param.IsEnablingAllowed())
{
    // User can toggle the enable state
    param.SetEnabled(!param.IsEnabled());
}
else
{
    // Enable state is fixed by system constraints
    qDebug() << "Cannot change enable state";
}

See also: SetEnabled

Implemented in iprm::CDelegatedEnableableParamComp, and iprm::CEnableableParam.

◆ SetEnabled()

virtual bool iprm::IEnableableParam::SetEnabled ( bool isEnabled = true )

pure virtual

Set the enabled state.

Changes whether the parameter is enabled or disabled.

Parameters

isEnabled New enable state. true to enable, false to disable.

Returns: true if the state change was allowed and successful, false otherwise.

Note: Returns false if IsEnablingAllowed() returns false.; Triggers CF_ENABLED notification on successful change.

// Enable
if (param.SetEnabled(true))
{
    qDebug() << "Successfully enabled";
}
 
// Disable
if (param.SetEnabled(false))
{
    qDebug() << "Successfully disabled";
}
 
// Toggle
param.SetEnabled(!param.IsEnabled());

See also: IsEnabled, IsEnablingAllowed, CF_ENABLED

Implemented in iprm::CDelegatedEnableableParamComp, iprm::CEnableableParam, and iqtgui::CHierarchicalCommand.

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

Acf/Include/iprm/IEnableableParam.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Usage Example

Conditional Parameter Example

Change Notification Example

Member Enumeration Documentation

◆ ChangeFlags

Member Function Documentation

◆ IsEnabled()

◆ IsEnablingAllowed()

◆ SetEnabled()