added alpha support to wxCocoa, also fixed compilation after alpha changes hopefully

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

diff --git a/docs/latex/wx/config.tex b/docs/latex/wx/config.tex
index 19839abcc9218d1915c495ee99eb5cc0a13d74d6..3700a8ec72fa42eb02582ec0093e03983ac398a9 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
 
 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
 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
 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
 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/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}
 
 
 \wxheading{Example}
 


@@ -89,8 +88,10 @@ one (especially because creating a wxFileConfig object might be a time
 consuming operation). In this case, you may create this global config object
 in the very start of the program and {\it Set()} it as the default. Then, from
 anywhere in your program, you may access it using the {\it Get()} function.
 consuming operation). In this case, you may create this global config object
 in the very start of the program and {\it Set()} it as the default. Then, from
 anywhere in your program, you may access it using the {\it Get()} function.

-Note that you must delete this object (usually in \helpref{wxApp::OnExit}{wxapponexit}) 
-in order to avoid memory leaks, wxWidgets won't do it automatically.
+This global wxConfig object will be deleted by wxWidgets automatically if it
+exists. Note that this implies that if you do delete this object yourself
+(usually in \helpref{wxApp::OnExit}{wxapponexit}) you must use {\it Set(NULL)}
+to prevent wxWidgets from deleting it the second time.

 
 As it happens, you may even further simplify the procedure described above:
 you may forget about calling {\it Set()}. When {\it Get()} is called and there
 
 As it happens, you may even further simplify the procedure described above:
 you may forget about calling {\it Set()}. When {\it Get()} is called and there


@@ -100,7 +101,7 @@ disable this behaviour {\it DontCreateOnDemand()} is provided.
 {\bf Note:} You should use either {\it Set()} or {\it Get()} because wxWidgets
 library itself would take advantage of it and could save various information
 in it. For example \helpref{wxFontMapper}{wxfontmapper} or Unix version
 {\bf Note:} You should use either {\it Set()} or {\it Get()} because wxWidgets
 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.
+of \helpref{wxFileDialog}{wxfiledialog} have the ability to use wxConfig class.

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


@@ -108,13 +109,13 @@ of \helpref{wxFileDialog}{wxfiledialog} have ability to use wxConfig class.
 \helpref{DontCreateOnDemand}{wxconfigbasedontcreateondemand}
 
 
 \helpref{DontCreateOnDemand}{wxconfigbasedontcreateondemand}
 
 

-\membersection{Constructor and destructor}
+\membersection{Constructor and destructor}\label{congigconstructordestructor}

 
 \helpref{wxConfigBase}{wxconfigbasector}\\
 \helpref{\destruct{wxConfigBase}}{wxconfigbasedtor}
 
 
 
 \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).
 
 As explained in \helpref{config overview}{wxconfigoverview}, the config classes
 support a file system-like hierarchy of keys (files) and groups (directories).


