FileConfig derives from BaseConfig and implements file based config class, i
Set and retrieve current path
Enumeration of subgroups/entries
Key access
Other functions
Filter functions.
FileConfig derives from BaseConfig and implements file based config class, i.e. it uses ASCII disk files to store the information. These files are alternatively called INI, .conf or .rc in the documentation. They are organized in groups or sections, which can nest (i.e. a group contains subgroups, which contain their own subgroups &c). Each group has some number of entries, which are "key = value" pairs. More precisely, the format is:# comments are allowed after either ';' or '#' (Win/UNIX standard) # blank lines (as above) are ignored # global entries are members of special (no name) top group written_for = wxWindows platform = Linux # the start of the group 'Foo' [Foo] # may put comments like this also # following 3 lines are entries key = value another_key = " strings with spaces in the beginning should be quoted, \ otherwise the spaces are lost" last_key = but you don't have to put " normally (nor quote them, like here) # subgroup of the group 'Foo' # (order is not important, only the name is: separator is '/', as in paths) [Foo/Bar] # entries prefixed with "!" are immutable, i.e. can't be changed if they are # set in the system wide .conf file !special_key = value bar_entry = whatever [Foo/Bar/Fubar] # depth is (theoretically :-) unlimited # may have the same name as key in another section bar_entry = whatever notYou {have read/write/delete}Entry functions (guess what they do) and also setCurrentPath to select current group. enum{Subgroups/Entries} allow you to get all entries in the config file (in the current group). Finally, flush() writes immediately all changed entries to disk (otherwise it would be done automatically in dtor) FileConfig manages not less than 2 config files for each program: global and local (or system and user if you prefer). Entries are read from both of them and the local entries override the global ones unless the latter is immutable (prefixed with '!') in which case a warning message is generated and local value is ignored. Of course, the changes are always written to local file only.
FileConfig(istream *iStream)
FileConfig(void)
~FileConfig()
Implementation of inherited pure virtual functions
const char* readEntry(const char *szKey, const char *szDefault = NULL) const
long int readEntry(const char *szKey, long int Default) const
double readEntry(const char *szKey, double Default) const
Bool writeEntry(const char *szKey, const char *szValue)
Bool writeEntry(const char *szKey, long int Value)
Bool writeEntry(const char *szKey, double Value)
Bool deleteEntry(const char *szKey)
Bool flush(Bool bCurrentOnly = FALSE)
Bool flush(ostream *oStream, Bool = FALSE)
Bool parseLine(const char *psz)
Enumeration
Enumerator* enumSubgroups() const
Enumerator* enumEntries() const
void Init()
alphabetic index hierarchy of classes
this page has been generated automatically by doc++
(c)opyright by Malte Zöckler, Roland Wunderling
contact: doc++@zib.de