clean up of memory debugging macros and chanegs to compile with CW7 (patch 548408)

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

diff --git a/docs/latex/wx/config.tex b/docs/latex/wx/config.tex
index 724c3a203b31154b15c125338f6eb03d44787bb2..920d8304062a2612cd4d14e43552b1e3ea77a5dd 100644 (file)
--- a/docs/latex/wx/config.tex
+++ b/docs/latex/wx/config.tex
@@ -1,28 +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: \helpref{wxIniConfig}{wxiniconfig},
-\helpref{wxFileConfig}{wxfileconfig}, \helpref{wxRegConfig}{wxregconfig} or
-any other.
+not be used by itself (it is an abstract base class) and you will always use one
+of its derivations: wxIniConfig, 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 \helpref{wxConfig}{wxconfig} 
+code even easier, wxWindows provides a typedef wxConfig

 which is mapped onto the native wxConfigBase implementation on the given
 platform: i.e. wxRegConfig under Win32, wxIniConfig under Win16 and
 wxFileConfig otherwise.
 
 which is mapped onto the native wxConfigBase implementation on the given
 platform: i.e. wxRegConfig under Win32, wxIniConfig under Win16 and
 wxFileConfig otherwise.
 

-See \helpref{config overview}{configoverview} for the descriptions of all
+See \helpref{config overview}{wxconfigoverview} for the descriptions of all

 features of this class.
 
 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 wxWindows choose a wxConfig class for your platform)\\
+<wx/confbase.h> (base config class)\\
+<wx/fileconf.h> (wxFileconfig class)\\
+<wx/msw/regconf.h> (wxRegConfig class)\\
+<wx/msw/iniconf.h> (wxIniConfig class)
+

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


@@ -33,7 +42,7 @@ Here is how you would typically use this class:
   wxConfig *config = new wxConfig("MyAppName");
 
   wxString str;
   wxConfig *config = new wxConfig("MyAppName");
 
   wxString str;

-  if ( config->Read(&str, "LastPrompt") ) {
+  if ( config->Read("LastPrompt", &str) ) {

     // last prompt was found in the config file/registry and its value is now
     // in str
     ...
     // last prompt was found in the config file/registry and its value is now
     // in str
     ...


@@ -44,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);

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


@@ -67,31 +76,31 @@ NB: in the documentation of this class, the words "config file" also mean
 "registry hive" for wxRegConfig and, generally speaking, might mean any
 physical storage where a wxConfigBase-derived class stores its data.
 
 "registry hive" for wxRegConfig and, generally speaking, might mean any
 physical storage where a wxConfigBase-derived class stores its data.
 

-\wxheading{See also}
-
-\helpref{wxIniConfig}{wxiniconfig}, \helpref{wxFileConfig}{wxfileconfig}, 
-\helpref{wxRegConfig}{wxregconfig}
-

 \latexignore{\rtfignore{\wxheading{Function groups}}}
 
 \latexignore{\rtfignore{\wxheading{Function groups}}}
 

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

 
 

-These function deal with the "default" config object. Although its usage is
+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
 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
 not at all mandatory it may be convenient to use a global config object
 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

-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 wxWindows will delete this config object for you during the program
+shutdown (from \helpref{wxApp::OnExit}{wxapponexit} to be precise) but you can
+also do it yourself earlier if needed.

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

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


@@ -104,12 +113,12 @@ disable this behaviour {\it DontCreateOnDemand()} is provided.
 
 \membersection{Path management}
 
 
 \membersection{Path management}
 

-As explained in \helpref{config overview}{configoverview}, the config classes
+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
 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

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


@@ -123,18 +132,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}


@@ -157,7 +166,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...


@@ -166,7 +175,7 @@ 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}


