Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

XMLStackComment Class Template Reference

Represents a comment in the XML. More...

#include <XMLStack.h>

Inheritance diagram for XMLStackComment::

XMLStackNode List of all members.

Public Types

typedef XMLStackComment<_E,
_Tr, _A> 
_XMLStackComment

Public Methods

 XMLStackComment (_XMLStackDocument *Doc, const _XMLStackString &Data)
 Constructor. More...

virtual ~XMLStackComment ()
 Destructor.

virtual void setValue (const _XMLStackString &Value)
 Replaces the textual data defined in the constructor.

virtual void setValue (unsigned long Value)
virtual void setValue (long Value)
virtual void setValue (unsigned int Value)
virtual void setValue (int Value)
virtual void setValue (unsigned short Value)
virtual void setValue (short Value)
virtual void setValue (signed char Value)
virtual void setValue (char Value)
virtual void setValue (unsigned char Value)
virtual void setValue (double Value, int Scale=6)
virtual void setValue (float Value, int Scale=6)
_XMLStackCommentoperator= (const _XMLStackString &Value)
 Convenience operator for setValue().

_XMLStackCommentoperator= (unsigned long &Value)
 Convenience operator for setValue().

_XMLStackCommentoperator= (long Value)
 Convenience operator for setValue().

_XMLStackCommentoperator= (unsigned int Value)
 Convenience operator for setValue().

_XMLStackCommentoperator= (int Value)
 Convenience operator for setValue().

_XMLStackCommentoperator= (unsigned short Value)
 Convenience operator for setValue().

_XMLStackCommentoperator= (short Value)
 Convenience operator for setValue().

_XMLStackCommentoperator= (signed char Value)
 Convenience operator for setValue().

_XMLStackCommentoperator= (char Value)
 Convenience operator for setValue().

_XMLStackCommentoperator= (unsigned char Value)
 Convenience operator for setValue().

_XMLStackCommentoperator= (double Value)
 Convenience operator for setValue().

_XMLStackCommentoperator= (float Value)
 Convenience operator for setValue().


Protected Methods

virtual void popped (void)
virtual _XMLStackNodeclone (void) const

Protected Attributes

_XMLStackString m_Text

Detailed Description

template<class _E, class _Tr = std::char_traits<_E>, class _A = std::allocator<_E>> class XMLStackComment

Represents a comment in the XML.

Comments are not interpreted by XML parsers. The only requirement is that the character sequence "--" does not appear in the comment, since that is used for the ending delimiter. Along the same lines, the comment cannot end with a single dash - either, since that will interfere with the ending delimiter.

Definition at line 1492 of file XMLStack.h.


Member Typedef Documentation

template<class _E, class _Tr = std::char_traits<_E>, class _A = std::allocator<_E>>
typedef XMLStackComment<_E, _Tr, _A> XMLStackComment<_E, _Tr, _A>::_XMLStackComment<_E, _Tr, _A>
 

Definition at line 1495 of file XMLStack.h.

Referenced by clone(), and XMLStackDocument::pushComment().


Constructor & Destructor Documentation

template<class _E, class _Tr = std::char_traits<_E>, class _A = std::allocator<_E>>
XMLStackComment<_E, _Tr, _A>::XMLStackComment<_E, _Tr, _A> ( _XMLStackDocument * Doc,
const _XMLStackString & Data ) [inline]
 

Constructor.

Parameters:
Doc   The XMLStackDocument instance this node belongs to.
Data   The textual data that will be written out to the XML buffer as a comment.
Exceptions:
XMLStackException   Thrown if the delimiter "--" appears in the text or the comment sends with a single dash and _DEBUG is defined.

Definition at line 1507 of file XMLStack.h.

template<class _E, class _Tr = std::char_traits<_E>, class _A = std::allocator<_E>>
XMLStackComment<_E, _Tr, _A>::~XMLStackComment<_E, _Tr, _A> ( ) [inline, virtual]
 

Destructor.

Definition at line 1514 of file XMLStack.h.


Member Function Documentation

template<class _E, class _Tr = std::char_traits<_E>, class _A = std::allocator<_E>>
_XMLStackNode * XMLStackComment<_E, _Tr, _A>::clone ( void ) const [inline, protected, virtual]
 

Reimplemented from XMLStackNode.

Definition at line 1637 of file XMLStack.h.

