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