]> git.saurik.com Git - wxWidgets.git/blob - docs/latex/wx/config.tex
Prep for wxPython 2.1b3 release
[wxWidgets.git] / docs / latex / wx / config.tex
1 \section{\class{wxConfigBase}}\label{wxconfigbase}
2
3 wxConfigBase class defines the basic interface of all config classes. It can
4 not be used by itself (it's an abstract base class) and you'll always use one
5 of its derivations: wxIniConfig, wxFileConfig, wxRegConfig or any other.
6
7 However, usually you don't even need to know the precise nature of the class
8 you're working with but you would just use the wxConfigBase methods. This
9 allows you to write the same code regardless of whether you're working with
10 the registry under Win32 or text-based config files under Unix (or even
11 Windows 3.1 .INI files if you're really unlucky). To make writing the portable
12 code even easier, wxWindows provides a typedef wxConfig
13 which is mapped onto the native wxConfigBase implementation on the given
14 platform: i.e. wxRegConfig under Win32, wxIniConfig under Win16 and
15 wxFileConfig otherwise.
16
17 See \helpref{config overview}{wxconfigoverview} for the descriptions of all
18 features of this class.
19
20 \wxheading{Derived from}
21
22 No base class
23
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
32 \wxheading{Example}
33
34 Here 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;
42 if ( config->Read("LastPrompt", &str) ) {
43 // last prompt was found in the config file/registry and its value is now
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
65 This basic example, of course, doesn't show all wxConfig features, such as
66 enumerating, testing for existence and deleting the entries and groups of
67 entries in the config file, its abilities to automatically store the default
68 values or expand the environment variables on the fly. However, the main idea
69 is that using this class is easy and that it should normally do what you
70 expect it to.
71
72 NB: in the documentation of this class, the words "config file" also mean
73 "registry hive" for wxRegConfig and, generally speaking, might mean any
74 physical storage where a wxConfigBase-derived class stores its data.
75
76 \latexignore{\rtfignore{\wxheading{Function groups}}}
77
78 \membersection{Static functions}
79
80 These functions deal with the "default" config object. Although its usage is
81 not at all mandatory it may be convenient to use a global config object
82 instead of creating and deleting the local config objects each time you need
83 one (especially because creating a wxFileConfig object might be a time
84 consuming operation). In this case, you may create this global config object
85 in the very start of the program and {\it Set()} it as the default. Then, from
86 anywhere in your program, you may access it using the {\it Get()} function. Of
87 course, you should delete it on the program termination (otherwise, not only a
88 memory leak will result, but even more importantly the changes won't be
89 written back!).
90
91 As it happens, you may even further simplify the procedure described above:
92 you may forget about calling {\it Set()}. When {\it Get()} is called and there
93 is no current object, it will create one using {\it Create()} function. To
94 disable this behaviour {\it DontCreateOnDemand()} is provided.
95
96 \helpref{Set}{wxconfigbaseset}\\
97 \helpref{Get}{wxconfigbaseget}\\
98 \helpref{Create}{wxconfigbasecreate}\\
99 \helpref{DontCreateOnDemand}{wxconfigbasedontcreateondemand}
100
101 \membersection{Constructor and destructor}
102
103 \helpref{wxConfigBase}{wxconfigbasector}\\
104 \helpref{\destruct{wxConfigBase}}{wxconfigbasedtor}
105
106 \membersection{Path management}
107
108 As explained in \helpref{config overview}{wxconfigoverview}, the config classes
109 support a file system-like hierarchy of keys (files) and groups (directories).
110 As in the file system case, to specify a key in the config class you must use
111 a path to it. Config classes also support the notion of the current group,
112 which makes it possible to use the relative paths. To clarify all this, here
113 is an example (it's only for the sake of demonstration, it doesn't do anything
114 sensible!):
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);
127
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
138 {\it Warning}: it's probably a good idea to always restore the path to its
139 old value on function exit:
140
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
153 because 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
155 doesn't save and restore the path):
156
157 \begin{verbatim}
158 void bar(wxConfigBase *config)
159 {
160 config->Write("Test", 17);
161
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
169 Finally, the path separator in wxConfigBase and derived classes is always '/',
170 regardless of the platform (i.e. it's {\bf not} '$\backslash\backslash$' under Windows).
171
172 \helpref{SetPath}{wxconfigbasesetpath}\\
173 \helpref{GetPath}{wxconfigbasegetpath}
174
175 \membersection{Enumeration}
176
177 The functions in this section allow to enumerate all entries and groups in the
178 config file. All functions here return FALSE when there are no more items.
179
180 You must pass the same index to GetNext and GetFirst (don't modify it).
181 Please note that it's {\bf not} the index of the current item (you will have
182 some great surprizes with wxRegConfig if you assume this) and you shouldn't
183 even look at it: it's just a "cookie" which stores the state of the
184 enumeration. It can't be stored inside the class because it would prevent you
185 from running several enumerations simultaneously, that's why you must pass it
186 explicitly.
187
188 Having 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
219 There are also functions to get the number of entries/subgroups without
220 actually enumerating them, but you will probably never need them.
221
222 \helpref{GetFirstGroup}{wxconfigbasegetfirstgroup}\\
223 \helpref{GetNextGroup}{wxconfigbasegetnextgroup}\\
224 \helpref{GetFirstEntry}{wxconfigbasegetfirstentry}\\
225 \helpref{GetNextEntry}{wxconfigbasegetnextentry}\\
226 \helpref{GetNumberOfEntries}{wxconfigbasegetnumberofentries}\\
227 \helpref{GetNumberOfGroups}{wxconfigbasegetnumberofgroups}
228
229 \membersection{Tests of existence}
230
231 \helpref{HasGroup}{wxconfigbasehasgroup}\\
232 \helpref{HasEntry}{wxconfigbasehasentry}\\
233 \helpref{Exists}{wxconfigbaseexists}\\
234 \helpref{GetEntryType}{wxconfigbasegetentrytype}
235
236 \membersection{Miscellaneous accessors}
237
238 \helpref{GetAppName}{wxconfigbasegetappname}\\
239 \helpref{GetVendorName}{wxconfigbasegetvendorname}
240
241 \membersection{Key access}
242
243 These function are the core of wxConfigBase class: they allow you to read and
244 write config file data. All {\it Read} function take a default value which
245 will be returned if the specified key is not found in the config file.
246
247 Currently, only two types of data are supported: string and long (but it might
248 change in the near future). To work with other types: for {\it int} or {\it
249 bool} you can work with function taking/returning {\it long} and just use the
250 casts. Better yet, just use {\it long} for all variables which you're going to
251 save 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
252 general, any other type you'd have to translate them to/from string
253 representation and use string functions.
254
255 Try not to read long values into string variables and vice versa: although it
256 just might work with wxFileConfig, you will get a system error with
257 wxRegConfig because in the Windows registry the different types of entries are
258 indeed used.
259
260 Final remark: the {\it szKey} parameter for all these functions can contain an
261 arbitrary path (either relative or absolute), not just the key name.
262
263 \helpref{Read}{wxconfigbaseread}\\
264 \helpref{Write}{wxconfigbasewrite}\\
265 \helpref{Flush}{wxconfigbaseflush}
266
267 \membersection{Rename entries/groups}
268
269 The functions in this section allow to rename entries or subgroups of the
270 current group. They will return FALSE on error. typically because either the
271 entry/group with the original name doesn't exist, because the entry/group with
272 the new name already exists or because the function is not supported in this
273 wxConfig implementation.
274
275 \helpref{RenameEntry}{wxconfigbaserenameentry}\\
276 \helpref{RenameGroup}{wxconfigbaserenamegroup}
277
278 \membersection{Delete entries/groups}
279
280 The functions in this section delete entries and/or groups of entries from the
281 config file. {\it DeleteAll()} is especially useful if you want to erase all
282 traces 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
290 Some aspects of wxConfigBase behaviour can be changed during run-time. The
291 first of them is the expansion of environment variables in the string values
292 read from the config file: for example, if you have the following in your
293 config 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
303 the 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
306 Although this feature is very useful, it may be annoying if you read a value
307 which containts '\$' or '\%' symbols (\% is used for environment variables
308 expansion under Windows) which are not used for environment variable
309 expansion. In this situation you may call SetExpandEnvVars(FALSE) just before
310 reading this value and SetExpandEnvVars(TRUE) just after. Another solution
311 would be to prefix the offending symbols with a backslash.
312
313 The 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
327 \membersection{wxConfigBase::wxConfigBase}\label{wxconfigbasector}
328
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}}
334
335 This is the default and only constructor of the wxConfigBase class, and
336 derived classes.
337
338 \wxheading{Parameters}
339
340 \docparam{appName}{The application name. If this is empty, the class will
341 normally use \helpref{wxApp::GetAppName}{wxappgetappname} to set it. The
342 application name is used in the registry key on Windows, and can be used to
343 deduce the local filename parameter if that is missing.}
344
345 \docparam{vendorName}{The vendor name. If this is empty, it is assumed that
346 no vendor name is wanted, if this is optional for the current config class.
347 The vendor name is appended to the application name for wxRegConfig.}
348
349 \docparam{localFilename}{Some config classes require a local filename. If this
350 is not present, but required, the application name will be used instead.}
351
352 \docparam{globalFilename}{Some config classes require a global filename. If
353 this is not present, but required, the application name will be used instead.}
354
355 \docparam{style}{Can be one of wxCONFIG\_USE\_LOCAL\_FILE and
356 wxCONFIG\_USE\_GLOBAL\_FILE. The style interpretation depends on the config
357 class and is ignored by some. For wxFileConfig, these styles determine whether
358 a local or global config file is created or used. If the flag is present but
359 the parameter is empty, the parameter will be set to a default. If the
360 parameter is present but the style flag not, the relevant flag will be added
361 to the style. For wxFileConfig you can also add wxCONFIG\_USE\_RELATIVE\_PATH
362 by logicaly or'ing it to either of the _FILE options to tell wxFileConfig to
363 use relative instead of absolute paths. }
364
365 \wxheading{Remarks}
366
367 By default, environment variable expansion is on and recording defaults is
368 off.
369
370 \membersection{wxConfigBase::\destruct{wxConfigBase}}\label{wxconfigbasedtor}
371
372 \func{}{\destruct{wxConfigBase}}{\void}
373
374 Empty but ensures that dtor of all derived classes is virtual.
375
376 \membersection{wxConfigBase::Create}\label{wxconfigbasecreate}
377
378 \func{static wxConfigBase *}{Create}{\void}
379
380 Create a new config object: this function will create the "best"
381 implementation of wxConfig available for the current platform, see comments
382 near the definition of wxCONFIG\_WIN32\_NATIVE for details. It returns the
383 created object and also sets it as the current one.
384
385 \membersection{wxConfigBase::DontCreateOnDemand}\label{wxconfigbasedontcreateondemand}
386
387 \func{void}{DontCreateOnDemand}{\void}
388
389 Calling this function will prevent {\it Get()} from automatically creating a
390 new config object if the current one is NULL. It might be useful to call it
391 near the program end to prevent new config object "accidental" creation.
392
393 \membersection{wxConfigBase::DeleteAll}\label{wxconfigbasedeleteall}
394
395 \func{bool}{DeleteAll}{\void}
396
397 Delete the whole underlying object (disk file, registry key, ...). Primarly
398 for use by desinstallation routine.
399
400 \membersection{wxConfigBase::DeleteEntry}\label{wxconfigbasedeleteentry}
401
402 \func{bool}{DeleteEntry}{\param{const wxString\& }{ key}, \param{bool}{
403 bDeleteGroupIfEmpty = TRUE}}
404
405 Deletes the specified entry and the group it belongs to if it was the last key
406 in it and the second parameter is true.
407
408 \membersection{wxConfigBase::DeleteGroup}\label{wxconfigbasedeletegroup}
409
410 \func{bool}{DeleteGroup}{\param{const wxString\& }{ key}}
411
412 Delete the group (with all subgroups)
413
414 \membersection{wxConfigBase::Exists}\label{wxconfigbaseexists}
415
416 \constfunc{bool}{Exists}{\param{wxString\& }{strName}}
417
418 returns 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
424 permanently writes all changes (otherwise, they're only written from object's
425 destructor)
426
427 \membersection{wxConfigBase::Get}\label{wxconfigbaseget}
428
429 \func{wxConfigBase *}{Get}{\void}
430
431 Get 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
438 Returns the application name.
439
440 \membersection{wxConfigBase::GetEntryType}\label{wxconfigbasegetentrytype}
441
442 \constfunc{enum wxConfigBase::EntryType}{GetEntryType}{\param{const wxString\& }{name}}
443
444 Returns the type of the given entry or {\it Unknown} if the entry doesn't
445 exist. This function should be used to decide which version of Read() should
446 be used because some of wxConfig implementations will complain about type
447 mismatch otherwise: e.g., an attempt to read a string value from an integer
448 key with wxRegConfig will fail.
449
450 The 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
463 \membersection{wxConfigBase::GetFirstGroup}\label{wxconfigbasegetfirstgroup}
464
465 \constfunc{bool}{GetFirstGroup}{\param{wxString\& }{str}, \param{long\&}{
466 index}}
467
468 Gets the first group.
469
470 \pythonnote{The wxPython version of this method returns a 3-tuple
471 consisting of the continue flag, the value string, and the index for
472 the next call.}
473
474 \membersection{wxConfigBase::GetFirstEntry}\label{wxconfigbasegetfirstentry}
475
476 \constfunc{bool}{GetFirstEntry}{\param{wxString\& }{str}, \param{long\&}{
477 index}}
478
479 Gets the first entry.
480
481 \pythonnote{The wxPython version of this method returns a 3-tuple
482 consisting of the continue flag, the value string, and the index for
483 the next call.}
484
485 \membersection{wxConfigBase::GetNextGroup}\label{wxconfigbasegetnextgroup}
486
487 \constfunc{bool}{GetNextGroup}{\param{wxString\& }{str}, \param{long\&}{
488 index}}
489
490 Gets the next group.
491
492 \pythonnote{The wxPython version of this method returns a 3-tuple
493 consisting of the continue flag, the value string, and the index for
494 the next call.}
495
496 \membersection{wxConfigBase::GetNextEntry}\label{wxconfigbasegetnextentry}
497
498 \constfunc{bool}{GetNextEntry}{\param{wxString\& }{str}, \param{long\&}{
499 index}}
500
501 Gets the next entry.
502
503 \pythonnote{The wxPython version of this method returns a 3-tuple
504 consisting of the continue flag, the value string, and the index for
505 the next call.}
506
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
515 Get number of entries/subgroups in the current group, with or without its
516 subgroups.
517
518 \membersection{wxConfigBase::GetPath}\label{wxconfigbasegetpath}
519
520 \constfunc{const wxString\&}{GetPath}{\void}
521
522 Retrieve the current path (always as absolute path).
523
524 \membersection{wxConfigBase::GetVendorName}\label{wxconfigbasegetvendorname}
525
526 \constfunc{wxString}{GetVendorName}{\void}
527
528 Returns the vendor name.
529
530 \membersection{wxConfigBase::HasEntry}\label{wxconfigbasehasentry}
531
532 \constfunc{bool}{HasEntry}{\param{wxString\& }{strName}}
533
534 returns TRUE if the entry by this name exists
535
536 \membersection{wxConfigBase::HasGroup}\label{wxconfigbasehasgroup}
537
538 \constfunc{bool}{HasGroup}{\param{const wxString\& }{strName}}
539
540 returns TRUE if the group by this name exists
541
542 \membersection{wxConfigBase::IsExpandingEnvVars}\label{wxconfigbaseisexpandingenvvars}
543
544 \constfunc{bool}{IsExpandingEnvVars}{\void}
545
546 Returns 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
552 Returns TRUE if we are writing defaults back to the config file.
553
554 \membersection{wxConfigBase::Read}\label{wxconfigbaseread}
555
556 \constfunc{bool}{Read}{\param{const wxString\& }{key}, \param{wxString*}{
557 str}}
558
559 Read a string from the key, returning TRUE if the value was read. If the key
560 was not found, {\it str} is not changed.
561
562 \constfunc{bool}{Read}{\param{const wxString\& }{key}, \param{wxString*}{
563 str}, \param{const wxString\& }{defaultVal}}
564
565 Read a string from the key. The default value is returned if the key was not
566 found.
567
568 Returns TRUE if value was really read, FALSE if the default was used.
569
570 \constfunc{wxString}{Read}{\param{const wxString\& }{key}, \param{const
571 wxString\& }{defaultVal}}
572
573 Another version of {\it Read()}, returning the string value directly.
574
575 \constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{long*}{ l}}
576
577 Reads a long value, returning TRUE if the value was found. If the value was
578 not found, {\it l} is not changed.
579
580 \constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{long*}{ l},
581 \param{long}{ defaultVal}}
582
583 Reads a long value, returning TRUE if the value was found. If the value was
584 not found, {\it defaultVal} is used instead.
585
586 \constfunc{long }{Read}{\param{const wxString\& }{key}, \param{long}{
587 defaultVal}}
588
589 Reads a long value from the key and returns it. {\it defaultVal} is returned
590 if the key is not found.
591
592 NB: writing
593
594 {\small \begin{verbatim} conf->Read("key", 0); \end{verbatim} }
595
596 won't work because the call is ambiguous: compiler can not choose between two
597 {\it Read} functions. Instead, write:
598
599 {\small \begin{verbatim} conf->Read("key", 0l); \end{verbatim} }
600
601 \constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{double*}{ d}}
602
603 Reads a double value, returning TRUE if the value was found. If the value was
604 not found, {\it d} is not changed.
605
606 \constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{double*}{ d},
607 \param{double}{ defaultVal}}
608
609 Reads a double value, returning TRUE if the value was found. If the value was
610 not found, {\it defaultVal} is used instead.
611
612 \constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{bool*}{ b}}
613
614 Reads a bool value, returning TRUE if the value was found. If the value was
615 not found, {\it b} is not changed.
616
617 \constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{bool*}{ d},
618 \param{bool}{ defaultVal}}
619
620 Reads a bool value, returning TRUE if the value was found. If the value was
621 not found, {\it defaultVal} is used instead.
622
623 \pythonnote{In place of a single overloaded method name, wxPython
624 implements 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
632 \membersection{wxConfigBase::RenameEntry}\label{wxconfigbaserenameentry}
633
634 \func{bool}{RenameEntry}{\param{const wxString\& }{ oldName}, \param{const wxString\& }{ newName}}
635
636 Renames an entry in the current group. The entries names (both the old and
637 the new one) shouldn't contain backslashes, i.e. only simple names and not
638 arbitrary paths are accepted by this function.
639
640 Returns FALSE if the {\it oldName} doesn't exist or if {\it newName} already
641 exists.
642
643 \membersection{wxConfigBase::RenameGroup}\label{wxconfigbaserenamegroup}
644
645 \func{bool}{RenameGroup}{\param{const wxString\& }{ oldName}, \param{const wxString\& }{ newName}}
646
647 Renames a subgroup of the current group. The subgroup names (both the old and
648 the new one) shouldn't contain backslashes, i.e. only simple names and not
649 arbitrary paths are accepted by this function.
650
651 Returns FALSE if the {\it oldName} doesn't exist or if {\it newName} already
652 exists.
653
654 \membersection{wxConfigBase::Set}\label{wxconfigbaseset}
655
656 \func{wxConfigBase *}{Set}{\param{wxConfigBase *}{pConfig}}
657
658 Sets the config object as the current one, returns the pointer to the previous
659 current object (both the parameter and returned value may be NULL)
660
661 \membersection{wxConfigBase::SetExpandingEnvVars}\label{wxconfigbasesetexpandingenvvars}
662
663 \func{void}{SetExpandEnvVars }{\param{bool }{bDoIt = TRUE}}
664
665 Determine whether we wish to expand environment variables in key values.
666
667 \membersection{wxConfigBase::SetPath}\label{wxconfigbasesetpath}
668
669 \func{void}{SetPath}{\param{const wxString\& }{strPath}}
670
671 Set current path: if the first character is '/', it's the absolute path,
672 otherwise it's a relative path. '..' is supported. If the strPath doesn't
673 exist it is created.
674
675 \membersection{wxConfigBase::SetRecordDefaults}\label{wxconfigbasesetrecorddefaults}
676
677 \func{void}{SetRecordDefaults}{\param{bool }{bDoIt = TRUE}}
678
679 Sets whether defaults are written back to the config file.
680
681 If on (default is off) all default values are written back to the config file.
682 This allows the user to see what config options may be changed and is probably
683 useful only for wxFileConfig.
684
685 \membersection{wxConfigBase::Write}\label{wxconfigbasewrite}
686
687 \func{bool}{Write}{\param{const wxString\& }{ key}, \param{const wxString\& }{
688 value}}
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
696 These functions write the specified value to the config file and return TRUE
697 on success.
698
699 \pythonnote{In place of a single overloaded method name, wxPython
700 implements 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
711