Panda3D
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Static Protected Member Functions | Protected Attributes | Static Protected Attributes | Friends

TiXmlAttribute Class Reference

An attribute is a name-value pair. More...

#include "tinyxml.h"

Inheritance diagram for TiXmlAttribute:
TiXmlBase

List of all members.

Public Types

enum  {
  TIXML_NO_ERROR = 0, 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
}

Public Member Functions

 TiXmlAttribute ()
 Construct an empty attribute.
 TiXmlAttribute (const char *_name, const char *_value)
 Construct an attribute with a name and value.
int Column () const
 See Row()
double DoubleValue () const
 Return the value of this attribute, converted to a double.
void * GetUserData ()
 Get a pointer to arbitrary user data.
const void * GetUserData () const
 Get a pointer to arbitrary user data.
int IntValue () const
 Return the value of this attribute, converted to an integer.
const char * Name () const
 Return the name of this attribute.
const TiXmlString & NameTStr () const
const TiXmlAttributeNext () const
 Get the next sibling attribute in the DOM. Returns null at end.
TiXmlAttributeNext ()
bool operator< (const TiXmlAttribute &rhs) const
bool operator== (const TiXmlAttribute &rhs) const
bool operator> (const TiXmlAttribute &rhs) const
virtual const char * Parse (const char *p, TiXmlParsingData *data, TiXmlEncoding encoding)
TiXmlAttributePrevious ()
const TiXmlAttributePrevious () const
 Get the previous sibling attribute in the DOM. Returns null at beginning.
virtual void Print (FILE *cfile, int depth) const
 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.
void Print (FILE *cfile, int depth, TiXmlString *str) const
int QueryDoubleValue (double *_value) const
 QueryDoubleValue examines the value string. See QueryIntValue().
int QueryIntValue (int *_value) const
 QueryIntValue examines the value string.
int Row () const
 Return the position, in the original source file, of this node or attribute.
void SetDocument (TiXmlDocument *doc)
void SetDoubleValue (double _value)
 Set the value from a double.
void SetIntValue (int _value)
 Set the value from an integer.
void SetName (const char *_name)
 Set the name of this attribute.
void SetUserData (void *user)
 Set a pointer to arbitrary user data.
void SetValue (const char *_value)
 Set the value.
const char * Value () const
 Return the value of this attribute.

Static Public Member Functions

static void EncodeString (const TiXmlString &str, TiXmlString *out)
 Expands entities in a string.
static bool IsWhiteSpaceCondensed ()
 Return the current white space setting.
static void SetCondenseWhiteSpace (bool condense)
 The world does not agree on whether white space should be kept or not.

Static Public Attributes

static const int utf8ByteTable [256]

Static Protected Member Functions

static void ConvertUTF32ToUTF8 (unsigned long input, char *output, int *length)
static const char * GetChar (const char *p, char *_value, int *length, TiXmlEncoding encoding)
static const char * GetEntity (const char *in, char *value, int *length, TiXmlEncoding encoding)
static int IsAlpha (unsigned char anyByte, TiXmlEncoding encoding)
static int IsAlphaNum (unsigned char anyByte, TiXmlEncoding encoding)
static bool IsWhiteSpace (int c)
static bool IsWhiteSpace (char c)
static const char * ReadName (const char *p, TiXmlString *name, TiXmlEncoding encoding)
static const char * ReadText (const char *in, TiXmlString *text, bool ignoreWhiteSpace, const char *endTag, bool ignoreCase, TiXmlEncoding encoding)
static const char * SkipWhiteSpace (const char *, TiXmlEncoding encoding)
static bool StringEqual (const char *p, const char *endTag, bool ignoreCase, TiXmlEncoding encoding)
static int ToLower (int v, TiXmlEncoding encoding)

Protected Attributes

TiXmlCursor location
void * userData
 Field containing a generic user pointer.

Static Protected Attributes

static const char * errorString [TIXML_ERROR_STRING_COUNT]

Friends

class TiXmlAttributeSet

Detailed Description

An attribute is a name-value pair.

Elements have an arbitrary number of attributes, each with a unique name.

Note:
The attributes are not TiXmlNodes, since they are not part of the tinyXML document object model. There are other suggested ways to look at this problem.

Definition at line 779 of file tinyxml.h.


Constructor & Destructor Documentation

TiXmlAttribute::TiXmlAttribute ( ) [inline]

Construct an empty attribute.

Definition at line 785 of file tinyxml.h.

TiXmlAttribute::TiXmlAttribute ( const char *  _name,
const char *  _value 
) [inline]

Construct an attribute with a name and value.

Definition at line 803 of file tinyxml.h.


Member Function Documentation

int TiXmlBase::Column ( ) const [inline, inherited]

See Row()

Definition at line 245 of file tinyxml.h.

double TiXmlAttribute::DoubleValue ( ) const

Return the value of this attribute, converted to a double.

Definition at line 1232 of file tinyxml.cpp.

void TiXmlBase::EncodeString ( const TiXmlString &  str,
TiXmlString *  out 
) [static, inherited]

Expands entities in a string.

Note this should not contian the tag's '<', '>', etc, or they will be transformed into entities!

Definition at line 52 of file tinyxml.cpp.

Referenced by TiXmlText::Print(), and TiXmlPrinter::Visit().

