xmlenumerations.h File Reference

Enumerations and constant values used primarily in the XML system but useful for interacting with it in other places. More...

#include "datatypes.h"

Include dependency graph for xmlenumerations.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces
	Mezzanine
	The bulk of the engine components go in this namspace.
	Mezzanine::XML
	All tools for working with XML are located in this namespace.

Enumerations
enum	Mezzanine::XML::Encoding {   Mezzanine::XML::EncodingAuto, Mezzanine::XML::EncodingUTF8, Mezzanine::XML::EncodingUTF16LE, Mezzanine::XML::EncodingUTF16BE,   Mezzanine::XML::EncodingUTF16, Mezzanine::XML::EncodingUTF32LE, Mezzanine::XML::EncodingUTF32BE, Mezzanine::XML::EncodingUTF32,   Mezzanine::XML::Encodingwchar_t, Mezzanine::XML::EncodingLatin1 }
	These flags determine the encoding of input data for an XML document. More...
enum	Mezzanine::XML::NodeType {   Mezzanine::XML::NodeNull, Mezzanine::XML::NodeDocument, Mezzanine::XML::NodeElement, Mezzanine::XML::NodePcdata,   Mezzanine::XML::NodeCdata, Mezzanine::XML::NodeComment, Mezzanine::XML::NodePi, Mezzanine::XML::NodeDeclaration,   Mezzanine::XML::NodeDocType }
	The types of nodes that could be in the XML Tree. More...
enum	Mezzanine::XML::ParseStatus {   Mezzanine::XML::StatusOk = 0, Mezzanine::XML::StatusFileNotFound, Mezzanine::XML::StatusIOError, Mezzanine::XML::StatusOutOfMemory,   Mezzanine::XML::StatusInternalError, Mezzanine::XML::StatusUnrecognizedTag, Mezzanine::XML::StatusBadProcessingInstruction, Mezzanine::XML::StatusBadComment,   Mezzanine::XML::StatusBadCdata, Mezzanine::XML::StatusBadDocType, Mezzanine::XML::StatusBadPcdata, Mezzanine::XML::StatusBadStartElement,   Mezzanine::XML::StatusBadAttribute, Mezzanine::XML::StatusBadEndElement, Mezzanine::XML::StatusEndElementMismatch }
	These statuses are used to help determine what issues, if any the parser had. Returned by Mezzanine::XML::ParseResult instances. More...
enum	Mezzanine::XML::XPathValueType {   Mezzanine::XML::XPathTypeNone, Mezzanine::XML::XPathTypeNodeSet, Mezzanine::XML::XPathTypeNumber, Mezzanine::XML::XPathTypeString,   Mezzanine::XML::XPathTypeBoole }
	XPathQuery return type. More...

Variables
const unsigned int	Mezzanine::XML::FormatDefault = FormatRaw
	The default set of formatting flags. Only FormatRaw is enabled. More...
const unsigned int	Mezzanine::XML::FormatIndent = 0x01
	Indent the nodes that are written to output stream with as many indentation strings as deep the node is in DOM tree. This flag is off by default.
const unsigned int	Mezzanine::XML::FormatNoDeclaration = 0x08
	Omit default XML declaration even if there is no declaration in the document. This flag is off by default.
const unsigned int	Mezzanine::XML::FormatNoEscapes = 0x10
	Don't escape GetAttribute Values and PCDATA contents. This flag is off by default.
const unsigned int	Mezzanine::XML::FormatRaw = 0x04
	Use raw output mode (no indentation and no line breaks are written). This flag is on by default.
const unsigned int	Mezzanine::XML::FormatSaveFileText = 0x20
	Open file using text mode in XML::Document::SaveFile. This enables special character (i.e. new-line) conversions on some systems. This flag is off by default.
const unsigned int	Mezzanine::XML::FormatWriteBom = 0x02
	Write encoding-specific Byte Order Mark (BOM) to the output stream. This flag is off by default.
const unsigned int	Mezzanine::XML::ParseCdata = 0x0004
	This flag determines if CDATA sections (NodeCdata) are added to the DOM tree. This flag is on by default.
const unsigned int	Mezzanine::XML::ParseComments = 0x0002
	This flag determines if comments (NodeComment) are added to the DOM tree. This flag is off by default.
const unsigned int	Mezzanine::XML::ParseDeclaration = 0x0100
	This flag determines if document declaration (NodeDeclaration) is added to the DOM tree. This flag is off by default.
const unsigned int	Mezzanine::XML::ParseDefault = ParseCdata | ParseEscapes | ParseWconvAttribute | ParseEol
	The default parsing mode. More...
const unsigned int	Mezzanine::XML::ParseDocType = 0x0200
	This flag determines if document type declaration (NodeDoctype) is added to the DOM tree. This flag is off by default.
const unsigned int	Mezzanine::XML::ParseEol = 0x0020
	This flag determines if EOL characters are normalized (converted to #xA) during parsing. This flag is on by default.
const unsigned int	Mezzanine::XML::ParseEscapes = 0x0010
	This flag determines if character and entity references are expanded during parsing. This flag is on by default.
const unsigned int	Mezzanine::XML::ParseFull = ParseDefault | ParsePi | ParseComments | ParseDeclaration | ParseDocType
	The full parsing mode. More...
const unsigned int	Mezzanine::XML::ParseMinimal = 0x0000
	Minimal parsing mode (equivalent to turning all other flags off). More...
const unsigned int	Mezzanine::XML::ParsePi = 0x0001
	This flag determines if processing instructions (NodePi) are added to the DOM tree. This flag is off by default.
const unsigned int	Mezzanine::XML::ParseWconvAttribute = 0x0040
	This flag determines if attribute values are normalized using CDATA normalization rules during parsing. This flag is on by default.
const unsigned int	Mezzanine::XML::ParseWnormAttribute = 0x0080
	This flag determines if attribute values are normalized using NMTOKENS normalization rules during parsing. This flag is off by default.
const unsigned int	Mezzanine::XML::ParseWsPcdata = 0x0008
	This flag determines if plain character data (NodePcdata) that consist only of whitespace are added to the DOM tree. More...
const unsigned int	Mezzanine::XML::ParseWsPcdata_single = 0x0400
	This flag determines if plain character data (NodePcdata) that is the only child of the parent node and that consists only of whitespace is added to the DOM tree. More...

Detailed Description

Enumerations and constant values used primarily in the XML system but useful for interacting with it in other places.

Definition in file xmlenumerations.h.