RXmlEngDocument Class Reference

Default constructor. An instance of RXmlEngDocument must be "opened" with one of OpenL() overloads before methods are invoked on the object.

Constructor

Creates a complete copy of the document and transfers ownership to the caller. The caller is required to call Close() on the new document. The new document is independant from this document and this document may be changed or closed without affecting the new document.

Closes document: All owned nodes, child nodes, and namespaces are freed. All data containers on the data container list are freed.

DISABLED for document; CloneDocumentL() must be used

Creates a new attribute.

aValue should represent the correct value of an attribute if it is put as-is into an XML file (with all characters correctly escaped with entity references when XML spec requires)

The TXmlEngElement class provides a rich set of attribute creation methods, which not only create attributes but also link them into elements.

See also: TXmlEngElement

There is no way to create attributes with namespaces (despite the DOM spec); you have to use one of the TXmlEngElement::AddNewAttributeL(..) methods instead

The returned attribute is the only reference to the allocated memory until you have attached the attribute to some element node.

Creates a new binary container and copies the specified cid and data into it. A pointer to the container is stored in the document's data container list that can be fetched using GetDataContainerList().

See also: GetDataContainerList( RArray<TXmlEngDataContainer>& aList )

leave

• One of the system-wide error codes

Creates a new chunk container and copies the specified cid into it. A reference to a memory chunk is stored in the container. The memory chunk must stay in scope for the lifetime of the container. A pointer to the container is stored in the document's data container list that can be fetched using GetDataContainerList().

See also: GetDataContainerList( RArray<TXmlEngDataContainer>& aList )

leave

• One of the system-wide error codes

Creates a new element from a specific namespace to be the root of the document tree. Any existing document element of the document is destroyed.

Creates a new element node that belongs to the specific namespace. A namespace declaration node is created on the element.

If the provided namespace uri is NULL, the element will be created without namespace.

Creates a new entity reference node and copies the specified string into it.

Note: < , > , ' , " and other predefined entity references should not be created with this method. These entity references are rather "character references" and are encoded/decoded automatically.

Creates a new file container and copies the specified cid into it. A reference to a file is stored in the container. aFile must stay in scope of the lifetime of the container. A pointer to the container is stored in the document's data container list that can be fetched using GetDataContainerList().

See also: GetDataContainerList( RArray<TXmlEngDataContainer>& aList )

leave

• One of the system-wide error codes

Creates a new processing instruction node and copies "target" and "data" into it.

Get the document element

Retrieves base URI (if defined) of the document

Retrieves an array of data containers owned by this document.

Note: The document ceases to be the owner of a data container when the data container (or one of its predecessors) is removed from the document or becomes part of another document. Unlinking a data container (or one of its predecessors) doesn't remove ownership of the data container from this document so the list might contain containers that are not linked to this document anymore.

Get the DOM implementation. Ownership is not transferred. Any operation on the returned object will affect this document directly, in particular, a call to RXmlEngDOMImplementation::Close() will cause further operations on this document to fail.

Check if document is standalone

Opens the document, initializing it with the internal state pointer from another RXmlEngDocument. This document becomes an alias for the document whose state is represented by aInternal and a change in either document will be reflected in the other. Close() need only be called once, however, it is not an error to call Close() on each RXmlEngDocument.

Opens the document and adds aRoot as the root of the DOM tree. If aRoot is currently part of another document, it will be unlinked. Ownership is transferred to this document.

Sets the specified attribute as a xml:id attribute, starting at aStartElement and recursing through the subtree. To set the specified attribute as a xml:id attribute for the entire DOM tree, see RegisterXmlId(const TDesC8&,const TDesC8&).

Sets the specified attribute as a xml:id attribute, recursing through the entire DOM tree. In order to specify a subtree only, see RegisterXmlId(TXmlEngElement,const TDesC8,const TDesC8).

DISABLED for document; Close() must be used

DISABLED for document; Close() must be used