Nebula
Loading...
Searching...
No Matches
TiXmlText Class Reference

#include <tinyxml.h>

Detailed Description

XML text.

A text node can have 2 ways to output the next. "normal" output and CDATA. It will default to the mode it was parsed from the XML file and you generally want to leave it alone, but you can change the output mode with SetCDATA() and query it with CDATA().

Inherits TiXmlNode.

Public Member Functions

 TiXmlText (const char *initValue)
 Constructor for text element.
 
virtual ~TiXmlText ()
 
 TiXmlText (const TiXmlText &copy)
 
void operator= (const TiXmlText &base)
 
virtual void Print (const Ptr< IO::TextWriter > &textWriter, int depth) const
 Write this text object to a FILE stream.
 
bool CDATA ()
 Queries whether this represents text using a CDATA section.
 
void SetCDATA (bool _cdata)
 Turns on or off a CDATA representation of text.
 
bool Raw ()
 Queries whether the text in this node is raw, meaning that it shouldn't be treated by any encoding.
 
void SetRaw (bool _raw)
 Turns on or off a raw representation of text.
 
virtual const char * Parse (const char *p, TiXmlParsingData *data, TiXmlEncoding encoding)
 
virtual const TiXmlTextToText () const
 Cast to a more defined type. Will return null not of the requested type.
 
virtual TiXmlTextToText ()
 Cast to a more defined type. Will return null not of the requested type.
 
- Public Member Functions inherited from TiXmlNode
virtual ~TiXmlNode ()
 
const char * Value () const
 The meaning of 'value' changes for the specific type of TiXmlNode.
 
void SetValue (const char *_value)
 Changes the value of the node.
 
void Clear ()
 Delete all the children of this node. Does not affect 'this'.
 
TiXmlNodeParent ()
 One step up the DOM.
 
const TiXmlNodeParent () const
 
const TiXmlNodeFirstChild () const
 The first child of this node. Will be null if there are no children.
 
TiXmlNodeFirstChild ()
 
const TiXmlNodeFirstChild (const char *value) const
 The first child of this node with the matching 'value'. Will be null if none found.
 
TiXmlNodeFirstChild (const char *value)
 The first child of this node with the matching 'value'. Will be null if none found.
 
const TiXmlNodeLastChild () const
 
TiXmlNodeLastChild ()
 The last child of this node. Will be null if there are no children.
 
const TiXmlNodeLastChild (const char *value) const
 
TiXmlNodeLastChild (const char *value)
 The last child of this node matching 'value'. Will be null if there are no children.
 
const TiXmlNodeIterateChildren (const TiXmlNode *previous) const
 An alternate way to walk the children of a node.
 
TiXmlNodeIterateChildren (TiXmlNode *previous)
 
const TiXmlNodeIterateChildren (const char *value, const TiXmlNode *previous) const
 This flavor of IterateChildren searches for children with a particular 'value'.
 
TiXmlNodeIterateChildren (const char *value, TiXmlNode *previous)
 
TiXmlNodeInsertEndChild (const TiXmlNode &addThis)
 Add a new node related to this.
 
TiXmlNodeLinkEndChild (TiXmlNode *addThis)
 Add a new node related to this.
 
TiXmlNodeInsertBeforeChild (TiXmlNode *beforeThis, const TiXmlNode &addThis)
 Add a new node related to this.
 
TiXmlNodeInsertAfterChild (TiXmlNode *afterThis, const TiXmlNode &addThis)
 Add a new node related to this.
 
TiXmlNodeReplaceChild (TiXmlNode *replaceThis, const TiXmlNode &withThis)
 Replace a child of this node.
 
bool RemoveChild (TiXmlNode *removeThis)
 Delete a child of this node.
 
const TiXmlNodePreviousSibling () const
 Navigate to a sibling node.
 
TiXmlNodePreviousSibling ()
 
const TiXmlNodePreviousSibling (const char *) const
 Navigate to a sibling node.
 
TiXmlNodePreviousSibling (const char *)
 
const TiXmlNodeNextSibling () const
 Navigate to a sibling node.
 
TiXmlNodeNextSibling ()
 
