From a36c7543d4eedaa9e10bfd9f4d9b81279b1bb7e6 Mon Sep 17 00:00:00 2001 From: Dana Jansens Date: Fri, 21 Mar 2003 18:41:36 +0000 Subject: rm the python api docs --- doc/python/config.txt | 68 --------------------------------------------------- 1 file changed, 68 deletions(-) delete mode 100644 doc/python/config.txt (limited to 'doc/python/config.txt') diff --git a/doc/python/config.txt b/doc/python/config.txt deleted file mode 100644 index 5ed5517e..00000000 --- a/doc/python/config.txt +++ /dev/null @@ -1,68 +0,0 @@ -config.Config - ----- - -This document describes the 'Config' class, exposed by Openbox's 'config' -module to its python scripts. - ----- - -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' -- cgit v1.2.3