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