ApplicationOptionBase

The core of the default object to store data of any type that should persist through sessions of the application. More...

Inheritance diagram for ApplicationOptionBase:

Public Member Functions
virtual	~ApplicationOptionBase ()
	Destructor.
virtual void	fromString (const String &)=0
	Sets the option value by parsing the given string.
virtual INIOption *	iniOption ()=0
	Creates an INIOption representation of this option for INI file serialization.
virtual bool	isDefault () const =0
	Checks whether the current value matches the default value.
virtual void	setToDefaultValue ()=0
	Resets the option value back to its default.
virtual StringAllocatingView	toString () const =0
	Converts the stored option value to a string representation.

Detailed Description

The core of the default object to store data of any type that should persist through sessions of the application.

---

Developers should use ApplicationOption.

Stores data of any type that can easily be saved or retrieved at runtime. Option belongs to a specific group for easy sorting and can be used to automatically generate widgets.

Definition at line 20 of file ApplicationOptions.h.

Member Function Documentation

fromString()

virtual void ApplicationOptionBase::fromString ( const String & )

pure virtual

Sets the option value by parsing the given string.

Parameters

[in]

value

The string to parse into the option's type.

Implemented in ApplicationOption< t_type >, ApplicationOption< ApplicationResource::ReleaseType >, ApplicationOption< bool >, ApplicationOption< fltp04 >, ApplicationOption< fltp08 >, ApplicationOption< Angle< fltp08 > >, ApplicationOption< BitFlag >, ApplicationOption< Bounds< 1, fltp08 > >, ApplicationOption< PasswordString >, ApplicationOption< RGBColor >, ApplicationOption< String >, ApplicationOption< Time >, ApplicationOption< TimeSpan >, ApplicationOption< TranslatedString >, ApplicationOption< UUID >, ApplicationOption< Vector< 3, fltp08 > >, ApplicationOption< Vector< 3, Angle< fltp08 > > >, ApplicationOption< Vector< WidgetMode::e_size, bool > >, ApplicationOption< Vertex< 3, fltp08 > >, ApplicationOption< PrivateKeyAlgorithm >, ApplicationOption< sint04 >, ApplicationOption< uint02 >, ApplicationOption< uint04 >, ApplicationOption< uint08 >, ApplicationOption< ViewportLayoutTheme >, and ApplicationOption< WidgetMode >.

iniOption()

virtual INIOption * ApplicationOptionBase::iniOption ( )

pure virtual

Creates an INIOption representation of this option for INI file serialization.

Returns

A pointer to the INIOption representing this option.

Implemented in ApplicationOption< t_type >, ApplicationOption< ApplicationResource::ReleaseType >, ApplicationOption< bool >, ApplicationOption< fltp04 >, ApplicationOption< fltp08 >, ApplicationOption< Angle< fltp08 > >, ApplicationOption< BitFlag >, ApplicationOption< Bounds< 1, fltp08 > >, ApplicationOption< PasswordString >, ApplicationOption< RGBColor >, ApplicationOption< String >, ApplicationOption< Time >, ApplicationOption< TimeSpan >, ApplicationOption< TranslatedString >, ApplicationOption< UUID >, ApplicationOption< Vector< 3, fltp08 > >, ApplicationOption< Vector< 3, Angle< fltp08 > > >, ApplicationOption< Vector< WidgetMode::e_size, bool > >, ApplicationOption< Vertex< 3, fltp08 > >, ApplicationOption< PrivateKeyAlgorithm >, ApplicationOption< sint04 >, ApplicationOption< uint02 >, ApplicationOption< uint04 >, ApplicationOption< uint08 >, ApplicationOption< ViewportLayoutTheme >, and ApplicationOption< WidgetMode >.

isDefault()

virtual bool ApplicationOptionBase::isDefault ( ) const

pure virtual

Checks whether the current value matches the default value.

Returns

True if the value is equal to the default, false otherwise.

Implemented in ApplicationOption< t_type >, ApplicationOption< ApplicationResource::ReleaseType >, ApplicationOption< bool >, ApplicationOption< fltp04 >, ApplicationOption< fltp08 >, ApplicationOption< Angle< fltp08 > >, ApplicationOption< BitFlag >, ApplicationOption< Bounds< 1, fltp08 > >, ApplicationOption< PasswordString >, ApplicationOption< RGBColor >, ApplicationOption< String >, ApplicationOption< Time >, ApplicationOption< TimeSpan >, ApplicationOption< TranslatedString >, ApplicationOption< UUID >, ApplicationOption< Vector< 3, fltp08 > >, ApplicationOption< Vector< 3, Angle< fltp08 > > >, ApplicationOption< Vector< WidgetMode::e_size, bool > >, ApplicationOption< Vertex< 3, fltp08 > >, ApplicationOption< PrivateKeyAlgorithm >, ApplicationOption< sint04 >, ApplicationOption< uint02 >, ApplicationOption< uint04 >, ApplicationOption< uint08 >, ApplicationOption< ViewportLayoutTheme >, and ApplicationOption< WidgetMode >.

toString()

virtual StringAllocatingView ApplicationOptionBase::toString ( ) const

pure virtual

Converts the stored option value to a string representation.

Returns

A string view containing the serialized value.

Implemented in ApplicationOption< t_type >, ApplicationOption< ApplicationResource::ReleaseType >, ApplicationOption< bool >, ApplicationOption< fltp04 >, ApplicationOption< fltp08 >, ApplicationOption< Angle< fltp08 > >, ApplicationOption< BitFlag >, ApplicationOption< Bounds< 1, fltp08 > >, ApplicationOption< PasswordString >, ApplicationOption< RGBColor >, ApplicationOption< String >, ApplicationOption< Time >, ApplicationOption< TimeSpan >, ApplicationOption< TranslatedString >, ApplicationOption< UUID >, ApplicationOption< Vector< 3, fltp08 > >, ApplicationOption< Vector< 3, Angle< fltp08 > > >, ApplicationOption< Vector< WidgetMode::e_size, bool > >, ApplicationOption< Vertex< 3, fltp08 > >, ApplicationOption< PrivateKeyAlgorithm >, ApplicationOption< sint04 >, ApplicationOption< uint02 >, ApplicationOption< uint04 >, ApplicationOption< uint08 >, ApplicationOption< ViewportLayoutTheme >, and ApplicationOption< WidgetMode >.

---

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

• Base/Headers/ApplicationOptions.h