@@ -184,10 +185,10 @@ regardless of the platform (i.e. it is {\bf not} '$\backslash\backslash$' under
 \helpref{GetPath}{wxconfigbasegetpath}
 
 
 \helpref{GetPath}{wxconfigbasegetpath}
 
 

-\membersection{Enumeration}
+\membersection{Enumeration}\label{configenumeration}

 
 The functions in this section allow to enumerate all entries and groups in the
 
 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.
+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
 
 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


@@ -200,6 +201,7 @@ explicitly.
 Having said all this, enumerating the config entries/groups is very simple:
 
 \begin{verbatim}
 Having said all this, enumerating the config entries/groups is very simple:
 
 \begin{verbatim}

+  wxConfigBase *config = ...;

   wxArrayString aNames;
 
   // enumeration variables
   wxArrayString aNames;
 
   // enumeration variables


@@ -239,7 +241,7 @@ actually enumerating them, but you will probably never need them.
 \helpref{GetNumberOfGroups}{wxconfigbasegetnumberofgroups}
 
 
 \helpref{GetNumberOfGroups}{wxconfigbasegetnumberofgroups}
 
 

-\membersection{Tests of existence}
+\membersection{Tests of existence}\label{configtestsofexistence}

 
 \helpref{HasGroup}{wxconfigbasehasgroup}\\
 \helpref{HasEntry}{wxconfigbasehasentry}\\
 
 \helpref{HasGroup}{wxconfigbasehasgroup}\\
 \helpref{HasEntry}{wxconfigbasehasentry}\\


@@ -247,14 +249,14 @@ actually enumerating them, but you will probably never need them.
 \helpref{GetEntryType}{wxconfigbasegetentrytype}
 
 
 \helpref{GetEntryType}{wxconfigbasegetentrytype}
 
 

-\membersection{Miscellaneous functions}
+\membersection{Miscellaneous functions}\label{configmiscellaneous}

 
 \helpref{GetAppName}{wxconfigbasegetappname}\\
 \helpref{GetVendorName}{wxconfigbasegetvendorname}\\
 \helpref{SetUmask}{wxfileconfigsetumask}
 
 
 
 \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
 
 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,10 +283,10 @@ arbitrary path (either relative or absolute), not just the key name.
 \helpref{Flush}{wxconfigbaseflush}
 
 
 \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
 
 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
+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.
 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.


@@ -293,7 +295,7 @@ wxConfig implementation.
 \helpref{RenameGroup}{wxconfigbaserenamegroup}
 
 
 \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
 
 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 +306,7 @@ traces of your program presence: for example, when you uninstall it.
 \helpref{DeleteAll}{wxconfigbasedeleteall}
 
 
 \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
 
 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 +388,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}.
 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 
 
 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 +398,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
 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.}
 
 
 is written.}
 
 


@@ -428,7 +431,7 @@ created object and also sets it as the current one.
 
 Calling this function will prevent {\it Get()} from automatically creating a
 new config object if the current one is NULL. It might be useful to call it
 
 Calling this function will prevent {\it Get()} from automatically creating a
 new config object if the current one is NULL. It might be useful to call it

-near the program end to prevent new config object "accidental" creation.
+near the program end to prevent "accidental" creation of a new config object.

 
 
 \membersection{wxConfigBase::DeleteAll}\label{wxconfigbasedeleteall}
 
 
 \membersection{wxConfigBase::DeleteAll}\label{wxconfigbasedeleteall}


@@ -436,7 +439,7 @@ near the program end to prevent new config object "accidental" creation.
 \func{bool}{DeleteAll}{\void}
 
 Delete the whole underlying object (disk file, registry key, ...). Primarly
 \func{bool}{DeleteAll}{\void}
 
 Delete the whole underlying object (disk file, registry key, ...). Primarly

-for use by desinstallation routine.
+for use by uninstallation routine.

 
 
 \membersection{wxConfigBase::DeleteEntry}\label{wxconfigbasedeleteentry}
 
 
 \membersection{wxConfigBase::DeleteEntry}\label{wxconfigbasedeleteentry}


@@ -451,14 +454,17 @@ in it and the second parameter is true.
 
 \func{bool}{DeleteGroup}{\param{const wxString\& }{ key}}
 
 
 \func{bool}{DeleteGroup}{\param{const wxString\& }{ key}}
 

-Delete the group (with all subgroups)
+Delete the group (with all subgroups). If the current path is under the group
+being deleted it is changed to its deepest still existing component. E.g. if
+the current path is \texttt{/A/B/C/D} and the group \texttt{C} is deleted the
+path becomes \texttt{/A/B}.

 
 
 \membersection{wxConfigBase::Exists}\label{wxconfigbaseexists}
 
 \constfunc{bool}{Exists}{\param{wxString\& }{strName}}
 
 
 
 \membersection{wxConfigBase::Exists}\label{wxconfigbaseexists}
 
 \constfunc{bool}{Exists}{\param{wxString\& }{strName}}
 

-returns true if either a group or an entry with a given name exists
+returns \true if either a group or an entry with a given name exists

 
 
 \membersection{wxConfigBase::Flush}\label{wxconfigbaseflush}
 
 
 \membersection{wxConfigBase::Flush}\label{wxconfigbaseflush}


