X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/736f28f8d86d93c61d73d94984b0ec3f3845795e..df10208f26d2659e5995fd00debeb4eaa11174cc:/docs/latex/wx/config.tex?ds=inline

diff --git a/docs/latex/wx/config.tex b/docs/latex/wx/config.tex
index 225dd4186a..6b2dc4fd7c 100644
--- a/docs/latex/wx/config.tex
+++ b/docs/latex/wx/config.tex
@@ -2,16 +2,17 @@
 
 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, wxFileConfig, wxRegConfig or any other.
+of its derivations: wxIniConfig, \helpref{wxFileConfig}{wxfileconfig},
+wxRegConfig or any other.
 
 However, usually you don't even need to know the precise nature of the class
 you're working with but you would just use the wxConfigBase methods. This
 allows you to write the same code regardless of whether you're working with
 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, wxWindows provides a typedef wxConfig
+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, wxIniConfig under Win16 and
+platform: i.e. wxRegConfig under Win32 (optionally wxIniConfig) and
 wxFileConfig otherwise.
 
 See \helpref{config overview}{wxconfigoverview} for the descriptions of all
@@ -26,9 +27,9 @@ No base class
 
 \wxheading{Include files}
 
-<wx/config.h> (to let wxWindows choose a wxConfig class for your platform)\\
+<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/fileconf.h> (wxFileConfig class)\\
 <wx/msw/regconf.h> (wxRegConfig class)\\
 <wx/msw/iniconf.h> (wxIniConfig class)
 
@@ -78,6 +79,7 @@ physical storage where a wxConfigBase-derived class stores its data.
 
 \latexignore{\rtfignore{\wxheading{Function groups}}}
 
+
 \membersection{Static functions}\label{wxconfigstaticfunctions}
 
 These functions deal with the "default" config object. Although its usage is
@@ -88,14 +90,14 @@ 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, wxWindows won't do it automatically.
+in order to avoid memory leaks, wxWidgets won't do it automatically.
 
 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
 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
+{\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.
@@ -105,12 +107,14 @@ of \helpref{wxFileDialog}{wxfiledialog} have ability to use wxConfig class.
 \helpref{Create}{wxconfigbasecreate}\\
 \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).
@@ -179,7 +183,8 @@ regardless of the platform (i.e. it is {\bf not} '$\backslash\backslash$' under
 \helpref{SetPath}{wxconfigbasesetpath}\\
 \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.
@@ -233,20 +238,23 @@ actually enumerating them, but you will probably never need them.
 \helpref{GetNumberOfEntries}{wxconfigbasegetnumberofentries}\\
 \helpref{GetNumberOfGroups}{wxconfigbasegetnumberofgroups}
 
-\membersection{Tests of existence}
+
+\membersection{Tests of existence}\label{configtestsofexistence}
 
 \helpref{HasGroup}{wxconfigbasehasgroup}\\
 \helpref{HasEntry}{wxconfigbasehasentry}\\
 \helpref{Exists}{wxconfigbaseexists}\\
 \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
@@ -272,7 +280,8 @@ arbitrary path (either relative or absolute), not just the key name.
 \helpref{Write}{wxconfigbasewrite}\\
 \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
@@ -283,7 +292,8 @@ wxConfig implementation.
 \helpref{RenameEntry}{wxconfigbaserenameentry}\\
 \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
@@ -293,7 +303,8 @@ traces of your program presence: for example, when you uninstall it.
 \helpref{DeleteGroup}{wxconfigbasedeletegroup}\\
 \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
@@ -332,6 +343,7 @@ The following functions control this option:
 
 }}
 
+
 \membersection{wxConfigBase::wxConfigBase}\label{wxconfigbasector}
 
 \func{}{wxConfigBase}{\param{const wxString\& }{appName = wxEmptyString},
@@ -375,28 +387,31 @@ 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}.
 
-\docparam{conv}{This parameter is only used by wxFileConfig when compiled
-in Unicode mode. It specifies the encoding in what the configuration file
-is written.}
-
 The wxCONFIG\_USE\_NO\_ESCAPE\_CHARACTERS style can be helpful if your config 
-file must be read or written to by a non-wxWindows program (which might not 
+file must be read or written to by a non-wxWidgets program (which might not 
 understand the escape characters). Note, however, that if 
 wxCONFIG\_USE\_NO\_ESCAPE\_CHARACTERS style is used, it is is now 
 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
+is written.}
+
+
 \wxheading{Remarks}
 
 By default, environment variable expansion is on and recording defaults is
 off.
 
