s/wxHyperLinkCtrl/wxHyperlinkCtrl/

[wxWidgets.git] / docs / latex / wx / config.tex

diff --git a/docs/latex/wx/config.tex b/docs/latex/wx/config.tex
index 536d025736cfa63494cfdcefbc109c991407ca2d..b2969399f734cfcd8baf1ceea3952541c4ac4d48 100644 (file)
--- a/docs/latex/wx/config.tex
+++ b/docs/latex/wx/config.tex
@@ -1,27 +1,37 @@
 \section{\class{wxConfigBase}}\label{wxconfigbase}
 
 wxConfigBase class defines the basic interface of all config classes. It can
 \section{\class{wxConfigBase}}\label{wxconfigbase}
 
 wxConfigBase class defines the basic interface of all config classes. It can

-not be used by itself (it's an abstract base class) and you'll always use one
-of its derivations: wxIniConfig, wxFileConfig, wxRegConfig or
-any other.
+not be used by itself (it is an abstract base class) and you will always use one
+of its derivations: \helpref{wxFileConfig}{wxfileconfig},
+wxRegConfig or any other.

 
 However, usually you don't even need to know the precise nature of the class
 you're working with but you would just use the wxConfigBase methods. This
 allows you to write the same code regardless of whether you're working with
 the registry under Win32 or text-based config files under Unix (or even
 Windows 3.1 .INI files if you're really unlucky). To make writing the portable
 
 However, usually you don't even need to know the precise nature of the class
 you're working with but you would just use the wxConfigBase methods. This
 allows you to write the same code regardless of whether you're working with
 the registry under Win32 or text-based config files under Unix (or even
 Windows 3.1 .INI files if you're really unlucky). To make writing the portable

-code even easier, wxWindows provides a typedef wxConfig
+code even easier, wxWidgets provides a typedef wxConfig

 which is mapped onto the native wxConfigBase implementation on the given
 which is mapped onto the native wxConfigBase implementation on the given

-platform: i.e. wxRegConfig under Win32, wxIniConfig under Win16 and
+platform: i.e. wxRegConfig under Win32 and

 wxFileConfig otherwise.
 
 wxFileConfig otherwise.
 

-%See \helpref{config overview}{configoverview} for the descriptions of all
-%features of this class.
+See \helpref{config overview}{wxconfigoverview} for the descriptions of all
+features of this class.
+
+It is highly recommended to use static functions {\it Get()} and/or {\it Set()}, 
+so please have a \helpref{look at them.}{wxconfigstaticfunctions}

 
 \wxheading{Derived from}
 
 No base class
 
 
 \wxheading{Derived from}
 
 No base class
 

+\wxheading{Include files}
+
+<wx/config.h> (to let wxWidgets choose a wxConfig class for your platform)\\
+<wx/confbase.h> (base config class)\\
+<wx/fileconf.h> (wxFileConfig class)\\
+<wx/msw/regconf.h> (wxRegConfig class)
+

 \wxheading{Example}
 
 Here is how you would typically use this class:
 \wxheading{Example}
 
 Here is how you would typically use this class:


@@ -43,7 +53,7 @@ Here is how you would typically use this class:
 
   // another example: using default values and the full path instead of just
   // key name: if the key is not found , the value 17 is returned
 
   // another example: using default values and the full path instead of just
   // key name: if the key is not found , the value 17 is returned

-  long value = config->Read("/LastRun/CalculatedValues/MaxValue", -1);
+  long value = config->Read("/LastRun/CalculatedValues/MaxValue", 17);

   ...
   ...
   ...
   ...
   ...
   ...


@@ -68,7 +78,8 @@ physical storage where a wxConfigBase-derived class stores its data.
 
 \latexignore{\rtfignore{\wxheading{Function groups}}}
 
 
 \latexignore{\rtfignore{\wxheading{Function groups}}}
 

-\membersection{Static functions}
+
+\membersection{Static functions}\label{wxconfigstaticfunctions}

 
 These functions deal with the "default" config object. Although its usage is
 not at all mandatory it may be convenient to use a global config object
 
 These functions deal with the "default" config object. Although its usage is
 not at all mandatory it may be convenient to use a global config object


@@ -76,34 +87,42 @@ instead of creating and deleting the local config objects each time you need
 one (especially because creating a wxFileConfig object might be a time
 consuming operation). In this case, you may create this global config object
 in the very start of the program and {\it Set()} it as the default. Then, from
 one (especially because creating a wxFileConfig object might be a time
 consuming operation). In this case, you may create this global config object
 in the very start of the program and {\it Set()} it as the default. Then, from

-anywhere in your program, you may access it using the {\it Get()} function. Of
-course, you should delete it on the program termination (otherwise, not only a
-memory leak will result, but even more importantly the changes won't be
-written back!).
+anywhere in your program, you may access it using the {\it Get()} function.
+This global wxConfig object will be deleted by wxWidgets automatically if it
+exists. Note that this implies that if you do delete this object yourself
+(usually in \helpref{wxApp::OnExit}{wxapponexit}) you must use {\it Set(NULL)}
+to prevent wxWidgets from deleting it the second time.

 
 As it happens, you may even further simplify the procedure described above:
 you may forget about calling {\it Set()}. When {\it Get()} is called and there
 is no current object, it will create one using {\it Create()} function. To
 disable this behaviour {\it DontCreateOnDemand()} is provided.
 
 
 As it happens, you may even further simplify the procedure described above:
 you may forget about calling {\it Set()}. When {\it Get()} is called and there
 is no current object, it will create one using {\it Create()} function. To
 disable this behaviour {\it DontCreateOnDemand()} is provided.
 

+{\bf Note:} You should use either {\it Set()} or {\it Get()} because wxWidgets
+library itself would take advantage of it and could save various information
+in it. For example \helpref{wxFontMapper}{wxfontmapper} or Unix version
+of \helpref{wxFileDialog}{wxfiledialog} have the ability to use wxConfig class.
+

 \helpref{Set}{wxconfigbaseset}\\
 \helpref{Get}{wxconfigbaseget}\\
 \helpref{Create}{wxconfigbasecreate}\\
 \helpref{DontCreateOnDemand}{wxconfigbasedontcreateondemand}
 
 \helpref{Set}{wxconfigbaseset}\\
 \helpref{Get}{wxconfigbaseget}\\
 \helpref{Create}{wxconfigbasecreate}\\
 \helpref{DontCreateOnDemand}{wxconfigbasedontcreateondemand}
 

-\membersection{Constructor and destructor}
+
+\membersection{Constructor and destructor}\label{congigconstructordestructor}

 
 \helpref{wxConfigBase}{wxconfigbasector}\\
 \helpref{\destruct{wxConfigBase}}{wxconfigbasedtor}
 
 
 \helpref{wxConfigBase}{wxconfigbasector}\\
 \helpref{\destruct{wxConfigBase}}{wxconfigbasedtor}
 

-\membersection{Path management}

 
 

-%As explained in \helpref{config overview}{configoverview},
-The config classes support a file system-like hierarchy of keys (files) and groups (directories).
+\membersection{Path management}\label{configpathmanagement}
+
+As explained in \helpref{config overview}{wxconfigoverview}, the config classes
+support a file system-like hierarchy of keys (files) and groups (directories).

 As in the file system case, to specify a key in the config class you must use
 a path to it. Config classes also support the notion of the current group,
 which makes it possible to use the relative paths. To clarify all this, here
 As in the file system case, to specify a key in the config class you must use
 a path to it. Config classes also support the notion of the current group,
 which makes it possible to use the relative paths. To clarify all this, here

-is an example (it's only for the sake of demonstration, it doesn't do anything
+is an example (it is only for the sake of demonstration, it doesn't do anything

 sensible!):
 
 \begin{verbatim}
 sensible!):
 
 \begin{verbatim}


@@ -117,18 +136,18 @@ sensible!):
 
   // create an entry in subgroup
   conf->Write("SubgroupEntry", 3);
 
   // create an entry in subgroup
   conf->Write("SubgroupEntry", 3);

-  
+

   // '..' is understood
   conf->Write("../GroupEntry", 2);
   conf->SetPath("..");
 
   wxASSERT( conf->Read("Subgroup/SubgroupEntry", 0l) == 3 );
 
   // '..' is understood
   conf->Write("../GroupEntry", 2);
   conf->SetPath("..");
 
   wxASSERT( conf->Read("Subgroup/SubgroupEntry", 0l) == 3 );
 

-  // use absolute path: it's allowed, too
+  // use absolute path: it is allowed, too

   wxASSERT( conf->Read("/RootEntry", 0l) == 1 );
 \end{verbatim}
 
   wxASSERT( conf->Read("/RootEntry", 0l) == 1 );
 \end{verbatim}
 

-{\it Warning}: it's probably a good idea to always restore the path to its
+{\it Warning}: it is probably a good idea to always restore the path to its

 old value on function exit:
 
 \begin{verbatim}
 old value on function exit:
 
 \begin{verbatim}


@@ -151,7 +170,7 @@ doesn't save and restore the path):
   void bar(wxConfigBase *config)
   {
     config->Write("Test", 17);
   void bar(wxConfigBase *config)
   {
     config->Write("Test", 17);

-    
+

     foo(config);
 
     // we're reading "/Foo/Data/Test" here! -1 will probably be returned...
     foo(config);
 
     // we're reading "/Foo/Data/Test" here! -1 will probably be returned...


@@ -160,20 +179,21 @@ doesn't save and restore the path):
 \end{verbatim}
 
 Finally, the path separator in wxConfigBase and derived classes is always '/',
 \end{verbatim}
 
 Finally, the path separator in wxConfigBase and derived classes is always '/',

-regardless of the platform (i.e. it's {\bf not} '$\backslash\backslash$' under Windows).
+regardless of the platform (i.e. it is {\bf not} '$\backslash\backslash$' under Windows).

 
 \helpref{SetPath}{wxconfigbasesetpath}\\
 \helpref{GetPath}{wxconfigbasegetpath}
 
 
 \helpref{SetPath}{wxconfigbasesetpath}\\
 \helpref{GetPath}{wxconfigbasegetpath}
 

-\membersection{Enumeration}
+
+\membersection{Enumeration}\label{configenumeration}

 
 The functions in this section allow to enumerate all entries and groups in the
 
 The functions in this section allow to enumerate all entries and groups in the

-config file. All functions here return FALSE when there are no more items.
+config file. All functions here return \false when there are no more items.

 
 You must pass the same index to GetNext and GetFirst (don't modify it).
 
 You must pass the same index to GetNext and GetFirst (don't modify it).

-Please note that it's {\bf not} the index of the current item (you will have
-some great surprizes with wxRegConfig if you assume this) and you shouldn't
-even look at it: it's just a "cookie" which stores the state of the
+Please note that it is {\bf not} the index of the current item (you will have
+some great surprises with wxRegConfig if you assume this) and you shouldn't
+even look at it: it is just a "cookie" which stores the state of the

 enumeration. It can't be stored inside the class because it would prevent you
 from running several enumerations simultaneously, that's why you must pass it
 explicitly.
 enumeration. It can't be stored inside the class because it would prevent you
 from running several enumerations simultaneously, that's why you must pass it
 explicitly.


@@ -181,6 +201,7 @@ explicitly.
 Having said all this, enumerating the config entries/groups is very simple:
 
 \begin{verbatim}
 Having said all this, enumerating the config entries/groups is very simple:
 
 \begin{verbatim}

+  wxConfigBase *config = ...;

   wxArrayString aNames;
 
   // enumeration variables
   wxArrayString aNames;
 
   // enumeration variables


@@ -219,20 +240,23 @@ actually enumerating them, but you will probably never need them.
 \helpref{GetNumberOfEntries}{wxconfigbasegetnumberofentries}\\
 \helpref{GetNumberOfGroups}{wxconfigbasegetnumberofgroups}
 
 \helpref{GetNumberOfEntries}{wxconfigbasegetnumberofentries}\\
 \helpref{GetNumberOfGroups}{wxconfigbasegetnumberofgroups}
 

-\membersection{Tests of existence}
+
+\membersection{Tests of existence}\label{configtestsofexistence}

 
 \helpref{HasGroup}{wxconfigbasehasgroup}\\
 \helpref{HasEntry}{wxconfigbasehasentry}\\
 
 \helpref{HasGroup}{wxconfigbasehasgroup}\\
 \helpref{HasEntry}{wxconfigbasehasentry}\\

-\helpref{Exists}{wxconfigbaseexists}
+\helpref{Exists}{wxconfigbaseexists}\\
+\helpref{GetEntryType}{wxconfigbasegetentrytype}

 
 

-\membersection{Miscellaneous accessors}

 
 

-\helpref{SetAppName}{wxconfigbasesetappname}\\
+\membersection{Miscellaneous functions}\label{configmiscellaneous}
+

 \helpref{GetAppName}{wxconfigbasegetappname}\\
 \helpref{GetAppName}{wxconfigbasegetappname}\\

-\helpref{SetVendorName}{wxconfigbasesetvendorname}\\
-\helpref{GetVendorName}{wxconfigbasegetvendorname}
+\helpref{GetVendorName}{wxconfigbasegetvendorname}\\
+\helpref{SetUmask}{wxfileconfigsetumask}
+

 
 

-\membersection{Key access}
+\membersection{Key access}\label{configkeyaccess}

 
 These function are the core of wxConfigBase class: they allow you to read and
 write config file data. All {\it Read} function take a default value which
 
 These function are the core of wxConfigBase class: they allow you to read and
 write config file data. All {\it Read} function take a default value which


@@ -242,7 +266,7 @@ Currently, only two types of data are supported: string and long (but it might
 change in the near future). To work with other types: for {\it int} or {\it
 bool} you can work with function taking/returning {\it long} and just use the
 casts. Better yet, just use {\it long} for all variables which you're going to
 change in the near future). To work with other types: for {\it int} or {\it
 bool} you can work with function taking/returning {\it long} and just use the
 casts. Better yet, just use {\it long} for all variables which you're going to

-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
+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

 general, any other type you'd have to translate them to/from string
 representation and use string functions.
 
 general, any other type you'd have to translate them to/from string
 representation and use string functions.
 


@@ -258,7 +282,20 @@ arbitrary path (either relative or absolute), not just the key name.
 \helpref{Write}{wxconfigbasewrite}\\
 \helpref{Flush}{wxconfigbaseflush}
 
 \helpref{Write}{wxconfigbasewrite}\\
 \helpref{Flush}{wxconfigbaseflush}
 

-\membersection{Delete entries/groups}
+
+\membersection{Rename entries/groups}\label{configrenaming}
+
+The functions in this section allow to rename entries or subgroups of the
+current group. They will return \false on error. typically because either the
+entry/group with the original name doesn't exist, because the entry/group with
+the new name already exists or because the function is not supported in this
+wxConfig implementation.
+
+\helpref{RenameEntry}{wxconfigbaserenameentry}\\
+\helpref{RenameGroup}{wxconfigbaserenamegroup}
+
+
+\membersection{Delete entries/groups}\label{configdeleting}

 
 The functions in this section delete entries and/or groups of entries from the
 config file. {\it DeleteAll()} is especially useful if you want to erase all
 
 The functions in this section delete entries and/or groups of entries from the
 config file. {\it DeleteAll()} is especially useful if you want to erase all


@@ -268,7 +305,8 @@ traces of your program presence: for example, when you uninstall it.
 \helpref{DeleteGroup}{wxconfigbasedeletegroup}\\
 \helpref{DeleteAll}{wxconfigbasedeleteall}
 
 \helpref{DeleteGroup}{wxconfigbasedeletegroup}\\
 \helpref{DeleteAll}{wxconfigbasedeleteall}
 

-\membersection{Options}
+
+\membersection{Options}\label{configoptions}

 
 Some aspects of wxConfigBase behaviour can be changed during run-time. The
 first of them is the expansion of environment variables in the string values
 
 Some aspects of wxConfigBase behaviour can be changed during run-time. The
 first of them is the expansion of environment variables in the string values


@@ -282,21 +320,21 @@ config file:
   # the following syntax is valud only under Windows
   UserData = %windir%\\data.dat
 \end{verbatim}
   # the following syntax is valud only under Windows
   UserData = %windir%\\data.dat
 \end{verbatim}

-
-the call to \verb$config->Read("UserData")$ will return something like
-\verb$"/home/zeitlin/data"$ if you're lucky enough to run a Linux system ;-)
+% $ % help EMACS syntax highlighting...
+the call to {\tt config->Read("UserData")} will return something like
+{\tt "/home/zeitlin/data"} if you're lucky enough to run a Linux system ;-)

 
 Although this feature is very useful, it may be annoying if you read a value
 which containts '\$' or '\%' symbols (\% is used for environment variables
 expansion under Windows) which are not used for environment variable
 
 Although this feature is very useful, it may be annoying if you read a value
 which containts '\$' or '\%' symbols (\% is used for environment variables
 expansion under Windows) which are not used for environment variable

-expansion. In this situation you may call SetExpandEnvVars(FALSE) just before
-reading this value and SetExpandEnvVars(TRUE) just after. Another solution
+expansion. In this situation you may call SetExpandEnvVars(false) just before
+reading this value and SetExpandEnvVars(true) just after. Another solution

 would be to prefix the offending symbols with a backslash.
 
 The following functions control this option:
 
 \helpref{IsExpandingEnvVars}{wxconfigbaseisexpandingenvvars}\\
 would be to prefix the offending symbols with a backslash.
 
 The following functions control this option:
 
 \helpref{IsExpandingEnvVars}{wxconfigbaseisexpandingenvvars}\\

-\helpref{SetExpandingEnvVars}{wxconfigbasesetexpandingenvvars}\\
+\helpref{SetExpandEnvVars}{wxconfigbasesetexpandenvvars}\\

 \helpref{SetRecordDefaults}{wxconfigbasesetrecorddefaults}\\
 \helpref{IsRecordingDefaults}{wxconfigbaseisrecordingdefaults}
 
 \helpref{SetRecordDefaults}{wxconfigbasesetrecorddefaults}\\
 \helpref{IsRecordingDefaults}{wxconfigbaseisrecordingdefaults}
 


@@ -307,43 +345,68 @@ The following functions control this option:
 
 }}
 
 
 }}
 

+

 \membersection{wxConfigBase::wxConfigBase}\label{wxconfigbasector}
 
 \func{}{wxConfigBase}{\param{const wxString\& }{appName = wxEmptyString},
  \param{const wxString\& }{vendorName = wxEmptyString},
  \param{const wxString\& }{localFilename = wxEmptyString},
  \param{const wxString\& }{globalFilename = wxEmptyString},
 \membersection{wxConfigBase::wxConfigBase}\label{wxconfigbasector}
 
 \func{}{wxConfigBase}{\param{const wxString\& }{appName = wxEmptyString},
  \param{const wxString\& }{vendorName = wxEmptyString},
  \param{const wxString\& }{localFilename = wxEmptyString},
  \param{const wxString\& }{globalFilename = wxEmptyString},

- \param{long}{ style = 0}}
+ \param{long}{ style = 0},
+ \param{wxMBConv\&}{ conv = wxConvUTF8}}

 
 

-This is the default and only constructor of the wxConfigBase class, and derived classes.
+This is the default and only constructor of the wxConfigBase class, and
+derived classes.

 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 

-\docparam{appName}{The application name. If this is empty, the class will normally
-use \helpref{wxApp::GetAppName}{wxappgetappname} to set it. The application name
-is used in the registry key on Windows, and can be used to deduce the local filename
-parameter if that is missing.}
+\docparam{appName}{The application name. If this is empty, the class will
+normally use \helpref{wxApp::GetAppName}{wxappgetappname} to set it. The
+application name is used in the registry key on Windows, and can be used to
+deduce the local filename parameter if that is missing.}

 
 \docparam{vendorName}{The vendor name. If this is empty, it is assumed that
 no vendor name is wanted, if this is optional for the current config class.
 The vendor name is appended to the application name for wxRegConfig.}
 
 
 \docparam{vendorName}{The vendor name. If this is empty, it is assumed that
 no vendor name is wanted, if this is optional for the current config class.
 The vendor name is appended to the application name for wxRegConfig.}
 

-\docparam{localFilename}{Some config classes require a local filename. If this is not
-present, but required, the application name will be used instead.}
-
-\docparam{globalFilename}{Some config classes require a global filename. If this is not
-present, but required, the application name will be used instead.}
+\docparam{localFilename}{Some config classes require a local filename. If this
+is not present, but required, the application name will be used instead.}
+
+\docparam{globalFilename}{Some config classes require a global filename. If
+this is not present, but required, the application name will be used instead.}
+
+\docparam{style}{Can be one of wxCONFIG\_USE\_LOCAL\_FILE and
+wxCONFIG\_USE\_GLOBAL\_FILE. The style interpretation depends on the config
+class and is ignored by some. For wxFileConfig, these styles determine whether
+a local or global config file is created or used. If the flag is present but
+the parameter is empty, the parameter will be set to a default. If the
+parameter is present but the style flag not, the relevant flag will be added
+to the style. For wxFileConfig you can also add wxCONFIG\_USE\_RELATIVE\_PATH 
+by logically or'ing it to either of the \_FILE options to tell wxFileConfig to 
+use relative instead of absolute paths.  For wxFileConfig, you can also 
+add wxCONFIG\_USE\_NO\_ESCAPE\_CHARACTERS which will turn off character 
+escaping for the values of entries stored in the config file: for example 
+a {\it foo} key with some backslash characters will be stored as {\tt foo=C:$\backslash$mydir} instead
+of the usual storage of {\tt foo=C:$\backslash\backslash$mydir}.
+For wxRegConfig, this flag refers to HKLM, and provides read-only access.
+
+The wxCONFIG\_USE\_NO\_ESCAPE\_CHARACTERS style can be helpful if your config 
+file must be read or written to by a non-wxWidgets program (which might not 
+understand the escape characters). Note, however, that if 
+wxCONFIG\_USE\_NO\_ESCAPE\_CHARACTERS style is used, it is is now 
+your application's responsibility to ensure that there is no newline or 
+other illegal characters in a value, before writing that value to the file.}
+
+\docparam{conv}{This parameter is only used by wxFileConfig when compiled
+in Unicode mode. It specifies the encoding in which the configuration file
+is written.}

 
 

-\docparam{style}{Can be one of wxCONFIG\_USE\_LOCAL\_FILE and wxCONFIG\_USE\_GLOBAL\_FILE.
-The style interpretation depends on the config class and is ignored by some.
-For wxFileConfig, these styles determine whether a local or global config file is created or used.
-If the flag is present but the parameter is empty, the parameter will be set to a default.
-If the parameter is present but the style flag not, the relevant flag will be added to the style.}

 
 \wxheading{Remarks}
 
 
 \wxheading{Remarks}
 

-By default, environment variable expansion is on and recording
-defaults is off.
+By default, environment variable expansion is on and recording defaults is
+off.
+

 
 \membersection{wxConfigBase::\destruct{wxConfigBase}}\label{wxconfigbasedtor}
 
 
 \membersection{wxConfigBase::\destruct{wxConfigBase}}\label{wxconfigbasedtor}
 


@@ -351,14 +414,16 @@ defaults is off.
 
 Empty but ensures that dtor of all derived classes is virtual.
 
 
 Empty but ensures that dtor of all derived classes is virtual.
 

+

 \membersection{wxConfigBase::Create}\label{wxconfigbasecreate}
 
 \func{static wxConfigBase *}{Create}{\void}
 
 Create a new config object: this function will create the "best"
 \membersection{wxConfigBase::Create}\label{wxconfigbasecreate}
 
 \func{static wxConfigBase *}{Create}{\void}
 
 Create a new config object: this function will create the "best"

-implementation of wxConfig available for the current platform, see
-comments near the definition of wxCONFIG\_WIN32\_NATIVE for details. It returns
-the created object and also sets it as the current one.
+implementation of wxConfig available for the current platform, see comments
+near the definition of wxCONFIG\_WIN32\_NATIVE for details. It returns the
+created object and also sets it as the current one.
+

 
 \membersection{wxConfigBase::DontCreateOnDemand}\label{wxconfigbasedontcreateondemand}
 
 
 \membersection{wxConfigBase::DontCreateOnDemand}\label{wxconfigbasedontcreateondemand}
 


@@ -366,21 +431,24 @@ the created object and also sets it as the current one.
 
 Calling this function will prevent {\it Get()} from automatically creating a
 new config object if the current one is NULL. It might be useful to call it
 
 Calling this function will prevent {\it Get()} from automatically creating a
 new config object if the current one is NULL. It might be useful to call it

-near the program end to prevent new config object "accidental" creation.
+near the program end to prevent "accidental" creation of a new config object.
+

 
 \membersection{wxConfigBase::DeleteAll}\label{wxconfigbasedeleteall}
 
 \func{bool}{DeleteAll}{\void}
 
 Delete the whole underlying object (disk file, registry key, ...). Primarly
 
 \membersection{wxConfigBase::DeleteAll}\label{wxconfigbasedeleteall}
 
 \func{bool}{DeleteAll}{\void}
 
 Delete the whole underlying object (disk file, registry key, ...). Primarly

-for use by desinstallation routine.
+for use by uninstallation routine.
+

 
 \membersection{wxConfigBase::DeleteEntry}\label{wxconfigbasedeleteentry}
 
 
 \membersection{wxConfigBase::DeleteEntry}\label{wxconfigbasedeleteentry}
 

-\func{bool}{DeleteEntry}{\param{const wxString\& }{ key}, \param{bool}{ bDeleteGroupIfEmpty = TRUE}}
+\func{bool}{DeleteEntry}{\param{const wxString\& }{ key}, \param{bool}{ bDeleteGroupIfEmpty = true}}
+
+Deletes the specified entry and the group it belongs to if it was the last key
+in it and the second parameter is true.

 
 

-Deletes the specified entry and the group it belongs to if
-it was the last key in it and the second parameter is true.

 
 \membersection{wxConfigBase::DeleteGroup}\label{wxconfigbasedeletegroup}
 
 
 \membersection{wxConfigBase::DeleteGroup}\label{wxconfigbasedeletegroup}
 


@@ -388,66 +456,130 @@ it was the last key in it and the second parameter is true.
 
 Delete the group (with all subgroups)
 
 
 Delete the group (with all subgroups)
 

+

 \membersection{wxConfigBase::Exists}\label{wxconfigbaseexists}
 
 \constfunc{bool}{Exists}{\param{wxString\& }{strName}}
 
 \membersection{wxConfigBase::Exists}\label{wxconfigbaseexists}
 
 \constfunc{bool}{Exists}{\param{wxString\& }{strName}}
 

-returns TRUE if either a group or an entry with a given name exists
+returns \true if either a group or an entry with a given name exists
+

 
 \membersection{wxConfigBase::Flush}\label{wxconfigbaseflush}
 
 
 \membersection{wxConfigBase::Flush}\label{wxconfigbaseflush}
 

-\func{bool}{Flush}{\param{bool }{bCurrentOnly = FALSE}}
+\func{bool}{Flush}{\param{bool }{bCurrentOnly = false}}

 
 permanently writes all changes (otherwise, they're only written from object's
 destructor)
 
 
 permanently writes all changes (otherwise, they're only written from object's
 destructor)
 

+

 \membersection{wxConfigBase::Get}\label{wxconfigbaseget}
 
 \membersection{wxConfigBase::Get}\label{wxconfigbaseget}
 

-\func{wxConfigBase *}{Get}{\void}
+\func{static wxConfigBase *}{Get}{\param{bool }{CreateOnDemand = true}}

 
 

-Get the current config object. If there is no current object, creates one
+Get the current config object. If there is no current object and
+{\it CreateOnDemand} is true, creates one

 (using {\it Create}) unless DontCreateOnDemand was called previously.
 
 (using {\it Create}) unless DontCreateOnDemand was called previously.
 

+

 \membersection{wxConfigBase::GetAppName}\label{wxconfigbasegetappname}
 
 \constfunc{wxString}{GetAppName}{\void}
 
 Returns the application name.
 
 \membersection{wxConfigBase::GetAppName}\label{wxconfigbasegetappname}
 
 \constfunc{wxString}{GetAppName}{\void}
 
 Returns the application name.
 

+
+\membersection{wxConfigBase::GetEntryType}\label{wxconfigbasegetentrytype}
+
+\constfunc{enum wxConfigBase::EntryType}{GetEntryType}{\param{const wxString\& }{name}}
+
+Returns the type of the given entry or {\it Unknown} if the entry doesn't
+exist. This function should be used to decide which version of Read() should
+be used because some of wxConfig implementations will complain about type
+mismatch otherwise: e.g., an attempt to read a string value from an integer
+key with wxRegConfig will fail.
+
+The result is an element of enum EntryType:
+
+\begin{verbatim}
+  enum EntryType
+  {
+    Type_Unknown,
+    Type_String,
+    Type_Boolean,
+    Type_Integer,
+    Type_Float
+  };
+\end{verbatim}
+
+

 \membersection{wxConfigBase::GetFirstGroup}\label{wxconfigbasegetfirstgroup}
 
 \constfunc{bool}{GetFirstGroup}{\param{wxString\& }{str}, \param{long\&}{ index}}
 
 Gets the first group.
 
 \membersection{wxConfigBase::GetFirstGroup}\label{wxconfigbasegetfirstgroup}
 
 \constfunc{bool}{GetFirstGroup}{\param{wxString\& }{str}, \param{long\&}{ index}}
 
 Gets the first group.
 

+\pythonnote{The wxPython version of this method returns a 3-tuple
+consisting of the continue flag, the value string, and the index for
+the next call.}
+
+\perlnote{In wxPerl this method takes no arguments and returns a 3-element
+list {\tt ( continue, str, index )}.}
+
+

 \membersection{wxConfigBase::GetFirstEntry}\label{wxconfigbasegetfirstentry}
 
 \constfunc{bool}{GetFirstEntry}{\param{wxString\& }{str}, \param{long\&}{ index}}
 
 Gets the first entry.
 
 \membersection{wxConfigBase::GetFirstEntry}\label{wxconfigbasegetfirstentry}
 
 \constfunc{bool}{GetFirstEntry}{\param{wxString\& }{str}, \param{long\&}{ index}}
 
 Gets the first entry.
 

+\pythonnote{The wxPython version of this method returns a 3-tuple
+consisting of the continue flag, the value string, and the index for
+the next call.}
+
+\perlnote{In wxPerl this method takes no arguments and returns a 3-element
+list {\tt ( continue, str, index )}.}
+
+

 \membersection{wxConfigBase::GetNextGroup}\label{wxconfigbasegetnextgroup}
 
 \constfunc{bool}{GetNextGroup}{\param{wxString\& }{str}, \param{long\&}{ index}}
 
 Gets the next group.
 
 \membersection{wxConfigBase::GetNextGroup}\label{wxconfigbasegetnextgroup}
 
 \constfunc{bool}{GetNextGroup}{\param{wxString\& }{str}, \param{long\&}{ index}}
 
 Gets the next group.
 

+\pythonnote{The wxPython version of this method returns a 3-tuple
+consisting of the continue flag, the value string, and the index for
+the next call.}
+
+\perlnote{In wxPerl this method only takes the {\tt index} parameter
+and returns a 3-element list {\tt ( continue, str, index )}.}
+
+

 \membersection{wxConfigBase::GetNextEntry}\label{wxconfigbasegetnextentry}
 
 \constfunc{bool}{GetNextEntry}{\param{wxString\& }{str}, \param{long\&}{ index}}
 
 Gets the next entry.
 
 \membersection{wxConfigBase::GetNextEntry}\label{wxconfigbasegetnextentry}
 
 \constfunc{bool}{GetNextEntry}{\param{wxString\& }{str}, \param{long\&}{ index}}
 
 Gets the next entry.
 

+\pythonnote{The wxPython version of this method returns a 3-tuple
+consisting of the continue flag, the value string, and the index for
+the next call.}
+
+\perlnote{In wxPerl this method only takes the {\tt index} parameter
+and returns a 3-element list {\tt ( continue, str, index )}.}
+
+

 \membersection{wxConfigBase::GetNumberOfEntries}\label{wxconfigbasegetnumberofentries}
 
 \membersection{wxConfigBase::GetNumberOfEntries}\label{wxconfigbasegetnumberofentries}
 

-\constfunc{uint }{GetNumberOfEntries}{\param{bool }{bRecursive = FALSE}}
+\constfunc{uint }{GetNumberOfEntries}{\param{bool }{bRecursive = false}}
+

 
 \membersection{wxConfigBase::GetNumberOfGroups}\label{wxconfigbasegetnumberofgroups}
 
 
 \membersection{wxConfigBase::GetNumberOfGroups}\label{wxconfigbasegetnumberofgroups}
 

-\constfunc{uint}{GetNumberOfGroups}{\param{bool }{bRecursive = FALSE}}
+\constfunc{uint}{GetNumberOfGroups}{\param{bool }{bRecursive = false}}
+
+Get number of entries/subgroups in the current group, with or without its
+subgroups.

 
 

-Get number of entries/subgroups in the current group, with or without
-its subgroups.

 
 \membersection{wxConfigBase::GetPath}\label{wxconfigbasegetpath}
 
 
 \membersection{wxConfigBase::GetPath}\label{wxconfigbasegetpath}
 


@@ -455,150 +587,199 @@ its subgroups.
 
 Retrieve the current path (always as absolute path).
 
 
 Retrieve the current path (always as absolute path).
 

+

 \membersection{wxConfigBase::GetVendorName}\label{wxconfigbasegetvendorname}
 
 \constfunc{wxString}{GetVendorName}{\void}
 
 Returns the vendor name.
 
 \membersection{wxConfigBase::GetVendorName}\label{wxconfigbasegetvendorname}
 
 \constfunc{wxString}{GetVendorName}{\void}
 
 Returns the vendor name.
 

+

 \membersection{wxConfigBase::HasEntry}\label{wxconfigbasehasentry}
 
 \constfunc{bool}{HasEntry}{\param{wxString\& }{strName}}
 
 \membersection{wxConfigBase::HasEntry}\label{wxconfigbasehasentry}
 
 \constfunc{bool}{HasEntry}{\param{wxString\& }{strName}}
 

-returns TRUE if the entry by this name exists
+returns \true if the entry by this name exists
+

 
 \membersection{wxConfigBase::HasGroup}\label{wxconfigbasehasgroup}
 
 \constfunc{bool}{HasGroup}{\param{const wxString\& }{strName}}
 
 
 \membersection{wxConfigBase::HasGroup}\label{wxconfigbasehasgroup}
 
 \constfunc{bool}{HasGroup}{\param{const wxString\& }{strName}}
 

-returns TRUE if the group by this name exists
+returns \true if the group by this name exists
+

 
 \membersection{wxConfigBase::IsExpandingEnvVars}\label{wxconfigbaseisexpandingenvvars}
 
 \constfunc{bool}{IsExpandingEnvVars}{\void}
 
 
 \membersection{wxConfigBase::IsExpandingEnvVars}\label{wxconfigbaseisexpandingenvvars}
 
 \constfunc{bool}{IsExpandingEnvVars}{\void}
 

-Returns TRUE if we are expanding environment variables in key values.
+Returns \true if we are expanding environment variables in key values.
+

 
 \membersection{wxConfigBase::IsRecordingDefaults}\label{wxconfigbaseisrecordingdefaults}
 
 
 \membersection{wxConfigBase::IsRecordingDefaults}\label{wxconfigbaseisrecordingdefaults}
 

-\func{bool}{IsRecordingDefaults}{\void} const
+\constfunc{bool}{IsRecordingDefaults}{\void}
+
+Returns \true if we are writing defaults back to the config file.

 
 

-Returns TRUE if we are writing defaults back to the config file.

 
 \membersection{wxConfigBase::Read}\label{wxconfigbaseread}
 
 \constfunc{bool}{Read}{\param{const wxString\& }{key}, \param{wxString*}{ str}}
 
 
 \membersection{wxConfigBase::Read}\label{wxconfigbaseread}
 
 \constfunc{bool}{Read}{\param{const wxString\& }{key}, \param{wxString*}{ str}}
 

-Read a string from the key, returning TRUE if the value was read. If the key was not
-found, {\it str} is not changed.
+Read a string from the key, returning \true if the value was read. If the key
+was not found, {\it str} is not changed.

 
 \constfunc{bool}{Read}{\param{const wxString\& }{key}, \param{wxString*}{ str}, \param{const wxString\& }{defaultVal}}
 
 
 \constfunc{bool}{Read}{\param{const wxString\& }{key}, \param{wxString*}{ str}, \param{const wxString\& }{defaultVal}}
 

-Read a string from the key. The default value is returned if the key was not found.
+Read a string from the key. The default value is returned if the key was not
+found.

 
 

-Returns TRUE if value was really read, FALSE if the default was used.
+Returns \true if value was really read, \false if the default was used.

 
 

-\constfunc{wxString}{Read}{\param{const wxString\& }{key}, \param{const wxString\& }{defaultVal}}
+\constfunc{wxString}{Read}{\param{const wxString\& }{key}, \param{const
+wxString\& }{defaultVal}}

 
 Another version of {\it Read()}, returning the string value directly.
 
 \constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{long*}{ l}}
 
 
 Another version of {\it Read()}, returning the string value directly.
 
 \constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{long*}{ l}}
 

