Documentation fixes, patch 1179223 by Andreas Mohr
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@33428 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
@@ -99,7 +99,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
|
||||
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}\\
|
||||
@@ -186,7 +186,7 @@ regardless of the platform (i.e. it is {\bf not} '$\backslash\backslash$' under
|
||||
\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
|
||||
@@ -284,7 +284,7 @@ arbitrary path (either relative or absolute), not just the key name.
|
||||
\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.
|
||||
@@ -429,7 +429,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
|
||||
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}
|
||||
@@ -437,7 +437,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
|
||||
for use by desinstallation routine.
|
||||
for use by uninstallation routine.
|
||||
|
||||
|
||||
\membersection{wxConfigBase::DeleteEntry}\label{wxconfigbasedeleteentry}
|
||||
@@ -459,7 +459,7 @@ Delete the group (with all subgroups)
|
||||
|
||||
\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}
|
||||
@@ -501,11 +501,11 @@ The result is an element of enum EntryType:
|
||||
\begin{verbatim}
|
||||
enum EntryType
|
||||
{
|
||||
Unknown,
|
||||
String,
|
||||
Boolean,
|
||||
Integer,
|
||||
Float
|
||||
Type_Unknown,
|
||||
Type_String,
|
||||
Type_Boolean,
|
||||
Type_Integer,
|
||||
Type_Float
|
||||
};
|
||||
\end{verbatim}
|
||||
|
||||
@@ -597,35 +597,35 @@ Returns the vendor name.
|
||||
|
||||
\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}}
|
||||
@@ -633,7 +633,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.
|
||||
|
||||
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}}
|
||||
@@ -642,13 +642,13 @@ Another version of {\it Read()}, returning the string value directly.
|
||||
|
||||
\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}}
|
||||
@@ -675,24 +675,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}}
|
||||
|
||||
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
|
||||
@@ -722,7 +722,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.
|
||||
|
||||
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.
|
||||
|
||||
|
||||
@@ -734,7 +734,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.
|
||||
|
||||
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.
|
||||
|
||||
|
||||
@@ -758,7 +758,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,
|
||||
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.
|
||||
|
||||
|
||||
@@ -767,7 +767,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
|
||||
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
|
||||
@@ -785,8 +785,7 @@ 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
|
||||
|
Reference in New Issue
Block a user