Panda3D
Public Types | Public Member Functions | Static Public Member Functions | List of all members
TiXmlBase Class Reference

TiXmlBase is a base class for every class in TinyXml. More...

Inheritance diagram for TiXmlBase:
TiXmlAttribute TiXmlNode TiXmlComment TiXmlDeclaration TiXmlDocument TiXmlElement TiXmlText TiXmlUnknown

Public Types

enum  {
  TIXML_NO_ERROR = 0, TIXML_ERROR = 1, TIXML_ERROR_OPENING_FILE = 2, TIXML_ERROR_PARSING_ELEMENT = 3,
  TIXML_ERROR_FAILED_TO_READ_ELEMENT_NAME = 4, TIXML_ERROR_READING_ELEMENT_VALUE = 5, TIXML_ERROR_READING_ATTRIBUTES = 6, TIXML_ERROR_PARSING_EMPTY = 7,
  TIXML_ERROR_READING_END_TAG = 8, TIXML_ERROR_PARSING_UNKNOWN = 9, TIXML_ERROR_PARSING_COMMENT = 10, TIXML_ERROR_PARSING_DECLARATION = 11,
  TIXML_ERROR_DOCUMENT_EMPTY = 12, TIXML_ERROR_EMBEDDED_NULL = 13, TIXML_ERROR_PARSING_CDATA = 14, TIXML_ERROR_DOCUMENT_TOP_ONLY = 15,
  TIXML_ERROR_STRING_COUNT = 16
}
 

Public Member Functions

int Column ()
 Get a pointer to arbitrary user data. More...
 
 GetUserData ()
 Get a pointer to arbitrary user data. More...
 
 GetUserData ()
 
str Parse (str p, TiXmlParsingData data, TiXmlEncoding encoding)
 
 Print (FILE cfile, int depth)
 All TinyXml classes can print themselves to a filestream or the string class (TiXmlString in non-STL mode, std::string in STL mode.) Either or both cfile and str can be null. More...
 
int Row ()
 Return the position, in the original source file, of this node or attribute. More...
 

Static Public Member Functions

static bool IsWhiteSpaceCondensed ()
 Return the current white space setting. More...
 
static SetCondenseWhiteSpace (bool condense)
 The world does not agree on whether white space should be kept or not. More...
 

Detailed Description

TiXmlBase is a base class for every class in TinyXml.

It does little except to establish that TinyXml classes can be printed and provide some utility functions.

In XML, the document and elements can contain other elements and other types of nodes.

A Document can contain: Element (container or leaf)
                        Comment (leaf)
                        Unknown (leaf)
                        Declaration( leaf )

An Element can contain: Element (container or leaf)
                        Text    (leaf)
                        Attributes (not on tree)
                        Comment (leaf)
                        Unknown (leaf)

A Decleration contains: Attributes (not on tree)

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
TIXML_NO_ERROR 
TIXML_ERROR 
TIXML_ERROR_OPENING_FILE 
TIXML_ERROR_PARSING_ELEMENT 
TIXML_ERROR_FAILED_TO_READ_ELEMENT_NAME 
TIXML_ERROR_READING_ELEMENT_VALUE 
TIXML_ERROR_READING_ATTRIBUTES 
TIXML_ERROR_PARSING_EMPTY 
TIXML_ERROR_READING_END_TAG 
TIXML_ERROR_PARSING_UNKNOWN 
TIXML_ERROR_PARSING_COMMENT 
TIXML_ERROR_PARSING_DECLARATION 
TIXML_ERROR_DOCUMENT_EMPTY 
TIXML_ERROR_EMBEDDED_NULL 
TIXML_ERROR_PARSING_CDATA 
TIXML_ERROR_DOCUMENT_TOP_ONLY 
TIXML_ERROR_STRING_COUNT 

Member Function Documentation

◆ Column()

int Column ( )

Get a pointer to arbitrary user data.

◆ GetUserData() [1/2]

GetUserData ( )

Get a pointer to arbitrary user data.

◆ GetUserData() [2/2]

GetUserData ( )

◆ IsWhiteSpaceCondensed()

static bool IsWhiteSpaceCondensed ( )
static

Return the current white space setting.

◆ Parse()

str Parse ( str  p,
TiXmlParsingData  data,
TiXmlEncoding  encoding 
)

◆ Print()

Print ( FILE  cfile,
int  depth 
)

All TinyXml classes can print themselves to a filestream or the string class (TiXmlString in non-STL mode, std::string in STL mode.) Either or both cfile and str can be null.

This is a formatted print, and will insert tabs and newlines.

(For an unformatted stream, use the << operator.)

◆ Row()

int Row ( )

Return the position, in the original source file, of this node or attribute.

The row and column are 1-based. (That is the first row and first column is 1,1). If the returns values are 0 or less, then the parser does not have a row and column value.

Generally, the row and column value will be set when the TiXmlDocument::Load(), TiXmlDocument::LoadFile(), or any TiXmlNode::Parse() is called. It will NOT be set when the DOM was created from operator>>.

The values reflect the initial load. Once the DOM is modified programmatically (by adding or changing nodes and attributes) the new values will NOT update to reflect changes in the document.

There is a minor performance cost to computing the row and column. Computation can be disabled if TiXmlDocument::SetTabSize() is called with 0 as the value.

See also
TiXmlDocument::SetTabSize()See Row()

◆ SetCondenseWhiteSpace()

static SetCondenseWhiteSpace ( bool  condense)
static

The world does not agree on whether white space should be kept or not.

In order to make everyone happy, these global, static functions are provided to set whether or not TinyXml will condense all white space into a single space or not. The default is to condense. Note changing this value is not thread safe.