Next: Configuration events, Previous: Configuration contexts, Up: Configuration functions [Contents][Index]
A Lepton configuration parameter consists of three components:
A string which identifies the general category in which the parameter lies (e.g. which application and/or plugin).
A string which specifically identifies the parameter within the group.
The value of the parameter. This is stored as a string, but can be converted to a number of possible scalar and list types.
Groups, names and values are all case-sensitive.
Returns a list of all groups available in cfg and its parent contexts.
Since 1.10.
Determines whether cfg or its parent contexts contain the specified group
Since 1.10.
Returns a list of all keys available in the specified group in cfg and its parent contexts.
Since 1.10.
Determines whether cfg or its parent contexts contains key in the specified group.
Since 1.10.
Removes the configuration parameter identified by the given group and key in the configuration context cfg. Returns ‘#t’ on success, ‘#f’ otherwise.
Removes the configuration group identified by group and all its parameters in the configuration context cfg. Returns ‘#t’ on success, ‘#f’ otherwise.
If a configuration context does not directly specify a value for a configuration parameter, it inherits the value from its parent context.
See Context parents.
Returns ‘#f’ if value of the configuration parameter with the given group and key is specified in the context cfg, and ‘#t’ if it is inherited from a parent context of cfg.
Since 1.10.
Returns the configuration context (either cfg or one of its parent contexts) in which the configuration parameter with the given group and key has its value defined.
Since 1.10.
Each value is stored as a UTF-8 string in the configuration file. However, this string can be parsed a several different types. All of the following types are supported:
In addition, lists of all the above are supported.
Retrieve configuration value as a string.
Since 1.10.
Retrieve configuration value as a boolean.
Since 1.10.
Retrieve configuration value as an exact integer.
Since 1.10.
Retrieve configuration value as an inexact real number.
Since 1.10.
Retrieve configuration value as a list of strings.
Since 1.10.
Retrieve configuration value as a list of booleans.
Since 1.10.
Retrieve configuration value as a list of exact integers.
Since 1.10.
Retrieve configuration value as a list of inexact real numbers.
Since 1.10.
Set the configuration parameter identified by the given group and key in the configuration context cfg. The type of value to set is inferred from value. Returns cfg.
Since 1.10.
Next: Configuration events, Previous: Configuration contexts, Up: Configuration functions [Contents][Index]