GrayLib::cXmlComment Class Reference

#include <cXmlDocument.h>

Inheritance diagram for GrayLib::cXmlComment:

Public Member Functions
	cXmlComment ()
	cXmlComment (cXmlString sValue)
	cXmlComment (const cXmlComment &)
void	operator= (const cXmlComment &rCopy)
virtual	~cXmlComment ()
virtual cXmlNode *	Clone () const
	Returns a copy of this Comment. More...
virtual HRESULT	SetParseNode (cXmlReader &rReader)
virtual HRESULT	Print (cStreamOutput &rOut, int nDepth=0) const
virtual bool	OnVisit (IXmlVisitor *visitor) const
	Walk the XML tree visiting this node and all of its children. More...
virtual cXmlComment *	ToComment ()
virtual const cXmlComment *	ToComment () const
Public Member Functions inherited from GrayLib::cXmlNode
virtual	~cXmlNode ()
XMLNODE_TYPE	get_Type () const
bool	isType (XMLNODE_TYPE eType) const
void	put_UserData (void *pUserData)
void *	get_UserData () const
virtual void	SetClear ()
	Delete all the children of this node. Does not affect 'this'. More...
void	put_Value (cXmlString sValue)
const cXmlString &	get_Value () const
HRESULT	QueryValueInt (int *piValue) const
HRESULT	QueryValueDouble (double *pdValue) const
	QueryValueDouble examines the value string. See QueryValueInt(). More...
int	get_ValueInt () const
	Return the value of this attribute, converted to an integer. More...
double	get_ValueDouble () const
	Return the value of this attribute, converted to a double. More...
void	put_ValueInt (int iValue)
	Set the value from an integer. More...
void	put_ValueDouble (double dValue)
	Set the value from a double. More...
cXmlDocument *	get_Document () const
cXmlNode *	GetPreviousSibling (const char *pszValue) const
	Navigate to a sibling node. More...
cXmlNode *	GetNextSiblingX (const char *pszValue) const
	Navigate to a sibling node with the given 'value'. More...
cXmlElement *	get_NextSiblingElement () const
cXmlElement *	GetNextSiblingElement (const char *pszValue) const
virtual cXmlContainer *	ToContainer ()
HRESULT	SetParse (const char *pszData, CXML_ENCODING_TYPE eEncoding=CXML_ENCODING_UNKNOWN)
ITERATE_t	get_Row () const
StrLen_t	get_Column () const
Public Member Functions inherited from Gray::cListNodeT< cXmlNode >
cXmlNode *	get_Next () const
cXmlNode *	get_Prev () const
Public Member Functions inherited from Gray::cListNodeBase
virtual	~cListNodeBase ()
cListBase *	get_Parent () const noexcept
cListNodeBase *	get_Next () const noexcept
cListNodeBase *	get_Prev () const noexcept
bool	hasParent () const noexcept
void	RemoveFromParent ()
virtual HRESULT	DisposeThis ()
Public Member Functions inherited from Gray::cHeapObject
	cHeapObject ()
virtual	~cHeapObject ()
bool	IsValidInsideN (INT_PTR index) const
bool	IsValidInsidePtr (void const *pTest) const
virtual size_t	GetHeapStatsThis (OUT ITERATE_t &iAllocCount) const
virtual bool	isValidCheck () const noexcept

Additional Inherited Members
Public Types inherited from GrayLib::cXml
enum	XMLNODE_TYPE { XMLNODE_QTY }
Static Public Member Functions inherited from GrayLib::cXmlNode
static HRESULT	PrintDepth (cStreamOutput &rOut, int nDepth)
Static Public Member Functions inherited from GrayLib::cXml
static StrLen_t GRAYCALL	ParseMicrosoftBOM (const BYTE *pszData)
static bool GRAYCALL	IsXML (const IniChar_t *pszStr, StrLen_t iLenMax=StrT::k_LEN_MAX)
static cXmlString GRAYCALL	GetAttributeStr (const IniChar_t *pszName, const cXmlString &sValue)
static void	AddPathElement (cXmlString &sPath, const cXmlString &sElement)
static void	RemovePathElement (cXmlString &sPath, const cXmlString &sElement)
Public Attributes inherited from GrayLib::cXmlNode
cTextPos	m_Pos
	Where (line,col) in the parsed XML document is this node? m_PosNode. More...
