X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/736f28f8d86d93c61d73d94984b0ec3f3845795e..50c538600e7586c256fe0145ac8054f045be6fbb:/docs/latex/wx/config.tex?ds=sidebyside diff --git a/docs/latex/wx/config.tex b/docs/latex/wx/config.tex index 225dd4186a..1e7a62879c 100644 --- 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 -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 -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 @@ -26,9 +26,9 @@ No base class \wxheading{Include files} - (to let wxWindows choose a wxConfig class for your platform)\\ + (to let wxWidgets choose a wxConfig class for your platform)\\ (base config class)\\ - (wxFileconfig class)\\ + (wxFileConfig class)\\ (wxRegConfig class)\\ (wxIniConfig class) @@ -88,14 +88,14 @@ 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 you must delete this object (usually in \helpref{wxApp::OnExit}{wxapponexit}) -in order to avoid memory leaks, wxWindows won't do it automatically. +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. -{\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. @@ -375,17 +375,18 @@ 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 +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} By default, environment variable expansion is on and recording defaults is