IXmlDocumentVisitor

Xml document visitor.

Header:	#include <AUI/Xml/IXmlDocumentVisitor.h>
CMake:	aui_link(my_target PUBLIC aui::xml)

Detailed Description

Root of the visitor chain passed to AXml::read. It is an IXmlEntityVisitor for the top level of the document, so visitEntity is called for every top-level element. Additionally, visitHeader is called when the <?xml ... ?> header is met.

struct MyDocument: IXmlDocumentVisitor {
    _<IXmlEntityVisitor> visitEntity(AString entityName) override {
        return _new<MyRoot>(std::move(entityName));
    }
};

See Parsing XML.

Public Methods

visitHeader

---

virtual _<IXmlHeaderVisitor> IXmlDocumentVisitor::visitHeader()

Visits xml header.

Returns

visitor of the header attributes (version, encoding...) or nullptr to ignore the header. The default implementation returns nullptr.