-Reads a long value, returning TRUE if the value was
-found. If the value was not found, {\it l} is not changed.
+Reads a long value, returning \true if the value was found. If the value was
+not found, {\it l} is not changed.

 
 

-\constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{long*}{ l}, \param{long}{ defaultVal}}
+\constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{long*}{ l},
+\param{long}{ defaultVal}}

 
 

-Reads a long value, returning TRUE if the value was
-found. If the value was not found, {\it defaultVal} is used instead.
+Reads a long value, returning \true if the value was found. If the value was
+not found, {\it defaultVal} is used instead.

 
 \constfunc{long }{Read}{\param{const wxString\& }{key}, \param{long}{ defaultVal}}
 
 
 \constfunc{long }{Read}{\param{const wxString\& }{key}, \param{long}{ defaultVal}}
 

-Reads a long value from the key and returns it. {\it defaultVal} is returned if the key is not
-found.
+Reads a long value from the key and returns it. {\it defaultVal} is returned
+if the key is not found.

 
 NB: writing
 
 {\small
 \begin{verbatim}
 
 NB: writing
 
 {\small
 \begin{verbatim}

-  conf->Read("key", 0);
+    conf->Read("key", 0);

 \end{verbatim}
 }
 
 \end{verbatim}
 }
 

-won't work because the call is ambiguous: compiler can not choose between two {\it Read} functions. Instead, write:
+won't work because the call is ambiguous: compiler can not choose between two
+{\it Read} functions. Instead, write:

 
 {\small
 \begin{verbatim}
 
 {\small
 \begin{verbatim}

-  conf->Read("key", 0l);
+    conf->Read("key", 0l);

 \end{verbatim}
 }
 
 \constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{double*}{ d}}
 
 \end{verbatim}
 }
 
 \constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{double*}{ d}}
 

