added and documented wxKeyEvent::GetUnicodeKey(); made it work for MSW; added test...

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

diff --git a/docs/latex/wx/config.tex b/docs/latex/wx/config.tex
index 18d836c78ed91c2c7de06c6c9b754117ec236952..1e7a62879c320f7ac868888a454637b27bfa2435 100644 (file)
--- a/docs/latex/wx/config.tex
+++ b/docs/latex/wx/config.tex
@@ -9,9 +9,9 @@ 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
 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 (optionally wxIniConfig) and

 wxFileConfig otherwise.
 
 See \helpref{config overview}{wxconfigoverview} for the descriptions of all
 wxFileConfig otherwise.
 
 See \helpref{config overview}{wxconfigoverview} for the descriptions of all


@@ -26,9 +26,9 @@ No base class
 
 \wxheading{Include files}
 
 
 \wxheading{Include files}
 

-<wx/config.h> (to let wxWindows choose a wxConfig class for your platform)\\
+<wx/config.h> (to let wxWidgets choose a wxConfig class for your platform)\\

 <wx/confbase.h> (base config class)\\
 <wx/confbase.h> (base config class)\\

-<wx/fileconf.h> (wxFileconfig class)\\
+<wx/fileconf.h> (wxFileConfig class)\\

 <wx/msw/regconf.h> (wxRegConfig class)\\
 <wx/msw/iniconf.h> (wxIniConfig class)
 
 <wx/msw/regconf.h> (wxRegConfig class)\\
 <wx/msw/iniconf.h> (wxIniConfig class)
 


@@ -86,17 +86,16 @@ 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.
+Note that you must delete this object (usually in \helpref{wxApp::OnExit}{wxapponexit}) 
+in order to avoid memory leaks, wxWidgets won't do it automatically.

 
 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 wxWindows
+{\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 ability to use wxConfig class.
 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 ability to use wxConfig class.


@@ -183,11 +182,11 @@ regardless of the platform (i.e. it is {\bf not} '$\backslash\backslash$' under
 \membersection{Enumeration}
 
 The functions in this section allow to enumerate all entries and groups in the
 \membersection{Enumeration}
 
 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).
 Please note that it is {\bf not} the index of the current item (you will have
 
 You must pass the same index to GetNext and GetFirst (don't modify it).
 Please note that it is {\bf not} the index of the current item (you will have

-some great surprizes with wxRegConfig if you assume this) and you shouldn't
+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
 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


@@ -257,7 +256,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.
 


@@ -276,7 +275,7 @@ arbitrary path (either relative or absolute), not just the key name.
 \membersection{Rename entries/groups}
 
 The functions in this section allow to rename entries or subgroups of the
 \membersection{Rename entries/groups}
 
 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
+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.
 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.


@@ -308,15 +307,15 @@ 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:
 would be to prefix the offending symbols with a backslash.
 
 The following functions control this option:


@@ -339,7 +338,8 @@ The following functions control this option:
  \param{const wxString\& }{vendorName = wxEmptyString},
  \param{const wxString\& }{localFilename = wxEmptyString},
  \param{const wxString\& }{globalFilename = 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.


@@ -368,8 +368,24 @@ 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 
 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 logicaly or'ing it to either of the \_FILE options to tell wxFileConfig to 
-use relative instead of absolute paths.  }
+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}.
+
+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 what the configuration file
+is written.}
+

 
 \wxheading{Remarks}
 
 
 \wxheading{Remarks}
 


@@ -408,7 +424,7 @@ for use by desinstallation 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.


@@ -423,21 +439,21 @@ Delete the group (with all subgroups)
 
 \constfunc{bool}{Exists}{\param{wxString\& }{strName}}
 
 
 \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)
 
 \membersection{wxConfigBase::Get}\label{wxconfigbaseget}
 
 
 permanently writes all changes (otherwise, they're only written from object's
 destructor)
 
 \membersection{wxConfigBase::Get}\label{wxconfigbaseget}
 

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

 
 Get the current config object. If there is no current object and
 
 Get the current config object. If there is no current object and

-{\it CreateOnDemand} is TRUE, creates one
+{\it CreateOnDemand} is true, creates one

 (using {\it Create}) unless DontCreateOnDemand was called previously.
 
 \membersection{wxConfigBase::GetAppName}\label{wxconfigbasegetappname}
 (using {\it Create}) unless DontCreateOnDemand was called previously.
 
 \membersection{wxConfigBase::GetAppName}\label{wxconfigbasegetappname}


@@ -479,6 +495,9 @@ Gets the first group.
 consisting of the continue flag, the value string, and the index for
 the next call.}
 
 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}}
 \membersection{wxConfigBase::GetFirstEntry}\label{wxconfigbasegetfirstentry}
 
 \constfunc{bool}{GetFirstEntry}{\param{wxString\& }{str}, \param{long\&}{ index}}


@@ -489,6 +508,9 @@ Gets the first entry.
 consisting of the continue flag, the value string, and the index for
 the next call.}
 
 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}}
 \membersection{wxConfigBase::GetNextGroup}\label{wxconfigbasegetnextgroup}
 
 \constfunc{bool}{GetNextGroup}{\param{wxString\& }{str}, \param{long\&}{ index}}


