Twitch SDK (Internal): ttv::xml::XMLElement Class Reference

◆ ClosingType()

int ttv::xml::XMLElement::ClosingType ( ) const

inline

◆ DeleteAttribute() [1/2]

void ttv::xml::XMLElement::DeleteAttribute ( const char * name )

Delete an attribute.

◆ DeleteAttribute() [2/2]

static void ttv::xml::XMLElement::DeleteAttribute ( XMLAttribute * attribute )

staticprivate

◆ DeleteChild()

void ttv::xml::XMLNode::DeleteChild ( XMLNode * node )

inherited

Delete a child of this node.

◆ DeleteChildren()

void ttv::xml::XMLNode::DeleteChildren ( )

inherited

Delete all the children of this node.

◆ DoubleAttribute()

double ttv::xml::XMLElement::DoubleAttribute ( const char * name ) const

inline

◆ FindAttribute() [1/2]

const XMLAttribute* ttv::xml::XMLElement::FindAttribute ( const char * name ) const

Query a specific attribute in the list.

◆ FindAttribute() [2/2]

XMLAttribute* ttv::xml::XMLElement::FindAttribute ( const char * name )

inlineprivate

◆ FindOrCreateAttribute()

XMLAttribute* ttv::xml::XMLElement::FindOrCreateAttribute ( const char * name )

private

◆ FirstAttribute()

const XMLAttribute* ttv::xml::XMLElement::FirstAttribute ( ) const

inline

Return the first attribute in the list.

◆ FirstChild() [1/2]

const XMLNode* ttv::xml::XMLNode::FirstChild ( ) const

inlineinherited

Get the first child node, or null if none exists.

◆ FirstChild() [2/2]

XMLNode* ttv::xml::XMLNode::FirstChild ( )

inlineinherited

◆ FirstChildElement() [1/2]

const XMLElement* ttv::xml::XMLNode::FirstChildElement ( const char * name = 0 ) const

inherited

Get the first child element, or optionally the first child element with the specified name.

◆ FirstChildElement() [2/2]

XMLElement* ttv::xml::XMLNode::FirstChildElement ( const char * name = 0 )

inlineinherited

◆ FloatAttribute()

float ttv::xml::XMLElement::FloatAttribute ( const char * name ) const

inline

◆ GetDocument() [1/2]

const XMLDocument* ttv::xml::XMLNode::GetDocument ( ) const

inlineinherited

Get the XMLDocument that owns this XMLNode.

◆ GetDocument() [2/2]

XMLDocument* ttv::xml::XMLNode::GetDocument ( )

inlineinherited

Get the XMLDocument that owns this XMLNode.

◆ GetText()

const char* ttv::xml::XMLElement::GetText ( ) const

Convenience function for easy access to the text inside an element. Although easy and concise, GetText() is limited compared to getting the XMLText child and accessing it directly.

If the first child of 'this' is a XMLText, the GetText() returns the character string of the Text node, else null is returned.

This is a convenient method for getting the text of simple contained text:

<foo>This is text</foo>
    const char* str = fooElement->GetText();

'str' will be a pointer to "This is text".

Note that this function can be misleading. If the element foo was created from this XML:

    <foo><b>This is text</b></foo>

then the value of str would be null. The first child node isn't a text node, it is another element. From this XML:

    <foo>This is <b>text</b></foo>

GetText() will return "This is ".

◆ GetUserData()

void* ttv::xml::XMLNode::GetUserData ( ) const

inlineinherited

Get user data set into the XMLNode. TinyXML-2 in no way processes or interprets user data. It is initially 0.

◆ InsertAfterChild()

XMLNode* ttv::xml::XMLNode::InsertAfterChild	(	XMLNode *	afterThis,
		XMLNode *	addThis
	)

inherited

Add a node after the specified child node. If the child node is already part of the document, it is moved from its old location to the new location. Returns the addThis argument or 0 if the afterThis node is not a child of this node, or if the node does not belong to the same document.

◆ InsertEndChild()

XMLNode* ttv::xml::XMLNode::InsertEndChild ( XMLNode * addThis )

inherited

Add a child node as the last (right) child. If the child node is already part of the document, it is moved from its old location to the new location. Returns the addThis argument or 0 if the node does not belong to the same document.