const TiXmlNodeNextSibling (const char *) const
 Navigate to a sibling node with the given 'value'.
 
TiXmlNodeNextSibling (const char *)
 
const TiXmlElementNextSiblingElement () const
 Convenience function to get through elements.
 
TiXmlElementNextSiblingElement ()
 
const TiXmlElementNextSiblingElement (const char *) const
 Convenience function to get through elements.
 
TiXmlElementNextSiblingElement (const char *)
 
const TiXmlElementFirstChildElement () const
 Convenience function to get through elements.
 
TiXmlElementFirstChildElement ()
 
const TiXmlElementFirstChildElement (const char *value) const
 Convenience function to get through elements.
 
TiXmlElementFirstChildElement (const char *value)
 
int Type () const
 Query the type (as an enumerated value, above) of this node.
 
const TiXmlDocumentGetDocument () const
 Return a pointer to the Document this node lives in.
 
TiXmlDocumentGetDocument ()
 
bool NoChildren () const
 Returns true if this node has no children.
 
virtual const TiXmlDocumentToDocument () const
 Cast to a more defined type. Will return null if not of the requested type.
 
virtual const TiXmlElementToElement () const
 Cast to a more defined type. Will return null if not of the requested type.
 
virtual const TiXmlCommentToComment () const
 Cast to a more defined type. Will return null if not of the requested type.
 
virtual const TiXmlUnknownToUnknown () const
 Cast to a more defined type. Will return null if not of the requested type.
 
virtual const TiXmlDeclarationToDeclaration () const
 Cast to a more defined type. Will return null if not of the requested type.
 
virtual TiXmlDocumentToDocument ()
 Cast to a more defined type. Will return null if not of the requested type.
 
virtual TiXmlElementToElement ()
 Cast to a more defined type. Will return null if not of the requested type.
 
virtual TiXmlCommentToComment ()
 Cast to a more defined type. Will return null if not of the requested type.
 
virtual TiXmlUnknownToUnknown ()
 Cast to a more defined type. Will return null if not of the requested type.
 
virtual TiXmlDeclarationToDeclaration ()
 Cast to a more defined type. Will return null if not of the requested type.
 
- Public Member Functions inherited from TiXmlBase
 TiXmlBase ()
 
virtual ~TiXmlBase ()
 
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 ()
 

Protected Member Functions

virtual TiXmlNodeClone () const
 [internal use] Creates a new Element and returns it.
 
void CopyTo (TiXmlText *target) const
 
virtual void StreamOut (TIXML_OSTREAM *out) const
 
bool Blank () const
 
- Protected Member Functions inherited from TiXmlNode
 TiXmlNode (NodeType _type)
 
void CopyTo (TiXmlNode *target) const
 
TiXmlNodeIdentify (const char *start, TiXmlEncoding encoding)
 
- Protected Member Functions inherited from TiXmlBase

Private Attributes

bool cdata
 
bool raw
 

Friends

class TiXmlElement
 

Additional Inherited Members

- Public Types inherited from TiXmlNode
enum  NodeType {
  DOCUMENT , ELEMENT , COMMENT , UNKNOWN ,
  TEXT , DECLARATION , TYPECOUNT
}
 The types of XML nodes supported by TinyXml. More...
 
- Public Types inherited from TiXmlBase
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
}
 
- Static Public Member Functions inherited from TiXmlBase
static void SetCondenseWhiteSpace (bool condense)
 The world does not agree on whether white space should be kept or not.
 
static bool IsWhiteSpaceCondensed ()
 Return the current white space setting.
 
- Static Public Attributes inherited from TiXmlBase
static const int utf8ByteTable [256]
 
- Static Protected Member Functions inherited from TiXmlBase
static const char * SkipWhiteSpace (const char *, TiXmlEncoding encoding)
 
static bool IsWhiteSpace (char c)
 
static bool IsWhiteSpace (int c)
 
static const char * ReadName (const char *p, TIXML_STRING *name, TiXmlEncoding encoding)
 
static const char * ReadText (const char *in, TIXML_STRING *text, bool ignoreWhiteSpace, const char *endTag, bool ignoreCase, TiXmlEncoding encoding)
 
