X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/5d1902d6d6efc842c8f488520d3cca40f1ae99f8..cc385968c4b81d0cee98c164cb870a8759d927bc:/docs/latex/wx/config.tex

diff --git a/docs/latex/wx/config.tex b/docs/latex/wx/config.tex
index 8e74b3d429..a36d300cc0 100644
--- a/docs/latex/wx/config.tex
+++ b/docs/latex/wx/config.tex
@@ -21,6 +21,14 @@ features of this class.
 
 No base class
 
+\wxheading{Include files}
+
+<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/msw/regconf.h> (wxRegConfig class)\\
+<wx/msw/iniconf.h> (wxIniConfig class)
+
 \wxheading{Example}
 
 Here is how you would typically use this class:
@@ -116,7 +124,7 @@ sensible!):
 
   // create an entry in subgroup
   conf->Write("SubgroupEntry", 3);
-  
+
   // '..' is understood
   conf->Write("../GroupEntry", 2);
   conf->SetPath("..");
@@ -150,7 +158,7 @@ doesn't save and restore the path):
   void bar(wxConfigBase *config)
   {
     config->Write("Test", 17);
-    
+
     foo(config);
 
     // we're reading "/Foo/Data/Test" here! -1 will probably be returned...
@@ -435,6 +443,10 @@ index}}
 
 Gets the first group.
 
+\pythonnote{The wxPython version of this method returns a 3-tuple
+consisting of the continue flag, the value string, and the index for
+the next call.}
+
 \membersection{wxConfigBase::GetFirstEntry}\label{wxconfigbasegetfirstentry}
 
 \constfunc{bool}{GetFirstEntry}{\param{wxString\& }{str}, \param{long\&}{
@@ -442,6 +454,10 @@ index}}
 
 Gets the first entry.
 
+\pythonnote{The wxPython version of this method returns a 3-tuple
+consisting of the continue flag, the value string, and the index for
+the next call.}
+
 \membersection{wxConfigBase::GetNextGroup}\label{wxconfigbasegetnextgroup}
 
 \constfunc{bool}{GetNextGroup}{\param{wxString\& }{str}, \param{long\&}{
@@ -449,6 +465,10 @@ index}}
 
 Gets the next group.
 
+\pythonnote{The wxPython version of this method returns a 3-tuple
+consisting of the continue flag, the value string, and the index for
+the next call.}
+
 \membersection{wxConfigBase::GetNextEntry}\label{wxconfigbasegetnextentry}
 
 \constfunc{bool}{GetNextEntry}{\param{wxString\& }{str}, \param{long\&}{
@@ -456,6 +476,10 @@ index}}
 
 Gets the next entry.
 
+\pythonnote{The wxPython version of this method returns a 3-tuple
+consisting of the continue flag, the value string, and the index for
+the next call.}
+
 \membersection{wxConfigBase::GetNumberOfEntries}\label{wxconfigbasegetnumberofentries}
 
 \constfunc{uint }{GetNumberOfEntries}{\param{bool }{bRecursive = FALSE}}
@@ -572,6 +596,15 @@ not found, {\it b} is not changed.
 Reads a bool value, returning TRUE if the value was found. If the value was
 not found, {\it defaultVal} is used instead.
 
+\pythonnote{In place of a single overloaded method name, wxPython
+implements the following methods:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{\bf{Read(key, default="")}}{Returns a string.}
+\twocolitem{\bf{ReadInt(key, default=0)}}{Returns an int.}
+\twocolitem{\bf{ReadFloat(key, default=0.0)}}{Returns a floating point number.}
+\end{twocollist}}
+}
+
 \membersection{wxConfigBase::RenameEntry}\label{wxconfigbaserenameentry}
 
 \func{bool}{RenameEntry}{\param{const wxString\& }{ oldName}, \param{const wxString\& }{ newName}}
@@ -651,4 +684,16 @@ value}}
 These functions write the specified value to the config file and return TRUE
 on success.
 
+\pythonnote{In place of a single overloaded method name, wxPython
+implements the following methods:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{\bf{Write(key, value)}}{Writes a string.}
+\twocolitem{\bf{WriteInt(key, value)}}{Writes an int.}
+\twocolitem{\bf{WriteFloat(key, value)}}{Writes a floating point number.}
+\end{twocollist}}
+}
+
+
+
+
 
