Added dataxpm.c to avoid name clash; removed ifdefing around wxDummyChar

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

diff --git a/docs/latex/wx/config.tex b/docs/latex/wx/config.tex
index 2b9abf764bb7b6f44de8f38a85027727069b19b0..8e74b3d4294bd09f90323d50cc3978719f568bd5 100644 (file)
--- a/docs/latex/wx/config.tex
+++ b/docs/latex/wx/config.tex
@@ -2,9 +2,7 @@
 
 wxConfigBase class defines the basic interface of all config classes. It can
 not be used by itself (it's an abstract base class) and you'll always use one
 
 wxConfigBase class defines the basic interface of all config classes. It can
 not be used by itself (it's an abstract base class) and you'll always use one

-of its derivations: \helpref{wxIniConfig}{wxiniconfig},
-\helpref{wxFileConfig}{wxfileconfig}, \helpref{wxRegConfig}{wxregconfig} or
-any other.
+of its derivations: wxIniConfig, 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
 
 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


@@ -259,6 +257,17 @@ arbitrary path (either relative or absolute), not just the key name.
 \helpref{Write}{wxconfigbasewrite}\\
 \helpref{Flush}{wxconfigbaseflush}
 
 \helpref{Write}{wxconfigbasewrite}\\
 \helpref{Flush}{wxconfigbaseflush}
 

+\membersection{Rename entries/groups}
+
+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
+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.
+
+\helpref{RenameEntry}{wxconfigbaserenameentry}\\
+\helpref{RenameGroup}{wxconfigbaserenamegroup}
+

 \membersection{Delete entries/groups}
 
 The functions in this section delete entries and/or groups of entries from the
 \membersection{Delete entries/groups}
 
 The functions in this section delete entries and/or groups of entries from the


@@ -547,7 +556,7 @@ 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},
 not found, {\it d} is not changed.
 
 \constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{double*}{ d},

-\param{double}{ defaultVal}}
+ \param{double}{ defaultVal}}

 
 Reads a double value, returning TRUE if the value was found. If the value was
 not found, {\it defaultVal} is used instead.
 
 Reads a double value, returning TRUE if the value was found. If the value was
 not found, {\it defaultVal} is used instead.


@@ -563,6 +572,28 @@ not found, {\it b} is not changed.
 Reads a bool value, returning TRUE if the value was found. If the value was
 not found, {\it defaultVal} is used instead.
 
 Reads a bool value, returning TRUE if the value was found. If the value was
 not found, {\it defaultVal} is used instead.
 

+\membersection{wxConfigBase::RenameEntry}\label{wxconfigbaserenameentry}
+
+\func{bool}{RenameEntry}{\param{const wxString\& }{ oldName}, \param{const wxString\& }{ newName}}
+
+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
+exists.
+
+\membersection{wxConfigBase::RenameGroup}\label{wxconfigbaserenamegroup}
+
+\func{bool}{RenameGroup}{\param{const wxString\& }{ oldName}, \param{const wxString\& }{ newName}}
+
+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
+exists.
+

 \membersection{wxConfigBase::Set}\label{wxconfigbaseset}
 
 \func{wxConfigBase *}{Set}{\param{wxConfigBase *}{pConfig}}
 \membersection{wxConfigBase::Set}\label{wxconfigbaseset}
 
 \func{wxConfigBase *}{Set}{\param{wxConfigBase *}{pConfig}}