cConfig Class Reference

List of all members.

Public Member Functions

mixed DeclareInteger (mixed name, mixed topic, mixed label, mixed desc, mixed default_value, mixed needs_restart, mixed validation_function)

mixed DeclareFloat (mixed name, mixed topic, mixed label, mixed desc, mixed default_value, mixed needs_restart, mixed validation_function)

mixed DeclareString (mixed name, mixed topic, mixed label, mixed desc, mixed default_value, mixed needs_restart, mixed validation_function)

mixed DeclareBoolean (mixed name, mixed topic, mixed label, mixed desc, mixed default_value, mixed needs_restart, mixed validation_function)

mixed DeclareEnum (mixed name, mixed topic, mixed label, mixed desc, mixed default_value, mixed possible_values, mixed needs_restart, mixed validation_function)

mixed ForAllNames (mixed f)

iterater over all options and calls f(name,typevalue,value)

mixed ForAllTopics (mixed f)

iterater over all topics and calls f(name)

mixed ForAllNamesInTopic (mixed topic, mixed f)

iterater over all options of one topic and calls f(name,typevalue,value)

mixed GetPossibleEnumValues (mixed name)

mixed ResetValue (mixed name)

resets the value of name to the declared default values

mixed Undeclare (mixed name)

mixed GetType (mixed name)

the type of the given value (typevalue constant) or nil if undeclared

mixed Get (mixed name)

returns the value if set or the default value

mixed IsDeclared (mixed name)

mixed IsValidValue (mixed name, mixed value)

mixed NeedsRestart (mixed name)

mixed RegisterListener (mixed f)

registers a listener function f(name,value) that gets called on :Set(name,value)

mixed Set (mixed name, mixed value)

returns true if successfull. invalid values or inexistent names will fail.

mixed _Declare (mixed name, mixed valuetype, mixed topic, mixed label, mixed desc, mixed default_value, mixed needs_restart, mixed enum_value_list, mixed validation_function)

mixed PrintError (mixed...)

mixed RebuildTopicList (mixed name)

Detailed Description

Definition at line 651 of file lua_pseudo_code.cpp.

Member Function Documentation

mixed cConfig::DeclareInteger	(	mixed	name,
		mixed	topic,
		mixed	label,
		mixed	desc,
		mixed	default_value,
		mixed	needs_restart,
		mixed	validation_function
	)			`[inline]`

Definition at line 653 of file lua_pseudo_code.cpp.

mixed cConfig::DeclareFloat	(	mixed	name,
		mixed	topic,
		mixed	label,
		mixed	desc,
		mixed	default_value,
		mixed	needs_restart,
		mixed	validation_function
	)			`[inline]`

Definition at line 655 of file lua_pseudo_code.cpp.

mixed cConfig::DeclareString	(	mixed	name,
		mixed	topic,
		mixed	label,
		mixed	desc,
		mixed	default_value,
		mixed	needs_restart,
		mixed	validation_function
	)			`[inline]`

Definition at line 657 of file lua_pseudo_code.cpp.

mixed cConfig::DeclareBoolean	(	mixed	name,
		mixed	topic,
		mixed	label,
		mixed	desc,
		mixed	default_value,
		mixed	needs_restart,
		mixed	validation_function
	)			`[inline]`

Definition at line 659 of file lua_pseudo_code.cpp.

mixed cConfig::DeclareEnum	(	mixed	name,
		mixed	topic,
		mixed	label,
		mixed	desc,
		mixed	default_value,
		mixed	possible_values,
		mixed	needs_restart,
		mixed	validation_function
	)			`[inline]`

Definition at line 661 of file lua_pseudo_code.cpp.

mixed cConfig::ForAllNames ( mixed f ) [inline]

iterater over all options and calls f(name,typevalue,value)

Definition at line 664 of file lua_pseudo_code.cpp.

mixed cConfig::ForAllTopics ( mixed f ) [inline]

iterater over all topics and calls f(name)

Definition at line 667 of file lua_pseudo_code.cpp.

mixed cConfig::ForAllNamesInTopic	(	mixed	topic,
		mixed	f
	)			`[inline]`

iterater over all options of one topic and calls f(name,typevalue,value)

Definition at line 670 of file lua_pseudo_code.cpp.

mixed cConfig::GetPossibleEnumValues ( mixed name ) [inline]

returns a list of possible values (dont modify the returned list!) only valid if the given name is a enum option

Definition at line 674 of file lua_pseudo_code.cpp.

mixed cConfig::ResetValue ( mixed name ) [inline]