◆ InsertFirstChild()

XMLNode* ttv::xml::XMLNode::InsertFirstChild ( XMLNode * addThis )

inherited

Add a child node as the first (left) child. If the child node is already part of the document, it is moved from its old location to the new location. Returns the addThis argument or 0 if the node does not belong to the same document.

◆ Int64Attribute()

int64_t ttv::xml::XMLElement::Int64Attribute ( const char * name ) const

inline

◆ IntAttribute()

int ttv::xml::XMLElement::IntAttribute ( const char * name ) const

inline

Given an attribute name, IntAttribute() returns the value of the attribute interpreted as an integer. 0 will be returned if there is an error. For a method with error checking, see QueryIntAttribute()

◆ LastChild() [1/2]

const XMLNode* ttv::xml::XMLNode::LastChild ( ) const

inlineinherited

Get the last child node, or null if none exists.

◆ LastChild() [2/2]

XMLNode* ttv::xml::XMLNode::LastChild ( )

inlineinherited

◆ LastChildElement() [1/2]

const XMLElement* ttv::xml::XMLNode::LastChildElement ( const char * name = 0 ) const

inherited

Get the last child element or optionally the last child element with the specified name.

◆ LastChildElement() [2/2]

XMLElement* ttv::xml::XMLNode::LastChildElement ( const char * name = 0 )

inlineinherited

◆ LinkEndChild()

XMLNode* ttv::xml::XMLNode::LinkEndChild ( XMLNode * addThis )

inlineinherited

◆ Name()

const char* ttv::xml::XMLElement::Name ( ) const

inline

Get the name of an element (which is the Value() of the node.)

◆ NextSibling() [1/2]

const XMLNode* ttv::xml::XMLNode::NextSibling ( ) const

inlineinherited

Get the next (right) sibling node of this node.

◆ NextSibling() [2/2]

XMLNode* ttv::xml::XMLNode::NextSibling ( )

inlineinherited

◆ NextSiblingElement() [1/2]

const XMLElement* ttv::xml::XMLNode::NextSiblingElement ( const char * name = 0 ) const

inherited

Get the next (right) sibling element of this node, with an optionally supplied name.

◆ NextSiblingElement() [2/2]

XMLElement* ttv::xml::XMLNode::NextSiblingElement ( const char * name = 0 )

inlineinherited

◆ NoChildren()

bool ttv::xml::XMLNode::NoChildren ( ) const

inlineinherited

Returns true if this node has no children.

◆ operator=()

void ttv::xml::XMLElement::operator= ( const XMLElement & )

private

◆ Parent() [1/2]

const XMLNode* ttv::xml::XMLNode::Parent ( ) const

inlineinherited

Get the parent of this node on the DOM.

◆ Parent() [2/2]

XMLNode* ttv::xml::XMLNode::Parent ( )

inlineinherited

◆ ParseAttributes()

char* ttv::xml::XMLElement::ParseAttributes ( char * p )

private

◆ ParseDeep()

char* ttv::xml::XMLElement::ParseDeep	(	char *	p,
		StrPair *	endTag
	)

protectedvirtual

Reimplemented from ttv::xml::XMLNode.

◆ PreviousSibling() [1/2]

const XMLNode* ttv::xml::XMLNode::PreviousSibling ( ) const

inlineinherited

Get the previous (left) sibling node of this node.

◆ PreviousSibling() [2/2]

XMLNode* ttv::xml::XMLNode::PreviousSibling ( )

inlineinherited

◆ PreviousSiblingElement() [1/2]

const XMLElement* ttv::xml::XMLNode::PreviousSiblingElement ( const char * name = 0 ) const

inherited

Get the previous (left) sibling element of this node, with an optionally supplied name.

◆ PreviousSiblingElement() [2/2]

XMLElement* ttv::xml::XMLNode::PreviousSiblingElement ( const char * name = 0 )

inlineinherited

◆ QueryAttribute() [1/6]

int ttv::xml::XMLElement::QueryAttribute	(	const char *	name,
		int *	value
	)		const

inline

