SFXXMLComment

[XML] Class that represents a Comment node.

#include <SFXXMLComment.hpp>

class SFXXMLComment : public SFXXMLText;

SFMTYPEDEFCLASS(SFXXMLComment)

Inheritance diagram

Collaboration diagram

Description

A Comment node(SFXXMLComment) contains a comment of the XML document.

Reference

Member

Constructor/Destructor
SFXXMLComment( `SFXXMLDocumentPtr` owner , `SFXAnsiStringConstRef` name ) Constructor of SFXXMLComment class.
SFXXMLComment( `SFXXMLCommentConstRef` other , `Bool` deep = false ) Constructor of SFXXMLComment class.
~SFXXMLComment( `Void` ) Destructor of SFXXMLComment class.

Public Functions
`SFCError`	CloneNode( `SFXXMLNodeHandle` clonenode , `Bool` deep ) Create a copy of this node.
`ACharConstPtr`	GetNodeName( `Void` ) Get the node name.
`NodeType`	GetNodeType( `Void` ) Get the node type.
`SFXXMLNodePtr`	GetParentNode( `Void` ) Get the parent node.
`SFXXMLCommentPtr`	SplitText( `SInt32` offset ) Split this node into 2 nodes.
`SFCError`	AppendChild( `SFXXMLNodeConstPtr` newchild ) (inherits from SFXXMLNode) Append a specified child node at the end.
`Void`	AppendData( `ACharConstPtr` data ) (inherits from SFXXMLText) Append a new string at the end of the string of this node.
`Void`	DeleteData( `SInt32` offset , `SInt32` count ) (inherits from SFXXMLText) Remove specified range of characters from the string of text node.
`Bool`	EqualNode( `SFXXMLNodeConstPtr` arg ) (inherits from SFXXMLNode) Check whether this node equals a specified node or not.
`DOMNodeListPtr`	GetChildNodes( `Void` ) (inherits from SFXXMLNode) Get all the child nodes.
`ACharConstPtr`	GetData( `Void` ) (inherits from SFXXMLText) Get the node value.
`SFXXMLNodePtr`	GetFirstChild( `Void` ) (inherits from SFXXMLNode) Get the first child node.
`SFXXMLNodePtr`	GetLastChild( `Void` ) (inherits from SFXXMLNode) Get the last child node.
`SInt32`	GetLength( `Void` ) (inherits from SFXXMLText) Get the length of text.
`SFXXMLNodePtr`	GetNextSibling( `Void` ) (inherits from SFXXMLText) Get the next sibling node.
`ACharConstPtr`	GetNodeValue( `Void` ) (inherits from SFXXMLText) Get the node value.
`SFXXMLNodePtr`	GetPreviousSibling( `Void` ) (inherits from SFXXMLText) Get the previous sibling node.
`SFXAnsiString`	GetText( `Void` ) (inherits from SFXXMLNode) Get the node text.
`Bool`	HasChildNodes( `Void` ) (inherits from SFXXMLNode) Check whether this node has any child nodes or not.
`SFCError`	InsertBefore( `SFXXMLNodeConstPtr` newchild , `SFXXMLNodeConstPtr` refchild ) (inherits from SFXXMLNode) Insert a specified node.
`Void`	InsertData( `SInt32` offset , `ACharConstPtr` data ) (inherits from SFXXMLText) Inserts the string in the textual content of the Text node.
`Bool`	IsSameNode( `SFXXMLNodeConstPtr` other ) (inherits from SFXXMLNode) Check whether this node is the same as a specified one or not.
`SFCError`	RemoveChild( `SFXXMLNodeConstPtr` oldchild ) (inherits from SFXXMLNode) Remove a specified child node including its descendant nodes.
`SFCError`	ReplaceChild( `SFXXMLNodeConstPtr` newchild , `SFXXMLNodeConstPtr` oldchild ) (inherits from SFXXMLNode) Replace a specified child node.
`Void`	ReplaceData( `SInt32` offset , `SInt32` count , `ACharConstPtr` data ) (inherits from SFXXMLText) Replace the text.
`Void`	SetData( `ACharConstPtr` data ) (inherits from SFXXMLText) Set the node value.
`Void`	SetNodeValue( `ACharConstPtr` value ) (inherits from SFXXMLText) Set the node value.
`SFCError`	SetText( `SFXAnsiStringConstRef` text ) (inherits from SFXXMLNode) Set the node text.
`SFXAnsiString`	SubstringData( `SInt32` offset , `SInt32` count ) (inherits from SFXXMLText) Extract the substring of the text.

Types
DOMNamedNodeMap (inherits from SFXXMLNode) Class to manage the DOM nodes by name
DOMNodeList (inherits from SFXXMLNode) Class to manage the DOM nodes by list
NodeType (inherits from SFXXMLNode) SFXXMLNode::NodeType is an enumeration type of NodeType values defined in the W3C DOM Level 1 Specification. Document Object Model (DOM) Level 1 Specification )

SFXXMLComment::SFXXMLComment

Constructor of SFXXMLComment class.

[ public, explicit ]
SFXXMLComment(
    SFXXMLDocumentPtr owner      // root node of the DOM tree
    SFXAnsiStringConstRef name   // name of the Comment node
);

[ public, explicit ]
SFXXMLComment(
    SFXXMLCommentConstRef other   // Comment node
    Bool deep = false             // whether or not to copy child nodes recursively
);

SFXXMLComment::~SFXXMLComment

Destructor of SFXXMLComment class.

[ public, virtual ]
virtual ~SFXXMLComment(Void);

SFXXMLComment::CloneNode

Create a copy of this node.

[ public, virtual ]
SFCError CloneNode(
    SFXXMLNodeHandle clonenode   // target node where to copy this node(Handle type)
    Bool deep                    // whether or not to copy the child nodes recursively[invalid]
);

Argument

clonenode: Specify the target node where to copy this node.
deep: This argument is invalid.

Return value

Success : SFERR_NO_ERROR
If failed : SFERR_FAILED

Reference

SFXXMLNode::CloneNode | SFXXMLNode

SFXXMLComment::GetNodeName

Get the node name.

[ public, virtual, const ]
ACharConstPtr GetNodeName(Void);

Return value

Return the "#comment" string.

Reference

SFXXMLNode::GetNodeName | SFXXMLNode

SFXXMLComment::GetNodeType

Get the node type.

[ public, virtual, const ]
NodeType GetNodeType(Void);

Return value

Return COMMENT_NODE.

Reference

SFXXMLNode::NodeType | SFXXMLNode::GetNodeType | SFXXMLNode

SFXXMLComment::GetParentNode

Get the parent node.

[ public, virtual, const ]
SFXXMLNodePtr GetParentNode(Void);

Return value

Return the parent node of this node. Return null if this node has no parent.

Reference

SFXXMLNode::GetParentNode | SFXXMLNode

SFXXMLComment::SplitText

Split this node into 2 nodes.

[ public ]
SFXXMLCommentPtr SplitText(
    SInt32 offset   // split at the position with this offset
);

Reference

SFXXMLText::SplitText | SFXXMLText