- Cal3D 0.9 API Reference -

Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | Related Pages

# TiXmlBase Class Reference

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

`#include <tinyxml.h>`

Inheritance diagram for TiXmlBase:

List of all members.

## Public Member Functions

virtual void | Print (FILE *cfile, int depth) const=0
| All TinyXml classes can print themselves to a filestream.

## Static Public Member Functions

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

## Protected Types

enum | { TIXML_NO_ERROR = 0, TIXML_ERROR, TIXML_ERROR_OPENING_FILE, TIXML_ERROR_OUT_OF_MEMORY, 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_STRING_COUNT
}

## Protected Member Functions

virtual void | StreamOut (TIXML_OSTREAM *) const=0
virtual const char * | Parse (const char *p)=0

## Static Protected Member Functions

const char * | SkipWhiteSpace (const char *)
bool | IsWhiteSpace (int c)
bool | StreamWhiteSpace (TIXML_ISTREAM *in, TIXML_STRING *tag)
bool | StreamTo (TIXML_ISTREAM *in, int character, TIXML_STRING *tag)
const char * | ReadName (const char *p, TIXML_STRING *name)
const char * | ReadText (const char *in, TIXML_STRING *text, bool ignoreWhiteSpace, const char *endTag, bool ignoreCase)
const char * | GetEntity (const char *in, char *value)
const char * | GetChar (const char *p, char *value)
void | PutString (const TIXML_STRING &str, TIXML_OSTREAM *out)
void | PutString (const TIXML_STRING &str, TIXML_STRING *out)
bool | StringEqual (const char *p, const char *endTag, bool ignoreCase)

## Static Protected Attributes

const char * | errorString [TIXML_ERROR_STRING_COUNT]

## Friends

class | TiXmlNode
class | TiXmlElement
class | TiXmlDocument

## 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 Function Documentation

virtual void TiXmlBase::Print | ( | FILE * | cfile,
|  | int | depth
| ) | const`[pure virtual]`

| All TinyXml classes can print themselves to a filestream. This is a formatted print, and will insert tabs and newlines. (For an unformatted stream, use the << operator.) Implemented in TiXmlAttribute, TiXmlElement, TiXmlComment, TiXmlText, TiXmlDeclaration, TiXmlUnknown, and TiXmlDocument.

void TiXmlBase::SetCondenseWhiteSpace | ( | bool | condense | ) | `[inline, 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 these values is not thread safe.

## Member Data Documentation

const char * TiXmlBase::errorString`[static, protected]`

| Initial value:
    {
        "No error",
        "Error",
        "Failed to open file",
        "Memory allocation failed.",
        "Error parsing Element.",
        "Failed to read Element name",
        "Error reading Element value.",
        "Error reading Attributes.",
        "Error: empty tag.",
        "Error reading end tag.",
        "Error parsing Unknown.",
        "Error parsing Comment.",
        "Error parsing Declaration.",
        "Error document empty."
    }

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

- tinyxml.h
- tinyxml.cpp
- tinyxmlerror.cpp
- tinyxmlparser.cpp

Generated at Wed Apr 7 16:57:18 2004 by The Cal3D Team with 1.3.6 © 1997-2001 Dimitri van Heesch