X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f6bcfd974ef26faf6f91a62cac09827e09463fd1..a9249b2eb2a40d8c71f828669045c4ddaa8dc5ff:/docs/latex/wx/config.tex?ds=sidebyside

diff --git a/docs/latex/wx/config.tex b/docs/latex/wx/config.tex
index 51e85c0c61..6ae7706b42 100644
--- a/docs/latex/wx/config.tex
+++ b/docs/latex/wx/config.tex
@@ -53,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
-  long value = config->Read("/LastRun/CalculatedValues/MaxValue", -1);
+  long value = config->Read("/LastRun/CalculatedValues/MaxValue", 17);
   ...
   ...
   ...
@@ -86,10 +86,10 @@ 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
@@ -257,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
-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.
 
@@ -309,8 +309,8 @@ config file:
   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 ;-)
+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
@@ -593,12 +593,20 @@ if the key is not found.
 
 NB: writing
 
-{\small \begin{verbatim} conf->Read("key", 0); \end{verbatim} }
+{\small
+\begin{verbatim}
+    conf->Read("key", 0);
+\end{verbatim}
+}
 
 won't work because the call is ambiguous: compiler can not choose between two
 {\it Read} functions. Instead, write:
 
-{\small \begin{verbatim} conf->Read("key", 0l); \end{verbatim} }
+{\small
+\begin{verbatim}
+    conf->Read("key", 0l);
+\end{verbatim}
+}
 
 \constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{double*}{ d}}
 
@@ -678,11 +686,12 @@ exist it is created.
 
 \func{void}{SetRecordDefaults}{\param{bool }{bDoIt = TRUE}}
 
-Sets whether defaults are written back to the config file.
+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 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.
+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}