Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages | Examples

TiXmlAttribute Class Reference

#include <tinyxml.h>

Inheritance diagram for TiXmlAttribute:

Inheritance graph
[legend]
Collaboration diagram for TiXmlAttribute:

Collaboration graph
[legend]
List of all members.

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 693 of file tinyxml.h.

Public 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_EMBEDDED_NULL, TIXML_ERROR_PARSING_CDATA,
  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.
const char * Name () const
 Return the name of this attribute.
const char * Value () const
 Return the value of this attribute.
int IntValue () const
 Return the value of this attribute, converted to an integer.
double DoubleValue () const
 Return the value of this attribute, converted to a double.
const TIXML_STRING & NameTStr () const
int QueryIntValue (int *_value) const
 QueryIntValue examines the value string.
int QueryDoubleValue (double *_value) const
 QueryDoubleValue examines the value string. See QueryIntValue().
void SetName (const char *_name)
 Set the name of this attribute.
void SetValue (const char *_value)
 Set the value.
void SetIntValue (int _value)
 Set the value from an integer.
void SetDoubleValue (double _value)
 Set the value from a double.
const TiXmlAttribute * Next () const
 Get the next sibling attribute in the DOM. Returns null at end.
TiXmlAttribute * Next ()
const TiXmlAttribute * Previous () const
 Get the previous sibling attribute in the DOM. Returns null at beginning.
TiXmlAttribute * Previous ()
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)
virtual void Print (FILE *cfile, int depth) const
 All TinyXml classes can print themselves to a filestream.
virtual void StreamOut (TIXML_OSTREAM *out) const
void SetDocument (TiXmlDocument *doc)
int Row () const
 Return the position, in the original source file, of this node or attribute.
int Column () const
 See Row().
void SetUserData (void *user)
void * GetUserData ()

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.

Static Public Attributes

const int utf8ByteTable [256]

Static Protected Member Functions

const char * SkipWhiteSpace (const char *, TiXmlEncoding encoding)
bool IsWhiteSpace (char c)
bool IsWhiteSpace (int c)
const char * ReadName (const char *p, TIXML_STRING *name, TiXmlEncoding encoding)
const char * ReadText (const char *in, TIXML_STRING *text, bool ignoreWhiteSpace, const char *endTag, bool ignoreCase, TiXmlEncoding encoding)
const char * GetEntity (const char *in, char *value, int *length, TiXmlEncoding encoding)
const char * GetChar (const char *p, char *_value, int *length, TiXmlEncoding encoding)
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, TiXmlEncoding encoding)
int IsAlpha (unsigned char anyByte, TiXmlEncoding encoding)
int IsAlphaNum (unsigned char anyByte, TiXmlEncoding encoding)
int ToLower (int v, TiXmlEncoding encoding)
void ConvertUTF32ToUTF8 (unsigned long input, char *output, int *length)

Protected Attributes

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

Static Protected Attributes

const char * errorString [TIXML_ERROR_STRING_COUNT]

Private Member Functions

 TiXmlAttribute (const TiXmlAttribute &)
void operator= (const TiXmlAttribute &base)

Private Attributes

TiXmlDocument * document
TIXML_STRING name
TIXML_STRING value
TiXmlAttribute * prev
TiXmlAttribute * next

Friends

class TiXmlAttributeSet

Member Enumeration Documentation

anonymous enum [inherited]
 

Enumeration values:
TIXML_NO_ERROR 
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_EMBEDDED_NULL 
TIXML_ERROR_PARSING_CDATA 
TIXML_ERROR_STRING_COUNT 

Definition at line 209 of file tinyxml.h.

Constructor & Destructor Documentation

TiXmlAttribute::TiXmlAttribute (   )  [inline]
 

Construct an empty attribute.

Definition at line 699 of file tinyxml.h.

References document, next, and prev.

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

Construct an attribute with a name and value.

Definition at line 717 of file tinyxml.h.

References document, name, next, prev, and value.

TiXmlAttribute::TiXmlAttribute (  const TiXmlAttribute &   )  [private]
 

Member Function Documentation

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

See Row().

Definition at line 196 of file tinyxml.h.

Referenced by main().