@@ -177,9 +186,9 @@ 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.
 
 You must pass the same index to GetNext and GetFirst (don't modify it).
 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's {\bf not} the index of the current item (you will have
+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 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
+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.


@@ -229,7 +238,14 @@ actually enumerating them, but you will probably never need them.
 
 \helpref{HasGroup}{wxconfigbasehasgroup}\\
 \helpref{HasEntry}{wxconfigbasehasentry}\\
 
 \helpref{HasGroup}{wxconfigbasehasgroup}\\
 \helpref{HasEntry}{wxconfigbasehasentry}\\

-\helpref{Exists}{wxconfigbaseexists}
+\helpref{Exists}{wxconfigbaseexists}\\
+\helpref{GetEntryType}{wxconfigbasegetentrytype}
+
+\membersection{Miscellaneous functions}
+
+\helpref{GetAppName}{wxconfigbasegetappname}\\
+\helpref{GetVendorName}{wxconfigbasegetvendorname}\\
+\helpref{SetUmask}{wxfileconfigsetumask}

 
 \membersection{Key access}
 
 
 \membersection{Key access}
 


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


@@ -257,6 +273,17 @@ arbitrary path (either relative or absolute), not just the key name.
 \helpref{Write}{wxconfigbasewrite}\\
 \helpref{Flush}{wxconfigbaseflush}
 
 \helpref{Write}{wxconfigbasewrite}\\
 \helpref{Flush}{wxconfigbaseflush}
 

+\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
+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}
 
 The functions in this section delete entries and/or groups of entries from the
 \membersection{Delete entries/groups}
 
 The functions in this section delete entries and/or groups of entries from the


@@ -281,9 +308,9 @@ 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
 
 Although this feature is very useful, it may be annoying if you read a value
 which containts '\$' or '\%' symbols (\% is used for environment variables


@@ -295,7 +322,7 @@ would be to prefix the offending symbols with a backslash.
 The following functions control this option:
 
 \helpref{IsExpandingEnvVars}{wxconfigbaseisexpandingenvvars}\\
 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}
 


@@ -306,99 +333,216 @@ The following functions control this option:
 
 }}
 
 
 }}
 

-\membersection{wxConfigBase::GetFirstGroup}\label{wxconfigbasegetfirstgroup}
+\membersection{wxConfigBase::wxConfigBase}\label{wxconfigbasector}

 
 

-\constfunc{bool}{GetFirstGroup}{\param{wxString\& }{str}, \param{long\&}{ index}}
+\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}}

 
 

-\membersection{wxConfigBase::GetNextGroup}\label{wxconfigbasegetnextgroup}
+This is the default and only constructor of the wxConfigBase class, and
+derived classes.

 
 

-\constfunc{bool}{GetNextGroup}{\param{wxString\& }{str}, \param{long\&}{ index}}
+\wxheading{Parameters}

 
 

-\membersection{wxConfigBase::GetFirstEntry}\label{wxconfigbasegetfirstentry}
+\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.}

 
 

-\constfunc{bool}{GetFirstEntry}{\param{wxString\& }{str}, \param{long\&}{ index}}
+\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.}

 
 

-\membersection{wxConfigBase::GetNextEntry}\label{wxconfigbasegetnextentry}
+\docparam{localFilename}{Some config classes require a local filename. If this
+is not present, but required, the application name will be used instead.}

 
 

-\constfunc{bool}{GetNextEntry}{\param{wxString\& }{str}, \param{long\&}{ index}}
+\docparam{globalFilename}{Some config classes require a global filename. If
+this is not present, but required, the application name will be used instead.}

 
 

-See the example above.
+\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 logicaly or'ing it to either of the \_FILE options to tell wxFileConfig to 
+use relative instead of absolute paths.  }

 
 

-\membersection{wxConfigBase::GetNumberOfEntries}\label{wxconfigbasegetnumberofentries}
+\wxheading{Remarks}

 
 

-\constfunc{uint }{GetNumberOfEntries}{\param{bool }{bRecursive = FALSE}}
+By default, environment variable expansion is on and recording defaults is
+off.

 
 

-\membersection{wxConfigBase::GetNumberOfGroups}\label{wxconfigbasegetnumberofgroups}
+\membersection{wxConfigBase::\destruct{wxConfigBase}}\label{wxconfigbasedtor}

 
 

-\constfunc{uint}{GetNumberOfGroups}{\param{bool }{bRecursive = FALSE}}
+\func{}{\destruct{wxConfigBase}}{\void}

 
 

-Get number of entries/subgroups in the current group, with or without
-its subgroups.
+Empty but ensures that dtor of all derived classes is virtual.

 
 

-\membersection{wxConfigBase::Set}\label{wxconfigbaseset}
+\membersection{wxConfigBase::Create}\label{wxconfigbasecreate}

 
 

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

 
 

