Chnaged includes to work without precompiled headers

[wxWidgets.git] / docs / latex / wx / config.tex

diff --git a/docs/latex/wx/config.tex b/docs/latex/wx/config.tex
index 95c0c13616290d9e6487eed71f3c3d43b0df0680..2e231e1e8cbcb120f3862a09dfa11948761aa08e 100644 (file)
--- a/docs/latex/wx/config.tex
+++ b/docs/latex/wx/config.tex
@@ -17,10 +17,21 @@ wxFileConfig otherwise.
 See \helpref{config overview}{wxconfigoverview} for the descriptions of all
 features of this class.
 
 See \helpref{config overview}{wxconfigoverview} for the descriptions of all
 features of this class.
 

+It is highly recommended to use static functions {\it Get()} and/or {\it Set()}, 
+so please have a \helpref{look at them.}{wxconfigstaticfunctions}
+

 \wxheading{Derived from}
 
 No base class
 
 \wxheading{Derived from}
 
 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:
 \wxheading{Example}
 
 Here is how you would typically use this class:


@@ -67,7 +78,7 @@ physical storage where a wxConfigBase-derived class stores its data.
 
 \latexignore{\rtfignore{\wxheading{Function groups}}}
 
 
 \latexignore{\rtfignore{\wxheading{Function groups}}}
 

-\membersection{Static functions}
+\membersection{Static functions}\label{wxconfigstaticfunctions}

 
 These functions deal with the "default" config object. Although its usage is
 not at all mandatory it may be convenient to use a global config object
 
 These functions deal with the "default" config object. Although its usage is
 not at all mandatory it may be convenient to use a global config object


@@ -85,6 +96,11 @@ 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.
 
 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
+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.
+

 \helpref{Set}{wxconfigbaseset}\\
 \helpref{Get}{wxconfigbaseget}\\
 \helpref{Create}{wxconfigbasecreate}\\
 \helpref{Set}{wxconfigbaseset}\\
 \helpref{Get}{wxconfigbaseget}\\
 \helpref{Create}{wxconfigbasecreate}\\


@@ -116,7 +132,7 @@ sensible!):
 
   // create an entry in subgroup
   conf->Write("SubgroupEntry", 3);
 
   // create an entry in subgroup
   conf->Write("SubgroupEntry", 3);

-  
+

   // '..' is understood
   conf->Write("../GroupEntry", 2);
   conf->SetPath("..");
   // '..' is understood
   conf->Write("../GroupEntry", 2);
   conf->SetPath("..");


@@ -150,7 +166,7 @@ doesn't save and restore the path):
   void bar(wxConfigBase *config)
   {
     config->Write("Test", 17);
   void bar(wxConfigBase *config)
   {
     config->Write("Test", 17);

-    
+

     foo(config);
 
     // we're reading "/Foo/Data/Test" here! -1 will probably be returned...
     foo(config);
 
     // we're reading "/Foo/Data/Test" here! -1 will probably be returned...


@@ -222,13 +238,12 @@ actually enumerating them, but you will probably never need them.
 
 \helpref{HasGroup}{wxconfigbasehasgroup}\\
 \helpref{HasEntry}{wxconfigbasehasentry}\\
 
 \helpref{HasGroup}{wxconfigbasehasgroup}\\
 \helpref{HasEntry}{wxconfigbasehasentry}\\

-\helpref{Exists}{wxconfigbaseexists}
+\helpref{Exists}{wxconfigbaseexists}\\
+\helpref{GetEntryType}{wxconfigbasegetentrytype}

 
 \membersection{Miscellaneous accessors}
 
 
 \membersection{Miscellaneous accessors}
 

-\helpref{SetAppName}{wxconfigbasesetappname}\\

 \helpref{GetAppName}{wxconfigbasegetappname}\\
 \helpref{GetAppName}{wxconfigbasegetappname}\\

-\helpref{SetVendorName}{wxconfigbasesetvendorname}\\

 \helpref{GetVendorName}{wxconfigbasegetvendorname}
 
 \membersection{Key access}
 \helpref{GetVendorName}{wxconfigbasegetvendorname}
 
 \membersection{Key access}


@@ -257,6 +272,17 @@ arbitrary path (either relative or absolute), not just the key name.
 \helpref{Write}{wxconfigbasewrite}\\
 \helpref{Flush}{wxconfigbaseflush}
 
 \helpref{Write}{wxconfigbasewrite}\\
 \helpref{Flush}{wxconfigbaseflush}
 

+\membersection{Rename entries/groups}
+
+The functions in this section allow to rename entries or subgroups of the
+current group. They will return FALSE on error. typically because either the
+entry/group with the original name doesn't exist, because the entry/group with
+the new name already exists or because the function is not supported in this
+wxConfig implementation.
+
+\helpref{RenameEntry}{wxconfigbaserenameentry}\\
+\helpref{RenameGroup}{wxconfigbaserenamegroup}
+

 \membersection{Delete entries/groups}
 
 The functions in this section delete entries and/or groups of entries from the
 \membersection{Delete entries/groups}
 
 The functions in this section delete entries and/or groups of entries from the


@@ -340,7 +366,9 @@ class and is ignored by some. For wxFileConfig, these styles determine whether
 a local or global config file is created or used. If the flag is present but
 the parameter is empty, the parameter will be set to a default. If the
 parameter is present but the style flag not, the relevant flag will be added
 a local or global config file is created or used. If the flag is present but
 the parameter is empty, the parameter will be set to a default. If the
 parameter is present but the style flag not, the relevant flag will be added

-to the style.}
+to the style. For wxFileConfig you can also add wxCONFIG\_USE\_RELATIVE\_PATH 
+by logicaly or'ing it to either of the \_FILE options to tell wxFileConfig to 
+use relative instead of absolute paths.  }

 
 \wxheading{Remarks}
 
 
 \wxheading{Remarks}
 


