vs_conf.Settings.Option Class Reference

Key wrapper class. More...

Public Member Functions
None	__init__ (self, str key, str desc, tuple options=None, Callable[[str], str] setter=str, Callable[[str], str] getter=str, object default=None, bool advanced=False)
str	__str__ (self)
bool	set_value (self, Any value)
	Sets the value for this option.
str	get_value (self)
	Get the value for this option.

Public Attributes
	key
	desc
	options
	setter
	getter
	value
	advanced

Static Public Attributes
str	key
str	desc
tuple	options
bool	advanced
Callable	setter [[str], str]
Callable	getter [[str], str]
str	value

Detailed Description

Key wrapper class.

Definition at line 125 of file vs_conf.py.

Constructor & Destructor Documentation

__init__()

None vs_conf.Settings.Option.__init__	(		self,
		str	key,
		str	desc,
		tuple	options = None,
		Callable[[str], str]	setter = str,
		Callable[[str], str]	getter = str,
		object	default = None,
		bool	advanced = False
	)

Definition at line 137 of file vs_conf.py.

Member Function Documentation

__str__()

str vs_conf.Settings.Option.__str__

(

self

)

Definition at line 155 of file vs_conf.py.

get_value()

str vs_conf.Settings.Option.get_value

(

self

)

Get the value for this option.

Returns: str: The value of this option

Definition at line 184 of file vs_conf.py.

set_value()

bool vs_conf.Settings.Option.set_value	(		self,
		Any	value
	)

Sets the value for this option.

Args: value (Any): The value to use to set

Returns: bool: The value was successfully set

Definition at line 166 of file vs_conf.py.

Member Data Documentation

advanced [1/2]

bool vs_conf.Settings.Option.advanced

static

Definition at line 131 of file vs_conf.py.

advanced [2/2]

vs_conf.Settings.Option.advanced

Definition at line 153 of file vs_conf.py.

desc [1/2]

str vs_conf.Settings.Option.desc

static

Definition at line 129 of file vs_conf.py.

desc [2/2]

vs_conf.Settings.Option.desc

Definition at line 148 of file vs_conf.py.

getter [1/2]

Callable vs_conf.Settings.Option.getter [[str], str]

static

Definition at line 133 of file vs_conf.py.

getter [2/2]

vs_conf.Settings.Option.getter

Definition at line 151 of file vs_conf.py.

key [1/2]

str vs_conf.Settings.Option.key

static

Definition at line 128 of file vs_conf.py.

key [2/2]

vs_conf.Settings.Option.key

Definition at line 147 of file vs_conf.py.

options [1/2]

tuple vs_conf.Settings.Option.options

static

Definition at line 130 of file vs_conf.py.

options [2/2]

vs_conf.Settings.Option.options

Definition at line 149 of file vs_conf.py.

setter [1/2]

Callable vs_conf.Settings.Option.setter [[str], str]

static

Definition at line 132 of file vs_conf.py.

setter [2/2]

vs_conf.Settings.Option.setter

Definition at line 150 of file vs_conf.py.

value [1/2]

str vs_conf.Settings.Option.value

static

Definition at line 135 of file vs_conf.py.

value [2/2]

vs_conf.Settings.Option.value

Definition at line 152 of file vs_conf.py.

---

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

• vs_conf.py