1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2 %% Name: xmldocument.tex
3 %% Purpose: wxXmlDocument documentation
4 %% Author: Francesco Montorsi
7 %% Copyright: (c) 2006 Francesco Montorsi
8 %% License: wxWindows license
9 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
11 \section{\class{wxXmlDocument
}}\label{wxxmldocument
}
13 This class holds XML data/
document as parsed by XML parser in the root node.
15 wxXmlDocument internally uses the expat library which comes with wxWidgets to parse the given stream.
17 A simple example of using XML classes is:
21 if (!doc.Load(wxT("myfile.xml")))
24 // start processing the XML file
25 if (doc.GetRoot()->GetName() != wxT("myroot-node"))
28 wxXmlNode *child = doc.GetRoot()->GetChildren();
31 if (child->GetName() == wxT("tag1"))
{
33 // process text enclosed by <tag1></tag1>
34 wxString content = child->GetNodeContent();
39 // process attributes of <tag1>
41 child->GetAttribute(wxT("attr1"),
42 wxT("default-value"));
44 child->GetAttribute(wxT("attr2"),
45 wxT("default-value"));
49 } else if (child->GetName() == wxT("tag2"))
{
54 child = child->GetNext();
58 {\bf Note:
} if you want to preserve the original formatting of the loaded file including whitespaces
59 and indentation, you need to turn off whitespace-only textnode removal and automatic indentation:
63 doc.Load(wxT("myfile.xml"), wxT("UTF-
8"), wxXMLDOC_KEEP_WHITESPACE_NODES);
65 // myfile2.xml will be indentic to myfile.xml saving it this way:
66 doc.Save(wxT("myfile2.xml"), wxXML_NO_INDENTATION);
69 Using default parameters, you will get a reformatted
document which in general is different from
70 the original loaded content:
74 doc.Load(wxT("myfile.xml"));
75 doc.Save(wxT("myfile2.xml")); // myfile2.xml != myfile.xml
79 \wxheading{Derived from
}
81 \helpref{wxObject
}{wxobject
}
83 \wxheading{Include files
}
89 \helpref{wxXml
}{librarieslist
}
93 \helpref{wxXmlNode
}{wxxmlnode
},
\helpref{wxXmlAttribute
}{wxxmlattribute
}
96 \latexignore{\rtfignore{\wxheading{Members
}}}
100 \membersection{wxXmlDocument::wxXmlDocument
}\label{wxxmldocumentwxxmldocument
}
102 \func{}{wxXmlDocument
}{\void}
105 \func{}{wxXmlDocument
}{\param{const wxString\&
}{filename
},
\param{const wxString\&
}{encoding = wxT("UTF-
8")
},
\param{int
}{flags = wxXMLDOC
\_NONE}}
107 Loads the given
{\it filename
} using the given encoding. See
\helpref{Load
}{wxxmldocumentload
}.
109 \func{}{wxXmlDocument
}{\param{wxInputStream\&
}{stream
},
\param{const wxString\&
}{encoding = wxT("UTF-
8")
},
\param{int
}{flags = wxXMLDOC
\_NONE}}
111 Loads the XML
document from given stream using the given encoding. See
\helpref{Load
}{wxxmldocumentload
}.
113 \func{}{wxXmlDocument
}{\param{const wxXmlDocument\&
}{doc
}}
115 Copy constructor. Deep copies all the XML tree of the given
document.
118 \membersection{wxXmlDocument::
\destruct{wxXmlDocument
}}\label{wxxmldocumentdtor
}
120 \func{}{\destruct{wxXmlDocument
}}{\void}
122 Virtual destructor. Frees the
document root node.
126 \membersection{wxXmlDocument::DetachRoot
}\label{wxxmldocumentdetachroot
}
128 \func{wxXmlNode*
}{DetachRoot
}{\void}
130 Detaches the
document root node and returns it. The
document root node will be set to
\NULL
131 and thus
\helpref{IsOk
}{wxxmldocumentisok
} will return
\false after calling this function.
133 Note that the caller is reponsible for deleting the returned node in order to avoid memory leaks.
137 \membersection{wxXmlDocument::GetEncoding
}\label{wxxmldocumentgetencoding
}
139 \constfunc{wxString
}{GetEncoding
}{\void}
141 Returns encoding of in-memory representation of the
document
142 (same as passed to
\helpref{Load
}{wxxmldocumentload
} or constructor, defaults to UTF-
8).
144 NB: this is meaningless in Unicode build where data are stored as
{\tt wchar
\_t*
}.
148 \membersection{wxXmlDocument::GetFileEncoding
}\label{wxxmldocumentgetfileencoding
}
150 \constfunc{wxString
}{GetFileEncoding
}{\void}
152 Returns encoding of
document (may be empty).
154 Note: this is the encoding original file was saved in,
{\bf not
} the
155 encoding of in-memory representation!
159 \membersection{wxXmlDocument::GetRoot
}\label{wxxmldocumentgetroot
}
161 \constfunc{wxXmlNode*
}{GetRoot
}{\void}
163 Returns the root node of the
document.
167 \membersection{wxXmlDocument::GetVersion
}\label{wxxmldocumentgetversion
}
169 \constfunc{wxString
}{GetVersion
}{\void}
171 Returns the version of
document.
172 This is the value in the
{\tt <?xml version="
1.0"?>
} header of the XML
document.
173 If the version attribute was not explicitely given in the header, this function
174 returns an empty string.
178 \membersection{wxXmlDocument::IsOk
}\label{wxxmldocumentisok
}
180 \constfunc{bool
}{IsOk
}{\void}
182 Returns
\true if the
document has been loaded successfully.
186 \membersection{wxXmlDocument::Load
}\label{wxxmldocumentload
}
188 \func{bool
}{Load
}{\param{const wxString\&
}{filename
},
\param{const wxString\&
}{encoding = wxT("UTF-
8")
},
\param{int
}{flags = wxXMLDOC
\_NONE}}
190 Parses
{\it filename
} as an xml
document and loads its data.
192 If
{\tt flags
} does not contain
{\tt wxXMLDOC
\_KEEP\_WHITESPACE\_NODES}, then, while loading, all nodes of
193 type
{\tt wxXML
\_TEXT\_NODE} (see
\helpref{wxXmlNode
}{wxxmlnode
}) are automatically skipped if they
194 contain whitespaces only.
195 The removal of these nodes makes the load process slightly faster and requires less memory however
196 makes impossible to recreate exactly the loaded text with a
\helpref{Save
}{wxxmldocumentsave
} call later.
197 Read the initial description of this class for more info.
199 Returns
\true on success,
\false otherwise.
201 \func{bool
}{Load
}{\param{wxInputStream\&
}{stream
},
\param{const wxString\&
}{encoding = wxT("UTF-
8")
},
\param{int
}{flags = wxXMLDOC
\_NONE}}
203 Like above but takes the data from given input stream.
206 \membersection{wxXmlDocument::Save
}\label{wxxmldocumentsave
}
208 \constfunc{bool
}{Save
}{\param{const wxString\&
}{filename
},
\param{int
}{indentstep =
1}}
210 Saves XML tree creating a file named with given string.
212 If
{\tt indentstep
} is greater than or equal to zero, then, while saving, an automatic indentation
213 is added with steps composed by
{\tt indentstep
} spaces.
214 If
{\tt indentstep
} is
{\tt wxXML
\_NO\_INDENTATION}, then, automatic indentation is turned off.
216 \constfunc{bool
}{Save
}{\param{wxOutputStream\&
}{stream
},
\param{int
}{indentstep =
1}}
218 Saves XML tree in the given output stream. See other overload for a description of
{\tt indentstep
}.
221 \membersection{wxXmlDocument::SetEncoding
}\label{wxxmldocumentsetencoding
}
223 \func{void
}{SetEncoding
}{\param{const wxString\&
}{enc
}}
225 Sets the enconding of the
document.
228 \membersection{wxXmlDocument::SetFileEncoding
}\label{wxxmldocumentsetfileencoding
}
230 \func{void
}{SetFileEncoding
}{\param{const wxString\&
}{encoding
}}
232 Sets the enconding of the file which will be used to save the
document.
235 \membersection{wxXmlDocument::SetRoot
}\label{wxxmldocumentsetroot
}
237 \func{void
}{SetRoot
}{\param{wxXmlNode*
}{node
}}
239 Sets the root node of this
document. Deletes previous root node.
240 Use
\helpref{DetachRoot
}{wxxmldocumentdetachroot
} and then
241 \helpref{SetRoot
}{wxxmldocumentsetroot
} if you want
242 to replace the root node without deleting the old
document tree.
245 \membersection{wxXmlDocument::SetVersion
}\label{wxxmldocumentsetversion
}
247 \func{void
}{SetVersion
}{\param{const wxString\&
}{version
}}
249 Sets the version of the XML file which will be used to save the
document.
252 \membersection{wxXmlDocument::operator=
}\label{wxxmldocumentoperatorassign
}
254 \func{wxXmlDocument\& operator
}{operator=
}{\param{const wxXmlDocument\&
}{doc
}}
256 Deep copies the given
document.