-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)
+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.
+
+\membersection{wxConfigBase::DontCreateOnDemand}\label{wxconfigbasedontcreateondemand}
+
+\func{void}{DontCreateOnDemand}{\void}
+
+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.
+
+\membersection{wxConfigBase::DeleteAll}\label{wxconfigbasedeleteall}
+
+\func{bool}{DeleteAll}{\void}
+
+Delete the whole underlying object (disk file, registry key, ...). Primarly
+for use by desinstallation routine.
+
+\membersection{wxConfigBase::DeleteEntry}\label{wxconfigbasedeleteentry}
+
+\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.
+
+\membersection{wxConfigBase::DeleteGroup}\label{wxconfigbasedeletegroup}
+
+\func{bool}{DeleteGroup}{\param{const wxString\& }{ key}}
+
+Delete the group (with all subgroups)
+
+\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
+
+\membersection{wxConfigBase::Flush}\label{wxconfigbaseflush}
+
+\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}
 
 
 \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::Create}\label{wxconfigbasecreate}
+\membersection{wxConfigBase::GetAppName}\label{wxconfigbasegetappname}

 
 

-\func{wxConfigBase *}{Create}{\void}
+\constfunc{wxString}{GetAppName}{\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.
+Returns the application name.

 
 

-\membersection{wxConfigBase::DontCreateOnDemand}\label{wxconfigbasedontcreateondemand}
+\membersection{wxConfigBase::GetEntryType}\label{wxconfigbasegetentrytype}

 
 

-\func{void}{DontCreateOnDemand}{\void}
+\constfunc{enum wxConfigBase::EntryType}{GetEntryType}{\param{const wxString\& }{name}}

 
 

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

 
 

-\membersection{wxConfigBase::wxConfigBase}\label{wxconfigbasector}
+The result is an element of enum EntryType:

 
 

-\func{}{wxConfigBase}{\void}
+\begin{verbatim}
+  enum EntryType
+  {
+    Unknown,
+    String,
+    Boolean,
+    Integer,
+    Float
+  };
+\end{verbatim}

 
 

-This is the default and only constructor of wxConfigBase class. It initializes
-it options: by default, environment variable expansion is on and recording
-defaults is off.
+\membersection{wxConfigBase::GetFirstGroup}\label{wxconfigbasegetfirstgroup}

 
 

-\membersection{wxConfigBase::\destruct{wxConfigBase}}\label{wxconfigbasedtor}
+\constfunc{bool}{GetFirstGroup}{\param{wxString\& }{str}, \param{long\&}{ index}}

 
 

-\func{}{\destruct{wxConfigBase}}{\void}
+Gets the first group.

 
 

-Empty but ensures that dtor of all derived classes is virtual.
+\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.}

 
 

-\membersection{wxConfigBase::SetPath}\label{wxconfigbasesetpath}
+\perlnote{In wxPerl this method takes no arguments and returns a 3-element
+list {\tt ( continue, str, index )}.}

 
 

-\func{void}{SetPath}{\param{const wxString\& }{strPath}}
+\membersection{wxConfigBase::GetFirstEntry}\label{wxconfigbasegetfirstentry}

 
 

-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.
+\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.
+
+\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.
+
+\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}
+
+\constfunc{uint }{GetNumberOfEntries}{\param{bool }{bRecursive = FALSE}}
+
+\membersection{wxConfigBase::GetNumberOfGroups}\label{wxconfigbasegetnumberofgroups}
+
+\constfunc{uint}{GetNumberOfGroups}{\param{bool }{bRecursive = FALSE}}
+
+Get number of entries/subgroups in the current group, with or without its
+subgroups.

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

-\constfunc{const wxString\& }{GetPath}{\void}
+\constfunc{const wxString\&}{GetPath}{\void}

 
 Retrieve the current path (always as absolute path).
 
 
 Retrieve the current path (always as absolute path).
 

-\membersection{wxConfigBase::HasGroup}\label{wxconfigbasehasgroup}
+\membersection{wxConfigBase::GetVendorName}\label{wxconfigbasegetvendorname}

 
 

-\constfunc{bool}{HasGroup}{\param{const wxString\& }{strName}}
+\constfunc{wxString}{GetVendorName}{\void}

 
 

-returns TRUE if the group by this name exists
+Returns the vendor name.

 
 \membersection{wxConfigBase::HasEntry}\label{wxconfigbasehasentry}
 
 
 \membersection{wxConfigBase::HasEntry}\label{wxconfigbasehasentry}
 