void TiXmlBase::ConvertUTF32ToUTF8 (  unsigned long  input,
char *  output,
int *  length
)  [static, protected, inherited]
 

Definition at line 87 of file tinyxmlparser.cpp.

Referenced by TiXmlBase::GetEntity().

double TiXmlAttribute::DoubleValue (   )  const
 

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

Definition at line 1339 of file tinyxml.cpp.

References value.

const char* TiXmlBase::GetChar (  const char *  p,
char *  _value,
int *  length,
TiXmlEncoding  encoding
)  [inline, static, protected, inherited]
 

Definition at line 283 of file tinyxml.h.

Referenced by TiXmlBase::ReadText().

const char * TiXmlBase::GetEntity (  const char *  in,
char *  value,
int *  length,
TiXmlEncoding  encoding
)  [static, protected, inherited]
 

Definition at line 427 of file tinyxmlparser.cpp.

References TiXmlBase::Entity::chr, TiXmlBase::ConvertUTF32ToUTF8(), TiXmlBase::entity, TiXmlBase::Entity::strLength, TIXML_STRING, and value.

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

Definition at line 199 of file tinyxml.h.

int TiXmlAttribute::IntValue (   )  const
 

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

Definition at line 1334 of file tinyxml.cpp.

References value.

int TiXmlBase::IsAlpha (  unsigned char  anyByte,
TiXmlEncoding  encoding
)  [static, protected, inherited]
 

Definition at line 128 of file tinyxmlparser.cpp.

Referenced by TiXmlNode::Identify(), and TiXmlBase::ReadName().

int TiXmlBase::IsAlphaNum (  unsigned char  anyByte,
TiXmlEncoding  encoding
)  [static, protected, inherited]
 

Definition at line 149 of file tinyxmlparser.cpp.

Referenced by TiXmlBase::ReadName().

bool TiXmlBase::IsWhiteSpace (  int  c  )  [inline, static, protected, inherited]
 

Definition at line 248 of file tinyxml.h.

bool TiXmlBase::IsWhiteSpace (  char  c  )  [inline, static, protected, inherited]
 

Definition at line 244 of file tinyxml.h.

Referenced by TiXmlText::Blank(), TiXmlDeclaration::Parse(), Parse(), TiXmlBase::ReadText(), and TiXmlBase::SkipWhiteSpace().

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

Return the current white space setting.

Definition at line 175 of file tinyxml.h.

Referenced by TiXmlElement::ReadValue().

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

Return the name of this attribute.

Definition at line 725 of file tinyxml.h.

References name.

Referenced by TiXmlAttributeSet::Add(), and TiXmlElement::CopyTo().

const TIXML_STRING& TiXmlAttribute::NameTStr (   )  const [inline]
 

Definition at line 731 of file tinyxml.h.

References TIXML_STRING.

Referenced by TiXmlElement::Parse().

TiXmlAttribute * TiXmlAttribute::Next (   ) 
 

Definition at line 1238 of file tinyxml.cpp.

References name, next, and value.

const TiXmlAttribute * TiXmlAttribute::Next (   )  const
 

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

Definition at line 1229 of file tinyxml.cpp.

References name, next, and value.

Referenced by TiXmlElement::CopyTo(), TiXmlElement::Print(), and TiXmlElement::StreamOut().

bool TiXmlAttribute::operator< (  const TiXmlAttribute &  rhs  )  const [inline]
 

Definition at line 767 of file tinyxml.h.

References name.

void TiXmlAttribute::operator= (  const TiXmlAttribute &  base  )  [private]
 

bool TiXmlAttribute::operator== (  const TiXmlAttribute &  rhs  )  const [inline]
 

Definition at line 766 of file tinyxml.h.

References name.

bool TiXmlAttribute::operator> (  const TiXmlAttribute &  rhs  )  const [inline]
 

Definition at line 768 of file tinyxml.h.

References name.

const char * TiXmlAttribute::Parse (  const char *  p,
TiXmlParsingData *  data,
TiXmlEncoding  encoding
)  [virtual]
 

Implements TiXmlBase.

Definition at line 1326 of file tinyxmlparser.cpp.