@@ -500,11 +506,11 @@ The result is an element of enum EntryType:
 \begin{verbatim}
   enum EntryType
   {
 \begin{verbatim}
   enum EntryType
   {

-    Unknown,
-    String,
-    Boolean,
-    Integer,
-    Float
+    Type_Unknown,
+    Type_String,
+    Type_Boolean,
+    Type_Integer,
+    Type_Float

   };
 \end{verbatim}
 
   };
 \end{verbatim}
 


@@ -596,35 +602,35 @@ Returns the vendor name.
 
 \constfunc{bool}{HasEntry}{\param{wxString\& }{strName}}
 
 
 \constfunc{bool}{HasEntry}{\param{wxString\& }{strName}}
 

-returns true if the entry by this name exists
+returns \true if the entry by this name exists

 
 
 \membersection{wxConfigBase::HasGroup}\label{wxconfigbasehasgroup}
 
 \constfunc{bool}{HasGroup}{\param{const wxString\& }{strName}}
 
 
 
 \membersection{wxConfigBase::HasGroup}\label{wxconfigbasehasgroup}
 
 \constfunc{bool}{HasGroup}{\param{const wxString\& }{strName}}
 

-returns true if the group by this name exists
+returns \true if the group by this name exists

 
 
 \membersection{wxConfigBase::IsExpandingEnvVars}\label{wxconfigbaseisexpandingenvvars}
 
 \constfunc{bool}{IsExpandingEnvVars}{\void}
 
 
 
 \membersection{wxConfigBase::IsExpandingEnvVars}\label{wxconfigbaseisexpandingenvvars}
 
 \constfunc{bool}{IsExpandingEnvVars}{\void}
 

-Returns true if we are expanding environment variables in key values.
+Returns \true if we are expanding environment variables in key values.

 
 
 \membersection{wxConfigBase::IsRecordingDefaults}\label{wxconfigbaseisrecordingdefaults}
 
 \constfunc{bool}{IsRecordingDefaults}{\void}
 
 
 
 \membersection{wxConfigBase::IsRecordingDefaults}\label{wxconfigbaseisrecordingdefaults}
 
 \constfunc{bool}{IsRecordingDefaults}{\void}
 

-Returns true if we are writing defaults back to the config file.
+Returns \true if we are writing defaults back to the config file.

 
 
 \membersection{wxConfigBase::Read}\label{wxconfigbaseread}
 
 \constfunc{bool}{Read}{\param{const wxString\& }{key}, \param{wxString*}{ str}}
 
 
 
 \membersection{wxConfigBase::Read}\label{wxconfigbaseread}
 
 \constfunc{bool}{Read}{\param{const wxString\& }{key}, \param{wxString*}{ str}}
 

-Read a string from the key, returning true if the value was read. If the key
+Read a string from the key, returning \true if the value was read. If the key

 was not found, {\it str} is not changed.
 
 \constfunc{bool}{Read}{\param{const wxString\& }{key}, \param{wxString*}{ str}, \param{const wxString\& }{defaultVal}}
 was not found, {\it str} is not changed.
 
 \constfunc{bool}{Read}{\param{const wxString\& }{key}, \param{wxString*}{ str}, \param{const wxString\& }{defaultVal}}


@@ -632,7 +638,7 @@ was not found, {\it str} is not changed.
 Read a string from the key. The default value is returned if the key was not
 found.
 
 Read a string from the key. The default value is returned if the key was not
 found.
 

-Returns true if value was really read, false if the default was used.
+Returns \true if value was really read, \false if the default was used.

 
 \constfunc{wxString}{Read}{\param{const wxString\& }{key}, \param{const
 wxString\& }{defaultVal}}
 
 \constfunc{wxString}{Read}{\param{const wxString\& }{key}, \param{const
 wxString\& }{defaultVal}}


@@ -641,13 +647,13 @@ Another version of {\it Read()}, returning the string value directly.
 
 \constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{long*}{ l}}
 
 
 \constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{long*}{ l}}
 

-Reads a long value, returning true if the value was found. If the value was
+Reads a long value, returning \true if the value was found. If the value was

 not found, {\it l} is not changed.
 
 \constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{long*}{ l},
 \param{long}{ defaultVal}}
 
 not found, {\it l} is not changed.
 
 \constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{long*}{ l},
 \param{long}{ defaultVal}}
 