+
 \membersection{wxConfigBase::\destruct{wxConfigBase}}\label{wxconfigbasedtor}
 
 \func{}{\destruct{wxConfigBase}}{\void}
 
 Empty but ensures that dtor of all derived classes is virtual.
 
+
 \membersection{wxConfigBase::Create}\label{wxconfigbasecreate}
 
 \func{static wxConfigBase *}{Create}{\void}
@@ -406,6 +421,7 @@ implementation of wxConfig available for the current platform, see comments
 near the definition of wxCONFIG\_WIN32\_NATIVE for details. It returns the
 created object and also sets it as the current one.
 
+
 \membersection{wxConfigBase::DontCreateOnDemand}\label{wxconfigbasedontcreateondemand}
 
 \func{void}{DontCreateOnDemand}{\void}
@@ -414,6 +430,7 @@ 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.
 
+
 \membersection{wxConfigBase::DeleteAll}\label{wxconfigbasedeleteall}
 
 \func{bool}{DeleteAll}{\void}
@@ -421,6 +438,7 @@ near the program end to prevent new config object "accidental" creation.
 Delete the whole underlying object (disk file, registry key, ...). Primarly
 for use by desinstallation routine.
 
+
 \membersection{wxConfigBase::DeleteEntry}\label{wxconfigbasedeleteentry}
 
 \func{bool}{DeleteEntry}{\param{const wxString\& }{ key}, \param{bool}{ bDeleteGroupIfEmpty = true}}
@@ -428,18 +446,21 @@ for use by desinstallation routine.
 Deletes the specified entry and the group it belongs to if it was the last key
 in it and the second parameter is true.
 
+
 \membersection{wxConfigBase::DeleteGroup}\label{wxconfigbasedeletegroup}
 
 \func{bool}{DeleteGroup}{\param{const wxString\& }{ key}}
 
 Delete the group (with all subgroups)
 
+
 \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
 
+
 \membersection{wxConfigBase::Flush}\label{wxconfigbaseflush}
 
 \func{bool}{Flush}{\param{bool }{bCurrentOnly = false}}
@@ -447,6 +468,7 @@ returns true if either a group or an entry with a given name exists
 permanently writes all changes (otherwise, they're only written from object's
 destructor)
 
+
 \membersection{wxConfigBase::Get}\label{wxconfigbaseget}
 
 \func{static wxConfigBase *}{Get}{\param{bool }{CreateOnDemand = true}}
@@ -455,12 +477,14 @@ 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}
 
 \constfunc{wxString}{GetAppName}{\void}
 
 Returns the application name.
 
+
 \membersection{wxConfigBase::GetEntryType}\label{wxconfigbasegetentrytype}
 
 \constfunc{enum wxConfigBase::EntryType}{GetEntryType}{\param{const wxString\& }{name}}
@@ -484,6 +508,7 @@ The result is an element of enum EntryType:
   };
 \end{verbatim}
 
+
 \membersection{wxConfigBase::GetFirstGroup}\label{wxconfigbasegetfirstgroup}
 
 \constfunc{bool}{GetFirstGroup}{\param{wxString\& }{str}, \param{long\&}{ index}}
@@ -497,6 +522,7 @@ the next call.}
 \perlnote{In wxPerl this method takes no arguments and returns a 3-element
 list {\tt ( continue, str, index )}.}
 
+
 \membersection{wxConfigBase::GetFirstEntry}\label{wxconfigbasegetfirstentry}
 
 \constfunc{bool}{GetFirstEntry}{\param{wxString\& }{str}, \param{long\&}{ index}}
@@ -510,6 +536,7 @@ the next call.}
 \perlnote{In wxPerl this method takes no arguments and returns a 3-element
 list {\tt ( continue, str, index )}.}
 
+
 \membersection{wxConfigBase::GetNextGroup}\label{wxconfigbasegetnextgroup}
 
 \constfunc{bool}{GetNextGroup}{\param{wxString\& }{str}, \param{long\&}{ index}}
@@ -523,6 +550,7 @@ the next call.}
 \perlnote{In wxPerl this method only takes the {\tt index} parameter
 and returns a 3-element list {\tt ( continue, str, index )}.}
 