resets the value of name to the declared default values

Definition at line 677 of file lua_pseudo_code.cpp.

mixed cConfig::Undeclare ( mixed name ) [inline]

Definition at line 679 of file lua_pseudo_code.cpp.

mixed cConfig::GetType ( mixed name ) [inline]

the type of the given value (typevalue constant) or nil if undeclared

Definition at line 682 of file lua_pseudo_code.cpp.

mixed cConfig::Get ( mixed name ) [inline]

returns the value if set or the default value

Definition at line 685 of file lua_pseudo_code.cpp.

mixed cConfig::IsDeclared ( mixed name ) [inline]

Definition at line 687 of file lua_pseudo_code.cpp.

mixed cConfig::IsValidValue	(	mixed	name,
		mixed	value
	)			`[inline]`

Definition at line 689 of file lua_pseudo_code.cpp.

mixed cConfig::NeedsRestart ( mixed name ) [inline]

Definition at line 691 of file lua_pseudo_code.cpp.

mixed cConfig::RegisterListener ( mixed f ) [inline]

registers a listener function f(name,value) that gets called on :Set(name,value)

Definition at line 694 of file lua_pseudo_code.cpp.

mixed cConfig::Set	(	mixed	name,
		mixed	value
	)			`[inline]`

returns true if successfull. invalid values or inexistent names will fail.

Definition at line 697 of file lua_pseudo_code.cpp.

mixed cConfig::_Declare	(	mixed	name,
		mixed	valuetype,
		mixed	topic,
		mixed	label,
		mixed	desc,
		mixed	default_value,
		mixed	needs_restart,
		mixed	enum_value_list,
		mixed	validation_function
	)			`[inline]`

----------------------------------------------------------------- ----------------------------------------------------------------- -------- internal stuff ----------------------------------------------------------------- ----------------------------------------------------------------- creates a config options (normally you dont call this directly, see DeclareBLA) does not overwrite existing declarations name : key name to access the option. its not possible to declare the same name under different topics valuetype : the topic : string to group options together label : human readable/understandable name of the option, ie for displaying in the gui needs_restart : if true a restart of the program is needed, default to false

Definition at line 711 of file lua_pseudo_code.cpp.

mixed cConfig::PrintError ( mixed... ) [inline]

Definition at line 713 of file lua_pseudo_code.cpp.

mixed cConfig::RebuildTopicList ( mixed name ) [inline]

Definition at line 715 of file lua_pseudo_code.cpp.

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

tmp/lua_pseudo_code.cpp


Public Member Functions
mixed	DeclareInteger (mixed name, mixed topic, mixed label, mixed desc, mixed default_value, mixed needs_restart, mixed validation_function)
mixed	DeclareFloat (mixed name, mixed topic, mixed label, mixed desc, mixed default_value, mixed needs_restart, mixed validation_function)
mixed	DeclareString (mixed name, mixed topic, mixed label, mixed desc, mixed default_value, mixed needs_restart, mixed validation_function)
mixed	DeclareBoolean (mixed name, mixed topic, mixed label, mixed desc, mixed default_value, mixed needs_restart, mixed validation_function)
mixed	DeclareEnum (mixed name, mixed topic, mixed label, mixed desc, mixed default_value, mixed possible_values, mixed needs_restart, mixed validation_function)
mixed	ForAllNames (mixed f)
	iterater over all options and calls f(name,typevalue,value)
mixed	ForAllTopics (mixed f)
	iterater over all topics and calls f(name)
mixed	ForAllNamesInTopic (mixed topic, mixed f)
	iterater over all options of one topic and calls f(name,typevalue,value)
mixed	GetPossibleEnumValues (mixed name)
mixed	ResetValue (mixed name)
	resets the value of name to the declared default values
mixed	Undeclare (mixed name)
mixed	GetType (mixed name)
	the type of the given value (typevalue constant) or nil if undeclared
mixed	Get (mixed name)
	returns the value if set or the default value
mixed	IsDeclared (mixed name)
mixed	IsValidValue (mixed name, mixed value)
mixed	NeedsRestart (mixed name)
mixed	RegisterListener (mixed f)
	registers a listener function f(name,value) that gets called on :Set(name,value)
mixed	Set (mixed name, mixed value)
	returns true if successfull. invalid values or inexistent names will fail.
mixed	_Declare (mixed name, mixed valuetype, mixed topic, mixed label, mixed desc, mixed default_value, mixed needs_restart, mixed enum_value_list, mixed validation_function)
mixed	PrintError (mixed...)
mixed	RebuildTopicList (mixed name)