String setting implementation. More...

#include <Setting.h>

Inheritance diagram for CSettingString:

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

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

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

	~CSettingString () 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. 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

void	Reset () override

virtual const std::string &	GetValue () const

virtual bool	SetValue (const std::string &value)

virtual const std::string &	GetDefault () const

virtual void	SetDefault (const std::string &value)

virtual bool	AllowEmpty () const

void	SetAllowEmpty (bool allowEmpty)

virtual bool	AllowNewOption () const

void	SetAllowNewOption (bool allowNewOption)

SettingOptionsType	GetOptionsType () const

const TranslatableStringSettingOptions &	GetTranslatableOptions () const

void	SetTranslatableOptions (const TranslatableStringSettingOptions &options)

const StringSettingOptions &	GetOptions () const

void	SetOptions (const StringSettingOptions &options)

const std::string &	GetOptionsFillerName () const

void	SetOptionsFillerName (const std::string &optionsFillerName, void *data=nullptr)

void	SetOptionsFiller (StringSettingOptionsFiller optionsFiller, void *data=nullptr)

StringSettingOptions	GetDynamicOptions () const

StringSettingOptions	UpdateDynamicOptions ()

SettingOptionsSort	GetOptionsSort () const

void	SetOptionsSort (SettingOptionsSort optionsSort)