@@ -499,6 +521,9 @@ Gets the next group.
 consisting of the continue flag, the value string, and the index for
 the next call.}
 
 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}}
 \membersection{wxConfigBase::GetNextEntry}\label{wxconfigbasegetnextentry}
 
 \constfunc{bool}{GetNextEntry}{\param{wxString\& }{str}, \param{long\&}{ index}}


@@ -509,13 +534,16 @@ Gets the next entry.
 consisting of the continue flag, the value string, and the index for
 the next call.}
 
 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.


@@ -536,31 +564,31 @@ Returns the vendor name.
 
 \constfunc{bool}{HasEntry}{\param{wxString\& }{strName}}
 
 
 \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}
 
 \constfunc{bool}{IsRecordingDefaults}{\void}
 
 
 \membersection{wxConfigBase::IsRecordingDefaults}\label{wxconfigbaseisrecordingdefaults}
 
 \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
+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}}
 was not found, {\it str} is not changed.
 
 \constfunc{bool}{Read}{\param{const wxString\& }{key}, \param{wxString*}{ str}, \param{const wxString\& }{defaultVal}}


@@ -568,7 +596,7 @@ was not found, {\it str} is not changed.
 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}}


@@ -577,13 +605,13 @@ Another version of {\it Read()}, returning the string value directly.
 
 \constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{long*}{ l}}
 
 
 \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
+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}}
 
 not found, {\it l} is not changed.
 
 \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
+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}}
 not found, {\it defaultVal} is used instead.
 
 \constfunc{long }{Read}{\param{const wxString\& }{key}, \param{long}{ defaultVal}}


@@ -593,33 +621,41 @@ if the key is not found.
 
 NB: writing
 
 
 NB: writing
 

-{\small \begin{verbatim} conf->Read("key", 0); \end{verbatim} }
+{\small
+\begin{verbatim}
+    conf->Read("key", 0);
+\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} conf->Read("key", 0l); \end{verbatim} }
+{\small
+\begin{verbatim}
+    conf->Read("key", 0l);
+\end{verbatim}
+}

 
 \constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{double*}{ d}}
 
 
 \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
+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}}
 
 not found, {\it d} is not changed.
 
 \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
+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}}
 
 not found, {\it defaultVal} is used instead.
 
 \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
+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}}
 
 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
+Reads a bool value, returning true if the value was found. If the value was

 not found, {\it defaultVal} is used instead.
 
 \pythonnote{In place of a single overloaded method name, wxPython
 not found, {\it defaultVal} is used instead.
 
 \pythonnote{In place of a single overloaded method name, wxPython


@@ -631,6 +667,15 @@ implements the following methods:\par
 \end{twocollist}}
 }
 
 \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}}
 \membersection{wxConfigBase::RenameEntry}\label{wxconfigbaserenameentry}
 
 \func{bool}{RenameEntry}{\param{const wxString\& }{ oldName}, \param{const wxString\& }{ newName}}


@@ -639,7 +684,7 @@ 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.
 
 the new one) shouldn't contain backslashes, i.e. only simple names and not
 arbitrary paths are accepted by this function.
 

-Returns FALSE if the {\it oldName} doesn't exist or if {\it newName} already
+Returns false if the {\it oldName} doesn't exist or if {\it newName} already

 exists.
 
 \membersection{wxConfigBase::RenameGroup}\label{wxconfigbaserenamegroup}
 exists.
 
 \membersection{wxConfigBase::RenameGroup}\label{wxconfigbaserenamegroup}


@@ -650,19 +695,19 @@ 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.
 
 the new one) shouldn't contain backslashes, i.e. only simple names and not
 arbitrary paths are accepted by this function.
 

-Returns FALSE if the {\it oldName} doesn't exist or if {\it newName} already
+Returns false if the {\it oldName} doesn't exist or if {\it newName} already

 exists.
 
 \membersection{wxConfigBase::Set}\label{wxconfigbaseset}
 
 exists.
 
 \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)
 
 \membersection{wxConfigBase::SetExpandEnvVars}\label{wxconfigbasesetexpandenvvars}
 
 
 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::SetExpandEnvVars}\label{wxconfigbasesetexpandenvvars}
 

-\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.
 


@@ -676,13 +721,14 @@ exist it is created.
 
 \membersection{wxConfigBase::SetRecordDefaults}\label{wxconfigbasesetrecorddefaults}
 
 
 \membersection{wxConfigBase::SetRecordDefaults}\label{wxconfigbasesetrecorddefaults}
 

-\func{void}{SetRecordDefaults}{\param{bool }{bDoIt = TRUE}}
+\func{void}{SetRecordDefaults}{\param{bool }{bDoIt = true}}

 
 

-Sets whether defaults are written back to the config file.
+Sets whether defaults are recorded to the config file whenever an attempt to
+read read the value which is not present in it is done.

 
 

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

 
 \membersection{wxConfigBase::SetUmask}\label{wxfileconfigsetumask}
 
 
 \membersection{wxConfigBase::SetUmask}\label{wxfileconfigsetumask}
 


@@ -708,7 +754,7 @@ value}}
 
 \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
+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
 on success.
 
 \pythonnote{In place of a single overloaded method name, wxPython


@@ -720,3 +766,11 @@ implements the following methods:\par
 \end{twocollist}}
 }
 
 \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}
+}}