-Reads a double value, returning TRUE if the value was
-found. If the value was not found, {\it d} is not changed.
+Reads a double value, returning \true if the value was found. If the value was
+not found, {\it d} is not changed.

 
 

-\constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{double*}{ d}, \param{double}{ defaultVal}}
+\constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{double*}{ d},
+ \param{double}{ defaultVal}}

 
 

-Reads a double value, returning TRUE if the value was
-found. If the value was not found, {\it defaultVal} is used instead.
+Reads a double value, returning \true if the value was found. If the value was
+not found, {\it defaultVal} is used instead.

 
 \constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{bool*}{ b}}
 
 
 \constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{bool*}{ b}}
 

-Reads a bool value, returning TRUE if the value was
-found. If the value was not found, {\it b} is not changed.
+Reads a bool value, returning \true if the value was found. If the value was
+not found, {\it b} is not changed.
+
+\constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{bool*}{ d},
+\param{bool}{ defaultVal}}
+
+Reads a bool value, returning \true if the value was found. If the value was
+not found, {\it defaultVal} is used instead.

 
 

-\constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{bool*}{ d}, \param{bool}{ defaultVal}}
+\pythonnote{In place of a single overloaded method name, wxPython
+implements the following methods:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{{\bf Read(key, default="")}}{Returns a string.}
+\twocolitem{{\bf ReadInt(key, default=0)}}{Returns an int.}
+\twocolitem{{\bf ReadFloat(key, default=0.0)}}{Returns a floating point number.}
+\end{twocollist}}
+}
+
+\perlnote{In place of a single overloaded method, wxPerl uses:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{{\bf Read(key, default="")}}{Returns a string}
+\twocolitem{{\bf ReadInt(key, default=0)}}{Returns an integer}
+\twocolitem{{\bf ReadFloat(key, default=0.0)}}{Returns a floating point number}
+\twocolitem{{\bf ReadBool(key, default=0)}}{Returns a boolean}
+\end{twocollist}
+}}
+
+
+\membersection{wxConfigBase::RenameEntry}\label{wxconfigbaserenameentry}
+
+\func{bool}{RenameEntry}{\param{const wxString\& }{ oldName}, \param{const wxString\& }{ newName}}
+
+Renames an entry in the current group. The entries names (both the old and
+the new one) shouldn't contain backslashes, i.e. only simple names and not
+arbitrary paths are accepted by this function.
+
+Returns \false if {\it oldName} doesn't exist or if {\it newName} already
+exists.
+
+
+\membersection{wxConfigBase::RenameGroup}\label{wxconfigbaserenamegroup}
+
+\func{bool}{RenameGroup}{\param{const wxString\& }{ oldName}, \param{const wxString\& }{ newName}}
+
+Renames a subgroup of the current group. The subgroup names (both the old and
+the new one) shouldn't contain backslashes, i.e. only simple names and not
+arbitrary paths are accepted by this function.
+
+Returns \false if {\it oldName} doesn't exist or if {\it newName} already
+exists.

 
 

