fix typo in Selecting() description (bug 1726270)

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

diff --git a/docs/latex/wx/xmldocument.tex b/docs/latex/wx/xmldocument.tex
index 9eafe3d020b8545f61ee9e61935445af27f1e53c..d73740818b4b27f844658e0d0469b8379deb9d71 100644 (file)
--- a/docs/latex/wx/xmldocument.tex
+++ b/docs/latex/wx/xmldocument.tex
@@ -37,8 +37,12 @@ while (child) {
 
 
         // process properties of <tag1>
-        wxString propvalue1 = child->GetPropVal(wxT("prop1"), wxT("default-value"));
-        wxString propvalue2 = child->GetPropVal(wxT("prop2"), wxT("default-value"));
+        wxString propvalue1 = 
+            child->GetPropVal(wxT("prop1"), 
+                              wxT("default-value"));
+        wxString propvalue2 = 
+            child->GetPropVal(wxT("prop2"), 
+                              wxT("default-value"));
 
         ...
 
@@ -57,7 +61,9 @@ and indentation, you need to turn off whitespace-only textnode removal and autom
 \begin{verbatim}
 wxXmlDocument doc;
 doc.Load(wxT("myfile.xml"), wxT("UTF-8"), wxXMLDOC_KEEP_WHITESPACE_NODES);
-doc.Save(wxT("myfile2.xml"), wxXML_NO_INDENTATION);       // myfile2.xml will be indentic to myfile.xml
+
+// myfile2.xml will be indentic to myfile.xml saving it this way:
+doc.Save(wxT("myfile2.xml"), wxXML_NO_INDENTATION);
 \end{verbatim}
 
 Using default parameters, you will get a reformatted document which in general is different from
@@ -66,7 +72,7 @@ the original loaded content:
 \begin{verbatim}
 wxXmlDocument doc;
 doc.Load(wxT("myfile.xml"));
-doc.Save(wxT("myfile2.xml"));       // myfile2.xml != myfile.xml
+doc.Save(wxT("myfile2.xml"));  // myfile2.xml != myfile.xml
 \end{verbatim}
 
 
@@ -86,6 +92,7 @@ doc.Save(wxT("myfile2.xml"));       // myfile2.xml != myfile.xml
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
+
 \membersection{wxXmlDocument::wxXmlDocument}\label{wxxmldocumentwxxmldocument}
 
 \func{}{wxXmlDocument}{\void}
@@ -93,15 +100,16 @@ doc.Save(wxT("myfile2.xml"));       // myfile2.xml != myfile.xml
 
 \func{}{wxXmlDocument}{\param{const wxString\& }{filename}, \param{const wxString\& }{encoding = wxT("UTF-8")}, \param{int }{flags = wxXMLDOC\_NONE}}
 
-Loads the given {\it filename} using the given encoding. See \helpref{Load()}{wxxmldocumentload}.
+Loads the given {\it filename} using the given encoding. See \helpref{Load}{wxxmldocumentload}.
 
 \func{}{wxXmlDocument}{\param{wxInputStream\& }{stream}, \param{const wxString\& }{encoding = wxT("UTF-8")}, \param{int }{flags = wxXMLDOC\_NONE}}
 
-Loads the XML document from given stream using the given encoding. See \helpref{Load()}{wxxmldocumentload}.
+Loads the XML document from given stream using the given encoding. See \helpref{Load}{wxxmldocumentload}.
 
 \func{}{wxXmlDocument}{\param{const wxXmlDocument\& }{doc}}
 
-Copy constructor.
+Copy constructor. Deep copies all the XML tree of the given document.
+
 
 \membersection{wxXmlDocument::\destruct{wxXmlDocument}}\label{wxxmldocumentdtor}
 
@@ -110,6 +118,7 @@ Copy constructor.
 Virtual destructor. Frees the document root node.
 
 
+
 \membersection{wxXmlDocument::DetachRoot}\label{wxxmldocumentdetachroot}
 
 \func{wxXmlNode*}{DetachRoot}{\void}
@@ -120,14 +129,16 @@ and thus \helpref{IsOk}{wxxmldocumentisok} will return \false after calling this
 Note that the caller is reponsible for deleting the returned node in order to avoid memory leaks.
 
 
+
 \membersection{wxXmlDocument::GetEncoding}\label{wxxmldocumentgetencoding}
 
 \constfunc{wxString}{GetEncoding}{\void}
 
 Returns encoding of in-memory representation of the document
-(same as passed to \helpref{Load()}{wxxmldocumentload} or constructor, defaults to UTF-8).
+(same as passed to \helpref{Load}{wxxmldocumentload} or constructor, defaults to UTF-8).
+
+NB: this is meaningless in Unicode build where data are stored as {\tt wchar\_t*}.
 
-NB: this is meaningless in Unicode build where data are stored as wchar\_t*.
 
 
 \membersection{wxXmlDocument::GetFileEncoding}\label{wxxmldocumentgetfileencoding}
@@ -136,10 +147,11 @@ NB: this is meaningless in Unicode build where data are stored as wchar\_t*.
 
 Returns encoding of document (may be empty).
 
-Note: this is the encoding original file was saved in, *not* the
+Note: this is the encoding original file was saved in, {\bf not} the
 encoding of in-memory representation!
 
 
+
 \membersection{wxXmlDocument::GetRoot}\label{wxxmldocumentgetroot}
 
 \constfunc{wxXmlNode*}{GetRoot}{\void}
@@ -147,6 +159,7 @@ encoding of in-memory representation!
 Returns the root node of the document.
 
 
+
 \membersection{wxXmlDocument::GetVersion}\label{wxxmldocumentgetversion}
 
 \constfunc{wxString}{GetVersion}{\void}
@@ -157,6 +170,7 @@ If the version property was not explicitely given in the header, this function
 returns an empty string.
 
 
+
 \membersection{wxXmlDocument::IsOk}\label{wxxmldocumentisok}
 
 \constfunc{bool}{IsOk}{\void}
@@ -164,6 +178,7 @@ returns an empty string.
 Returns \true if the document has been loaded successfully.
 
 
+
 \membersection{wxXmlDocument::Load}\label{wxxmldocumentload}
 
 \func{bool}{Load}{\param{const wxString\& }{filename}, \param{const wxString\& }{encoding = wxT("UTF-8")}, \param{int }{flags = wxXMLDOC\_NONE}}
@@ -183,6 +198,7 @@ Returns \true on success, \false otherwise.
 
 Like above but takes the data from given input stream.
 
+
 \membersection{wxXmlDocument::Save}\label{wxxmldocumentsave}
 
 \constfunc{bool}{Save}{\param{const wxString\& }{filename}, \param{int }{indentstep = 1}}
@@ -197,25 +213,30 @@ If {\tt indentstep} is {\tt wxXML\_NO\_INDENTATION}, then, automatic indentation
 
 Saves XML tree in the given output stream. See other overload for a description of {\tt indentstep}.
 
+
 \membersection{wxXmlDocument::SetEncoding}\label{wxxmldocumentsetencoding}
 
 \func{void}{SetEncoding}{\param{const wxString\& }{enc}}
 
 Sets the enconding of the document.
 
+
 \membersection{wxXmlDocument::SetFileEncoding}\label{wxxmldocumentsetfileencoding}
 
 \func{void}{SetFileEncoding}{\param{const wxString\& }{encoding}}
 
 Sets the enconding of the file which will be used to save the document.
 
+
 \membersection{wxXmlDocument::SetRoot}\label{wxxmldocumentsetroot}
 
 \func{void}{SetRoot}{\param{wxXmlNode* }{node}}
 
 Sets the root node of this document. Deletes previous root node.
-Use \helpref{DetachRoot}{wxxmlnodedetachroot} and then SetRoot if you want to
-replace the root node without deleting the old document tree.
+Use \helpref{DetachRoot}{wxxmldocumentdetachroot} and then 
+\helpref{SetRoot}{wxxmldocumentsetroot} if you want
+to replace the root node without deleting the old document tree.
+
 
 \membersection{wxXmlDocument::SetVersion}\label{wxxmldocumentsetversion}
 
@@ -223,9 +244,10 @@ replace the root node without deleting the old document tree.
 
 Sets the version of the XML file which will be used to save the document.
 
+
 \membersection{wxXmlDocument::operator=}\label{wxxmldocumentoperatorassign}
 
 \func{wxXmlDocument\& operator}{operator=}{\param{const wxXmlDocument\& }{doc}}
 
-Copies the given document.
+Deep copies the given document.