added wxImage::IsTransparent(x, y)

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

diff --git a/docs/latex/wx/config.tex b/docs/latex/wx/config.tex
index 19839abcc9218d1915c495ee99eb5cc0a13d74d6..d8b57af2b45cf5167cd9710054d0c7677346be77 100644 (file)
--- a/docs/latex/wx/config.tex
+++ b/docs/latex/wx/config.tex
@@ -2,7 +2,7 @@
 
 wxConfigBase class defines the basic interface of all config classes. It can
 not be used by itself (it is an abstract base class) and you will always use one
-of its derivations: wxIniConfig, \helpref{wxFileConfig}{wxfileconfig},
+of its derivations: \helpref{wxFileConfig}{wxfileconfig},
 wxRegConfig or any other.
 
 However, usually you don't even need to know the precise nature of the class
@@ -12,7 +12,7 @@ the registry under Win32 or text-based config files under Unix (or even
 Windows 3.1 .INI files if you're really unlucky). To make writing the portable
 code even easier, wxWidgets provides a typedef wxConfig
 which is mapped onto the native wxConfigBase implementation on the given
-platform: i.e. wxRegConfig under Win32 (optionally wxIniConfig) and
+platform: i.e. wxRegConfig under Win32 and
 wxFileConfig otherwise.
 
 See \helpref{config overview}{wxconfigoverview} for the descriptions of all
@@ -30,8 +30,7 @@ No base class
 <wx/config.h> (to let wxWidgets 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)
+<wx/msw/regconf.h> (wxRegConfig class)
 
 \wxheading{Example}
 
@@ -108,13 +107,13 @@ of \helpref{wxFileDialog}{wxfiledialog} have ability to use wxConfig class.
 \helpref{DontCreateOnDemand}{wxconfigbasedontcreateondemand}
 
 
-\membersection{Constructor and destructor}
+\membersection{Constructor and destructor}\label{congigconstructordestructor}
 
 \helpref{wxConfigBase}{wxconfigbasector}\\
 \helpref{\destruct{wxConfigBase}}{wxconfigbasedtor}
 
 
-\membersection{Path management}
+\membersection{Path management}\label{configpathmanagement}
 
 As explained in \helpref{config overview}{wxconfigoverview}, the config classes
 support a file system-like hierarchy of keys (files) and groups (directories).
@@ -184,7 +183,7 @@ regardless of the platform (i.e. it is {\bf not} '$\backslash\backslash$' under
 \helpref{GetPath}{wxconfigbasegetpath}
 
 
-\membersection{Enumeration}
+\membersection{Enumeration}\label{configenumeration}
 
 The functions in this section allow to enumerate all entries and groups in the
 config file. All functions here return false when there are no more items.
@@ -200,6 +199,7 @@ explicitly.
 Having said all this, enumerating the config entries/groups is very simple:
 
 \begin{verbatim}
+  wxConfigBase *config = ...;
   wxArrayString aNames;
 
   // enumeration variables
@@ -239,7 +239,7 @@ actually enumerating them, but you will probably never need them.
 \helpref{GetNumberOfGroups}{wxconfigbasegetnumberofgroups}
 
 
-\membersection{Tests of existence}
+\membersection{Tests of existence}\label{configtestsofexistence}
 
 \helpref{HasGroup}{wxconfigbasehasgroup}\\
 \helpref{HasEntry}{wxconfigbasehasentry}\\
@@ -247,14 +247,14 @@ actually enumerating them, but you will probably never need them.
 \helpref{GetEntryType}{wxconfigbasegetentrytype}
 
 
-\membersection{Miscellaneous functions}
+\membersection{Miscellaneous functions}\label{configmiscellaneous}
 
 \helpref{GetAppName}{wxconfigbasegetappname}\\
 \helpref{GetVendorName}{wxconfigbasegetvendorname}\\
 \helpref{SetUmask}{wxfileconfigsetumask}
 
 
-\membersection{Key access}
+\membersection{Key access}\label{configkeyaccess}
 
 These function are the core of wxConfigBase class: they allow you to read and
 write config file data. All {\it Read} function take a default value which
@@ -281,7 +281,7 @@ arbitrary path (either relative or absolute), not just the key name.
 \helpref{Flush}{wxconfigbaseflush}
 
 
-\membersection{Rename entries/groups}
+\membersection{Rename entries/groups}\label{configrenaming}
 
 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
@@ -293,7 +293,7 @@ wxConfig implementation.
 \helpref{RenameGroup}{wxconfigbaserenamegroup}
 
 
-\membersection{Delete entries/groups}
+\membersection{Delete entries/groups}\label{configdeleting}
 
 The functions in this section delete entries and/or groups of entries from the
 config file. {\it DeleteAll()} is especially useful if you want to erase all
@@ -304,7 +304,7 @@ traces of your program presence: for example, when you uninstall it.
 \helpref{DeleteAll}{wxconfigbasedeleteall}
 
 
-\membersection{Options}
+\membersection{Options}\label{configoptions}
 
 Some aspects of wxConfigBase behaviour can be changed during run-time. The
 first of them is the expansion of environment variables in the string values
@@ -386,6 +386,7 @@ add wxCONFIG\_USE\_NO\_ESCAPE\_CHARACTERS which will turn off character
 escaping for the values of entries stored in the config file: for example 
 a {\it foo} key with some backslash characters will be stored as {\tt foo=C:$\backslash$mydir} instead
 of the usual storage of {\tt foo=C:$\backslash\backslash$mydir}.
+For wxRegConfig, this flag refers to HKLM, and provides read-only access.
 
 The wxCONFIG\_USE\_NO\_ESCAPE\_CHARACTERS style can be helpful if your config 
 file must be read or written to by a non-wxWidgets program (which might not 
@@ -395,7 +396,7 @@ your application's responsibility to ensure that there is no newline or
 other illegal characters in a value, before writing that value to the file.}
 
 \docparam{conv}{This parameter is only used by wxFileConfig when compiled
-in Unicode mode. It specifies the encoding in what the configuration file
+in Unicode mode. It specifies the encoding in which the configuration file
 is written.}
 
 
@@ -804,3 +805,4 @@ implements the following methods:\par
 \twocolitem{{\bf WriteBool(key, value)}}{Writes a boolean}
 \end{twocollist}
 }}
+