]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/xmlnode.tex
compilation fix for wxUSE_STL==1 in DoGetSibling()
[wxWidgets.git] / docs / latex / wx / xmlnode.tex
index 331f8000ac5ad2b6aa7f6d77608c012364cea3d2..de6b34900832c1df5ec8d5129dc35497d00771ff 100644 (file)
@@ -30,6 +30,10 @@ No base class
 
 <wx/xml/xml.h>
 
+\wxheading{Library}
+
+\helpref{wxXml}{librarieslist}
+
 \wxheading{Constants}
 
 The following are the node types supported by \helpref{wxXmlNode}{wxxmlnode}:
@@ -65,7 +69,7 @@ enum wxXmlNodeType
 
 \membersection{wxXmlNode::wxXmlNode}\label{wxxmlnodewxxmlnode}
 
-\func{}{wxXmlNode}{\param{wxXmlNode* }{parent}, \param{wxXmlNodeType }{type}, \param{const wxString\& }{name}, \param{const wxString\& }{content = wxEmptyString}, \param{wxXmlAttribute* }{attrs = \NULL}, \param{wxXmlNode* }{next = \NULL}}
+\func{}{wxXmlNode}{\param{wxXmlNode* }{parent}, \param{wxXmlNodeType }{type}, \param{const wxString\& }{name}, \param{const wxString\& }{content = wxEmptyString}, \param{wxXmlAttribute* }{attrs = \NULL}, \param{wxXmlNode* }{next = \NULL}, \param{int }{lineNo = -1}}
 
 \wxheading{Parameters}
 
@@ -82,6 +86,7 @@ constructor and it shouldn't be done again.}
 and its eventual siblings are attached to the node.}
 \docparam{next}{If not \NULL, this node and its eventual siblings are attached to
 the node.}
+\docparam{lineNo}{Number of line this node was present at in input file or -1.}
 
 Creates this XML node and eventually insert it into an existing XML tree.
 
@@ -95,7 +100,7 @@ after using copy ctor and are never unmodified by operator=.
 On the other hand, it DOES copy children and attributes.
 
 
-\func{}{wxXmlNode}{\param{wxXmlNodeType }{type}, \param{const wxString\& }{name}, \param{const wxString\& }{content = wxEmptyString}}
+\func{}{wxXmlNode}{\param{wxXmlNodeType }{type}, \param{const wxString\& }{name}, \param{const wxString\& }{content = wxEmptyString}, \param{int }{lineNo = -1}}
 
 A simplified version of the first constructor form, assuming a \NULL parent.
 
@@ -156,6 +161,12 @@ This function searches only the parents of this node until it finds {\tt grandpa
 or the \NULL node (which is the parent of non-linked nodes or the parent of a
 \helpref{wxXmlDocument}{wxxmldocument}'s root node).
 
+\membersection{wxXmlNode::GetLineNumber}\label{wxxmlnodegetlinenumber}
+
+\constfunc{int}{GetLineNumber}{\void}
+
+Returns line number of the node in the input XML file or -1 if it is unknown.
+
 
 \membersection{wxXmlNode::GetNodeContent}\label{wxxmlnodegetnodecontent}
 
@@ -203,7 +214,8 @@ Returns a pointer to the parent of this node or \NULL if this node has no parent
 \constfunc{bool}{GetAttribute}{\param{const wxString\& }{attrName}, \param{wxString* }{value}}
 
 Returns \true if a attribute named {\it attrName} could be found.
-If the {\it value} pointer is not \NULL, the value of that attribute is saved there.
+The value of that attribute is saved in \arg{value} (which
+must not be \NULL).
 
 \constfunc{wxString}{GetAttribute}{\param{const wxString\& }{attrName}, \param{const wxString\& }{defaultVal}}