-Reads a bool value, returning TRUE if the value was
-found. If the value was not found, {\it defaultVal} is used instead.

 
 \membersection{wxConfigBase::Set}\label{wxconfigbaseset}
 
 
 \membersection{wxConfigBase::Set}\label{wxconfigbaseset}
 

-\func{wxConfigBase *}{Set}{\param{wxConfigBase *}{pConfig}}
+\func{static wxConfigBase *}{Set}{\param{wxConfigBase *}{pConfig}}

 
 Sets the config object as the current one, returns the pointer to the previous
 current object (both the parameter and returned value may be NULL)
 
 
 Sets the config object as the current one, returns the pointer to the previous
 current object (both the parameter and returned value may be NULL)
 

-\membersection{wxConfigBase::SetAppName}\label{wxconfigbasesetappname}
-
-\func{void }{SetAppName}{\param{const wxString\&}{ appName}}

 
 

-Sets the application name.
+\membersection{wxConfigBase::SetExpandEnvVars}\label{wxconfigbasesetexpandenvvars}

 
 

-\membersection{wxConfigBase::SetExpandingEnvVars}\label{wxconfigbasesetexpandingenvvars}
-
-\func{void}{SetExpandEnvVars }{\param{bool }{bDoIt = TRUE}}
+\func{void}{SetExpandEnvVars }{\param{bool }{bDoIt = true}}

 
 Determine whether we wish to expand environment variables in key values.
 
 
 Determine whether we wish to expand environment variables in key values.
 