static const char * GetEntity (const char *in, char *value, int *length, TiXmlEncoding encoding)
 
static const char * GetChar (const char *p, char *_value, int *length, TiXmlEncoding encoding)
 
static void PutString (const TIXML_STRING &str, TIXML_OSTREAM *out)
 
static void PutString (const TIXML_STRING &str, TIXML_STRING *out)
 
static bool StringEqual (const char *p, const char *endTag, bool ignoreCase, TiXmlEncoding encoding)
 
static int IsAlpha (unsigned char anyByte, TiXmlEncoding encoding)
 
static int IsAlphaNum (unsigned char anyByte, TiXmlEncoding encoding)
 
static int ToLower (int v, TiXmlEncoding encoding)
 
static void ConvertUTF32ToUTF8 (unsigned long input, char *output, int *length)
 
- Protected Attributes inherited from TiXmlNode
TiXmlNodeparent
 
NodeType type
 
TiXmlNodefirstChild
 
TiXmlNodelastChild
 
TIXML_STRING value
 
TiXmlNodeprev
 
TiXmlNodenext
 
- Protected Attributes inherited from TiXmlBase
TiXmlCursor location
 
void * userData
 Field containing a generic user pointer.
 
- Static Protected Attributes inherited from TiXmlBase
static const char * errorString [TIXML_ERROR_STRING_COUNT]
 

Constructor & Destructor Documentation

◆ TiXmlText() [1/2]

TiXmlText::TiXmlText ( const char * initValue)
inline

Constructor for text element.

By default, it is treated as normal, encoded text. If you want it be output as a CDATA text element, set the parameter _cdata to 'true'

◆ ~TiXmlText()

virtual TiXmlText::~TiXmlText ( )
inlinevirtual

◆ TiXmlText() [2/2]

TiXmlText::TiXmlText ( const TiXmlText & copy)
inline

Member Function Documentation

◆ Blank()

bool TiXmlText::Blank ( ) const
protected

◆ CDATA()

bool TiXmlText::CDATA ( )
inline

Queries whether this represents text using a CDATA section.

◆ Clone()

TiXmlNode * TiXmlText::Clone ( ) const
protectedvirtual

[internal use] Creates a new Element and returns it.

Implements TiXmlNode.

◆ CopyTo()

void TiXmlText::CopyTo ( TiXmlText * target) const
protected

◆ operator=()

void TiXmlText::operator= ( const TiXmlText & base)
inline

◆ Parse()

const char * TiXmlText::Parse ( const char * p,
TiXmlParsingData * data,
TiXmlEncoding encoding )
virtual

Implements TiXmlBase.

◆ Print()

void TiXmlText::Print ( const Ptr< IO::TextWriter > & textWriter,
int depth ) const
virtual

Write this text object to a FILE stream.

Implements TiXmlBase.

◆ Raw()

bool TiXmlText::Raw ( )
inline

Queries whether the text in this node is raw, meaning that it shouldn't be treated by any encoding.

◆ SetCDATA()

void TiXmlText::SetCDATA ( bool _cdata)
inline

Turns on or off a CDATA representation of text.

◆ SetRaw()

void TiXmlText::SetRaw ( bool _raw)
inline

Turns on or off a raw representation of text.

◆ StreamOut()

void TiXmlText::StreamOut ( TIXML_OSTREAM * out) const
protectedvirtual

Implements TiXmlBase.

◆ ToText() [1/2]

virtual TiXmlText * TiXmlText::ToText ( )
inlinevirtual

Cast to a more defined type. Will return null not of the requested type.

Reimplemented from TiXmlNode.

◆ ToText() [2/2]

virtual const TiXmlText * TiXmlText::ToText ( ) const
inlinevirtual

Cast to a more defined type. Will return null not of the requested type.

Reimplemented from TiXmlNode.

Friends And Related Symbol Documentation

◆ TiXmlElement

friend class TiXmlElement
friend

Member Data Documentation

◆ cdata

bool TiXmlText::cdata
private

◆ raw

bool TiXmlText::raw
private

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