-Reads a long value, returning true if the value was found. If the value was
+Reads a long value, returning \true if the value was found. If the value was

 not found, {\it defaultVal} is used instead.
 
 \constfunc{long }{Read}{\param{const wxString\& }{key}, \param{long}{ defaultVal}}
 not found, {\it defaultVal} is used instead.
 
 \constfunc{long }{Read}{\param{const wxString\& }{key}, \param{long}{ defaultVal}}


@@ -674,24 +680,24 @@ won't work because the call is ambiguous: compiler can not choose between two
 
 \constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{double*}{ d}}
 
 
 \constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{double*}{ d}}
 

-Reads a double value, returning true if the value was found. If the value was
+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},
  \param{double}{ defaultVal}}
 
 not found, {\it d} is not changed.
 
 \constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{double*}{ d},
  \param{double}{ defaultVal}}
 

-Reads a double value, returning true if the value was found. If the value was
+Reads a double value, returning \true if the value was found. If the value was

 not found, {\it defaultVal} is used instead.
 
 \constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{bool*}{ b}}
 
 not found, {\it defaultVal} is used instead.
 
 \constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{bool*}{ b}}
 

-Reads a bool value, returning true if the value was found. If the value was
+Reads a bool value, returning \true if the value was found. If the value was

 not found, {\it b} is not changed.
 
 \constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{bool*}{ d},
 \param{bool}{ defaultVal}}
 
 not found, {\it b} is not changed.
 
 \constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{bool*}{ d},
 \param{bool}{ defaultVal}}
 

-Reads a bool value, returning true if the value was found. If the value was
+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
 not found, {\it defaultVal} is used instead.
 
 \pythonnote{In place of a single overloaded method name, wxPython


@@ -721,7 +727,7 @@ 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.
 
 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
+Returns \false if {\it oldName} doesn't exist or if {\it newName} already

 exists.
 
 
 exists.
 
 


@@ -733,7 +739,7 @@ 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.
 
 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
+Returns \false if {\it oldName} doesn't exist or if {\it newName} already

 exists.
 
 
 exists.
 
 


@@ -757,7 +763,7 @@ Determine whether we wish to expand environment variables in key values.
 \func{void}{SetPath}{\param{const wxString\& }{strPath}}
 
 Set current path: if the first character is '/', it is the absolute path,
 \func{void}{SetPath}{\param{const wxString\& }{strPath}}
 
 Set current path: if the first character is '/', it is the absolute path,

-otherwise it is a relative path. '..' is supported. If the strPath doesn't
+otherwise it is a relative path. '..' is supported. If strPath doesn't

 exist it is created.
 
 
 exist it is created.
 
 


@@ -766,7 +772,7 @@ exist it is created.
 \func{void}{SetRecordDefaults}{\param{bool }{bDoIt = true}}
 
 Sets whether defaults are recorded to the config file whenever an attempt to
 \func{void}{SetRecordDefaults}{\param{bool }{bDoIt = true}}
 
 Sets whether defaults are recorded to the config file whenever an attempt to

-read read the value which is not present in it is done.
+read the value which is not present in it is done.

 
 If on (default is off) all default values for the settings used by the program
 are written back to the config file. This allows the user to see what config
 
 If on (default is off) all default values for the settings used by the program
 are written back to the config file. This allows the user to see what config


@@ -784,8 +790,7 @@ value}}
 
 \func{bool}{Write}{\param{const wxString\& }{ key}, \param{bool}{ value}}
 
 
 \func{bool}{Write}{\param{const wxString\& }{ key}, \param{bool}{ 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
 
 \pythonnote{In place of a single overloaded method name, wxPython
 implements the following methods:\par


@@ -804,3 +809,4 @@ implements the following methods:\par
 \twocolitem{{\bf WriteBool(key, value)}}{Writes a boolean}
 \end{twocollist}
 }}
 \twocolitem{{\bf WriteBool(key, value)}}{Writes a boolean}
 \end{twocollist}
 }}

+