X-Git-Url: https://git.dogcows.com/gitweb?a=blobdiff_plain;f=doc%2Fpython%2Fconfig.txt;h=5ed5517e68a1271a57656d2000b31627f5459ca8;hb=7f590e53607ef1592d65a425b9cdcaa181912465;hp=0362fde1707cc3251f5f8d9a4910ab32989340bd;hpb=74c683ee5fb232d7fe9f517b21ffd9ee50872dce;p=chaz%2Fopenbox

diff --git a/doc/python/config.txt b/doc/python/config.txt
index 0362fde1..5ed5517e 100644
--- a/doc/python/config.txt
+++ b/doc/python/config.txt
@@ -11,3 +11,58 @@ Methods
 
 ----
 
+add(modulename, name, friendlyname, description, type, default, **keywords):
+
+Add a variable to the configuration system for a module.
+
+	modulename: The name of the module, e.g. 'focus'
+	name: The name of the variable, e.g. 'my_variable'
+	friendlyname: The user-friendly name of the variable, e.g.
+		      'My Variable'
+	description: The detailed destription of the variable, e.g.
+		     'Does Things'
+	type: The type of the variable, one of:
+	      * 'boolean'
+	      * 'enum'
+	      * 'integer'
+	      * 'string'
+	      * 'function'
+	      * 'object'
+	default: The default value for the variable, e.g. 300
+	keywords: Extra keyword=value pairs to further define the variable.
+		  These can be:
+		  * For 'enum' types:
+                     * options : A list of possible options for the variable.
+                                 This *must* be set for all enum variables.
+		  * For 'integer' types:
+                     * min : The minimum value for the variable.
+                     * max : The maximum value for the variable.
+
+----
+
+set(modulename, name, value):
+
+Sets the value for a variable of the specified module.
+
+	modulename: The name of the module, e.g. 'focus'
+	name: The name of the variable, e.g. 'my_variable'
+	value: The new value for the variable.
+
+----
+
+reset(modulename, name):
+
+Resets the value for a variable in the specified module back to its original
+(default) value.
+
+	modulename: The name of the module, e.g. 'focus'
+	name: The name of the variable, e.g. 'my_variable'
+
+----
+
+get(modulename, name):
+
+Returns the current value for a variable in the specified module.
+
+	modulename: The name of the module, e.g. 'focus'
+	name: The name of the variable, e.g. 'my variable'