updated legalese regarding libtiff, libjpeg

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

diff --git a/docs/latex/wx/config.tex b/docs/latex/wx/config.tex
index 30a6a6aeab704898b2a705c45c5317beeb334c9d..2e231e1e8cbcb120f3862a09dfa11948761aa08e 100644 (file)
--- a/docs/latex/wx/config.tex
+++ b/docs/latex/wx/config.tex
@@ -17,6 +17,9 @@ wxFileConfig otherwise.
 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
@@ -75,7 +78,7 @@ physical storage where a wxConfigBase-derived class stores its data.
 
 \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
@@ -93,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.
 
+{\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}\\
@@ -358,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
-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}
 
@@ -424,9 +434,10 @@ destructor)
 
 \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}
@@ -443,7 +454,7 @@ 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 \helpref{wxRegConfig}{wxregconfig} will fail.
+key with wxRegConfig will fail.
 
 The result is an element of enum EntryType:
 
@@ -621,9 +632,9 @@ 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.}
+\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}}
 }
 
@@ -697,9 +708,9 @@ 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.}
+\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}}
 }