References document, TiXmlBase::IsWhiteSpace(), name, TiXmlBase::ReadName(), TiXmlBase::ReadText(), TiXmlDocument::SetError(), TiXmlBase::SkipWhiteSpace(), TiXmlDocument::TabSize(), and value.

Referenced by TiXmlDeclaration::Parse(), and TiXmlElement::Parse().

TiXmlAttribute * TiXmlAttribute::Previous (   ) 
 

Definition at line 1256 of file tinyxml.cpp.

References name, prev, and value.

const TiXmlAttribute * TiXmlAttribute::Previous (   )  const
 

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

Definition at line 1247 of file tinyxml.cpp.

References name, prev, and value.

void TiXmlAttribute::Print (  FILE *  cfile,
int  depth
)  const [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.)

Implements TiXmlBase.

Definition at line 1265 of file tinyxml.cpp.

References name, TiXmlBase::PutString(), TIXML_STRING, and value.

Referenced by TiXmlElement::Print().

void TiXmlBase::PutString (  const TIXML_STRING &  str,
TIXML_STRING *  out
)  [static, protected, inherited]
 

Definition at line 43 of file tinyxml.cpp.

References TiXmlBase::entity.

void TiXmlBase::PutString (  const TIXML_STRING &  str,
TIXML_OSTREAM *  out
)  [static, protected, inherited]
 

Definition at line 36 of file tinyxml.cpp.

References TIXML_STRING.

Referenced by TiXmlText::Print(), Print(), TiXmlDeclaration::StreamOut(), TiXmlText::StreamOut(), and StreamOut().

int TiXmlAttribute::QueryDoubleValue (  double *  _value  )  const
 

QueryDoubleValue examines the value string. See QueryIntValue().

Definition at line 1304 of file tinyxml.cpp.

References value.

Referenced by 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 1297 of file tinyxml.cpp.

References value.

Referenced by TiXmlElement::QueryIntAttribute().

const char * TiXmlBase::ReadName (  const char *  p,
TIXML_STRING *  name,
TiXmlEncoding  encoding
)  [static, protected, inherited]
 

Definition at line 397 of file tinyxmlparser.cpp.

References TiXmlBase::IsAlpha(), and TiXmlBase::IsAlphaNum().

Referenced by Parse(), and TiXmlElement::Parse().

const char * TiXmlBase::ReadText (  const char *  in,
TIXML_STRING *  text,
bool  ignoreWhiteSpace,
const char *  endTag,
bool  ignoreCase,
TiXmlEncoding  encoding
)  [static, protected, inherited]
 

Definition at line 561 of file tinyxmlparser.cpp.

References TiXmlBase::GetChar(), TiXmlBase::IsWhiteSpace(), TiXmlBase::SkipWhiteSpace(), and TiXmlBase::StringEqual().

Referenced by TiXmlText::Parse(), Parse(), and TiXmlComment::Parse().

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 195 of file tinyxml.h.

Referenced by main().

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 values is not thread safe.

Definition at line 172 of file tinyxml.h.

Referenced by main().

void TiXmlAttribute::SetDocument (  TiXmlDocument *  doc  )  [inline]
 

Definition at line 781 of file tinyxml.h.

References document.

Referenced by TiXmlElement::Parse().

void TiXmlAttribute::SetDoubleValue (  double  _value  ) 
 

Set the value from a double.

Definition at line 1322 of file tinyxml.cpp.

References SetValue().

void TiXmlAttribute::SetIntValue (  int  _value  ) 
 

Set the value from an integer.

Definition at line 1311 of file tinyxml.cpp.

References SetValue().

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

Set the name of this attribute.

Definition at line 746 of file tinyxml.h.

References name.

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

Definition at line 198 of file tinyxml.h.

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

Set the value.

Definition at line 747 of file tinyxml.h.

References value.

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

const char * TiXmlBase::SkipWhiteSpace (  const char *  ,
TiXmlEncoding  encoding
)  [static, protected, inherited]
 

Definition at line 313 of file tinyxmlparser.cpp.

References TiXmlBase::IsWhiteSpace(), TIXML_UTF_LEAD_0, and TIXML_UTF_LEAD_1.

