latex/wx/config.tex

4 not be used by itself (it is an abstract base class) and you will always use one
15 platform: i.e. wxRegConfig under Win32 and
21 It is highly recommended to use static functions {\it Get()} and/or {\it Set()},
46     // last prompt was found in the config file/registry and its value is now
54   // another example: using default values and the full path instead of just
69 enumerating, testing for existence and deleting the entries and groups of
72 is that using this class is easy and that it should normally do what you
76 "registry hive" for wxRegConfig and, generally speaking, might mean any
86 instead of creating and deleting the local config objects each time you need
89 in the very start of the program and {\it Set()} it as the default. Then, from
97 you may forget about calling {\it Set()}. When {\it Get()} is called and there
102 library itself would take advantage of it and could save various information
112 \membersection{Constructor and destructor}\label{congigconstructordestructor}
121 support a file system-like hierarchy of keys (files) and groups (directories).
167 doesn't save and restore the path):
181 Finally, the path separator in wxConfigBase and derived classes is always '/',
190 The functions in this section allow to enumerate all entries and groups in the
193 You must pass the same index to GetNext and GetFirst (don't modify it).
195 some great surprises with wxRegConfig if you assume this) and you shouldn't
229   ... we have all group (and entry) names in aNames...
261 These function are the core of wxConfigBase class: they allow you to read and
265 Currently, only two types of data are supported: string and long (but it might
267 bool} you can work with function taking/returning {\it long} and just use the
269 save in the config file: chances are that {\tt sizeof(bool) == sizeof(int) == sizeof(long)} anyhow on your system. For {\it float}, {\it double} and, in
271 representation and use string functions.
273 Try not to read long values into string variables and vice versa: although it
300 The functions in this section delete entries and/or groups of entries from the
331 reading this value and SetExpandEnvVars(true) just after. Another solution
358 This is the default and only constructor of the wxConfigBase class, and
365 application name is used in the registry key on Windows, and can be used to
378 \docparam{style}{Can be one of wxCONFIG\_USE\_LOCAL\_FILE and
380 class and is ignored by some implementations. For wxFileConfig, these styles
383 config file and if wxCONFIG\_USE\_LOCAL\_FILE is used, settings are read from
384 and written to local config file (if they are both set, global file is read
423 By default, environment variable expansion is on and recording defaults is
441 created object and also sets it as the current one.
465 Deletes the specified entry and the group it belongs to if it was the last key
466 in it and the second parameter is true.
475 the current path is \texttt{/A/B/C/D} and the group \texttt{C} is deleted the
498 Get the current config object. If there is no current object and
541 consisting of the continue flag, the value string, and the index for
544 \perlnote{In wxPerl this method takes no arguments and returns a 3-element
555 consisting of the continue flag, the value string, and the index for
558 \perlnote{In wxPerl this method takes no arguments and returns a 3-element
569 consisting of the continue flag, the value string, and the index for
573 and returns a 3-element list {\tt ( continue, str, index )}.}
583 consisting of the continue flag, the value string, and the index for
587 and returns a 3-element list {\tt ( continue, str, index )}.}
677 Reads a long value from the key and returns it. {\it defaultVal} is returned
742 Renames an entry in the current group. The entries names (both the old and
743 the new one) shouldn't contain backslashes, i.e. only simple names and not
754 Renames a subgroup of the current group. The subgroup names (both the old and
755 the new one) shouldn't contain backslashes, i.e. only simple names and not
767 current object (both the parameter and returned value may be NULL)
795 options may be changed and is probably useful only for wxFileConfig.
809 These functions write the specified value to the config file and return \true on success.