+
 \membersection{wxConfigBase::GetNextEntry}\label{wxconfigbasegetnextentry}
 
 \constfunc{bool}{GetNextEntry}{\param{wxString\& }{str}, \param{long\&}{ index}}
@@ -536,10 +564,12 @@ the next call.}
 \perlnote{In wxPerl this method only takes the {\tt index} parameter
 and returns a 3-element list {\tt ( continue, str, index )}.}
 
+
 \membersection{wxConfigBase::GetNumberOfEntries}\label{wxconfigbasegetnumberofentries}
 
 \constfunc{uint }{GetNumberOfEntries}{\param{bool }{bRecursive = false}}
 
+
 \membersection{wxConfigBase::GetNumberOfGroups}\label{wxconfigbasegetnumberofgroups}
 
 \constfunc{uint}{GetNumberOfGroups}{\param{bool }{bRecursive = false}}
@@ -547,42 +577,49 @@ and returns a 3-element list {\tt ( continue, str, index )}.}
 Get number of entries/subgroups in the current group, with or without its
 subgroups.
 
+
 \membersection{wxConfigBase::GetPath}\label{wxconfigbasegetpath}
 
 \constfunc{const wxString\&}{GetPath}{\void}
 
 Retrieve the current path (always as absolute path).
 
+
 \membersection{wxConfigBase::GetVendorName}\label{wxconfigbasegetvendorname}
 
 \constfunc{wxString}{GetVendorName}{\void}
 
 Returns the vendor name.
 
+
 \membersection{wxConfigBase::HasEntry}\label{wxconfigbasehasentry}
 
 \constfunc{bool}{HasEntry}{\param{wxString\& }{strName}}
 
 returns true if the entry by this name exists
 
+
 \membersection{wxConfigBase::HasGroup}\label{wxconfigbasehasgroup}
 
 \constfunc{bool}{HasGroup}{\param{const wxString\& }{strName}}
 
 returns true if the group by this name exists
 
+
 \membersection{wxConfigBase::IsExpandingEnvVars}\label{wxconfigbaseisexpandingenvvars}
 
 \constfunc{bool}{IsExpandingEnvVars}{\void}
 
 Returns true if we are expanding environment variables in key values.
 
+
 \membersection{wxConfigBase::IsRecordingDefaults}\label{wxconfigbaseisrecordingdefaults}
 
 \constfunc{bool}{IsRecordingDefaults}{\void}
 
 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}}
@@ -675,6 +712,7 @@ implements the following methods:\par
 \end{twocollist}
 }}
 
+
 \membersection{wxConfigBase::RenameEntry}\label{wxconfigbaserenameentry}
 
 \func{bool}{RenameEntry}{\param{const wxString\& }{ oldName}, \param{const wxString\& }{ newName}}
@@ -686,6 +724,7 @@ 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}}
@@ -697,6 +736,7 @@ 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{static wxConfigBase *}{Set}{\param{wxConfigBase *}{pConfig}}
@@ -704,12 +744,14 @@ exists.
 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::SetExpandEnvVars}\label{wxconfigbasesetexpandenvvars}
 
 \func{void}{SetExpandEnvVars }{\param{bool }{bDoIt = true}}
 
 Determine whether we wish to expand environment variables in key values.
 
+
 \membersection{wxConfigBase::SetPath}\label{wxconfigbasesetpath}
 
 \func{void}{SetPath}{\param{const wxString\& }{strPath}}
@@ -718,6 +760,7 @@ 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
 exist it is created.
 
+
 \membersection{wxConfigBase::SetRecordDefaults}\label{wxconfigbasesetrecorddefaults}
 
 \func{void}{SetRecordDefaults}{\param{bool }{bDoIt = true}}
@@ -729,18 +772,6 @@ 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
 options may be changed and is probably useful only for wxFileConfig.
 
-\membersection{wxConfigBase::SetUmask}\label{wxfileconfigsetumask}
-
-\func{void}{SetUmask}{\param{int }{mode}}
-
-{\bf NB:} this function is not in the base wxConfigBase class but is only
-implemented in wxFileConfig. Moreover, this function is Unix-specific and
-doesn't do anything on other platforms.
-
-SetUmask() allows to set the mode to be used for the config file creation.
-For example, to create a config file which is not readable by other users
-(useful if it stores some sensitive information, such as passwords), you
-should do {\tt SetUmask(0077)}.
 
 \membersection{wxConfigBase::Write}\label{wxconfigbasewrite}
 
