Action setting implementation. More...

#include <Setting.h>

Inheritance diagram for CSettingAction:

Public Member Functions
	CSettingAction (const std::string &id, CSettingsManager *settingsManager=nullptr)

	CSettingAction (const std::string &id, int label, CSettingsManager *settingsManager=nullptr)

	CSettingAction (const std::string &id, const CSettingAction &setting)

	~CSettingAction () override=default

std::shared_ptr< CSetting >	Clone (const std::string &id) const override

void	MergeDetails (const CSetting &other) override

bool	Deserialize (const TiXmlNode *node, bool update=false) override
	Deserializes the given XML node into the properties of the setting object.

SettingType	GetType () const override

bool	FromString (const std::string &value) override

std::string	ToString () const override

bool	Equals (const std::string &value) const override

bool	CheckValidity (const std::string &value) const override

void	Reset () override

bool	HasData () const

const std::string &	GetData () const

void	SetData (std::string_view data)

Public Member Functions inherited from CSetting
	CSetting (const std::string &id, CSettingsManager *settingsManager=nullptr)

	CSetting (const std::string &id, const CSetting &setting)

	~CSetting () override=default

void	MergeBasics (const CSetting &other)

bool	IsEnabled () const

bool	GetEnabled () const

void	SetEnabled (bool enabled)

bool	IsDefault () const

const std::string &	GetParent () const

void	SetParent (std::string_view parentSetting)

SettingLevel	GetLevel () const

void	SetLevel (SettingLevel level)

std::shared_ptr< ISettingControl >	GetControl () const

void	SetControl (std::shared_ptr< ISettingControl > control)

const SettingDependencies &	GetDependencies () const

void	SetDependencies (const SettingDependencies &dependencies)

const std::set< CSettingUpdate > &	GetUpdates () const

void	SetCallback (ISettingCallback *callback)

bool	IsReference () const

const std::string &	GetReferencedId () const

void	SetReferencedId (std::string_view referencedId)

void	MakeReference (const std::string &referencedId="")

bool	GetVisible () const

bool	IsVisible () const override
	Whether the setting object is visible or hidden.

void	OnSettingAction (const std::shared_ptr< const CSetting > &setting) override
	The given setting has been activated.

Public Member Functions inherited from ISetting
	ISetting (const std::string &id, CSettingsManager *settingsManager=nullptr)
	Creates a new setting object with the given identifier.

virtual	~ISetting ()=default

const std::string &	GetId () const
	Gets the identifier of the setting object.

virtual void	SetVisible (bool visible)
	Sets the visibility state of the setting object.

int	GetLabel () const
	Gets the localizeable label ID of the setting group.

void	SetLabel (int label)
	Sets the localizeable label ID of the setting group.

int	GetHelp () const
	Gets the localizeable help ID of the setting group.

void	SetHelp (int help)
	Sets the localizeable help ID of the setting group.

virtual bool	MeetsRequirements () const
	Whether the setting object meets all necessary requirements.

virtual void	CheckRequirements ()
	Checks if the setting object meets all necessary requirements.

virtual void	SetRequirementsMet (bool requirementsMet)
	Sets whether the setting object meets all necessary requirements.

Protected Member Functions
virtual void	copy (const CSettingAction &setting)

Protected Member Functions inherited from CSetting
bool	OnSettingChanging (const std::shared_ptr< const CSetting > &setting) override
	The value of the given setting is being changed.

void	OnSettingChanged (const std::shared_ptr< const CSetting > &setting) override
	The value of the given setting has changed.

bool	OnSettingUpdate (const std::shared_ptr< CSetting > &setting, const char oldSettingId, const TiXmlNode oldSettingNode) override
	The given setting needs to be updated.

void	OnSettingPropertyChanged (const std::shared_ptr< const CSetting > &setting, const char *propertyName) override
	The given property of the given setting has changed.

void	Copy (const CSetting &setting)

template<class TSetting >
std::shared_ptr< TSetting >	shared_from_base ()

Protected Member Functions inherited from ISettingCallback
virtual	~ISettingCallback ()=default

Protected Attributes
std::string	m_data

Protected Attributes inherited from CSetting
ISettingCallback *	m_callback = nullptr

bool	m_enabled = true

std::string	m_parentSetting

SettingLevel	m_level = SettingLevel::Standard

std::shared_ptr< ISettingControl >	m_control

