X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/cb3b65d4e2fa6572db7c2b364fe1e9ba4153c206..366e8ae67583e44f719d1c2fabb3a24eb3bda5b3:/docs/latex/wx/config.tex

diff --git a/docs/latex/wx/config.tex b/docs/latex/wx/config.tex
index 6ae7706b42..0a44bd3fd2 100644
--- a/docs/latex/wx/config.tex
+++ b/docs/latex/wx/config.tex
@@ -187,7 +187,7 @@ config file. All functions here return FALSE when there are no more items.
 
 You must pass the same index to GetNext and GetFirst (don't modify it).
 Please note that it is {\bf not} the index of the current item (you will have
-some great surprizes with wxRegConfig if you assume this) and you shouldn't
+some great surprises with wxRegConfig if you assume this) and you shouldn't
 even look at it: it is just a "cookie" which stores the state of the
 enumeration. It can't be stored inside the class because it would prevent you
 from running several enumerations simultaneously, that's why you must pass it
@@ -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 \tt{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.
 
@@ -308,9 +308,9 @@ config file:
   # the following syntax is valud only under Windows
   UserData = %windir%\\data.dat
 \end{verbatim}
-
-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 ;-)
+% $ % help EMACS syntax highlighting...
+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
@@ -434,7 +434,7 @@ destructor)
 
 \membersection{wxConfigBase::Get}\label{wxconfigbaseget}
 
-\func{wxConfigBase *}{Get}{\param{bool }{CreateOnDemand = TRUE}}
+\func{static wxConfigBase *}{Get}{\param{bool }{CreateOnDemand = TRUE}}
 
 Get the current config object. If there is no current object and
 {\it CreateOnDemand} is TRUE, creates one
@@ -479,6 +479,9 @@ Gets the first group.
 consisting of the continue flag, the value string, and the index for
 the next call.}
 
+\perlnote{In wxPerl this method takes no arguments and returns a 3-element
+list {\tt ( continue, str, index )}.}
+
 \membersection{wxConfigBase::GetFirstEntry}\label{wxconfigbasegetfirstentry}
 
 \constfunc{bool}{GetFirstEntry}{\param{wxString\& }{str}, \param{long\&}{ index}}
@@ -489,6 +492,9 @@ Gets the first entry.
 consisting of the continue flag, the value string, and the index for
 the next call.}
 
+\perlnote{In wxPerl this method takes no arguments and returns a 3-element
+list {\tt ( continue, str, index )}.}
+
 \membersection{wxConfigBase::GetNextGroup}\label{wxconfigbasegetnextgroup}
 
 \constfunc{bool}{GetNextGroup}{\param{wxString\& }{str}, \param{long\&}{ index}}
@@ -499,6 +505,9 @@ Gets the next group.
 consisting of the continue flag, the value string, and the index for
 the next call.}
 
+\perlnote{In wxPerl this method only takes the {\tt index} parameter
+and returns a 3-element list {\tt ( continue, str, index )}.}
+
 \membersection{wxConfigBase::GetNextEntry}\label{wxconfigbasegetnextentry}
 
 \constfunc{bool}{GetNextEntry}{\param{wxString\& }{str}, \param{long\&}{ index}}
@@ -509,6 +518,9 @@ Gets the next entry.
 consisting of the continue flag, the value string, and the index for
 the next call.}
 
+\perlnote{In wxPerl this method only takes the {\tt index} parameter
+and returns a 3-element list {\tt ( continue, str, index )}.}
+
 \membersection{wxConfigBase::GetNumberOfEntries}\label{wxconfigbasegetnumberofentries}
 
 \constfunc{uint }{GetNumberOfEntries}{\param{bool }{bRecursive = FALSE}}
@@ -639,6 +651,15 @@ implements the following methods:\par
 \end{twocollist}}
 }
 
+\perlnote{In place of a single overloaded method, wxPerl uses:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{{\bf Read(key, default="")}}{Returns a string}
+\twocolitem{{\bf ReadInt(key, default=0)}}{Returns an integer}
+\twocolitem{{\bf ReadFloat(key, default=0.0)}}{Returns a floating point number}
+\twocolitem{{\bf ReadBool(key, default=0)}}{Returns a boolean}
+\end{twocollist}
+}}
+
 \membersection{wxConfigBase::RenameEntry}\label{wxconfigbaserenameentry}
 
 \func{bool}{RenameEntry}{\param{const wxString\& }{ oldName}, \param{const wxString\& }{ newName}}
@@ -663,7 +684,7 @@ exists.
 
 \membersection{wxConfigBase::Set}\label{wxconfigbaseset}
 
-\func{wxConfigBase *}{Set}{\param{wxConfigBase *}{pConfig}}
+\func{static wxConfigBase *}{Set}{\param{wxConfigBase *}{pConfig}}
 
 Sets the config object as the current one, returns the pointer to the previous
 current object (both the parameter and returned value may be NULL)
@@ -729,3 +750,11 @@ implements the following methods:\par
 \end{twocollist}}
 }
 
+\perlnote{In place of a single overloaded method, wxPerl uses:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{{\bf Write(key, value)}}{Writes a string}
+\twocolitem{{\bf WriteInt(key, value)}}{Writes an integer}
+\twocolitem{{\bf WriteFloat(key, value)}}{Writes a floating point number}
+\twocolitem{{\bf WriteBool(key, value)}}{Writes a boolean}
+\end{twocollist}
+}}