@@ -406,104 +550,211 @@ returns TRUE if the group by this name exists
 
 returns TRUE if the entry by this name exists
 
 
 returns TRUE if the entry by this name exists
 

-\membersection{wxConfigBase::Exists}\label{wxconfigbaseexists}
+\membersection{wxConfigBase::HasGroup}\label{wxconfigbasehasgroup}

 
 

-\constfunc{bool}{Exists}{\param{wxString\& }{strName}}
+\constfunc{bool}{HasGroup}{\param{const wxString\& }{strName}}

 
 

-returns TRUE if either a group or an entry with a given name exists
+returns TRUE if the group by this name exists
+
+\membersection{wxConfigBase::IsExpandingEnvVars}\label{wxconfigbaseisexpandingenvvars}
+
+\constfunc{bool}{IsExpandingEnvVars}{\void}
+
+Returns TRUE if we are expanding environment variables in key values.
+
+\membersection{wxConfigBase::IsRecordingDefaults}\label{wxconfigbaseisrecordingdefaults}
+
+\constfunc{bool}{IsRecordingDefaults}{\void}
+
+Returns TRUE if we are writing defaults back to the config file.

 
 \membersection{wxConfigBase::Read}\label{wxconfigbaseread}
 
 
 \membersection{wxConfigBase::Read}\label{wxconfigbaseread}
 

-\constfunc{bool}{Read}{\param{wxString *}{pStr}, \param{const char *}{szKey}, \param{const char *}{szDefault = NULL}}
+\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: returns TRUE if value was really read, FALSE if
-default was used (the default value is returned if the key wasn't found)
+\constfunc{bool}{Read}{\param{const wxString\& }{key}, \param{wxString*}{ str}, \param{const wxString\& }{defaultVal}}

 
 

-\constfunc{const char *}{Read}{\param{const char *}{szKey}, \param{const char *}{szDefault = NULL}}
+Read a string from the key. The default value is returned if the key was not
+found.

 
 

-Another version of {\it Read()} using static buffer.
+Returns TRUE if value was really read, FALSE if the default was used.

 
 

-NB: although this function seems more convenient, you should only use it if
-you know what you're doing! As it uses a static buffer, it means it will be
-overwritten after each call to this function! If you do use it, you should
-save the returned value to a wxString as soon as possible.
+\constfunc{wxString}{Read}{\param{const wxString\& }{key}, \param{const
+wxString\& }{defaultVal}}

 
 

-\constfunc{long }{Read}{\param{const char *}{szKey}, \param{long}{ lDefault}}
+Another version of {\it Read()}, returning the string value directly.

 
 

-Read a long value from the key and return it (lDefault is returned if key not
-found).
+\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.
+
+\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.
+
+\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.

 
 NB: writing
 
 NB: writing

+
+{\small

 \begin{verbatim}
 \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 2
-{\it Read} functions. Instead, just write
+}
+
+won't work because the call is ambiguous: compiler can not choose between two
+{\it Read} functions. Instead, write:
+
+{\small

 \begin{verbatim}
 \begin{verbatim}

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

 \end{verbatim}
 \end{verbatim}

+}

 
 

-\constfunc{bool}{Read}{\param{long*}{ pl}, \param{const char*}{ szKey}, \param{long}{ lDefault = 0}}
+\constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{double*}{ d}}

 
 

-Another function for reading long values, it returns TRUE if the key was
-really read from config file and FALSE if the default value was used.
+Reads a double value, returning TRUE if the value was found. If the value was
+not found, {\it d} is not changed.

 
 

-\membersection{wxConfigBase::Write}\label{wxconfigbasewrite}
+\constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{double*}{ d},
+ \param{double}{ defaultVal}}

 
 

-\func{bool}{Write}{\param{const char*}{ szKey}, \param{const char*}{ szValue}}
+Reads a double value, returning TRUE if the value was found. If the value was
+not found, {\it defaultVal} is used instead.

 
 

-\func{bool}{Write}{\param{const char*}{ szKey}, \param{long}{ lValue}}
+\constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{bool*}{ b}}

 
 

-Both of these functions write the specified value to the config file and
-return TRUE on success.
+Reads a bool value, returning TRUE if the value was found. If the value was
+not found, {\it b} is not changed.

 
 