Given an attribute name, QueryAttribute() returns XML_NO_ERROR, XML_WRONG_ATTRIBUTE_TYPE if the conversion can't be performed, or XML_NO_ATTRIBUTE if the attribute doesn't exist. It is overloaded for the primitive types, and is a generally more convenient replacement of QueryIntAttribute() and related functions.

If successful, the result of the conversion will be written to 'value'. If not successful, nothing will be written to 'value'. This allows you to provide default value:

int value = 10;
QueryAttribute( "foo", &value );        // if "foo" isn't found, value will still be 10

◆ QueryAttribute() [2/6]

int ttv::xml::XMLElement::QueryAttribute	(	const char *	name,
		unsigned int *	value
	)		const

inline

◆ QueryAttribute() [3/6]

int ttv::xml::XMLElement::QueryAttribute	(	const char *	name,
		int64_t *	value
	)		const

inline

◆ QueryAttribute() [4/6]

int ttv::xml::XMLElement::QueryAttribute	(	const char *	name,
		bool *	value
	)		const

inline

◆ QueryAttribute() [5/6]

int ttv::xml::XMLElement::QueryAttribute	(	const char *	name,
		double *	value
	)		const

inline

◆ QueryAttribute() [6/6]

int ttv::xml::XMLElement::QueryAttribute	(	const char *	name,
		float *	value
	)		const

inline

◆ QueryBoolAttribute()

XMLError ttv::xml::XMLElement::QueryBoolAttribute	(	const char *	name,
		bool *	value
	)		const

inline

◆ QueryBoolText()

XMLError ttv::xml::XMLElement::QueryBoolText ( bool * bval ) const

◆ QueryDoubleAttribute()

XMLError ttv::xml::XMLElement::QueryDoubleAttribute	(	const char *	name,
		double *	value
	)		const

inline

◆ QueryDoubleText()

XMLError ttv::xml::XMLElement::QueryDoubleText ( double * dval ) const

◆ QueryFloatAttribute()

XMLError ttv::xml::XMLElement::QueryFloatAttribute	(	const char *	name,
		float *	value
	)		const

inline

◆ QueryFloatText()

XMLError ttv::xml::XMLElement::QueryFloatText ( float * fval ) const

◆ QueryInt64Attribute()

XMLError ttv::xml::XMLElement::QueryInt64Attribute	(	const char *	name,
		int64_t *	value
	)		const

inline

◆ QueryInt64Text()

XMLError ttv::xml::XMLElement::QueryInt64Text ( int64_t * uval ) const

◆ QueryIntAttribute()

XMLError ttv::xml::XMLElement::QueryIntAttribute	(	const char *	name,
		int *	value
	)		const

inline

Given an attribute name, QueryIntAttribute() returns XML_NO_ERROR, XML_WRONG_ATTRIBUTE_TYPE if the conversion can't be performed, or XML_NO_ATTRIBUTE if the attribute doesn't exist. If successful, the result of the conversion will be written to 'value'. If not successful, nothing will be written to 'value'. This allows you to provide default value:

int value = 10;
QueryIntAttribute( "foo", &value );     // if "foo" isn't found, value will still be 10

◆ QueryIntText()

XMLError ttv::xml::XMLElement::QueryIntText ( int * ival ) const

Convenience method to query the value of a child text node. This is probably best shown by example. Given you have a document is this form:

    <point>
        <x>1</x>
        <y>1.4</y>
    </point>

The QueryIntText() and similar functions provide a safe and easier way to get to the "value" of x and y.

    int x = 0;
    float y = 0;    // types of x and y are contrived for example
    const XMLElement* xElement = pointElement->FirstChildElement( "x" );
    const XMLElement* yElement = pointElement->FirstChildElement( "y" );
    xElement->QueryIntText( &x );
    yElement->QueryFloatText( &y );

Returns: XML_SUCCESS (0) on success, XML_CAN_NOT_CONVERT_TEXT if the text cannot be converted to the requested type, and XML_NO_TEXT_NODE if there is no child text to query.

◆ QueryUnsignedAttribute()

XMLError ttv::xml::XMLElement::QueryUnsignedAttribute	(	const char *	name,
		unsigned int *	value
	)		const

inline

◆ QueryUnsignedText()

XMLError ttv::xml::XMLElement::QueryUnsignedText ( unsigned * uval ) const