const void* TiXmlBase::GetUserData ( ) const [inline, inherited]

Get a pointer to arbitrary user data.

Definition at line 249 of file tinyxml.h.

References TiXmlBase::userData.

void* TiXmlBase::GetUserData ( ) [inline, inherited]

Get a pointer to arbitrary user data.

Definition at line 248 of file tinyxml.h.

References TiXmlBase::userData.

int TiXmlAttribute::IntValue ( ) const

Return the value of this attribute, converted to an integer.

Definition at line 1227 of file tinyxml.cpp.

static bool TiXmlBase::IsWhiteSpaceCondensed ( ) [inline, static, inherited]

Return the current white space setting.

Definition at line 224 of file tinyxml.h.

const char* TiXmlAttribute::Name ( ) const [inline]

Return the name of this attribute.

Definition at line 811 of file tinyxml.h.

const TiXmlAttribute * TiXmlAttribute::Next ( ) const

Get the next sibling attribute in the DOM. Returns null at end.

Definition at line 1125 of file tinyxml.cpp.

Referenced by TiXmlElement::Print(), and TiXmlPrinter::VisitEnter().

const TiXmlAttribute * TiXmlAttribute::Previous ( ) const

Get the previous sibling attribute in the DOM. Returns null at beginning.

Definition at line 1145 of file tinyxml.cpp.

virtual void TiXmlAttribute::Print ( FILE *  cfile,
int  depth 
) const [inline, virtual]

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.)

Implements TiXmlBase.

Definition at line 870 of file tinyxml.h.

Referenced by TiXmlPrinter::VisitEnter().

int TiXmlAttribute::QueryDoubleValue ( double *  _value) const

QueryDoubleValue examines the value string. See QueryIntValue().

Definition at line 1198 of file tinyxml.cpp.

Referenced by TiXmlElement::Attribute(), and TiXmlElement::QueryDoubleAttribute().

int TiXmlAttribute::QueryIntValue ( int *  _value) const

QueryIntValue examines the value string.

It is an alternative to the IntValue() method with richer error checking. If the value is an integer, it is stored in 'value' and the call returns TIXML_SUCCESS. If it is not an integer, it returns TIXML_WRONG_TYPE.

A specialized but useful call. Note that for success it returns 0, which is the opposite of almost all other TinyXml calls.

Definition at line 1191 of file tinyxml.cpp.

Referenced by TiXmlElement::Attribute(), and TiXmlElement::QueryIntAttribute().

int TiXmlBase::Row ( ) const [inline, inherited]

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()

Definition at line 244 of file tinyxml.h.

static void TiXmlBase::SetCondenseWhiteSpace ( bool  condense) [inline, static, inherited]

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.

Definition at line 221 of file tinyxml.h.

void TiXmlAttribute::SetDoubleValue ( double  _value)

Set the value from a double.

Definition at line 1216 of file tinyxml.cpp.

References SetValue().

Referenced by TiXmlElement::SetDoubleAttribute().

void TiXmlAttribute::SetIntValue ( int  _value)

Set the value from an integer.

Definition at line 1205 of file tinyxml.cpp.

References SetValue().

Referenced by TiXmlElement::SetAttribute().

void TiXmlAttribute::SetName ( const char *  _name) [inline]

Set the name of this attribute.

Definition at line 835 of file tinyxml.h.

void TiXmlBase::SetUserData ( void *  user) [inline, inherited]

Set a pointer to arbitrary user data.

Definition at line 247 of file tinyxml.h.

References TiXmlBase::userData.

void TiXmlAttribute::SetValue ( const char *  _value) [inline]

Set the value.

Definition at line 836 of file tinyxml.h.

Referenced by TiXmlElement::SetAttribute(), SetDoubleValue(), and SetIntValue().

const char* TiXmlAttribute::Value ( ) const [inline]

Return the value of this attribute.

Definition at line 812 of file tinyxml.h.

Referenced by TiXmlElement::Attribute().


Member Data Documentation

const char * TiXmlBase::errorString [static, protected, inherited]
Initial value:
{
  "No error",
  "Error",
  "Failed to open file",
  "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.",
  "Error null (0) or unexpected EOF found in input stream.",
  "Error parsing CDATA.",
  "Error when TiXmlDocument added to document, because TiXmlDocument can only be at the root.",
}

Definition at line 371 of file tinyxml.h.

void* TiXmlBase::userData [protected, inherited]

Field containing a generic user pointer.

Definition at line 376 of file tinyxml.h.

Referenced by TiXmlBase::GetUserData(), and TiXmlBase::SetUserData().

const int TiXmlBase::utf8ByteTable [static, inherited]
Initial value:
{
  
    1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  
    1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  
    1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  
    1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  
    1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  
    1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  
    1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  
    1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  
    1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  
    1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  
    1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  
    1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  
    1,  1,  2,  2,  2,  2,  2,  2,  2,  2,  2,  2,  2,  2,  2,  2,  
    2,  2,  2,  2,  2,  2,  2,  2,  2,  2,  2,  2,  2,  2,  2,  2,  
    3,  3,  3,  3,  3,  3,  3,  3,  3,  3,  3,  3,  3,  3,  3,  3,  
    4,  4,  4,  4,  4,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1 
}

Definition at line 253 of file tinyxml.h.


The documentation for this class was generated from the following files:
 All Classes Functions Variables Enumerations