X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/538f3830191e25eaf0edb0a379e08d4f85ee49bc..a387938f80a2804f259e7305513231be39620fd2:/docs/latex/wx/xmldocument.tex diff --git a/docs/latex/wx/xmldocument.tex b/docs/latex/wx/xmldocument.tex index 0a5bcb5b12..cdc5ed9ad4 100644 --- a/docs/latex/wx/xmldocument.tex +++ b/docs/latex/wx/xmldocument.tex @@ -86,16 +86,17 @@ doc.Save(wxT("myfile2.xml")); // myfile2.xml != myfile.xml \latexignore{\rtfignore{\wxheading{Members}}} + \membersection{wxXmlDocument::wxXmlDocument}\label{wxxmldocumentwxxmldocument} \func{}{wxXmlDocument}{\void} -\func{}{wxXmlDocument}{\param{const wxString\& }{filename}, \param{const wxString\& }{encoding = wxT("UTF-8")}, \param{int }{flags = wxXMLDOC_NONE}} +\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}. -\func{}{wxXmlDocument}{\param{wxInputStream\& }{stream}, \param{const wxString\& }{encoding = wxT("UTF-8")}, \param{int }{flags = wxXMLDOC_NONE}} +\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}. @@ -103,6 +104,7 @@ Loads the XML document from given stream using the given encoding. See \helpref{ Copy constructor. + \membersection{wxXmlDocument::\destruct{wxXmlDocument}}\label{wxxmldocumentdtor} \func{}{\destruct{wxXmlDocument}}{\void} @@ -110,6 +112,7 @@ Copy constructor. Virtual destructor. Frees the document root node. + \membersection{wxXmlDocument::DetachRoot}\label{wxxmldocumentdetachroot} \func{wxXmlNode*}{DetachRoot}{\void} @@ -120,6 +123,7 @@ 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} @@ -130,6 +134,7 @@ Returns encoding of in-memory representation of the document NB: this is meaningless in Unicode build where data are stored as wchar\_t*. + \membersection{wxXmlDocument::GetFileEncoding}\label{wxxmldocumentgetfileencoding} \constfunc{wxString}{GetFileEncoding}{\void} @@ -140,6 +145,7 @@ Note: this is the encoding original file was saved in, *not* the encoding of in-memory representation! + \membersection{wxXmlDocument::GetRoot}\label{wxxmldocumentgetroot} \constfunc{wxXmlNode*}{GetRoot}{\void} @@ -147,6 +153,7 @@ encoding of in-memory representation! Returns the root node of the document. + \membersection{wxXmlDocument::GetVersion}\label{wxxmldocumentgetversion} \constfunc{wxString}{GetVersion}{\void} @@ -157,6 +164,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,14 +172,15 @@ 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}} +\func{bool}{Load}{\param{const wxString\& }{filename}, \param{const wxString\& }{encoding = wxT("UTF-8")}, \param{int }{flags = wxXMLDOC\_NONE}} Parses {\it filename} as an xml document and loads its data. -If {\tt flags} does not contain {\tt wxXMLDOC_KEEP_WHITESPACE_NODES}, then, while loading, all nodes of -type {\tt wxXML_TEXT_NODE} (see \helpref{wxXmlNode}{wxxmlnode}) are automatically skipped if they +If {\tt flags} does not contain {\tt wxXMLDOC\_KEEP\_WHITESPACE\_NODES}, then, while loading, all nodes of +type {\tt wxXML\_TEXT\_NODE} (see \helpref{wxXmlNode}{wxxmlnode}) are automatically skipped if they contain whitespaces only. The removal of these nodes makes the load process slightly faster and requires less memory however makes impossible to recreate exactly the loaded text with a \helpref{Save}{wxxmldocumentsave} call later. @@ -179,10 +188,11 @@ Read the initial description of this class for more info. Returns \true on success, \false otherwise. -\func{bool}{Load}{\param{wxInputStream\& }{stream}, \param{const wxString\& }{encoding = wxT("UTF-8")}, \param{int }{flags = wxXMLDOC_NONE}} +\func{bool}{Load}{\param{wxInputStream\& }{stream}, \param{const wxString\& }{encoding = wxT("UTF-8")}, \param{int }{flags = wxXMLDOC\_NONE}} 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}} @@ -191,31 +201,35 @@ Saves XML tree creating a file named with given string. If {\tt indentstep} is greater than or equal to zero, then, while saving, an automatic indentation is added with steps composed by {\tt indentstep} spaces. -If {\tt indentstep} is {\tt wxXML_NO_INDENTATION}, then, automatic indentation is turned off. +If {\tt indentstep} is {\tt wxXML\_NO\_INDENTATION}, then, automatic indentation is turned off. \constfunc{bool}{Save}{\param{wxOutputStream\& }{stream}, \param{int }{indentstep = 1}} 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 SetRoot if you want +to replace the root node without deleting the old document tree. + \membersection{wxXmlDocument::SetVersion}\label{wxxmldocumentsetversion} @@ -223,6 +237,7 @@ 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}}