TXmlEngNode Class Reference

Unlinks the node from the double-linked list and relinks any neighbour nodes. Despite being removed from the list, the node retains links to its old neighbours! Use with care!!

No checks are made. Neither the parent's, nor the node's properties are updated.

Gets the first child

Gets the list of children.

Check if the node has attributes. Namespace-to-prefix bindings are not considered attributes.

Check if the node has child nodes.

Get the inner XML string. This method returns all content of the node, exluding node markup. Child nodes will be included. Any existing contents in aBuffer will be destroyed. This method allocates memory for the buffer.

Check if the given namespace is the same as the default namespace for this node.

Note: "" or NULL can be used to denote undefined namespace

Check if the node is NULL

Checks if a node is the same as this node. Nodes are considered the same if they refer to the same in-memory data structure.

Check if the node content is "simple text" for element and attribute nodes.

If the node content is "simple text" then it is represented by a single TXmlEngTextNode (or derived type). The contents can be obtained through a call to Value(). A node that has multiple child text nodes does not have node content that is "simple text" and the contents must be obtained through a call to WholeTextContentsCopyL().

The contents of TXmlEngComment, TXmlEngCDATASection, TXmlEngTextNode, and Processing Instuction data are always "simple".

See also: TXmlEngNode::Value() TXmlEngAttr::Value() TXmlEngElement::Text() TXmlEngNode::WholeTextContentsCopyL()

Gets the last child

Inserts this node before the specified node in the double-linked list.

No checks are made. Neither the parent's, nor the node's properties are updated.

Searches for the namespace URI that is bound to the given prefix.

See also: TXmlEngElement::LookupNamespaceByPrefixL(const TDesC8&)

Searches for the prefix bound to the given aNamespaceUri and applicable within the scope of this node.

See also: TXmlEngElement::LookupNamespaceByUriL()

Moves the node to another part of the tree or to another document. The node is unlinked from its current postion (if any) and appended to its new parent.

Note: In many cases this method call should be followed by a call to ReconcileNamespacesL().

See also: ReconcileNamespacesL()

This method has been deprecated and will be removed in a future release.

Moves the node to another part of the tree or to another document. The node is unlinked from its current postion (if any) and appended to its new parent.

Note: In many cases this method call should be followed by a call to ReconcileNamespacesL().

Gets the node name.

This method generally follows the DOM spec: ------------------------------------------------------------------------------- The values of nodeName, nodeValue, and attributes vary according to the node type as follows:

interface nodeName nodeValue attributes ------------------------------------------------------------------------------- Attr = Attr.name = Attr.value = null CDATASection = "#cdata-section" = CharacterData.data = null Comment = "#comment" = CharacterData.data = null Document = "#document" = null = null DocumentFragment = "#document-fragment" = null = null DocumentType = DocumentType.name = null = null Element = Element.tagName = null = NamedNodeMap Entity = entity name = null = null EntityReference = name of entity referenced = null = null Notation = notation name = null = null ProcessingInstruction = target = data = null Text = "#text" = CharacterData.data = null -------------------------------------------------------------------------------

Retrieves the namespace declaration that applies to the node's namespace

Note: The DOM spec does not consider namespace declarations as a kind of node. This API adds TXmlEngNamespace, which is derived from TXmlEngNode.

Gets the namespace URI.

Gets the next sibling

Gets the node type. Used to find out the type of the node prior to casting the node to one of TXmlEngNode class to one of its derived subclasses (TXmlEngElement, TXmlEngAttr, TXmlEngTextNode, etc.).

See also: TXmlEngDOMNodeType

Pre-condition

Node must not be NULL

Check if node is not NULL

Get the outer XML string. This method returns all content of the node, including node markup. Child nodes will be included. Any existing contents in aBuffer will be destroyed. This method allocates memory for the buffer.

Gets the owning document

Note: An instance of the RXmlEngDocument class returns itself

Gets the parent node

Gets the namespace prefix.

Gets the previous sibling

Ensures that namespaces referred to in the node and its descendants are within the scope of the node.

This method checks that all the namespaces declared within the subtree parented by this node are properly declared. This is needed for example after a Copy or an Unlink followed by an Append operation. The subtree may still hold pointers to namespace declarations outside the subtree or they may be invalid/masked. The function tries to reuse the existing namespaces found in the new environment as much as possible. If not possible, the new namespaces are redeclared at the top of the subtree.

This method should be used after unlinking nodes and inserting them into another document tree or into another part of the original tree, if some nodes of the subtree are removed from the scope of the namespace declaration they refer to.

Unlinks this node and destroys it; all child nodes are also destroyed and all memory is freed.

Note: Document nodes cannot be removed with this method. Use RXmlEngDocument::Close() instead.

Removes the user data object attached to this node and transfers ownership to the caller. The user data object is not deleted.

This node is replaced with another node (or subtree). The replacement node is linked into the document tree instead of this node. The replaced node is destroyed. Replacement of a node with a NULL TXmlEngNode is legal and equivalent to removing the node.

aNode is unlinked from its previous location, which can be none (i.e. not linked), within the same document tree, or within another document tree.

Note: Not applicable to document nodes.

See also: SubstituteForL(TXmlEngNode)

This method has been deprecated and will be removed in a future release.

This node is replaced with another node (or subtree). The replacement node is linked into the document tree instead of this node. The replaced node is destroyed. Replacement of a node with a NULL TXmlEngNode is legal and equivalent to removing the node.

aNode is unlinked from its previous location, which can be none (i.e. not linked), within the same document tree, or within another document tree.

Note: Not applicable to document nodes.

See also: SubstituteForL(TXmlEngNode)

Unlinks this node and puts another in its place. This function is the same as ReplaceWithL(), but this node is not freed.

aNode is unlinked from its previous location, which can be none (i.e. not linked), within the same document tree, or within another document tree.

It is possible to use a NULL TXmlEngNode object as an argument. In this case, this node will simply be removed from the tree, but not freed.

Note: Not applicable to document nodes.

See also: ReplaceWithL()

Detaches the node from the document tree. The document maintains ownership of the node until it is linked elsewhere.

Note: Remember to use ReconcileNamespacesL() later, if the extracted node (or subtree) contains references to namespace declarations outside of the subtree.

See also: ReconcileNamespacesL()

Gets the user data object attached to this node. Ownership is not transferred.

Gets the value of this node.

Note: Since this is not a virtual function, it is better to always cast nodes to a specific type and then use the specific method for getting the "node value".

Gets a copy of the node's text content. What is returned depends on the node type. Any existing content in the specified buffer is destroyed. This method allocates memory for the buffer.