Public Member Functions inherited from CTraitedSetting< std::string, SettingType::String >
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

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 (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	IsReference () const

const std::string &	GetReferencedId () const

void	SetReferencedId (const std::string &referencedId)

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

bool	GetVisible () const

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

void	OnSettingAction (const 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...

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

Protected Member Functions inherited from CTraitedSetting< std::string, SettingType::String >
	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 (const std::shared_ptr< const CSetting > &setting) override
	The value of the given setting is being changed. More...

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

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

void	OnSettingPropertyChanged (const 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
std::string	m_value

std::string	m_default

bool	m_allowEmpty = false

bool	m_allowNewOption = false

TranslatableStringSettingOptions	m_translatableOptions

StringSettingOptions	m_options

std::string	m_optionsFillerName

StringSettingOptionsFiller	m_optionsFiller = nullptr

void *	m_optionsFillerData = nullptr

StringSettingOptions	m_dynamicOptions

SettingOptionsSort	m_optionsSort = SettingOptionsSort::NoSorting

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 const Value	DefaultValue

static Logger	s_logger

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

Additional Inherited Members
Public Types inherited from CTraitedSetting< std::string, SettingType::String >
typedef std::string	Value

Static Public Member Functions inherited from CTraitedSetting< std::string, SettingType::String >
static SettingType	Type ()

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

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

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

Detailed Description

String setting implementation.

See also: CSetting

Constructor & Destructor Documentation

◆ CSettingString() [1/3]

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

◆ CSettingString() [2/3]

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

◆ CSettingString() [3/3]

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

◆ ~CSettingString()

CSettingString::~CSettingString ( )

overridedefault

Member Function Documentation

◆ AllowEmpty()

virtual bool CSettingString::AllowEmpty ( ) const

inlinevirtual

◆ AllowNewOption()

virtual bool CSettingString::AllowNewOption ( ) const

inlinevirtual

◆ CheckValidity()

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

overridevirtual

Implements CSetting.

Reimplemented in CSettingDate, and CSettingTime.

◆ Clone()

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

overridevirtual

Implements CSetting.

Reimplemented in CSettingAddon, CSettingDate, CSettingTime, and CSettingPath.

◆ copy()

void CSettingString::copy ( const CSettingString & setting )

protectedvirtual

◆ Deserialize()

bool CSettingString::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.

Reimplemented in CSettingAddon, and CSettingPath.

◆ Equals()

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

inlineoverridevirtual

Implements CSetting.

◆ FromString()

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

inlineoverridevirtual

Implements CSetting.

◆ GetDefault()

virtual const std::string & CSettingString::GetDefault ( ) const

inlinevirtual

◆ GetDynamicOptions()

StringSettingOptions CSettingString::GetDynamicOptions ( ) const

inline

◆ GetOptions()

const StringSettingOptions & CSettingString::GetOptions ( ) const

inline

◆ GetOptionsFillerName()

const std::string & CSettingString::GetOptionsFillerName ( ) const

inline

◆ GetOptionsSort()

SettingOptionsSort CSettingString::GetOptionsSort ( ) const

inline

◆ GetOptionsType()

SettingOptionsType CSettingString::GetOptionsType ( ) const

◆ GetTranslatableOptions()

const TranslatableStringSettingOptions & CSettingString::GetTranslatableOptions ( ) const

inline

◆ GetValue()

virtual const std::string & CSettingString::GetValue ( ) const

inlinevirtual

◆ MergeDetails()

void CSettingString::MergeDetails ( const CSetting & other )

overridevirtual

Implements CSetting.

◆ Reset()

void CSettingString::Reset ( void )

inlineoverridevirtual

Implements CSetting.

◆ SetAllowEmpty()

void CSettingString::SetAllowEmpty ( bool allowEmpty )

inline

◆ SetAllowNewOption()

void CSettingString::SetAllowNewOption ( bool allowNewOption )

inline

◆ SetDefault()

void CSettingString::SetDefault ( const std::string & value )

virtual

◆ SetOptions()

void CSettingString::SetOptions ( const StringSettingOptions & options )

inline

◆ SetOptionsFiller()

void CSettingString::SetOptionsFiller	(	StringSettingOptionsFiller	optionsFiller,
		void *	data = `nullptr`
	)

inline

◆ SetOptionsFillerName()

void CSettingString::SetOptionsFillerName	(	const std::string &	optionsFillerName,
		void *	data = `nullptr`
	)

inline

◆ SetOptionsSort()

void CSettingString::SetOptionsSort ( SettingOptionsSort optionsSort )

inline

◆ SetTranslatableOptions()

void CSettingString::SetTranslatableOptions ( const TranslatableStringSettingOptions & options )

inline

◆ SetValue()

bool CSettingString::SetValue ( const std::string & value )

virtual

Reimplemented in CSettingPath.

◆ ToString()

std::string CSettingString::ToString ( ) const

inlineoverridevirtual

Implements CSetting.

◆ UpdateDynamicOptions()

StringSettingOptions CSettingString::UpdateDynamicOptions ( )

Member Data Documentation

◆ DefaultValue

const CSettingString::Value CSettingString::DefaultValue

staticprotected

◆ m_allowEmpty

bool CSettingString::m_allowEmpty = false

protected

◆ m_allowNewOption

bool CSettingString::m_allowNewOption = false

protected

◆ m_default

std::string CSettingString::m_default

protected

◆ m_dynamicOptions

StringSettingOptions CSettingString::m_dynamicOptions

protected

◆ m_options

StringSettingOptions CSettingString::m_options

protected

◆ m_optionsFiller

StringSettingOptionsFiller CSettingString::m_optionsFiller = nullptr

protected

◆ m_optionsFillerData

void* CSettingString::m_optionsFillerData = nullptr

protected

◆ m_optionsFillerName

std::string CSettingString::m_optionsFillerName

protected

◆ m_optionsSort

SettingOptionsSort CSettingString::m_optionsSort = SettingOptionsSort::NoSorting

protected

◆ m_translatableOptions

TranslatableStringSettingOptions CSettingString::m_translatableOptions

protected

◆ m_value

std::string CSettingString::m_value

protected

◆ s_logger

Logger CSettingString::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

◆ CSettingString() [1/3]

◆ CSettingString() [2/3]

◆ CSettingString() [3/3]

◆ ~CSettingString()

Member Function Documentation

◆ AllowEmpty()

◆ AllowNewOption()

◆ CheckValidity()

◆ Clone()

◆ copy()

◆ Deserialize()

◆ Equals()

◆ FromString()

◆ GetDefault()

◆ GetDynamicOptions()

◆ GetOptions()

◆ GetOptionsFillerName()

◆ GetOptionsSort()

◆ GetOptionsType()

◆ GetTranslatableOptions()

◆ GetValue()

◆ MergeDetails()

◆ Reset()

◆ SetAllowEmpty()

◆ SetAllowNewOption()

◆ SetDefault()

◆ SetOptions()

◆ SetOptionsFiller()

◆ SetOptionsFillerName()

◆ SetOptionsSort()

◆ SetTranslatableOptions()

◆ SetValue()

◆ ToString()

◆ UpdateDynamicOptions()

Member Data Documentation

◆ DefaultValue

◆ m_allowEmpty

◆ m_allowNewOption

◆ m_default

◆ m_dynamicOptions

◆ m_options

◆ m_optionsFiller

◆ m_optionsFillerData

◆ m_optionsFillerName

◆ m_optionsSort

◆ m_translatableOptions

◆ m_value

◆ s_logger