This class holds XML data/document as parsed by XML parser in the root node.
wxXmlDocument internally uses the expat library which comes with wxWidgets to parse the given stream.
A simple example of using XML classes is:
wxXmlDocument doc; if (!doc.Load(wxT("myfile.xml")) return false; // start processing the XML file if (doc.GetRoot()->GetName() != wxT("myroot-node")) return false; wxXmlNode *child = doc.GetRoot()->GetChildren(); while (child) { if (child->GetName() == wxT("tag1")) { // process text enclosed by <tag1></tag1> wxString content = child->GetNodeContent(); ... // process properties of <tag1> wxString propvalue1 = child->GetPropVal(wxT("prop1"), wxT("default-value")); wxString propvalue2 = child->GetPropVal(wxT("prop2"), wxT("default-value")); ... } else if (child->GetName() == wxT("tag2")) { // process tag2 ... } child = child->GetNext(); }
Derived from
Include files
<wx/xml/xml.h>
See also
Members
wxXmlDocument::wxXmlDocument
wxXmlDocument::~wxXmlDocument
wxXmlDocument::GetEncoding
wxXmlDocument::GetFileEncoding
wxXmlDocument::GetRoot
wxXmlDocument::GetVersion
wxXmlDocument::IsOk
wxXmlDocument::Load
wxXmlDocument::Save
wxXmlDocument::SetEncoding
wxXmlDocument::SetFileEncoding
wxXmlDocument::SetRoot
wxXmlDocument::SetVersion
wxXmlDocument::operator=
wxXmlDocument()
wxXmlDocument(const wxString& filename, const wxString& encoding = wxT("UTF-8"))
Loads the given filename using the given encoding. See Load().
wxXmlDocument(wxInputStream& stream, const wxString& encoding = wxT("UTF-8"))
Loads the XML document from given stream using the given encoding. See Load().
wxXmlDocument(const wxXmlDocument& doc)
Copy constructor.
~wxXmlDocument()
Virtual destructor. Frees the document root node.
wxString GetEncoding() const
Returns encoding of in-memory representation of the document (same as passed to Load() or constructor, defaults to UTF-8).
NB: this is meaningless in Unicode build where data are stored as wchar_t*.
wxString GetFileEncoding() const
Returns encoding of document (may be empty).
Note: this is the encoding original file was saved in, *not* the encoding of in-memory representation!
wxXmlNode* GetRoot() const
Returns the root node of the document.
wxString GetVersion() const
Returns the version of document. This is the value in the <?xml version="1.0"?> header of the XML document. If the version property was not explicitely given in the header, this function returns an empty string.
bool IsOk() const
Returns true if the document has been loaded successfully.
bool Load(const wxString& filename, const wxString& encoding = wxT("UTF-8"))
Parses filename as an xml document and loads data. Returns true on success, false otherwise.
bool Load(wxInputStream& stream, const wxString& encoding = wxT("UTF-8"))
Like above but takes the data from given input stream.
bool Save(const wxString& filename) const
Saves XML tree creating a file named with given string.
bool Save(wxOutputStream& stream) const
Saves XML tree in the given output stream.
void SetEncoding(const wxString& enc)
Sets the enconding of the document.
void SetFileEncoding(const wxString& encoding)
Sets the enconding of the file which will be used to save the document.
void SetRoot(wxXmlNode* node)
Sets the root node of this document. Deletes previous root node.
void SetVersion(const wxString& version)
Sets the version of the XML file which will be used to save the document.
wxXmlDocument& operator operator=(const wxXmlDocument& doc)
Copies the given document.