The XMLHandlers Class Reference

Event handlers that can installed by the client and called while parsing a XML document. More...

Declaration

class XMLHandlers { ... }

Included Headers

#include <libxml/xml.h>

Public Member Typedefs Index

using	Attributes = std::unordered_map< std::string, std::string >
using	StartDocType = void()
using	EndDocType = void()
using	StartElementType = void(const std::string &, const Attributes &)
using	EndElementType = void(const std::string &)
using	ErrorType = void(const std::string, int, const std::string &)
using	CharsType = void(const std::string &)

Public Member Attributes Index

std::function< StartDocType >	startDocument
	handler invoked at the start of the document More...
std::function< EndDocType >	endDocument
	handler invoked at the end of the document More...
std::function< StartElementType >	startElement
	handler invoked when an opening tag has been found More...
std::function< EndElementType >	endElement
	handler invoked when a closing tag has been found More...
std::function< CharsType >	characters
	handler invoked when content between tags has been found More...
std::function< ErrorType >	error
	handler invoked when the parser encounters an error More...

Public Static Functions Index

static std::string	value (const Attributes &attrib, const std::string &key)

Description

Event handlers that can installed by the client and called while parsing a XML document.

Definition at line 26 of file xml.h.

Public Member Typedefs

Attributes

using XMLHandlers::Attributes = std::unordered_map<std::string,std::string>

Definition at line 29 of file xml.h.

29 using Attributes = std::unordered_map<std::string,std::string>;

CharsType

using XMLHandlers::CharsType = void(const std::string &)

Definition at line 35 of file xml.h.

35 using CharsType = void(const std::string &);

EndDocType

using XMLHandlers::EndDocType = void()

Definition at line 31 of file xml.h.

31 using EndDocType = void();

EndElementType

using XMLHandlers::EndElementType = void(const std::string &)

Definition at line 33 of file xml.h.

33 using EndElementType = void(const std::string &);

ErrorType

using XMLHandlers::ErrorType = void(const std::string,int,const std::string &)

Definition at line 34 of file xml.h.

34 using ErrorType = void(const std::string,int,const std::string &);

StartDocType

using XMLHandlers::StartDocType = void()

Definition at line 30 of file xml.h.

30 using StartDocType = void();

StartElementType

using XMLHandlers::StartElementType = void(const std::string &,const Attributes &)

Definition at line 32 of file xml.h.

32 using StartElementType = void(const std::string &,const Attributes &);

Public Member Attributes

characters

std::function<CharsType> XMLHandlers::characters

handler invoked when content between tags has been found

Definition at line 41 of file xml.h.

41 std::function<CharsType> characters; /**< handler invoked when content between tags has been found */

Referenced by parseTagFile.

endDocument

std::function<EndDocType> XMLHandlers::endDocument

handler invoked at the end of the document

Definition at line 38 of file xml.h.

38 std::function<EndDocType> endDocument; /**< handler invoked at the end of the document */

endElement

std::function<EndElementType> XMLHandlers::endElement

handler invoked when a closing tag has been found

Definition at line 40 of file xml.h.

40 std::function<EndElementType> endElement; /**< handler invoked when a closing tag has been found */

Referenced by LayoutDocManager::init, LayoutDocManager::parse and parseTagFile.

error

std::function<ErrorType> XMLHandlers::error

handler invoked when the parser encounters an error

Definition at line 42 of file xml.h.

42 std::function<ErrorType> error; /**< handler invoked when the parser encounters an error */

Referenced by LayoutDocManager::init, LayoutDocManager::parse and parseTagFile.

startDocument

std::function<StartDocType> XMLHandlers::startDocument

handler invoked at the start of the document

Definition at line 37 of file xml.h.

37 std::function<StartDocType> startDocument; /**< handler invoked at the start of the document */

Referenced by parseTagFile.

startElement

std::function<StartElementType> XMLHandlers::startElement

handler invoked when an opening tag has been found

Definition at line 39 of file xml.h.

39 std::function<StartElementType> startElement; /**< handler invoked when an opening tag has been found */

Referenced by LayoutDocManager::init, LayoutDocManager::parse and parseTagFile.

Public Static Functions

value()

std::string XMLHandlers::value (const Attributes & attrib, const std::string & key)

inline static

Definition at line 44 of file xml.h.

44 static std::string value(const Attributes &attrib,const std::string &key)

45 {

46 auto it = attrib.find(key);

47 if (it!=attrib.end())

48 {

49 return it->second;

50 }

51 return "";

52 }

Referenced by elemIsVisible, anonymous{tagreader.cpp}::TagFileParser::startBase, anonymous{tagreader.cpp}::TagFileParser::startCompound, anonymous{tagreader.cpp}::TagFileParser::startDocAnchor, anonymous{tagreader.cpp}::TagFileParser::startEnumValue, anonymous{tagreader.cpp}::TagFileParser::startIncludes, LayoutParser::startLayout, anonymous{tagreader.cpp}::TagFileParser::startMember, LayoutParser::startMemberDeclEntry, LayoutParser::startMemberDefEntry, LayoutParser::startNavEntry and LayoutParser::startSectionEntry.

---

The documentation for this class was generated from the following file:

• xml.h

---

Generated via doxygen2docusaurus by Doxygen 1.14.0.