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
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
<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}
{\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}\\
\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.
+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
Having said all this, enumerating the config entries/groups is very simple:
\begin{verbatim}
+ wxConfigBase *config = ...;
wxArrayString aNames;
// enumeration variables
\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
+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.
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
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}
\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}
\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}
\begin{verbatim}
enum EntryType
{
- Unknown,
- String,
- Boolean,
- Integer,
- Float
+ Type_Unknown,
+ Type_String,
+ Type_Boolean,
+ Type_Integer,
+ Type_Float
};
\end{verbatim}
\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}}
-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}
-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}
-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}}
-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}}
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{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}}
-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}}
\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}}
-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}}
-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}}
-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
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.
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.
\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.
\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
\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
\twocolitem{{\bf WriteBool(key, value)}}{Writes a boolean}
\end{twocollist}
}}
+
projects / wxWidgets.git / blobdiff