]> git.saurik.com Git - wxWidgets.git/blame - docs/latex/wx/config.tex
wxLog::FlushActive added
[wxWidgets.git] / docs / latex / wx / config.tex
CommitLineData
c4afa2cb
VZ
1\section{\class{wxConfigBase}}\label{wxconfigbase}
2
3wxConfigBase class defines the basic interface of all config classes. It can
4not be used by itself (it's an abstract base class) and you'll always use one
2319d2b0 5of its derivations: wxIniConfig, wxFileConfig, wxRegConfig or any other.
c4afa2cb
VZ
6
7However, usually you don't even need to know the precise nature of the class
8you're working with but you would just use the wxConfigBase methods. This
9allows you to write the same code regardless of whether you're working with
10the registry under Win32 or text-based config files under Unix (or even
11Windows 3.1 .INI files if you're really unlucky). To make writing the portable
052ae0e5 12code even easier, wxWindows provides a typedef wxConfig
c4afa2cb
VZ
13which is mapped onto the native wxConfigBase implementation on the given
14platform: i.e. wxRegConfig under Win32, wxIniConfig under Win16 and
15wxFileConfig otherwise.
16
5f3cd8a2
VZ
17See \helpref{config overview}{wxconfigoverview} for the descriptions of all
18features of this class.
c4afa2cb
VZ
19
20\wxheading{Derived from}
21
22No base class
23
954b8ae6
JS
24\wxheading{Include files}
25
26<wx/config.h> (to let wxWindows choose a wxConfig class for your platform)\\
27<wx/confbase.h> (base config class)\\
28<wx/fileconf.h> (wxFileconfig class)\\
29<wx/msw/regconf.h> (wxRegConfig class)\\
30<wx/msw/iniconf.h> (wxIniConfig class)
31
c4afa2cb
VZ
32\wxheading{Example}
33
34Here is how you would typically use this class:
35
36\begin{verbatim}
37 // using wxConfig instead of writing wxFileConfig or wxRegConfig enhances
38 // portability of the code
39 wxConfig *config = new wxConfig("MyAppName");
40
41 wxString str;
052ae0e5 42 if ( config->Read("LastPrompt", &str) ) {
b8de493f 43 // last prompt was found in the config file/registry and its value is now
c4afa2cb
VZ
44 // in str
45 ...
46 }
47 else {
48 // no last prompt...
49 }
50
51 // another example: using default values and the full path instead of just
52 // key name: if the key is not found , the value 17 is returned
53 long value = config->Read("/LastRun/CalculatedValues/MaxValue", -1);
54 ...
55 ...
56 ...
57 // at the end of the program we would save everything back
58 config->Write("LastPrompt", str);
59 config->Write("/LastRun/CalculatedValues/MaxValue", value);
60
61 // the changes will be written back automatically
62 delete config;
63\end{verbatim}
64
65This basic example, of course, doesn't show all wxConfig features, such as
66enumerating, testing for existence and deleting the entries and groups of
b8de493f 67entries in the config file, its abilities to automatically store the default
c4afa2cb
VZ
68values or expand the environment variables on the fly. However, the main idea
69is that using this class is easy and that it should normally do what you
70expect it to.
71
72NB: in the documentation of this class, the words "config file" also mean
73"registry hive" for wxRegConfig and, generally speaking, might mean any
b8de493f 74physical storage where a wxConfigBase-derived class stores its data.
c4afa2cb 75
b8de493f 76\latexignore{\rtfignore{\wxheading{Function groups}}}
c4afa2cb 77
b8de493f 78\membersection{Static functions}
c4afa2cb 79
052ae0e5 80These functions deal with the "default" config object. Although its usage is
c4afa2cb
VZ
81not at all mandatory it may be convenient to use a global config object
82instead of creating and deleting the local config objects each time you need
83one (especially because creating a wxFileConfig object might be a time
84consuming operation). In this case, you may create this global config object
85in the very start of the program and {\it Set()} it as the default. Then, from
86anywhere in your program, you may access it using the {\it Get()} function. Of
87course, you should delete it on the program termination (otherwise, not only a
88memory leak will result, but even more importantly the changes won't be
89written back!).
90
91As it happens, you may even further simplify the procedure described above:
92you may forget about calling {\it Set()}. When {\it Get()} is called and there
93is no current object, it will create one using {\it Create()} function. To
94disable this behaviour {\it DontCreateOnDemand()} is provided.
95
b8de493f
JS
96\helpref{Set}{wxconfigbaseset}\\
97\helpref{Get}{wxconfigbaseget}\\
98\helpref{Create}{wxconfigbasecreate}\\
99\helpref{DontCreateOnDemand}{wxconfigbasedontcreateondemand}
c4afa2cb 100
b8de493f 101\membersection{Constructor and destructor}
c4afa2cb 102
b8de493f
JS
103\helpref{wxConfigBase}{wxconfigbasector}\\
104\helpref{\destruct{wxConfigBase}}{wxconfigbasedtor}
c4afa2cb 105
b8de493f 106\membersection{Path management}
c4afa2cb 107
5f3cd8a2
VZ
108As explained in \helpref{config overview}{wxconfigoverview}, the config classes
109support a file system-like hierarchy of keys (files) and groups (directories).
c4afa2cb
VZ
110As in the file system case, to specify a key in the config class you must use
111a path to it. Config classes also support the notion of the current group,
112which makes it possible to use the relative paths. To clarify all this, here
113is an example (it's only for the sake of demonstration, it doesn't do anything
114sensible!):
115
116\begin{verbatim}
117 wxConfig *config = new wxConfig("FooBarApp");
118
119 // right now the current path is '/'
120 conf->Write("RootEntry", 1);
121
122 // go to some other place: if the group(s) don't exist, they will be created
123 conf->SetPath("/Group/Subgroup");
124
125 // create an entry in subgroup
126 conf->Write("SubgroupEntry", 3);
21f280f4 127
c4afa2cb
VZ
128 // '..' is understood
129 conf->Write("../GroupEntry", 2);
130 conf->SetPath("..");
131
132 wxASSERT( conf->Read("Subgroup/SubgroupEntry", 0l) == 3 );
133
134 // use absolute path: it's allowed, too
135 wxASSERT( conf->Read("/RootEntry", 0l) == 1 );
136\end{verbatim}
137
b8de493f 138{\it Warning}: it's probably a good idea to always restore the path to its
c4afa2cb 139old value on function exit:
b8de493f 140
c4afa2cb
VZ
141\begin{verbatim}
142 void foo(wxConfigBase *config)
143 {
144 wxString strOldPath = config->GetPath();
145
146 config->SetPath("/Foo/Data");
147 ...
148
149 config->SetPath(strOldPath);
150 }
151\end{verbatim}
152
153because otherwise the assert in the following example will surely fail
154(we suppose here that {\it foo()} function is the same as above except that it
155doesn't save and restore the path):
156
157\begin{verbatim}
158 void bar(wxConfigBase *config)
159 {
160 config->Write("Test", 17);
21f280f4 161
c4afa2cb
VZ
162 foo(config);
163
164 // we're reading "/Foo/Data/Test" here! -1 will probably be returned...
165 wxASSERT( config->Read("Test", -1) == 17 );
166 }
167\end{verbatim}
168
169Finally, the path separator in wxConfigBase and derived classes is always '/',
b8de493f 170regardless of the platform (i.e. it's {\bf not} '$\backslash\backslash$' under Windows).
c4afa2cb 171
b8de493f
JS
172\helpref{SetPath}{wxconfigbasesetpath}\\
173\helpref{GetPath}{wxconfigbasegetpath}
c4afa2cb 174
b8de493f 175\membersection{Enumeration}
c4afa2cb
VZ
176
177The functions in this section allow to enumerate all entries and groups in the
b8de493f 178config file. All functions here return FALSE when there are no more items.
c4afa2cb 179
b8de493f 180You must pass the same index to GetNext and GetFirst (don't modify it).
c4afa2cb
VZ
181Please note that it's {\bf not} the index of the current item (you will have
182some great surprizes with wxRegConfig if you assume this) and you shouldn't
183even look at it: it's just a "cookie" which stores the state of the
184enumeration. It can't be stored inside the class because it would prevent you
185from running several enumerations simultaneously, that's why you must pass it
186explicitly.
187
188Having said all this, enumerating the config entries/groups is very simple:
189
190\begin{verbatim}
191 wxArrayString aNames;
192
193 // enumeration variables
194 wxString str;
195 long dummy;
196
197 // first enum all entries
198 bool bCont = config->GetFirstEntry(str, dummy);
199 while ( bCont ) {
200 aNames.Add(str);
201
202 bCont = GetConfig()->GetNextEntry(str, dummy);
203 }
204
205 ... we have all entry names in aNames...
206
207 // now all groups...
208 bCont = GetConfig()->GetFirstGroup(str, dummy);
209 while ( bCont ) {
210 aNames.Add(str);
211
212 bCont = GetConfig()->GetNextGroup(str, dummy);
213 }
214
215 ... we have all group (and entry) names in aNames...
216
217\end{verbatim}
218
b8de493f 219There are also functions to get the number of entries/subgroups without
c4afa2cb
VZ
220actually enumerating them, but you will probably never need them.
221
b8de493f
JS
222\helpref{GetFirstGroup}{wxconfigbasegetfirstgroup}\\
223\helpref{GetNextGroup}{wxconfigbasegetnextgroup}\\
224\helpref{GetFirstEntry}{wxconfigbasegetfirstentry}\\
225\helpref{GetNextEntry}{wxconfigbasegetnextentry}\\
226\helpref{GetNumberOfEntries}{wxconfigbasegetnumberofentries}\\
227\helpref{GetNumberOfGroups}{wxconfigbasegetnumberofgroups}
c4afa2cb 228
b8de493f 229\membersection{Tests of existence}
c4afa2cb 230
b8de493f
JS
231\helpref{HasGroup}{wxconfigbasehasgroup}\\
232\helpref{HasEntry}{wxconfigbasehasentry}\\
19d40bab
VZ
233\helpref{Exists}{wxconfigbaseexists}\\
234\helpref{GetEntryType}{wxconfigbasegetentrytype}
c4afa2cb 235
052ae0e5
JS
236\membersection{Miscellaneous accessors}
237
052ae0e5 238\helpref{GetAppName}{wxconfigbasegetappname}\\
052ae0e5
JS
239\helpref{GetVendorName}{wxconfigbasegetvendorname}
240
b8de493f 241\membersection{Key access}
c4afa2cb
VZ
242
243These function are the core of wxConfigBase class: they allow you to read and
244write config file data. All {\it Read} function take a default value which
245will be returned if the specified key is not found in the config file.
246
247Currently, only two types of data are supported: string and long (but it might
248change in the near future). To work with other types: for {\it int} or {\it
249bool} you can work with function taking/returning {\it long} and just use the
250casts. Better yet, just use {\it long} for all variables which you're going to
b8de493f 251save in the config file: chances are that \verb$sizeof(bool) == sizeof(int) == sizeof(long)$ anyhow on your system. For {\it float}, {\it double} and, in
c4afa2cb
VZ
252general, any other type you'd have to translate them to/from string
253representation and use string functions.
254
255Try not to read long values into string variables and vice versa: although it
256just might work with wxFileConfig, you will get a system error with
257wxRegConfig because in the Windows registry the different types of entries are
258indeed used.
259
260Final remark: the {\it szKey} parameter for all these functions can contain an
261arbitrary path (either relative or absolute), not just the key name.
262
b8de493f
JS
263\helpref{Read}{wxconfigbaseread}\\
264\helpref{Write}{wxconfigbasewrite}\\
265\helpref{Flush}{wxconfigbaseflush}
266
5d1902d6
VZ
267\membersection{Rename entries/groups}
268
269The functions in this section allow to rename entries or subgroups of the
270current group. They will return FALSE on error. typically because either the
271entry/group with the original name doesn't exist, because the entry/group with
272the new name already exists or because the function is not supported in this
273wxConfig implementation.
274
275\helpref{RenameEntry}{wxconfigbaserenameentry}\\
276\helpref{RenameGroup}{wxconfigbaserenamegroup}
277
b8de493f
JS
278\membersection{Delete entries/groups}
279
280The functions in this section delete entries and/or groups of entries from the
281config file. {\it DeleteAll()} is especially useful if you want to erase all
282traces of your program presence: for example, when you uninstall it.
283
284\helpref{DeleteEntry}{wxconfigbasedeleteentry}\\
285\helpref{DeleteGroup}{wxconfigbasedeletegroup}\\
286\helpref{DeleteAll}{wxconfigbasedeleteall}
287
288\membersection{Options}
289
290Some aspects of wxConfigBase behaviour can be changed during run-time. The
291first of them is the expansion of environment variables in the string values
292read from the config file: for example, if you have the following in your
293config file:
294
295\begin{verbatim}
296 # config file for my program
297 UserData = $HOME/data
298
299 # the following syntax is valud only under Windows
300 UserData = %windir%\\data.dat
301\end{verbatim}
302
303the call to \verb$config->Read("UserData")$ will return something like
304\verb$"/home/zeitlin/data"$ if you're lucky enough to run a Linux system ;-)
305
306Although this feature is very useful, it may be annoying if you read a value
307which containts '\$' or '\%' symbols (\% is used for environment variables
308expansion under Windows) which are not used for environment variable
309expansion. In this situation you may call SetExpandEnvVars(FALSE) just before
310reading this value and SetExpandEnvVars(TRUE) just after. Another solution
311would be to prefix the offending symbols with a backslash.
312
313The following functions control this option:
314
315\helpref{IsExpandingEnvVars}{wxconfigbaseisexpandingenvvars}\\
316\helpref{SetExpandingEnvVars}{wxconfigbasesetexpandingenvvars}\\
317\helpref{SetRecordDefaults}{wxconfigbasesetrecorddefaults}\\
318\helpref{IsRecordingDefaults}{wxconfigbaseisrecordingdefaults}
319
320%%%%% MEMBERS HERE %%%%%
321\helponly{\insertatlevel{2}{
322
323\wxheading{Members}
324
325}}
326
052ae0e5 327\membersection{wxConfigBase::wxConfigBase}\label{wxconfigbasector}
b8de493f 328
052ae0e5
JS
329\func{}{wxConfigBase}{\param{const wxString\& }{appName = wxEmptyString},
330 \param{const wxString\& }{vendorName = wxEmptyString},
331 \param{const wxString\& }{localFilename = wxEmptyString},
332 \param{const wxString\& }{globalFilename = wxEmptyString},
333 \param{long}{ style = 0}}
b8de493f 334
5f3cd8a2
VZ
335This is the default and only constructor of the wxConfigBase class, and
336derived classes.
b8de493f 337
052ae0e5 338\wxheading{Parameters}
b8de493f 339
5f3cd8a2
VZ
340\docparam{appName}{The application name. If this is empty, the class will
341normally use \helpref{wxApp::GetAppName}{wxappgetappname} to set it. The
342application name is used in the registry key on Windows, and can be used to
343deduce the local filename parameter if that is missing.}
b8de493f 344
052ae0e5
JS
345\docparam{vendorName}{The vendor name. If this is empty, it is assumed that
346no vendor name is wanted, if this is optional for the current config class.
347The vendor name is appended to the application name for wxRegConfig.}
b8de493f 348
5f3cd8a2
VZ
349\docparam{localFilename}{Some config classes require a local filename. If this
350is not present, but required, the application name will be used instead.}
b8de493f 351
5f3cd8a2
VZ
352\docparam{globalFilename}{Some config classes require a global filename. If
353this is not present, but required, the application name will be used instead.}
b8de493f 354
5f3cd8a2
VZ
355\docparam{style}{Can be one of wxCONFIG\_USE\_LOCAL\_FILE and
356wxCONFIG\_USE\_GLOBAL\_FILE. The style interpretation depends on the config
357class and is ignored by some. For wxFileConfig, these styles determine whether
358a local or global config file is created or used. If the flag is present but
359the parameter is empty, the parameter will be set to a default. If the
360parameter is present but the style flag not, the relevant flag will be added
3135da71
RS
361to the style. For wxFileConfig you can also add wxCONFIG\_USE\_RELATIVE\_PATH
362by logicaly or'ing it to either of the _FILE options to tell wxFileConfig to
363use relative instead of absolute paths. }
b8de493f 364
052ae0e5 365\wxheading{Remarks}
b8de493f 366
5f3cd8a2
VZ
367By default, environment variable expansion is on and recording defaults is
368off.
b8de493f 369
052ae0e5 370\membersection{wxConfigBase::\destruct{wxConfigBase}}\label{wxconfigbasedtor}
b8de493f 371
052ae0e5 372\func{}{\destruct{wxConfigBase}}{\void}
b8de493f 373
052ae0e5 374Empty but ensures that dtor of all derived classes is virtual.
b8de493f
JS
375
376\membersection{wxConfigBase::Create}\label{wxconfigbasecreate}
377
052ae0e5 378\func{static wxConfigBase *}{Create}{\void}
b8de493f
JS
379
380Create a new config object: this function will create the "best"
5f3cd8a2
VZ
381implementation of wxConfig available for the current platform, see comments
382near the definition of wxCONFIG\_WIN32\_NATIVE for details. It returns the
383created object and also sets it as the current one.
b8de493f
JS
384
385\membersection{wxConfigBase::DontCreateOnDemand}\label{wxconfigbasedontcreateondemand}
386
387\func{void}{DontCreateOnDemand}{\void}
388
389Calling this function will prevent {\it Get()} from automatically creating a
390new config object if the current one is NULL. It might be useful to call it
391near the program end to prevent new config object "accidental" creation.
392
052ae0e5 393\membersection{wxConfigBase::DeleteAll}\label{wxconfigbasedeleteall}
b8de493f 394
052ae0e5 395\func{bool}{DeleteAll}{\void}
b8de493f 396
052ae0e5
JS
397Delete the whole underlying object (disk file, registry key, ...). Primarly
398for use by desinstallation routine.
b8de493f 399
052ae0e5 400\membersection{wxConfigBase::DeleteEntry}\label{wxconfigbasedeleteentry}
b8de493f 401
5f3cd8a2
VZ
402\func{bool}{DeleteEntry}{\param{const wxString\& }{ key}, \param{bool}{
403bDeleteGroupIfEmpty = TRUE}}
b8de493f 404
5f3cd8a2
VZ
405Deletes the specified entry and the group it belongs to if it was the last key
406in it and the second parameter is true.
b8de493f 407
052ae0e5 408\membersection{wxConfigBase::DeleteGroup}\label{wxconfigbasedeletegroup}
b8de493f 409
052ae0e5 410\func{bool}{DeleteGroup}{\param{const wxString\& }{ key}}
b8de493f 411
052ae0e5
JS
412Delete the group (with all subgroups)
413
414\membersection{wxConfigBase::Exists}\label{wxconfigbaseexists}
415
416\constfunc{bool}{Exists}{\param{wxString\& }{strName}}
417
418returns TRUE if either a group or an entry with a given name exists
419
420\membersection{wxConfigBase::Flush}\label{wxconfigbaseflush}
421
422\func{bool}{Flush}{\param{bool }{bCurrentOnly = FALSE}}
423
424permanently writes all changes (otherwise, they're only written from object's
425destructor)
426
427\membersection{wxConfigBase::Get}\label{wxconfigbaseget}
428
429\func{wxConfigBase *}{Get}{\void}
430
431Get the current config object. If there is no current object, creates one
432(using {\it Create}) unless DontCreateOnDemand was called previously.
433
434\membersection{wxConfigBase::GetAppName}\label{wxconfigbasegetappname}
435
436\constfunc{wxString}{GetAppName}{\void}
437
438Returns the application name.
439
19d40bab
VZ
440\membersection{wxConfigBase::GetEntryType}\label{wxconfigbasegetentrytype}
441
442\constfunc{enum wxConfigBase::EntryType}{GetEntryType}{\param{const wxString\& }{name}}
443
444Returns the type of the given entry or {\it Unknown} if the entry doesn't
445exist. This function should be used to decide which version of Read() should
446be used because some of wxConfig implementations will complain about type
447mismatch otherwise: e.g., an attempt to read a string value from an integer
6776a0b2 448key with wxRegConfig will fail.
19d40bab
VZ
449
450The result is an element of enum EntryType:
451
452\begin{verbatim}
453 enum EntryType
454 {
455 Unknown,
456 String,
457 Boolean,
458 Integer,
459 Float
460 };
461\end{verbatim}
462
052ae0e5
JS
463\membersection{wxConfigBase::GetFirstGroup}\label{wxconfigbasegetfirstgroup}
464
5f3cd8a2
VZ
465\constfunc{bool}{GetFirstGroup}{\param{wxString\& }{str}, \param{long\&}{
466index}}
052ae0e5
JS
467
468Gets the first group.
469
21f280f4
RD
470\pythonnote{The wxPython version of this method returns a 3-tuple
471consisting of the continue flag, the value string, and the index for
472the next call.}
473
052ae0e5
JS
474\membersection{wxConfigBase::GetFirstEntry}\label{wxconfigbasegetfirstentry}
475
5f3cd8a2
VZ
476\constfunc{bool}{GetFirstEntry}{\param{wxString\& }{str}, \param{long\&}{
477index}}
052ae0e5
JS
478
479Gets the first entry.
480
21f280f4
RD
481\pythonnote{The wxPython version of this method returns a 3-tuple
482consisting of the continue flag, the value string, and the index for
483the next call.}
484
052ae0e5
JS
485\membersection{wxConfigBase::GetNextGroup}\label{wxconfigbasegetnextgroup}
486
5f3cd8a2
VZ
487\constfunc{bool}{GetNextGroup}{\param{wxString\& }{str}, \param{long\&}{
488index}}
052ae0e5
JS
489
490Gets the next group.
491
21f280f4
RD
492\pythonnote{The wxPython version of this method returns a 3-tuple
493consisting of the continue flag, the value string, and the index for
494the next call.}
495
052ae0e5
JS
496\membersection{wxConfigBase::GetNextEntry}\label{wxconfigbasegetnextentry}
497
5f3cd8a2
VZ
498\constfunc{bool}{GetNextEntry}{\param{wxString\& }{str}, \param{long\&}{
499index}}
052ae0e5
JS
500
501Gets the next entry.
502
21f280f4
RD
503\pythonnote{The wxPython version of this method returns a 3-tuple
504consisting of the continue flag, the value string, and the index for
505the next call.}
506
052ae0e5
JS
507\membersection{wxConfigBase::GetNumberOfEntries}\label{wxconfigbasegetnumberofentries}
508
509\constfunc{uint }{GetNumberOfEntries}{\param{bool }{bRecursive = FALSE}}
510
511\membersection{wxConfigBase::GetNumberOfGroups}\label{wxconfigbasegetnumberofgroups}
512
513\constfunc{uint}{GetNumberOfGroups}{\param{bool }{bRecursive = FALSE}}
514
5f3cd8a2
VZ
515Get number of entries/subgroups in the current group, with or without its
516subgroups.
b8de493f
JS
517
518\membersection{wxConfigBase::GetPath}\label{wxconfigbasegetpath}
519
052ae0e5 520\constfunc{const wxString\&}{GetPath}{\void}
b8de493f
JS
521
522Retrieve the current path (always as absolute path).
523
052ae0e5 524\membersection{wxConfigBase::GetVendorName}\label{wxconfigbasegetvendorname}
b8de493f 525
052ae0e5 526\constfunc{wxString}{GetVendorName}{\void}
b8de493f 527
052ae0e5 528Returns the vendor name.
b8de493f
JS
529
530\membersection{wxConfigBase::HasEntry}\label{wxconfigbasehasentry}
531
532\constfunc{bool}{HasEntry}{\param{wxString\& }{strName}}
533
534returns TRUE if the entry by this name exists
535
052ae0e5 536\membersection{wxConfigBase::HasGroup}\label{wxconfigbasehasgroup}
b8de493f 537
052ae0e5 538\constfunc{bool}{HasGroup}{\param{const wxString\& }{strName}}
b8de493f 539
052ae0e5
JS
540returns TRUE if the group by this name exists
541
542\membersection{wxConfigBase::IsExpandingEnvVars}\label{wxconfigbaseisexpandingenvvars}
543
544\constfunc{bool}{IsExpandingEnvVars}{\void}
545
546Returns TRUE if we are expanding environment variables in key values.
547
548\membersection{wxConfigBase::IsRecordingDefaults}\label{wxconfigbaseisrecordingdefaults}
549
550\func{bool}{IsRecordingDefaults}{\void} const
551
552Returns TRUE if we are writing defaults back to the config file.
b8de493f
JS
553
554\membersection{wxConfigBase::Read}\label{wxconfigbaseread}
555
5f3cd8a2
VZ
556\constfunc{bool}{Read}{\param{const wxString\& }{key}, \param{wxString*}{
557str}}
052ae0e5 558
5f3cd8a2
VZ
559Read a string from the key, returning TRUE if the value was read. If the key
560was not found, {\it str} is not changed.
052ae0e5 561
5f3cd8a2
VZ
562\constfunc{bool}{Read}{\param{const wxString\& }{key}, \param{wxString*}{
563str}, \param{const wxString\& }{defaultVal}}
052ae0e5 564
5f3cd8a2
VZ
565Read a string from the key. The default value is returned if the key was not
566found.
c4afa2cb 567
052ae0e5 568Returns TRUE if value was really read, FALSE if the default was used.
c4afa2cb 569
5f3cd8a2
VZ
570\constfunc{wxString}{Read}{\param{const wxString\& }{key}, \param{const
571wxString\& }{defaultVal}}
c4afa2cb 572
052ae0e5 573Another version of {\it Read()}, returning the string value directly.
c4afa2cb 574
052ae0e5 575\constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{long*}{ l}}
c4afa2cb 576
5f3cd8a2
VZ
577Reads a long value, returning TRUE if the value was found. If the value was
578not found, {\it l} is not changed.
c4afa2cb 579
5f3cd8a2
VZ
580\constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{long*}{ l},
581\param{long}{ defaultVal}}
052ae0e5 582
5f3cd8a2
VZ
583Reads a long value, returning TRUE if the value was found. If the value was
584not found, {\it defaultVal} is used instead.
052ae0e5 585
5f3cd8a2
VZ
586\constfunc{long }{Read}{\param{const wxString\& }{key}, \param{long}{
587defaultVal}}
052ae0e5 588
5f3cd8a2
VZ
589Reads a long value from the key and returns it. {\it defaultVal} is returned
590if the key is not found.
c4afa2cb
VZ
591
592NB: writing
052ae0e5 593
5f3cd8a2 594{\small \begin{verbatim} conf->Read("key", 0); \end{verbatim} }
052ae0e5 595
5f3cd8a2
VZ
596won't work because the call is ambiguous: compiler can not choose between two
597{\it Read} functions. Instead, write:
052ae0e5 598
5f3cd8a2 599{\small \begin{verbatim} conf->Read("key", 0l); \end{verbatim} }
c4afa2cb 600
052ae0e5 601\constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{double*}{ d}}
c4afa2cb 602
5f3cd8a2
VZ
603Reads a double value, returning TRUE if the value was found. If the value was
604not found, {\it d} is not changed.
c4afa2cb 605
5f3cd8a2 606\constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{double*}{ d},
0d57be45 607 \param{double}{ defaultVal}}
b8de493f 608
5f3cd8a2
VZ
609Reads a double value, returning TRUE if the value was found. If the value was
610not found, {\it defaultVal} is used instead.
b8de493f 611
052ae0e5 612\constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{bool*}{ b}}
c4afa2cb 613
5f3cd8a2
VZ
614Reads a bool value, returning TRUE if the value was found. If the value was
615not found, {\it b} is not changed.
b8de493f 616
5f3cd8a2
VZ
617\constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{bool*}{ d},
618\param{bool}{ defaultVal}}
c4afa2cb 619
5f3cd8a2
VZ
620Reads a bool value, returning TRUE if the value was found. If the value was
621not found, {\it defaultVal} is used instead.
c4afa2cb 622
21f280f4
RD
623\pythonnote{In place of a single overloaded method name, wxPython
624implements the following methods:\par
625\indented{2cm}{\begin{twocollist}
626\twocolitem{\bf{Read(key, default="")}}{Returns a string.}
627\twocolitem{\bf{ReadInt(key, default=0)}}{Returns an int.}
628\twocolitem{\bf{ReadFloat(key, default=0.0)}}{Returns a floating point number.}
629\end{twocollist}}
630}
631
5d1902d6
VZ
632\membersection{wxConfigBase::RenameEntry}\label{wxconfigbaserenameentry}
633
634\func{bool}{RenameEntry}{\param{const wxString\& }{ oldName}, \param{const wxString\& }{ newName}}
635
636Renames an entry in the current group. The entries names (both the old and
637the new one) shouldn't contain backslashes, i.e. only simple names and not
638arbitrary paths are accepted by this function.
639
640Returns FALSE if the {\it oldName} doesn't exist or if {\it newName} already
641exists.
642
643\membersection{wxConfigBase::RenameGroup}\label{wxconfigbaserenamegroup}
644
645\func{bool}{RenameGroup}{\param{const wxString\& }{ oldName}, \param{const wxString\& }{ newName}}
646
647Renames a subgroup of the current group. The subgroup names (both the old and
648the new one) shouldn't contain backslashes, i.e. only simple names and not
649arbitrary paths are accepted by this function.
650
651Returns FALSE if the {\it oldName} doesn't exist or if {\it newName} already
652exists.
653
052ae0e5 654\membersection{wxConfigBase::Set}\label{wxconfigbaseset}
c4afa2cb 655
052ae0e5 656\func{wxConfigBase *}{Set}{\param{wxConfigBase *}{pConfig}}
c4afa2cb 657
052ae0e5
JS
658Sets the config object as the current one, returns the pointer to the previous
659current object (both the parameter and returned value may be NULL)
c4afa2cb 660
052ae0e5 661\membersection{wxConfigBase::SetExpandingEnvVars}\label{wxconfigbasesetexpandingenvvars}
c4afa2cb 662
052ae0e5 663\func{void}{SetExpandEnvVars }{\param{bool }{bDoIt = TRUE}}
b8de493f 664
052ae0e5 665Determine whether we wish to expand environment variables in key values.
c4afa2cb 666
052ae0e5 667\membersection{wxConfigBase::SetPath}\label{wxconfigbasesetpath}
c4afa2cb 668
052ae0e5 669\func{void}{SetPath}{\param{const wxString\& }{strPath}}
c4afa2cb 670
052ae0e5 671Set current path: if the first character is '/', it's the absolute path,
5f3cd8a2
VZ
672otherwise it's a relative path. '..' is supported. If the strPath doesn't
673exist it is created.
c4afa2cb 674
052ae0e5 675\membersection{wxConfigBase::SetRecordDefaults}\label{wxconfigbasesetrecorddefaults}
c4afa2cb 676
052ae0e5
JS
677\func{void}{SetRecordDefaults}{\param{bool }{bDoIt = TRUE}}
678
679Sets whether defaults are written back to the config file.
c4afa2cb 680
5f3cd8a2
VZ
681If on (default is off) all default values are written back to the config file.
682This allows the user to see what config options may be changed and is probably
683useful only for wxFileConfig.
c4afa2cb 684
052ae0e5
JS
685\membersection{wxConfigBase::Write}\label{wxconfigbasewrite}
686
5f3cd8a2
VZ
687\func{bool}{Write}{\param{const wxString\& }{ key}, \param{const wxString\& }{
688value}}
052ae0e5
JS
689
690\func{bool}{Write}{\param{const wxString\& }{ key}, \param{long}{ value}}
691
692\func{bool}{Write}{\param{const wxString\& }{ key}, \param{double}{ value}}
693
694\func{bool}{Write}{\param{const wxString\& }{ key}, \param{bool}{ value}}
695
5f3cd8a2
VZ
696These functions write the specified value to the config file and return TRUE
697on success.
c4afa2cb 698
21f280f4
RD
699\pythonnote{In place of a single overloaded method name, wxPython
700implements the following methods:\par
701\indented{2cm}{\begin{twocollist}
702\twocolitem{\bf{Write(key, value)}}{Writes a string.}
703\twocolitem{\bf{WriteInt(key, value)}}{Writes an int.}
704\twocolitem{\bf{WriteFloat(key, value)}}{Writes a floating point number.}
705\end{twocollist}}
706}
707
708
709
710
c4afa2cb 711