]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/config.tex
wxMGL compilation fixes
[wxWidgets.git] / docs / latex / wx / config.tex
index a0619267874b729cedd0fc2b1f3b51ed8ab0c36e..03b3a892236e830770478bb2284b1be1d86b8006 100644 (file)
@@ -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/fileconf.h> (wxFileconfig class)\\
+<wx/fileconf.h> (wxFileConfig 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.
-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
@@ -376,10 +375,6 @@ 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}.
 
-\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.}
-
 The wxCONFIG\_USE\_NO\_ESCAPE\_CHARACTERS style can be helpful if your config 
 file must be read or written to by a non-wxWindows program (which might not 
 understand the escape characters). Note, however, that if 
@@ -387,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.}
 
+\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