+

 \membersection{wxConfigBase::SetPath}\label{wxconfigbasesetpath}
 
 \func{void}{SetPath}{\param{const wxString\& }{strPath}}
 
 \membersection{wxConfigBase::SetPath}\label{wxconfigbasesetpath}
 
 \func{void}{SetPath}{\param{const wxString\& }{strPath}}
 

-Set current path: if the first character is '/', it's the absolute path,
-otherwise it's a relative path. '..' is supported. If the strPath
-doesn't exist it is created.
+Set current path: if the first character is '/', it is the absolute path,
+otherwise it is a relative path. '..' is supported. If strPath doesn't
+exist it is created.

 
 

-\membersection{wxConfigBase::SetRecordDefaults}\label{wxconfigbasesetrecorddefaults}

 
 

-\func{void}{SetRecordDefaults}{\param{bool }{bDoIt = TRUE}}
-
-Sets whether defaults are written back to the config file.
+\membersection{wxConfigBase::SetRecordDefaults}\label{wxconfigbasesetrecorddefaults}

 
 

-If on (default is off) all default values are written back to the config file. This allows
-the user to see what config options may be changed and is probably useful only
-for wxFileConfig.
+\func{void}{SetRecordDefaults}{\param{bool }{bDoIt = true}}

 
 

