|
|
A class for parsing and quickly accessing INI style configuration files
| Configuration ()
| Configuration |
Create an empty configuration
| Configuration (const char *filename)
| Configuration |
Create a configuration from a file
Parameters:
| filename | Name of file to initialize from |
| inline Configuration& operator= (const String &value)
| operator= |
Assignment from string operator
Reimplemented from String.
| inline unsigned int sections ()
| sections |
[const]
Get the number of sections
Returns: Count of sections
| NamedList * getSection (unsigned int index)
| getSection |
[const]
Retrive an entire section
Parameters:
| index | Index of the section |
Returns: The section's content or NULL if no such section
| NamedList * getSection (const String §)
| getSection |
[const]
Retrive an entire section
Parameters:
| sect | Name of the section |
Returns: The section's content or NULL if no such section
| NamedString * getKey (const String §, const String &key)
| getKey |
[const]
Locate a key/value pair in the section.
Parameters:
| sect | Name of the section |
| key | Name of the key in section |
Returns: A pointer to the key/value pair or NULL.
| const char * getValue (const String §, const String &key, const char *defvalue = 0)
| getValue |
[const]
Retrive the value of a key in a section.
Parameters:
| sect | Name of the section |
| key | Name of the key in section |
| defvalue | Default value to return if not found |
Returns: The string contained in the key or the default
| int getIntValue (const String §, const String &key, int defvalue = 0)
| getIntValue |
[const]
Retrive the numeric value of a key in a section.
Parameters:
| sect | Name of the section |
| key | Name of the key in section |
| defvalue | Default value to return if not found |
Returns: The number contained in the key or the default
| int getIntValue (const String §, const String &key, const TokenDict *tokens, int defvalue = 0)
| getIntValue |
[const]
Retrive the numeric value of a key in a section trying first a table lookup.
Parameters:
| sect | Name of the section |
| key | Name of the key in section |
| tokens | A pointer to an array of tokens to try to lookup |
| defvalue | Default value to return if not found |
Returns: The number contained in the key or the default
| bool getBoolValue (const String §, const String &key, bool defvalue = false)
| getBoolValue |
[const]
Retrive the boolean value of a key in a section.
Parameters:
| sect | Name of the section |
| key | Name of the key in section |
| defvalue | Default value to return if not found |
Returns: The boolean value contained in the key or the default
| void clearSection (const char *sect = 0)
| clearSection |
Deletes an entire section
Parameters:
| sect | Name of section to delete, NULL to delete all |
| void clearKey (const String §, const String &key)
| clearKey |
Deletes a key/value pair
Parameters:
| sect | Name of section |
| key | Name of the key to delete |
| void addValue (const String §, const char *key, const char *value = 0)
| addValue |
Add the value of a key in a section.
Parameters:
| sect | Name of the section, will be created if missing |
| key | Name of the key to add in the section |
| value | Value to set in the key |
| void setValue (const String §, const char *key, const char *value = 0)
| setValue |
Set the value of a key in a section.
Parameters:
| sect | Name of the section, will be created if missing |
| key | Name of the key in section, will be created if missing |
| value | Value to set in the key |
| void setValue (const String §, const char *key, int value)
| setValue |
Set the numeric value of a key in a section.
Parameters:
| sect | Name of the section, will be created if missing |
| key | Name of the key in section, will be created if missing |
| value | Value to set in the key |
| void setValue (const String §, const char *key, bool value)
| setValue |
Set the boolean value of a key in a section.
Parameters:
| sect | Name of the section, will be created if missing |
| key | Name of the key in section, will be created if missing |
| value | Value to set in the key |
| bool load ()
| load |
Load the configuration from file
Returns: True if successfull, false for failure
| bool save ()
| save |
[const]
Save the configuration to file
Returns: True if successfull, false for failure
| Generated by: kk on nyx on Sat Jun 4 19:29:41 2005, using kdoc 2.0a54. |