SettingDependencies	m_dependencies

std::set< CSettingUpdate >	m_updates

bool	m_changed = false

CSharedSection	m_critical

std::string	m_referencedId

Protected Attributes inherited from ISetting
std::string	m_id

CSettingsManager *	m_settingsManager

Static Protected Attributes
static Logger	s_logger

Static Protected Attributes inherited from ISetting
static constexpr int	DefaultLabel = -1

Additional Inherited Members
Static Public Member Functions inherited from CSetting
static bool	DeserializeIdentification (const TiXmlNode *node, std::string &identification, bool &isReference)
	Deserializes the given XML node to retrieve a setting object's identifier and whether the setting is a reference to another setting or not.

Static Public Member Functions inherited from ISetting
static bool	DeserializeIdentification (const TiXmlNode *node, std::string &identification)
	Deserializes the given XML node to retrieve a setting object's identifier.

Static Protected Member Functions inherited from ISetting
static bool	DeserializeIdentificationFromAttribute (const TiXmlNode *node, const std::string &attribute, std::string &identification)
	Deserializes the given XML node to retrieve a setting object's identifier from the given attribute.

Detailed Description

Action setting implementation.

A setting action will trigger a call to the OnSettingAction() callback method when activated.

See also: CSetting

Constructor & Destructor Documentation

◆ CSettingAction() [1/3]

CSettingAction::CSettingAction	(	const std::string &	id,
		CSettingsManager *	settingsManager = nullptr )

◆ CSettingAction() [2/3]

CSettingAction::CSettingAction	(	const std::string &	id,
		int	label,
		CSettingsManager *	settingsManager = nullptr )

◆ CSettingAction() [3/3]

CSettingAction::CSettingAction	(	const std::string &	id,
		const CSettingAction &	setting )

◆ ~CSettingAction()

CSettingAction::~CSettingAction ( )

overridedefault

Member Function Documentation

◆ CheckValidity()

bool CSettingAction::CheckValidity ( const std::string & value ) const

inlineoverridevirtual

Implements CSetting.

◆ Clone()

SettingPtr CSettingAction::Clone ( const std::string & id ) const

overridevirtual

Implements CSetting.

◆ copy()

void CSettingAction::copy ( const CSettingAction & setting )

protectedvirtual

◆ Deserialize()

bool CSettingAction::Deserialize	(	const TiXmlNode *	node,
		bool	update = false )

overridevirtual

Deserializes the given XML node into the properties of the setting object.

If the update parameter is true, the checks for mandatory properties are skipped and values are only updated.

Parameters

node	XML node containing the properties of the setting object
update	Whether to perform checks for mandatory properties or not

Returns: True if deserialization was successful, false otherwise

Reimplemented from CSetting.

◆ Equals()

bool CSettingAction::Equals ( const std::string & value ) const

inlineoverridevirtual

Implements CSetting.

◆ FromString()

bool CSettingAction::FromString ( const std::string & value )

inlineoverridevirtual

Implements CSetting.

◆ GetData()

const std::string & CSettingAction::GetData ( ) const

inline

◆ GetType()

SettingType CSettingAction::GetType ( ) const

inlineoverridevirtual

Implements CSetting.

◆ HasData()

bool CSettingAction::HasData ( ) const

inline

◆ MergeDetails()

void CSettingAction::MergeDetails ( const CSetting & other )

overridevirtual

Implements CSetting.

◆ Reset()

void CSettingAction::Reset ( )

inlineoverridevirtual

Implements CSetting.

◆ SetData()

void CSettingAction::SetData ( std::string_view data )

inline

◆ ToString()

std::string CSettingAction::ToString ( ) const

inlineoverridevirtual

Implements CSetting.

Member Data Documentation

◆ m_data

std::string CSettingAction::m_data

protected

◆ s_logger

Logger CSettingAction::s_logger

staticprotected

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

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CSettingAction() [1/3]

◆ CSettingAction() [2/3]

◆ CSettingAction() [3/3]

◆ ~CSettingAction()

Member Function Documentation

◆ CheckValidity()

◆ Clone()

◆ copy()

◆ Deserialize()

◆ Equals()

◆ FromString()

◆ GetData()

◆ GetType()

◆ HasData()

◆ MergeDetails()

◆ Reset()

◆ SetData()

◆ ToString()

Member Data Documentation

◆ m_data

◆ s_logger