SFXXMLProcessingInstruction

[XML] Class which represents a ProcessingInstruction node.

#include <SFXXMLProcessingInstruction.hpp>

class SFXXMLProcessingInstruction : public SFXXMLNode;

SFMTYPEDEFCLASS(SFXXMLProcessingInstruction)

Inheritance diagram

Collaboration diagram

Description

A ProcessingInstruction node(SFXXMLProcessingInstruction class) contains processing instructions of the XML document.

Reference

Member

Constructor/Destructor
SFXXMLProcessingInstruction( `SFXXMLDocumentPtr` owner , `SFXAnsiStringConstRef` target , `SFXAnsiStringConstRef` data ) Constructor of the SFXXMLProcessingInstruction class.
SFXXMLProcessingInstruction( `SFXXMLProcessingInstructionConstRef` other , `Bool` deep = false ) Constructor of the SFXXMLProcessingInstruction class.
~SFXXMLProcessingInstruction( `Void` ) Destructor of the SFXXMLProcessingInstruction class.

Public Functions
`SFCError`	CloneNode( `SFXXMLNodeHandle` clonenode , `Bool` deep ) Create a copy of this node.
`ACharConstPtr`	GetData( `Void` ) Get the node value.
`SFXXMLNodePtr`	GetNextSibling( `Void` ) Get the next sibling node.
`ACharConstPtr`	GetNodeName( `Void` ) Get the node name.
`NodeType`	GetNodeType( `Void` ) Get the node type.
`ACharConstPtr`	GetNodeValue( `Void` ) Get the node value.
`SFXXMLNodePtr`	GetParentNode( `Void` ) Get the parent node.
`SFXXMLNodePtr`	GetPreviousSibling( `Void` ) Get the previous sibling node.
`ACharConstPtr`	GetTarget( `Void` ) Get the target of this ProcessingInstruction node.
`Void`	SetData( `ACharConstPtr` data ) Set the node value.
`Void`	SetNodeValue( `ACharConstPtr` value ) Set the node value.
`SFCError`	AppendChild( `SFXXMLNodeConstPtr` newchild ) (inherits from SFXXMLNode) Append the specified child node at the end.
`Bool`	EqualNode( `SFXXMLNodeConstPtr` arg ) (inherits from SFXXMLNode) Check whether this node equals the specified node or not.
`DOMNodeListPtr`	GetChildNodes( `Void` ) (inherits from SFXXMLNode) Get all the child nodes.
`SFXXMLNodePtr`	GetFirstChild( `Void` ) (inherits from SFXXMLNode) Get the first child node.
`SFXXMLNodePtr`	GetLastChild( `Void` ) (inherits from SFXXMLNode) Get the last child 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 the specified node.
`Bool`	IsSameNode( `SFXXMLNodeConstPtr` other ) (inherits from SFXXMLNode) Check whether this node is the same as the specified one or not.
`SFCError`	RemoveChild( `SFXXMLNodeConstPtr` oldchild ) (inherits from SFXXMLNode) Remove the specified child node including its descendant nodes.
`SFCError`	ReplaceChild( `SFXXMLNodeConstPtr` newchild , `SFXXMLNodeConstPtr` oldchild ) (inherits from SFXXMLNode) Replace the specified child node.
`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 )

SFXXMLProcessingInstruction::SFXXMLProcessingInstruction

Constructor of the SFXXMLProcessingInstruction class.

[ public, explicit ]
SFXXMLProcessingInstruction(
    SFXXMLDocumentPtr owner        // root node of the DOM tree
    SFXAnsiStringConstRef target   // target of the processing instruction
    SFXAnsiStringConstRef data     // content of the processing instruction
);

[ public, explicit ]
SFXXMLProcessingInstruction(
    SFXXMLProcessingInstructionConstRef other   // ProcessingInstruction node
    Bool deep = false                           // whether or not to copy the child nodes recursively
);

SFXXMLProcessingInstruction::~SFXXMLProcessingInstruction

Destructor of the SFXXMLProcessingInstruction class.

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

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

If succeeds: SFERR_NO_ERROR
If failed: SFERR_FAILED

Reference

SFXXMLNode::CloneNode

SFXXMLProcessingInstruction::GetData

Get the node value.

[ public, const ]
ACharConstPtr GetData(Void);

Return value

Return the value of ProcessingInstruction node, i.e., the content of this processing instruction.

Description

The content of this processing instruction is from the first non white space character after the target to the character immediately preceding "?>".

Same as the SFXXMLProcessingInstruction::GetNodeValue function.

Reference

SFXXMLProcessingInstruction::GetNodeValue | SFXXMLProcessingInstruction::SetNodeValue | SFXXMLProcessingInstruction::SetData

SFXXMLProcessingInstruction::GetNextSibling

Get the next sibling node.

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

Return value

Return the next sibling node of this node. If this node has no next sibling node, null is returned.

Reference

SFXXMLProcessingInstruction::GetPreviousSibling | SFXXMLNode::GetNextSibling| SFXXMLNode::GetPreviousSibling | SFXXMLNode

SFXXMLProcessingInstruction::GetNodeName

Get the node name.

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

Description

	Note
	The name of the ProcessingInstruction node is the target name of the XML document.

Reference

SFXXMLNode::GetNodeName

SFXXMLProcessingInstruction::GetNodeType

Get the node type.

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

Return value

Retrun PROCESSING_INSTRUCTION_NODE.

Reference

SFXXMLNode::NodeType | SFXXMLNode::GetNodeType | SFXXMLNode

SFXXMLProcessingInstruction::GetNodeValue

Get the node value.

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

Return value

Return the value of ProcessingInstruction node, i.e., the content of this processing instruction.

Description

The content of this processing instruction is from the first non white space character after the target to the character immediately preceding "?>".

Same as the SFXXMLProcessingInstruction::GetData function.

Reference

SFXXMLProcessingInstruction::GetData | SFXXMLProcessingInstruction::SetNodeValue | SFXXMLProcessingInstruction::SetData | SFXXMLNode::GetNodeValue

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

SFXXMLProcessingInstruction::GetPreviousSibling

Get the previous sibling node.

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

Return value

Return the previous sibling node of this node. If this node has no previous sibling node, null is returned.

Reference

SFXXMLProcessingInstruction::GetNextSibling | SFXXMLNode::GetPreviousSibling | SFXXMLNode::GetNextSibling | SFXXMLNode

SFXXMLProcessingInstruction::GetTarget

Get the target of this ProcessingInstruction node.

[ public, const ]
ACharConstPtr GetTarget(Void);

Description

The target is the first token following the markup that begins the processing instruction.

SFXXMLProcessingInstruction::SetData

Set the node value.

[ public ]
Void SetData(
    ACharConstPtr data   // content of the processing instruction to set
);

Description

Set the value(content of the processing instruction) to this node.

Same as the SFXXMLProcessingInstruction::SetNodeValue function.

Reference

SFXXMLProcessingInstruction::SetNodeValue | SFXXMLProcessingInstruction::GetNodeValue | SFXXMLProcessingInstruction::GetData

SFXXMLProcessingInstruction::SetNodeValue

Set the node value.

[ public, virtual ]
Void SetNodeValue(
    ACharConstPtr value   // the content of the processing content
);

Description

Set the value(content of the processing instruction) to this node.

Same as the SFXXMLProcessingInstruction::SetData function.

Reference

SFXXMLProcessingInstruction::SetData | SFXXMLProcessingInstruction::GetData | SFXXMLProcessingInstruction::GetNodeValue | SFXXMLNode::SetNodeValue