X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/cc81d32f2bf8c159f3b1bf6ddaf62e6d77720209..2c6f14e1a7b5062fcf77eda40824d820d9ac288e:/docs/latex/wx/config.tex?ds=sidebyside diff --git a/docs/latex/wx/config.tex b/docs/latex/wx/config.tex index dd1c906ac2..03b3a89223 100644 --- a/docs/latex/wx/config.tex +++ b/docs/latex/wx/config.tex @@ -28,7 +28,7 @@ No base class (to let wxWindows choose a wxConfig class for your platform)\\ (base config class)\\ - (wxFileconfig class)\\ + (wxFileConfig class)\\ (wxRegConfig class)\\ (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 @@ -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{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. @@ -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.} +\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