5 This document describes the 'Config' class, exposed by Openbox's 'config'
6 module to its python scripts.
14 add(modulename, name, friendlyname, description, type, default, **keywords):
16 Add a variable to the configuration system for a module.
18 modulename: The name of the module, e.g. 'focus'
19 name: The name of the variable, e.g. 'my_variable'
20 friendlyname: The user-friendly name of the variable, e.g.
22 description: The detailed destription of the variable, e.g.
24 type: The type of the variable, one of:
31 default: The default value for the variable, e.g. 300
32 keywords: Extra keyword=value pairs to further define the variable.
35 * options : A list of possible options for the variable.
36 This *must* be set for all enum variables.
37 * For 'integer' types:
38 * min : The minimum value for the variable.
39 * max : The maximum value for the variable.
43 set(modulename, name, value):
45 Sets the value for a variable of the specified module.
47 modulename: The name of the module, e.g. 'focus'
48 name: The name of the variable, e.g. 'my_variable'
49 value: The new value for the variable.
53 reset(modulename, name):
55 Resets the value for a variable in the specified module back to its original
58 modulename: The name of the module, e.g. 'focus'
59 name: The name of the variable, e.g. 'my_variable'
63 get(modulename, name):
65 Returns the current value for a variable in the specified module.
67 modulename: The name of the module, e.g. 'focus'
68 name: The name of the variable, e.g. 'my variable'