Referenced by TiXmlNode::Identify(), TiXmlDeclaration::Parse(), Parse(), TiXmlComment::Parse(), TiXmlUnknown::Parse(), TiXmlElement::Parse(), TiXmlDocument::Parse(), TiXmlBase::ReadText(), and TiXmlElement::ReadValue().

void TiXmlAttribute::StreamOut (  TIXML_OSTREAM *  out  )  const [virtual]
 

Implements TiXmlBase.

Definition at line 1279 of file tinyxml.cpp.

References name, TiXmlBase::PutString(), and value.

Referenced by TiXmlElement::StreamOut().

bool TiXmlBase::StringEqual (  const char *  p,
const char *  endTag,
bool  ignoreCase,
TiXmlEncoding  encoding
)  [static, protected, inherited]
 

Definition at line 521 of file tinyxmlparser.cpp.

References TiXmlBase::ToLower().

Referenced by TiXmlNode::Identify(), TiXmlDeclaration::Parse(), TiXmlText::Parse(), TiXmlComment::Parse(), TiXmlElement::Parse(), TiXmlDocument::Parse(), TiXmlBase::ReadText(), and TiXmlElement::ReadValue().

int TiXmlBase::ToLower (  int  v,
TiXmlEncoding  encoding
)  [inline, static, protected, inherited]
 

Definition at line 344 of file tinyxml.h.

Referenced by TiXmlBase::StringEqual().

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

Return the value of this attribute.

Definition at line 726 of file tinyxml.h.

References value.

Referenced by TiXmlElement::Attribute(), TiXmlElement::CopyTo(), TiXmlDeclaration::Parse(), and TiXmlElement::Parse().

Friends And Related Function Documentation

friend class TiXmlAttributeSet [friend]
 

Definition at line 695 of file tinyxml.h.

Member Data Documentation

TiXmlDocument* TiXmlAttribute::document [private]
 

Definition at line 787 of file tinyxml.h.

Referenced by Parse(), SetDocument(), and TiXmlAttribute().

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

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.",
        "Error null (0) or unexpected EOF found in input stream.",
        "Error parsing CDATA.",
}

Definition at line 34 of file tinyxmlerror.cpp.

TiXmlCursor TiXmlBase::location [protected, inherited]
 

Definition at line 335 of file tinyxml.h.

TIXML_STRING TiXmlAttribute::name [private]
 

Definition at line 788 of file tinyxml.h.

Referenced by TiXmlAttributeSet::Find(), Name(), Next(), operator<(), operator==(), operator>(), Parse(), Previous(), Print(), SetName(), StreamOut(), and TiXmlAttribute().

TiXmlAttribute* TiXmlAttribute::next [private]
 

Definition at line 791 of file tinyxml.h.

Referenced by TiXmlAttributeSet::Add(), TiXmlAttributeSet::Find(), Next(), TiXmlAttributeSet::Remove(), TiXmlAttribute(), TiXmlAttributeSet::TiXmlAttributeSet(), and TiXmlAttributeSet::~TiXmlAttributeSet().

TiXmlAttribute* TiXmlAttribute::prev [private]
 

Definition at line 790 of file tinyxml.h.

Referenced by TiXmlAttributeSet::Add(), Previous(), TiXmlAttributeSet::Remove(), TiXmlAttribute(), TiXmlAttributeSet::TiXmlAttributeSet(), and TiXmlAttributeSet::~TiXmlAttributeSet().

void* TiXmlBase::userData [protected, inherited]
 

Field containing a generic user pointer.

Definition at line 338 of file tinyxml.h.

Referenced by TiXmlNode::CopyTo().

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 65 of file tinyxmlparser.cpp.

TIXML_STRING TiXmlAttribute::value [private]
 

Definition at line 789 of file tinyxml.h.

Referenced by DoubleValue(), IntValue(), Next(), Parse(), Previous(), Print(), QueryDoubleValue(), QueryIntValue(), SetValue(), StreamOut(), TiXmlAttribute(), and Value().

The documentation for this class was generated from the following files:
Generated on Wed Sep 5 12:54:43 2007 for DSACSS Operational Code by  doxygen 1.3.9.1