template<class _E, class _Tr = std::char_traits<_E>, class _A = std::allocator<_E>>
_XMLStackComment<_E, _Tr, _A> & XMLStackComment<_E, _Tr, _A>::operator= ( float Value ) [inline]
 

Convenience operator for setValue().

Reimplemented from XMLStackNode.

Definition at line 1614 of file XMLStack.h.

template<class _E, class _Tr = std::char_traits<_E>, class _A = std::allocator<_E>>
_XMLStackComment<_E, _Tr, _A> & XMLStackComment<_E, _Tr, _A>::operator= ( double Value ) [inline]
 

Convenience operator for setValue().

Reimplemented from XMLStackNode.

Definition at line 1607 of file XMLStack.h.

template<class _E, class _Tr = std::char_traits<_E>, class _A = std::allocator<_E>>
_XMLStackComment<_E, _Tr, _A> & XMLStackComment<_E, _Tr, _A>::operator= ( unsigned char Value ) [inline]
 

Convenience operator for setValue().

Reimplemented from XMLStackNode.

Definition at line 1600 of file XMLStack.h.

template<class _E, class _Tr = std::char_traits<_E>, class _A = std::allocator<_E>>
_XMLStackComment<_E, _Tr, _A> & XMLStackComment<_E, _Tr, _A>::operator= ( char Value ) [inline]
 

Convenience operator for setValue().

Reimplemented from XMLStackNode.

Definition at line 1593 of file XMLStack.h.

template<class _E, class _Tr = std::char_traits<_E>, class _A = std::allocator<_E>>
_XMLStackComment<_E, _Tr, _A> & XMLStackComment<_E, _Tr, _A>::operator= ( signed char Value ) [inline]
 

Convenience operator for setValue().

Reimplemented from XMLStackNode.

Definition at line 1586 of file XMLStack.h.

template<class _E, class _Tr = std::char_traits<_E>, class _A = std::allocator<_E>>
_XMLStackComment<_E, _Tr, _A> & XMLStackComment<_E, _Tr, _A>::operator= ( short Value ) [inline]
 

Convenience operator for setValue().

Reimplemented from XMLStackNode.

Definition at line 1579 of file XMLStack.h.

template<class _E, class _Tr = std::char_traits<_E>, class _A = std::allocator<_E>>
_XMLStackComment<_E, _Tr, _A> & XMLStackComment<_E, _Tr, _A>::operator= ( unsigned short Value ) [inline]
 

Convenience operator for setValue().

Reimplemented from XMLStackNode.

Definition at line 1572 of file XMLStack.h.

template<class _E, class _Tr = std::char_traits<_E>, class _A = std::allocator<_E>>
_XMLStackComment<_E, _Tr, _A> & XMLStackComment<_E, _Tr, _A>::operator= ( int Value ) [inline]
 

Convenience operator for setValue().

Reimplemented from XMLStackNode.

Definition at line 1565 of file XMLStack.h.

template<class _E, class _Tr = std::char_traits<_E>, class _A = std::allocator<_E>>
_XMLStackComment<_E, _Tr, _A> & XMLStackComment<_E, _Tr, _A>::operator= ( unsigned int Value ) [inline]
 

Convenience operator for setValue().

Reimplemented from XMLStackNode.

Definition at line 1558 of file XMLStack.h.

template<class _E, class _Tr = std::char_traits<_E>, class _A = std::allocator<_E>>
_XMLStackComment<_E, _Tr, _A> & XMLStackComment<_E, _Tr, _A>::operator= ( long Value ) [inline]
 

Convenience operator for setValue().

Reimplemented from XMLStackNode.

Definition at line 1551 of file XMLStack.h.

template<class _E, class _Tr = std::char_traits<_E>, class _A = std::allocator<_E>>
_XMLStackComment<_E, _Tr, _A> & XMLStackComment<_E, _Tr, _A>::operator= ( unsigned long & Value ) [inline]
 

Convenience operator for setValue().

Reimplemented from XMLStackNode.

Definition at line 1544 of file XMLStack.h.

template<class _E, class _Tr = std::char_traits<_E>, class _A = std::allocator<_E>>
_XMLStackComment<_E, _Tr, _A> & XMLStackComment<_E, _Tr, _A>::operator= ( const _XMLStackString & Value ) [inline]
 

Convenience operator for setValue().

Reimplemented from XMLStackNode.

Definition at line 1537 of file XMLStack.h.

