SFXXMLCDATASection

[XML] Class that represents a CDATASection node.

#include <SFXXMLCDATASection.hpp>

class SFXXMLCDATASection : public SFXXMLText;

SFMTYPEDEFCLASS(SFXXMLCDATASection)

Inheritance diagram

Collaboration diagram

Description

A CDATASection node(SFXXMLCDATASection) contains a CDATA section of the XML document.

Reference

Member

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

Public Functions
`SFCError`	AppendChild( `SFXXMLNodeConstPtr` newchild ) Append a specified child node at the end.
`SFCError`	CloneNode( `SFXXMLNodeHandle` clonenode , `Bool` deep ) Create a copy of this node.
`DOMNodeListPtr`	GetChildNodes( `Void` ) Get all the child nodes.
`SFXXMLNodePtr`	GetFirstChild( `Void` ) Get the first child node.
`SFXXMLNodePtr`	GetLastChild( `Void` ) Get the last child node.
`ACharConstPtr`	GetNodeName( `Void` ) Get the node name.
`NodeType`	GetNodeType( `Void` ) Get the node type.
`SFXXMLNodePtr`	GetParentNode( `Void` ) Get the parent node.
`Bool`	HasChildNodes( `Void` ) Check whether this node has any child nodes or not.
`SFCError`	InsertBefore( `SFXXMLNodeConstPtr` newchild , `SFXXMLNodeConstPtr` refchild ) Insert a specified node.
`SFCError`	RemoveChild( `SFXXMLNodeConstPtr` oldchild ) Remove a specified child node including its descendant nodes.
`SFCError`	ReplaceChild( `SFXXMLNodeConstPtr` newchild , `SFXXMLNodeConstPtr` oldchild ) Replace a specified child node.
`SFXXMLTextPtr`	SplitText( `SInt32` offset ) Split this node into 2 nodes.
`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.
`ACharConstPtr`	GetData( `Void` ) (inherits from SFXXMLText) Get the node value.
`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.
`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.
`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 )

SFXXMLCDATASection::SFXXMLCDATASection

Constructor of SFXXMLCDATASection class.

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

[ public, explicit ]
SFXXMLCDATASection(
    SFXXMLCDATASectionConstRef other   // CDATASection node
    Bool deep = false                  // whether or not to copy child nodes recursively
);

SFXXMLCDATASection::~SFXXMLCDATASection

Destructor of SFXXMLCDATASection class.

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

SFXXMLCDATASection::AppendChild

Append a specified child node at the end.

[ public, virtual ]
SFCError AppendChild(
    SFXXMLNodeConstPtr newchild   // child node to append
);

Return value

Success : SFERR_NO_ERROR
If invalid argument : SFERR_INVALID_PARAM
If insufficient memory : SFERR_NO_MEMORY
If failed : SFERR_FAILED

Description

The "newchild" node is appended as the last child node to this node without copying it.

If the "newchild" node belongs to a DOM tree, it will be removed from that tree.

Reference

SFXXMLNode::AppendChild | SFXXMLNode

SFXXMLCDATASection::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

SFXXMLCDATASection::GetChildNodes

Get all the child nodes.

[ public, virtual, const ]
DOMNodeListPtr GetChildNodes(Void);

Return value

Return the pointer to the SFXXMLNode::DOMNodeList instance that contains all child nodes of this node.

Description

	Note
	Each element of `SFXXMLNode::DOMNodeList` is of the "pointer to the SFXXMLNode" type.

Reference

SFXXMLNode::DOMNodeList | SFXXMLNode::GetChildNodes | SFXXMLNode

SFXXMLCDATASection::GetFirstChild

Get the first child node.

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

Return value

Return the first child node of this node. Return null if this node has no child.

Reference

SFXXMLNode::GetFirstChild | SFXXMLNode

SFXXMLCDATASection::GetLastChild

Get the last child node.

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

Return value

Return the last child node of this node. Return null if this node has no child.

Reference

SFXXMLNode::GetLastChild | SFXXMLNode

SFXXMLCDATASection::GetNodeName

Get the node name.

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

Return value

Return the "#cdata-section" string.

Reference

SFXXMLNode::GetNodeName | SFXXMLNode

SFXXMLCDATASection::GetNodeType

Get the node type.

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

Return value

Return CDATA_SECTION_NODE.

Reference

SFXXMLNode::NodeType | SFXXMLNode::GetNodeType | SFXXMLNode

SFXXMLCDATASection::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

SFXXMLCDATASection::HasChildNodes

Check whether this node has any child nodes or not.

[ public, virtual, const ]
Bool HasChildNodes(Void);

Return value

If yes : true
Otherwise : false

Reference

SFXXMLNode::HasChildNodes | SFXXMLNode

SFXXMLCDATASection::InsertBefore

Insert a specified node.

[ public, virtual ]
SFCError InsertBefore(
    SFXXMLNodeConstPtr newchild   // node to insert
    SFXXMLNodeConstPtr refchild   // newchild node is inserted before refchild node
);

Return value

Success : SFERR_NO_ERROR
If invalid argument : SFERR_INVALID_PARAM
If insufficient memory : SFERR_NO_MEMORY
If failed : SFERR_FAILED

Reference

SFXXMLNode::InsertBefore | SFXXMLNode

SFXXMLCDATASection::RemoveChild

Remove a specified child node including its descendant nodes.

[ public, virtual ]
SFCError RemoveChild(
    SFXXMLNodeConstPtr oldchild   // child node to remove
);

Return value

Success : SFERR_NO_ERROR
If invalid parameter : SFERR_INVALID_PARAM
If failed : SFERR_FAILED

Reference

SFXXMLNode::RemoveChild | SFXXMLNode

SFXXMLCDATASection::ReplaceChild

Replace a specified child node.

[ public, virtual ]
SFCError ReplaceChild(
    SFXXMLNodeConstPtr newchild   // new child node to replace with
    SFXXMLNodeConstPtr oldchild   // old child node to be replaced
);

Return value

Success : SFERR_NO_ERROR
If invalid argument : SFERR_INVALID_PARAM
If insufficient memory : SFERR_NO_MEMORY
If failed : SFERR_FAILED

Reference

SFXXMLNode::ReplaceChild | SFXXMLNode

SFXXMLCDATASection::SplitText

Split this node into 2 nodes.

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

Reference

SFXXMLText::SplitText | SFXXMLText