@@ -406,9 +434,10 @@ destructor)
 
 \membersection{wxConfigBase::Get}\label{wxconfigbaseget}
 
 
 \membersection{wxConfigBase::Get}\label{wxconfigbaseget}
 

-\func{wxConfigBase *}{Get}{\void}
+\func{wxConfigBase *}{Get}{\param{bool }{CreateOnDemand = TRUE}}

 
 

-Get the current config object. If there is no current object, creates one
+Get the current config object. If there is no current object and
+{\it CreateOnDemand} is TRUE, creates one

 (using {\it Create}) unless DontCreateOnDemand was called previously.
 
 \membersection{wxConfigBase::GetAppName}\label{wxconfigbasegetappname}
 (using {\it Create}) unless DontCreateOnDemand was called previously.
 
 \membersection{wxConfigBase::GetAppName}\label{wxconfigbasegetappname}


@@ -417,6 +446,29 @@ Get the current config object. If there is no current object, creates one
 
 Returns the application name.
 
 
 Returns the application name.
 

+\membersection{wxConfigBase::GetEntryType}\label{wxconfigbasegetentrytype}
+
+\constfunc{enum wxConfigBase::EntryType}{GetEntryType}{\param{const wxString\& }{name}}
+
+Returns the type of the given entry or {\it Unknown} if the entry doesn't
+exist. This function should be used to decide which version of Read() should
+be used because some of wxConfig implementations will complain about type
+mismatch otherwise: e.g., an attempt to read a string value from an integer
+key with wxRegConfig will fail.
+
+The result is an element of enum EntryType:
+
+\begin{verbatim}
+  enum EntryType
+  {
+    Unknown,
+    String,
+    Boolean,
+    Integer,
+    Float
+  };
+\end{verbatim}
+

 \membersection{wxConfigBase::GetFirstGroup}\label{wxconfigbasegetfirstgroup}
 
 \constfunc{bool}{GetFirstGroup}{\param{wxString\& }{str}, \param{long\&}{
 \membersection{wxConfigBase::GetFirstGroup}\label{wxconfigbasegetfirstgroup}
 
 \constfunc{bool}{GetFirstGroup}{\param{wxString\& }{str}, \param{long\&}{


@@ -424,6 +476,10 @@ index}}
 
 Gets the first group.
 
 
 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\&}{
 \membersection{wxConfigBase::GetFirstEntry}\label{wxconfigbasegetfirstentry}
 
 \constfunc{bool}{GetFirstEntry}{\param{wxString\& }{str}, \param{long\&}{


@@ -431,6 +487,10 @@ index}}
 
 Gets the first entry.
 
 
 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\&}{
 \membersection{wxConfigBase::GetNextGroup}\label{wxconfigbasegetnextgroup}
 
 \constfunc{bool}{GetNextGroup}{\param{wxString\& }{str}, \param{long\&}{


@@ -438,6 +498,10 @@ index}}
 
 Gets the next group.
 
 
 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\&}{
 \membersection{wxConfigBase::GetNextEntry}\label{wxconfigbasegetnextentry}
 
 \constfunc{bool}{GetNextEntry}{\param{wxString\& }{str}, \param{long\&}{


@@ -445,6 +509,10 @@ index}}
 
 Gets the next entry.
 
 
 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}}
 \membersection{wxConfigBase::GetNumberOfEntries}\label{wxconfigbasegetnumberofentries}
 
 \constfunc{uint }{GetNumberOfEntries}{\param{bool }{bRecursive = FALSE}}


