Real number setting implementation. More...

#include <Setting.h>

Inheritance diagram for CSettingNumber:

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

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

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

	CSettingNumber (const std::string &id, int label, float value, float minimum, float step, float maximum, CSettingsManager *settingsManager=nullptr)

	~CSettingNumber () override=default

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

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

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

virtual bool	CheckValidity (double value) const

void	Reset () override

double	GetValue () const

bool	SetValue (double value)

double	GetDefault () const

void	SetDefault (double value)

double	GetMinimum () const

void	SetMinimum (double minimum)

double	GetStep () const

void	SetStep (double step)

double	GetMaximum () const

void	SetMaximum (double maximum)

Public Member Functions inherited from CTraitedSetting< double, SettingType::Number >
SettingType	GetType () const override

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

bool	IsEnabled () const

void	SetEnabled (bool enabled)

bool	IsDefault () const

const std::string &	GetParent () const

void	SetParent (const std::string &parentSetting)

SettingLevel	GetLevel () const

void	SetLevel (SettingLevel level)

std::shared_ptr< const ISettingControl >	GetControl () const

std::shared_ptr< ISettingControl >	GetControl ()

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	IsVisible () const override
	Whether the setting object is visible or hidden. More...

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

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

virtual	~ISetting ()=default

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

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

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

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

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

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

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

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

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

Additional Inherited Members
Public Types inherited from CTraitedSetting< double, SettingType::Number >
typedef double	Value

Static Public Member Functions inherited from CTraitedSetting< double, SettingType::Number >
static SettingType	Type ()

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. More...

Protected Member Functions inherited from CTraitedSetting< double, SettingType::Number >
	CTraitedSetting (const std::string &id, CSettingsManager *settingsManager=nullptr)

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

	~CTraitedSetting () override=default

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

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

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

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

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

Protected Attributes inherited from ISetting
std::string	m_id

CSettingsManager *	m_settingsManager

Detailed Description

Real number setting implementation.

See also: CSetting

Constructor & Destructor Documentation

◆ CSettingNumber() [1/4]

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

◆ CSettingNumber() [2/4]

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

◆ CSettingNumber() [3/4]

CSettingNumber::CSettingNumber	(	const std::string &	id,
		int	label,
		float	value,
		CSettingsManager *	settingsManager = `nullptr`
	)

◆ CSettingNumber() [4/4]

CSettingNumber::CSettingNumber	(	const std::string &	id,
		int	label,
		float	value,
		float	minimum,
		float	step,
		float	maximum,
		CSettingsManager *	settingsManager = `nullptr`
	)

◆ ~CSettingNumber()

CSettingNumber::~CSettingNumber ( )

overridedefault

Member Function Documentation

◆ CheckValidity() [1/2]

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

overridevirtual

Implements CSetting.

◆ CheckValidity() [2/2]

bool CSettingNumber::CheckValidity ( double value ) const

virtual

◆ Clone()

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

overridevirtual

Implements CSetting.

◆ Deserialize()

bool CSettingNumber::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 CSettingNumber::Equals ( const std::string & value ) const

overridevirtual

Implements CSetting.

◆ FromString()

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

overridevirtual

Implements CSetting.

◆ GetDefault()

double CSettingNumber::GetDefault ( ) const

inline

◆ GetMaximum()

double CSettingNumber::GetMaximum ( ) const

inline

◆ GetMinimum()

double CSettingNumber::GetMinimum ( ) const

inline

◆ GetStep()

double CSettingNumber::GetStep ( ) const

inline

◆ GetValue()

double CSettingNumber::GetValue ( ) const

inline

◆ Reset()

void CSettingNumber::Reset ( void )

inlineoverridevirtual

Implements CSetting.

◆ SetDefault()

void CSettingNumber::SetDefault ( double value )

◆ SetMaximum()

void CSettingNumber::SetMaximum ( double maximum )

inline

◆ SetMinimum()

void CSettingNumber::SetMinimum ( double minimum )

inline

◆ SetStep()

void CSettingNumber::SetStep ( double step )

inline

◆ SetValue()

bool CSettingNumber::SetValue ( double value )

◆ ToString()

std::string CSettingNumber::ToString ( ) const

overridevirtual

Implements CSetting.

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CSettingNumber() [1/4]

◆ CSettingNumber() [2/4]

◆ CSettingNumber() [3/4]

◆ CSettingNumber() [4/4]

◆ ~CSettingNumber()

Member Function Documentation

◆ CheckValidity() [1/2]

◆ CheckValidity() [2/2]

◆ Clone()

◆ Deserialize()

◆ Equals()

◆ FromString()

◆ GetDefault()

◆ GetMaximum()

◆ GetMinimum()

◆ GetStep()

◆ GetValue()

◆ Reset()

◆ SetDefault()

◆ SetMaximum()

◆ SetMinimum()

◆ SetStep()

◆ SetValue()

◆ ToString()