-\membersection{wxConfigBase::SetVendorName}\label{wxconfigbasesetvendorname}
+Sets whether defaults are recorded to the config file whenever an attempt to
+read the value which is not present in it is done.

 
 

-\func{void}{SetVendorName}{\param{const wxString\&}{ vendorName}}
+If on (default is off) all default values for the settings used by the program
+are written back to the config file. This allows the user to see what config
+options may be changed and is probably useful only for wxFileConfig.

 
 

-Sets the vendor name.

 
 \membersection{wxConfigBase::Write}\label{wxconfigbasewrite}
 
 
 \membersection{wxConfigBase::Write}\label{wxconfigbasewrite}
 

-\func{bool}{Write}{\param{const wxString\& }{ key}, \param{const wxString\& }{ value}}
+\func{bool}{Write}{\param{const wxString\& }{ key}, \param{const wxString\& }{
+value}}

 
 \func{bool}{Write}{\param{const wxString\& }{ key}, \param{long}{ value}}
 
 
 \func{bool}{Write}{\param{const wxString\& }{ key}, \param{long}{ value}}
 


@@ -606,7 +787,23 @@ Sets the vendor name.
 
 \func{bool}{Write}{\param{const wxString\& }{ key}, \param{bool}{ value}}
 
 
 \func{bool}{Write}{\param{const wxString\& }{ key}, \param{bool}{ value}}
 

-These functions write the specified value to the config file and
-return TRUE on success.
+These functions write the specified value to the config file and return \true on success.

 
 

+\pythonnote{In place of a single overloaded method name, wxPython
+implements the following methods:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{{\bf Write(key, value)}}{Writes a string.}
+\twocolitem{{\bf WriteInt(key, value)}}{Writes an int.}
+\twocolitem{{\bf WriteFloat(key, value)}}{Writes a floating point number.}
+\end{twocollist}}
+}
+
+\perlnote{In place of a single overloaded method, wxPerl uses:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{{\bf Write(key, value)}}{Writes a string}
+\twocolitem{{\bf WriteInt(key, value)}}{Writes an integer}
+\twocolitem{{\bf WriteFloat(key, value)}}{Writes a floating point number}
+\twocolitem{{\bf WriteBool(key, value)}}{Writes a boolean}
+\end{twocollist}
+}}