@@ -545,7 +613,7 @@ Reads a double value, returning TRUE if the value was found. If the value was
 not found, {\it d} is not changed.
 
 \constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{double*}{ d},
 not found, {\it d} is not changed.
 
 \constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{double*}{ d},

-\param{double}{ defaultVal}}
+ \param{double}{ defaultVal}}

 
 Reads a double value, returning TRUE if the value was found. If the value was
 not found, {\it defaultVal} is used instead.
 
 Reads a double value, returning TRUE if the value was found. If the value was
 not found, {\it defaultVal} is used instead.


@@ -561,6 +629,37 @@ 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.
 
 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}}
+
+Renames an entry in the current group. The entries names (both the old and
+the new one) shouldn't contain backslashes, i.e. only simple names and not
+arbitrary paths are accepted by this function.
+
+Returns FALSE if the {\it oldName} doesn't exist or if {\it newName} already
+exists.
+
+\membersection{wxConfigBase::RenameGroup}\label{wxconfigbaserenamegroup}
+
+\func{bool}{RenameGroup}{\param{const wxString\& }{ oldName}, \param{const wxString\& }{ newName}}
+
+Renames a subgroup of the current group. The subgroup names (both the old and
+the new one) shouldn't contain backslashes, i.e. only simple names and not
+arbitrary paths are accepted by this function.
+
+Returns FALSE if the {\it oldName} doesn't exist or if {\it newName} already
+exists.
+

 \membersection{wxConfigBase::Set}\label{wxconfigbaseset}
 
 \func{wxConfigBase *}{Set}{\param{wxConfigBase *}{pConfig}}
 \membersection{wxConfigBase::Set}\label{wxconfigbaseset}
 
 \func{wxConfigBase *}{Set}{\param{wxConfigBase *}{pConfig}}


@@ -568,12 +667,6 @@ not found, {\it defaultVal} is used instead.
 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)
 
 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)
 

-\membersection{wxConfigBase::SetAppName}\label{wxconfigbasesetappname}
-
-\func{void }{SetAppName}{\param{const wxString\&}{ appName}}
-
-Sets the application name.
-

 \membersection{wxConfigBase::SetExpandingEnvVars}\label{wxconfigbasesetexpandingenvvars}
 
 \func{void}{SetExpandEnvVars }{\param{bool }{bDoIt = TRUE}}
 \membersection{wxConfigBase::SetExpandingEnvVars}\label{wxconfigbasesetexpandingenvvars}
 
 \func{void}{SetExpandEnvVars }{\param{bool }{bDoIt = TRUE}}


@@ -598,12 +691,6 @@ 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.
 
 This allows the user to see what config options may be changed and is probably
 useful only for wxFileConfig.
 

-\membersection{wxConfigBase::SetVendorName}\label{wxconfigbasesetvendorname}
-
-\func{void}{SetVendorName}{\param{const wxString\&}{ vendorName}}
-
-Sets the vendor name.
-

 \membersection{wxConfigBase::Write}\label{wxconfigbasewrite}
 
 \func{bool}{Write}{\param{const wxString\& }{ key}, \param{const wxString\& }{
 \membersection{wxConfigBase::Write}\label{wxconfigbasewrite}
 
 \func{bool}{Write}{\param{const wxString\& }{ key}, \param{const wxString\& }{


@@ -618,4 +705,16 @@ value}}
 These functions write the specified value to the config file and return TRUE
 on success.
 
 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}}
+}
+
+
+
+