template<class _E, class _Tr = std::char_traits<_E>, class _A = std::allocator<_E>>
void XMLStackComment<_E, _Tr, _A>::popped ( void ) [inline, protected, virtual]
 

Reimplemented from XMLStackNode.

Definition at line 1623 of file XMLStack.h.

template<class _E, class _Tr = std::char_traits<_E>, class _A = std::allocator<_E>>
void XMLStackComment<_E, _Tr, _A>::setValue ( float Value,
int Scale = 6 ) [inline, virtual]
 

Reimplemented from XMLStackNode.

Definition at line 1531 of file XMLStack.h.

template<class _E, class _Tr = std::char_traits<_E>, class _A = std::allocator<_E>>
void XMLStackComment<_E, _Tr, _A>::setValue ( double Value,
int Scale = 6 ) [inline, virtual]
 

Reimplemented from XMLStackNode.

Definition at line 1527 of file XMLStack.h.

template<class _E, class _Tr = std::char_traits<_E>, class _A = std::allocator<_E>>
void XMLStackComment<_E, _Tr, _A>::setValue ( unsigned char Value ) [inline, virtual]
 

Reimplemented from XMLStackNode.

Definition at line 1526 of file XMLStack.h.

template<class _E, class _Tr = std::char_traits<_E>, class _A = std::allocator<_E>>
void XMLStackComment<_E, _Tr, _A>::setValue ( char Value ) [inline, virtual]
 

Reimplemented from XMLStackNode.

Definition at line 1525 of file XMLStack.h.

template<class _E, class _Tr = std::char_traits<_E>, class _A = std::allocator<_E>>
void XMLStackComment<_E, _Tr, _A>::setValue ( signed char Value ) [inline, virtual]
 

Reimplemented from XMLStackNode.

Definition at line 1524 of file XMLStack.h.

template<class _E, class _Tr = std::char_traits<_E>, class _A = std::allocator<_E>>
void XMLStackComment<_E, _Tr, _A>::setValue ( short Value ) [inline, virtual]
 

Reimplemented from XMLStackNode.

Definition at line 1523 of file XMLStack.h.

template<class _E, class _Tr = std::char_traits<_E>, class _A = std::allocator<_E>>
void XMLStackComment<_E, _Tr, _A>::setValue ( unsigned short Value ) [inline, virtual]
 

Reimplemented from XMLStackNode.

Definition at line 1522 of file XMLStack.h.

template<class _E, class _Tr = std::char_traits<_E>, class _A = std::allocator<_E>>
void XMLStackComment<_E, _Tr, _A>::setValue ( int Value ) [inline, virtual]
 

Reimplemented from XMLStackNode.

Definition at line 1521 of file XMLStack.h.

template<class _E, class _Tr = std::char_traits<_E>, class _A = std::allocator<_E>>
void XMLStackComment<_E, _Tr, _A>::setValue ( unsigned int Value ) [inline, virtual]
 

Reimplemented from XMLStackNode.

Definition at line 1520 of file XMLStack.h.

template<class _E, class _Tr = std::char_traits<_E>, class _A = std::allocator<_E>>
void XMLStackComment<_E, _Tr, _A>::setValue ( long Value ) [inline, virtual]
 

Reimplemented from XMLStackNode.

Definition at line 1519 of file XMLStack.h.

template<class _E, class _Tr = std::char_traits<_E>, class _A = std::allocator<_E>>
void XMLStackComment<_E, _Tr, _A>::setValue ( unsigned long Value ) [inline, virtual]
 

Reimplemented from XMLStackNode.

Definition at line 1518 of file XMLStack.h.

template<class _E, class _Tr = std::char_traits<_E>, class _A = std::allocator<_E>>
void XMLStackComment<_E, _Tr, _A>::setValue ( const _XMLStackString & Value ) [inline, virtual]
 

Replaces the textual data defined in the constructor.

Reimplemented from XMLStackNode.

Definition at line 1517 of file XMLStack.h.


Member Data Documentation

template<class _E, class _Tr = std::char_traits<_E>, class _A = std::allocator<_E>>
_XMLStackString XMLStackComment<_E, _Tr, _A>::m_Text [protected]
 

Definition at line 1621 of file XMLStack.h.


The documentation for this class was generated from the following file:
Generated at Mon Aug 6 11:54:21 2001 for XMLStack by doxygen1.2.6 written by Dimitri van Heesch, © 1997-2001