## wxXmlDocument

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();
    }

Note: if you want to preserve the original formatting of the loaded file including whitespaces and indentation, you need to turn off whitespace-only textnode removal and automatic indentation:

    wxXmlDocument doc;
    doc.Load(wxT("myfile.xml"), wxT("UTF-8"), wxXMLDOC_KEEP_WHITESPACE_NODES);

    // myfile2.xml will be indentic to myfile.xml saving it this way:
    doc.Save(wxT("myfile2.xml"), wxXML_NO_INDENTATION);

Using default parameters, you will get a reformatted document which in general is different from the original loaded content:

    wxXmlDocument doc;
    doc.Load(wxT("myfile.xml"));
    doc.Save(wxT("myfile2.xml"));  // myfile2.xml != myfile.xml

Derived from

wxObject

Include files

<wx/xml/xml.h>

See also

wxXmlNode, wxXmlProperty

Members

wxXmlDocument::wxXmlDocument
wxXmlDocument::~wxXmlDocument
wxXmlDocument::DetachRoot
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

wxXmlDocument()

wxXmlDocument(const wxString& filename, const wxString& encoding = wxT("UTF-8"), int flags = wxXMLDOC_NONE)

Loads the given filename using the given encoding. See Load.

wxXmlDocument(wxInputStream& stream, const wxString& encoding = wxT("UTF-8"), int flags = wxXMLDOC_NONE)

Loads the XML document from given stream using the given encoding. See Load.

wxXmlDocument(const wxXmlDocument& doc)

Copy constructor. Deep copies all the XML tree of the given document.

### wxXmlDocument::~wxXmlDocument

~wxXmlDocument()

Virtual destructor. Frees the document root node.

### wxXmlDocument::DetachRoot

wxXmlNode* DetachRoot()

Detaches the document root node and returns it. The document root node will be set to `NULL` and thus IsOk will return `false` after calling this function.

Note that the caller is reponsible for deleting the returned node in order to avoid memory leaks.

### wxXmlDocument::GetEncoding

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*`.

### wxXmlDocument::GetFileEncoding

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!

### wxXmlDocument::GetRoot

wxXmlNode* GetRoot() const

Returns the root node of the document.

### wxXmlDocument::GetVersion

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.

### wxXmlDocument::IsOk

bool IsOk() const

Returns `true` if the document has been loaded successfully.

### wxXmlDocument::Load

bool Load(const wxString& filename, const wxString& encoding = wxT("UTF-8"), int flags = wxXMLDOC_NONE)

Parses filename as an xml document and loads its data.

If `flags` does not contain `wxXMLDOC_KEEP_WHITESPACE_NODES`, then, while loading, all nodes of type `wxXML_TEXT_NODE` (see 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 Save call later. Read the initial description of this class for more info.

Returns `true` on success, `false` otherwise.

bool Load(wxInputStream& stream, const wxString& encoding = wxT("UTF-8"), int flags = wxXMLDOC_NONE)

Like above but takes the data from given input stream.

### wxXmlDocument::Save

bool Save(const wxString& filename, int indentstep = 1) const

Saves XML tree creating a file named with given string.

If `indentstep` is greater than or equal to zero, then, while saving, an automatic indentation is added with steps composed by `indentstep` spaces. If `indentstep` is `wxXML_NO_INDENTATION`, then, automatic indentation is turned off.

bool Save(wxOutputStream& stream, int indentstep = 1) const

Saves XML tree in the given output stream. See other overload for a description of `indentstep`.

### wxXmlDocument::SetEncoding

void SetEncoding(const wxString& enc)

Sets the enconding of the document.

### wxXmlDocument::SetFileEncoding

void SetFileEncoding(const wxString& encoding)

Sets the enconding of the file which will be used to save the document.

### wxXmlDocument::SetRoot

void SetRoot(wxXmlNode* node)

Sets the root node of this document. Deletes previous root node. Use DetachRoot and then SetRoot if you want to replace the root node without deleting the old document tree.

### wxXmlDocument::SetVersion

void SetVersion(const wxString& version)

Sets the version of the XML file which will be used to save the document.

### wxXmlDocument::operator=

wxXmlDocument& operator operator=(const wxXmlDocument& doc)

Deep copies the given document.