-\membersection{wxConfigBase::Flush}\label{wxconfigbaseflush}
+\constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{bool*}{ d},
+\param{bool}{ defaultVal}}

 
 

-\func{bool}{Flush}{\param{bool }{bCurrentOnly = FALSE}}
+Reads a bool value, returning TRUE if the value was found. If the value was
+not found, {\it defaultVal} is used instead.

 
 

-permanently writes all changes (otherwise, they're only written from object's
-destructor)
+\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}}
+}

 
 

-\membersection{wxConfigBase::DeleteEntry}\label{wxconfigbasedeleteentry}
+\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}
+}}

 
 

-\func{bool}{DeleteEntry}{\param{const char*}{ szKey}, \param{bool}{ bDeleteGroupIfEmpty = TRUE}}
+\membersection{wxConfigBase::RenameEntry}\label{wxconfigbaserenameentry}

 
 

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

 
 

-\membersection{wxConfigBase::DeleteGroup}\label{wxconfigbasedeletegroup}
+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.

 
 

-\func{bool}{DeleteGroup}{\param{const char*}{ szKey}}
+Returns FALSE if the {\it oldName} doesn't exist or if {\it newName} already
+exists.

 
 

-Delete the group (with all subgroups)
+\membersection{wxConfigBase::RenameGroup}\label{wxconfigbaserenamegroup}

 
 

-\membersection{wxConfigBase::DeleteAll}\label{wxconfigbasedeleteall}
+\func{bool}{RenameGroup}{\param{const wxString\& }{ oldName}, \param{const wxString\& }{ newName}}

 
 

-\func{bool}{DeleteAll}{\void}
+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.

 
 

-Delete the whole underlying object (disk file, registry key, ...). Primarly
-for use by desinstallation routine.
+Returns FALSE if the {\it oldName} doesn't exist or if {\it newName} already
+exists.

 
 

-\membersection{wxConfigBase::IsExpandingEnvVars}\label{wxconfigbaseisexpandingenvvars}
+\membersection{wxConfigBase::Set}\label{wxconfigbaseset}

 
 

-\constfunc{bool}{IsExpandingEnvVars}{\void}
+\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::SetExpandingEnvVars}\label{wxconfigbasesetexpandingenvvars}
+\membersection{wxConfigBase::SetExpandEnvVars}\label{wxconfigbasesetexpandenvvars}

 
 \func{void}{SetExpandEnvVars }{\param{bool }{bDoIt = TRUE}}
 
 
 \func{void}{SetExpandEnvVars }{\param{bool }{bDoIt = TRUE}}
 

-The second option is recording of the default values: if it is 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.
+Determine whether we wish to expand environment variables in key values.

 
 

-The next functions control this option.
+\membersection{wxConfigBase::SetPath}\label{wxconfigbasesetpath}
+
+\func{void}{SetPath}{\param{const wxString\& }{strPath}}
+
+Set current path: if the first character is '/', it is the absolute path,
+otherwise it is a relative path. '..' is supported. If the strPath doesn't
+exist it is created.

 
 \membersection{wxConfigBase::SetRecordDefaults}\label{wxconfigbasesetrecorddefaults}
 
 \func{void}{SetRecordDefaults}{\param{bool }{bDoIt = TRUE}}
 
 
 \membersection{wxConfigBase::SetRecordDefaults}\label{wxconfigbasesetrecorddefaults}
 
 \func{void}{SetRecordDefaults}{\param{bool }{bDoIt = TRUE}}
 

-\membersection{wxConfigBase::IsRecordingDefaults}\label{wxconfigbaseisrecordingdefaults}
+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 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}

 
 

-\func{bool}{IsRecordingDefaults}{\void} const
+\func{void}{SetUmask}{\param{int }{mode}}

 
 

+{\bf NB:} this function is not in the base wxConfigBase class but is only
+implemented in wxFileConfig. Moreover, this function is Unix-specific and
+doesn't do anything on other platforms.
+
+SetUmask() allows to set the mode to be used for the config file creation.
+For example, to create a config file which is not readable by other users
+(useful if it stores some sensitive information, such as passwords), you
+should do {\tt SetUmask(0077)}.
+
+\membersection{wxConfigBase::Write}\label{wxconfigbasewrite}
+
+\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{double}{ 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.
+
+\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}
+}}