Static Public Attributes inherited from GrayLib::cXml
static const char	k_xmlHeader [6] = "<?xml"
	"<?xml" // not case sensitive ! More...
static const char	k_xmlEnd [3] = "?>"
	"?>" More...
static const char	k_commentHeader [5] = "<!--"
	"<!--" // comments are not reentrant! More...
static const char	k_commentEnd [4] = "-->"
	"-->" More...
static const char	k_cdataHeader [10] = "<![CDATA["
	"<![CDATA[" More...
static const char	k_cdataEnd [4] = "]]>"
	"]]>" More...
static const char	k_dtdHeader [3] = "<!"
	"<!" More...
Protected Member Functions inherited from GrayLib::cXmlNode
	cXmlNode (XMLNODE_TYPE eNodeType, cXmlString sValue="")
	Only instantiate as a derived type. More...
virtual void	SetCopy (const cXmlNode &n)
Protected Member Functions inherited from Gray::cListNodeBase
virtual void	put_Parent (cListBase *pParent)
	cListNodeBase () noexcept
Protected Member Functions inherited from Gray::cHeapObject
const void *	get_HeapPtr () const noexcept override
	Get the top level (outermost, freeable) class pointer. I can delete get_HeapPtr(). More...
Protected Member Functions inherited from Gray::cNonCopyable
	cNonCopyable () noexcept
	Force the use of Factory creation via protected constructor. More...
	~cNonCopyable () noexcept
Protected Attributes inherited from GrayLib::cXmlNode
const XMLNODE_TYPE	m_eNodeType
cXmlString	m_sValue
	parent usage dependent m_eNodeType. More...
void *	m_pUserData
	Field containing a generic pointer to arbitrary user data. More...

Detailed Description

An XML "<!-- comment block -->"

Constructor & Destructor Documentation

cXmlComment() [1/3]

GrayLib::cXmlComment::cXmlComment ( )

inline

Constructs an empty comment.

cXmlComment() [2/3]

GrayLib::cXmlComment::cXmlComment ( cXmlString  sValue )

inline

Construct a comment from text.

cXmlComment() [3/3]

GrayLib::cXmlComment::cXmlComment

(

const cXmlComment &

rCopy

)

~cXmlComment()

virtual GrayLib::cXmlComment::~cXmlComment ( )

inlinevirtual

Member Function Documentation

Clone()

cXmlNode * GrayLib::cXmlComment::Clone ( ) const

virtual

Returns a copy of this Comment.

Implements GrayLib::cXmlNode.

OnVisit()

bool GrayLib::cXmlComment::OnVisit ( IXmlVisitor *  visitor ) const

virtual

Walk the XML tree visiting this node and all of its children.

Implements GrayLib::cXmlNode.

operator=()

void GrayLib::cXmlComment::operator= ( const cXmlComment &  rCopy )

inline

Print()

HRESULT GrayLib::cXmlComment::Print ( cStreamOutput &  rOut, int  nDepth = 0  ) const

virtual

All cXml classes can print themselves to a filestream or the string class (cXmlString in non-STL mode, std::string in STL mode.) Either or both pFile and string can be null.

This is a formatted print, and will insert tabs and newlines.

(For an unformatted stream, use the << operator.)

Implements GrayLib::cXmlNode.

SetParseNode()

HRESULT GrayLib::cXmlComment::SetParseNode ( cXmlReader &  rReader )

virtual

Populate node. Parse XMLNODE_Comment

Implements GrayLib::cXmlNode.

ToComment() [1/2]

virtual cXmlComment* GrayLib::cXmlComment::ToComment ( )

inlinevirtual

ToComment() [2/2]

virtual const cXmlComment* GrayLib::cXmlComment::ToComment ( ) const

inlinevirtual

---

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

• c:/Dennis/Source/Gray/GrayLib/include/Xml/cXmlDocument.h
• c:/Dennis/Source/Gray/GrayLib/src/Xml/cXmlDocument.cpp