Generate pywrap as a console tool.

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

diff --git a/docs/latex/wx/config.tex b/docs/latex/wx/config.tex
index dd1c906ac25d10a4434738a3cf880f0969d15e7f..f1bdd6b7236400b02b422ace81682b284640f2a4 100644 (file)
--- a/docs/latex/wx/config.tex
+++ b/docs/latex/wx/config.tex
@@ -11,7 +11,7 @@ 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
 which is mapped onto the native wxConfigBase implementation on the given
 Windows 3.1 .INI files if you're really unlucky). To make writing the portable
 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
+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


@@ -28,7 +28,7 @@ No base class
 
 <wx/config.h> (to let wxWindows choose a wxConfig class for your platform)\\
 <wx/confbase.h> (base config class)\\
 
 <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/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)
 


@@ -87,9 +87,8 @@ 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.
 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.

-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.
+Note that you must delete this object (usually in \helpref{wxApp::OnExit}{wxapponexit}) 
+in order to avoid memory leaks, wxWindows 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
 
 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


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


@@ -382,6 +382,11 @@ 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.}
 
 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}
 
 By default, environment variable expansion is on and recording defaults is
 \wxheading{Remarks}
 
 By default, environment variable expansion is on and recording defaults is