SFXXMLDocumentFragment

[XML] Class which represents a DocumentFragment node.

#include <SFXXMLDocumentFragment.hpp>

class SFXXMLDocumentFragment : public SFXXMLNode;

SFMTYPEDEFCLASS(SFXXMLDocumentFragment)

Inheritance diagram

Collaboration diagram

Description

A DocumentFragment node(SFXXMLDocumentFragment) contains a document fragment of the XML document.

Reference

Member

Constructor/Destructor
SFXXMLDocumentFragment( `SFXXMLDocumentPtr` owner ) Constructor of the SFXXMLDocumentFragment class.
SFXXMLDocumentFragment( `SFXXMLDocumentFragmentConstRef` other , `Bool` deep = false ) Constructor of the SFXXMLDocumentFragment class.
~SFXXMLDocumentFragment( `Void` ) Destructor of the SFXXMLDocumentFragment class.

Public Functions
`SFCError`	AppendChild( `SFXXMLNodeConstPtr` newchild ) Append the 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.
`Bool`	HasChildNodes( `Void` ) Check wheteher or not this node has any child nodes.
`SFCError`	InsertBefore( `SFXXMLNodeConstPtr` newchild , `SFXXMLNodeConstPtr` refchild ) Insert the specified node.
`SFCError`	RemoveChild( `SFXXMLNodeConstPtr` oldchild ) Remove the specified child node including its descendant nodes.
`SFCError`	ReplaceChild( `SFXXMLNodeConstPtr` newchild , `SFXXMLNodeConstPtr` oldchild ) Replace the specified child node.
`Bool`	EqualNode( `SFXXMLNodeConstPtr` arg ) (inherits from SFXXMLNode) Check whether this node equals the specified node or not.
`SFXXMLNodePtr`	GetNextSibling( `Void` ) (inherits from SFXXMLNode) Get the next sibling node.
`ACharConstPtr`	GetNodeValue( `Void` ) (inherits from SFXXMLNode) Get the node value.
`SFXXMLNodePtr`	GetParentNode( `Void` ) (inherits from SFXXMLNode) Get the parent node.
`SFXXMLNodePtr`	GetPreviousSibling( `Void` ) (inherits from SFXXMLNode) Get the previous sibling node.
`SFXAnsiString`	GetText( `Void` ) (inherits from SFXXMLNode) Get the node text.
`Bool`	IsSameNode( `SFXXMLNodeConstPtr` other ) (inherits from SFXXMLNode) Check whether this node is the same as the specified one or not.
`Void`	SetNodeValue( `ACharConstPtr` value ) (inherits from SFXXMLNode) Set the node value.
`SFCError`	SetText( `SFXAnsiStringConstRef` text ) (inherits from SFXXMLNode) Set the node 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 )

SFXXMLDocumentFragment::SFXXMLDocumentFragment

Constructor of the SFXXMLDocumentFragment class.

[ public, explicit ]
SFXXMLDocumentFragment(
    SFXXMLDocumentPtr owner   // root node of the DOM tree
);

[ public, explicit ]
SFXXMLDocumentFragment(
    SFXXMLDocumentFragmentConstRef other   // DocumentFragment node
    Bool deep = false                      // whether or not to copy child nodes recursively
);

SFXXMLDocumentFragment::~SFXXMLDocumentFragment

Destructor of the SFXXMLDocumentFragment class.

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

SFXXMLDocumentFragment::AppendChild

Append the specified child node at the end.

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

Return value

If succeeds: SFERR_NO_ERROR
If the newchild argument is invalid: SFERR_INVALID_PARAM
If insufficient memory: SFERR_NO_MEMORY

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

SFXXMLDocumentFragment::InsertBefore | SFXXMLNode::AppendChild | SFXXMLNode

SFXXMLDocumentFragment::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
);

Argument

clonenode

Specify the target node where to copy this node.

deep

If true is set to this argument, copy the child nodes recursively.

Otherwise, copy only this node.

Return value

If succeeds: SFERR_NO_ERROR
If failed: SFERR_FAILED

Reference

SFXXMLNode::CloneNode | SFXXMLNode

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

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

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

SFXXMLDocumentFragment::GetNodeName

Get the node name.

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

Return value

Return the "#document-fragment" string.

Reference

SFXXMLNode::GetNodeName | SFXXMLNode

SFXXMLDocumentFragment::GetNodeType

Get the node type.

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

Return value

Return DOCUMENT_FRAGMENT_NODE.

Reference

SFXXMLNode::NodeType | SFXXMLNode::GetNodeType | SFXXMLNode

SFXXMLDocumentFragment::HasChildNodes

Check wheteher or not this node has any child nodes.

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

Return value

If yes: true
Otherwise: false

Reference

SFXXMLNode::HasChildNodes | SFXXMLNode

SFXXMLDocumentFragment::InsertBefore

Insert the specified node.

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

Return value

If succeeds: SFERR_NO_ERROR
If the newchild / refchild argument is invalid: SFERR_INVALID_PARAM
If insufficient memory: SFERR_NO_MEMORY

Description

Insert the newchild node before the refchild node. If the refchild argument is specified as null, append the newchild node as the last child node.

When the newchild node is the DocumentFragment node, all the child nodes of the newchild node are inserted in the same order before the refchild node.

When the newchild node has already existed in the DOM tree, it is removed before insertion.

Reference

SFXXMLNode::InsertBefore | SFXXMLNode

SFXXMLDocumentFragment::RemoveChild

Remove the specified child node including its descendant nodes.

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

Return value

If succeeds: SFERR_NO_ERROR
If the old argument is null or is not the child node of this node: SFERR_INVALID_PARAM
If failed: SFERR_FAILED

Reference

SFXXMLNode::RemoveChild | SFXXMLNode

SFXXMLDocumentFragment::ReplaceChild

Replace the 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

If succeeds: SFERR_NO_ERROR
If the newchild / oldchild argument is invalid: SFERR_INVALID_PARAM
If insufficient memory: SFERR_NO_MEMORY
If failed: SFERR_FAILED

Reference

SFXXMLDocumentFragment::InsertBefore | SFXXMLDocumentFragment::RemoveChild | SFXXMLNode::ReplaceChild | SFXXMLNode