ApplicationOptions Class Reference

The container for storing N-number of ApplicationOption for the program. Almost all options are typically "user options" and are added to that container by default. More...

#include <ApplicationOptions.h>

Collaboration diagram for ApplicationOptions:

Public Member Functions
void	addOption (const TranslatedString &group_name, const TranslatedString &name, ApplicationOptionBase *value)
void	addOption (const TranslatedString &name, ApplicationOptionBase *value)
void	addToINI (const TranslatedString &group_name, INIFactory &factory)
void	addToINI (INIFactory &factory)
	ApplicationOptions ()
const ApplicationOptionBase *	getOption (const TranslatedString &group, const TranslatedString &name) const
const ApplicationOptionBase *	getOption (const TranslatedString &name) const
void	logOptions (ProgressInfo *log, bool log_only_non_defaults)
void	setToDefaults ()
void	setToDefaults (const TranslatedString &group_name)

Static Public Member Functions
static ApplicationOptions &	UserOptions ()

Protected Attributes
Dictionary< TranslatedString, Dictionary< TranslatedString, ApplicationOptionBase * > >	m_options

Detailed Description

The container for storing N-number of ApplicationOption for the program. Almost all options are typically "user options" and are added to that container by default.

---

Class: ApplicationOptions

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.

Constructor & Destructor Documentation

ApplicationOptions()

ApplicationOptions

(

)

Member Function Documentation

addOption() [1/2]

void addOption ( const TranslatedString & group_name, const TranslatedString & name, ApplicationOptionBase * value )

inline

addOption() [2/2]

void addOption ( const TranslatedString & name, ApplicationOptionBase * value )

inline

addToINI() [1/2]

void addToINI	(	const TranslatedString &	group_name,
		INIFactory &	factory )

addToINI() [2/2]

void addToINI

(

INIFactory &

factory

)

getOption() [1/2]

const ApplicationOptionBase * getOption ( const TranslatedString & group, const TranslatedString & name ) const

inline

getOption() [2/2]

const ApplicationOptionBase * getOption ( const TranslatedString & name ) const

inline

logOptions()

void logOptions	(	ProgressInfo *	log,
		bool	log_only_non_defaults )

setToDefaults() [1/2]

void setToDefaults

(

)

setToDefaults() [2/2]

void setToDefaults

(

const TranslatedString &

group_name

)

UserOptions()

static ApplicationOptions & UserOptions ( )

static

Member Data Documentation

m_options

Dictionary<TranslatedString, Dictionary<TranslatedString, ApplicationOptionBase*> > m_options

protected

---

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

• Base/Headers/ApplicationOptions.h