Gdome2 Reference Manual
<<< Previous Page | Home | Up | Next Page >>>

# GdomeDocument

## Name

GdomeDocument -- Interface Document implementation.

## Synopsis

    struct      GdomeDocument;
    GdomeDocumentType* gdome_doc_doctype        (GdomeDocument *self,
                                                 GdomeException *exc);
    GdomeDOMImplementation* gdome_doc_implementation
                                                (GdomeDocument *self,
                                                 GdomeException *exc);
    GdomeElement* gdome_doc_documentElement     (GdomeDocument *self,
                                                 GdomeException *exc);
    GdomeElement* gdome_doc_createElement       (GdomeDocument *self,
                                                 GdomeDOMString *tagName,
                                                 GdomeException *exc);
    GdomeDocumentFragment* gdome_doc_createDocumentFragment
                                                (GdomeDocument *self,
                                                 GdomeException *exc);
    GdomeText*  gdome_doc_createTextNode        (GdomeDocument *self,
                                                 GdomeDOMString *data,
                                                 GdomeException *exc);
    GdomeComment* gdome_doc_createComment       (GdomeDocument *self,
                                                 GdomeDOMString *data,
                                                 GdomeException *exc);
    GdomeCDATASection* gdome_doc_createCDATASection
                                                (GdomeDocument *self,
                                                 GdomeDOMString *data,
                                                 GdomeException *exc);
    GdomeProcessingInstruction* gdome_doc_createProcessingInstruction
                                                (GdomeDocument *self,
                                                 GdomeDOMString *target,
                                                 GdomeDOMString *data,
                                                 GdomeException *exc);
    GdomeAttr*  gdome_doc_createAttribute       (GdomeDocument *self,
                                                 GdomeDOMString *name,
                                                 GdomeException *exc);
    GdomeEntityReference* gdome_doc_createEntityReference
                                                (GdomeDocument *self,
                                                 GdomeDOMString *name,
                                                 GdomeException *exc);
    GdomeNodeList* gdome_doc_getElementsByTagName
                                                (GdomeDocument *self,
                                                 GdomeDOMString *tagname,
                                                 GdomeException *exc);
    GdomeNode*  gdome_doc_importNode            (GdomeDocument *self,
                                                 GdomeNode *importedNode,
                                                 GdomeBoolean deep,
                                                 GdomeException *exc);
    GdomeElement* gdome_doc_createElementNS     (GdomeDocument *self,
                                                 GdomeDOMString *namespaceURI,
                                                 GdomeDOMString *qualifiedName,
                                                 GdomeException *exc);
    GdomeAttr*  gdome_doc_createAttributeNS     (GdomeDocument *self,
                                                 GdomeDOMString *namespaceURI,
                                                 GdomeDOMString *qualifiedName,
                                                 GdomeException *exc);
    GdomeNodeList* gdome_doc_getElementsByTagNameNS
                                                (GdomeDocument *self,
                                                 GdomeDOMString *namespaceURI,
                                                 GdomeDOMString *localName,
                                                 GdomeException *exc);
    GdomeElement* gdome_doc_getElementById      (GdomeDocument *self,
                                                 GdomeDOMString *elementId,
                                                 GdomeException *exc);
    GdomeEvent* gdome_doc_createEvent           (GdomeDocument *self,
                                                 GdomeDOMString *eventType,
                                                 GdomeException *exc);
    void        gdome_doc_ref                   (GdomeDocument *self,
                                                 GdomeException *exc);
    void        gdome_doc_unref                 (GdomeDocument *self,
                                                 GdomeException *exc);
    gpointer    gdome_doc_query_interface       (GdomeDocument *self,
                                                 const char *interface,
                                                 GdomeException *exc);
    GdomeDOMString* gdome_doc_nodeName          (GdomeDocument *self,
                                                 GdomeException *exc);
    GdomeDOMString* gdome_doc_nodeValue         (GdomeDocument *self,
                                                 GdomeException *exc);
    void        gdome_doc_set_nodeValue         (GdomeDocument *self,
                                                 GdomeDOMString *nodeValue,
                                                 GdomeException *exc);
    unsigned short gdome_doc_nodeType           (GdomeDocument *self,
                                                 GdomeException *exc);
    GdomeNode*  gdome_doc_parentNode            (GdomeDocument *self,
                                                 GdomeException *exc);
    GdomeNodeList* gdome_doc_childNodes         (GdomeDocument *self,
                                                 GdomeException *exc);
    GdomeNode*  gdome_doc_firstChild            (GdomeDocument *self,
                                                 GdomeException *exc);
    GdomeNode*  gdome_doc_lastChild             (GdomeDocument *self,
                                                 GdomeException *exc);
    GdomeNode*  gdome_doc_previousSibling       (GdomeDocument *self,
                                                 GdomeException *exc);
    GdomeNode*  gdome_doc_nextSibling           (GdomeDocument *self,
                                                 GdomeException *exc);
    GdomeNamedNodeMap* gdome_doc_attributes     (GdomeDocument *self,
                                                 GdomeException *exc);
    GdomeDocument* gdome_doc_ownerDocument      (GdomeDocument *self,
                                                 GdomeException *exc);
    GdomeNode*  gdome_doc_insertBefore          (GdomeDocument *self,
                                                 GdomeNode *newChild,
                                                 GdomeNode *refChild,
                                                 GdomeException *exc);
    GdomeNode*  gdome_doc_replaceChild          (GdomeDocument *self,
                                                 GdomeNode *newChild,
                                                 GdomeNode *oldChild,
                                                 GdomeException *exc);
    GdomeNode*  gdome_doc_removeChild           (GdomeDocument *self,
                                                 GdomeNode *oldChild,
                                                 GdomeException *exc);
    GdomeNode*  gdome_doc_appendChild           (GdomeDocument *self,
                                                 GdomeNode *newChild,
                                                 GdomeException *exc);
    GdomeBoolean gdome_doc_hasChildNodes        (GdomeDocument *self,
                                                 GdomeException *exc);
    GdomeNode*  gdome_doc_cloneNode             (GdomeDocument *self,
                                                 GdomeBoolean deep,
                                                 GdomeException *exc);
    void        gdome_doc_normalize             (GdomeDocument *self,
                                                 GdomeException *exc);
    GdomeBoolean gdome_doc_isSupported          (GdomeDocument *self,
                                                 GdomeDOMString *feature,
                                                 GdomeDOMString *version,
                                                 GdomeException *exc);
    GdomeDOMString* gdome_doc_namespaceURI      (GdomeDocument *self,
                                                 GdomeException *exc);
    GdomeDOMString* gdome_doc_prefix            (GdomeDocument *self,
                                                 GdomeException *exc);
    void        gdome_doc_set_prefix            (GdomeDocument *self,
                                                 GdomeDOMString *prefix,
                                                 GdomeException *exc);
    GdomeDOMString* gdome_doc_localName         (GdomeDocument *self,
                                                 GdomeException *exc);
    GdomeBoolean gdome_doc_hasAttributes        (GdomeDocument *self,
                                                 GdomeException *exc);
    void        gdome_doc_addEventListener      (GdomeDocument *self,
                                                 GdomeDOMString *type,
                                                 GdomeEventListener *listener,
                                                 GdomeBoolean useCapture,
                                                 GdomeException *exc);
    void        gdome_doc_removeEventListener   (GdomeDocument *self,
                                                 GdomeDOMString *type,
                                                 GdomeEventListener *listener,
                                                 GdomeBoolean useCapture,
                                                 GdomeException *exc);
    GdomeBoolean gdome_doc_dispatchEvent        (GdomeDocument *self,
                                                 GdomeEvent *evt,
                                                 GdomeException *exc);
    void        gdome_doc_subTreeDispatchEvent  (GdomeDocument *self,
                                                 GdomeEvent *evt,
                                                 GdomeException *exc);
    GdomeBoolean gdome_doc_canAppend            (GdomeDocument *self,
                                                 GdomeNode *newChild,
                                                 GdomeException *exc);

## Description

The GdomeDocument interface represents the entire HTML or XML document. Conceptually, it is the root of the document tree, and provides the primary access to the document's data.

Since elements, text nodes, comments, processing instructions, etc. cannot exist outside the context of a GdomeDocument, the GdomeDocument interface also contains the factory methods needed to create these objects. The GdomeNode objects created have a gdome_n_ownerDocument() method which associates them with the GdomeDocument within whose context they were created.

## Details

### struct GdomeDocument

    struct GdomeDocument {
    	gpointer user_data;
    };

### gdome_doc_doctype ()

    GdomeDocumentType* gdome_doc_doctype        (GdomeDocument *self,
                                                 GdomeException *exc);

`self` : | Document Object ref
`exc` : | Exception Object ref
Returns : | The Document Type Declaration associated with this document. The DOM Level 2 does not support editing the Document Type Declaration. docType cannot be altered in any way, including through the use of methods inherited from the Node interface, such as insertNode or removeNode.

### gdome_doc_implementation ()

    GdomeDOMImplementation* gdome_doc_implementation
                                                (GdomeDocument *self,
                                                 GdomeException *exc);

`self` : | Document Object ref
`exc` : | Exception Object ref
Returns : | the DOMImplementation object that handles this document.

### gdome_doc_documentElement ()

    GdomeElement* gdome_doc_documentElement     (GdomeDocument *self,
                                                 GdomeException *exc);

`self` : | Document Object ref
`exc` : | Exception Object ref
Returns : | the root Element of the Document.

### gdome_doc_createElement ()

    GdomeElement* gdome_doc_createElement       (GdomeDocument *self,
                                                 GdomeDOMString *tagName,
                                                 GdomeException *exc);

Creates an element of the type specified. Note that the instance returned implements the Element interface, so attributes can be specified directly on the returned object. To create an element with a qualified name and namespace URI, use the gdome_doc_createElementNS() function.

`self` : | Document Object ref
`tagName` : | The name of the element type to instantiate.
`exc` : | Exception Object ref
Returns : | a new Element object with the nodeName attribute set to tagName, and localName, prefix, and namespaceURI set to `NULL`.

### gdome_doc_createDocumentFragment ()

    GdomeDocumentFragment* gdome_doc_createDocumentFragment
                                                (GdomeDocument *self,
                                                 GdomeException *exc);

Creates an empty DocumentFragment object.

`self` : | Document Object ref
`exc` : | Exception Object ref
Returns : | the new DocumentFragment object.

### gdome_doc_createTextNode ()

    GdomeText*  gdome_doc_createTextNode        (GdomeDocument *self,
                                                 GdomeDOMString *data,
                                                 GdomeException *exc);

Creates a Text node given the specified string.

`self` : | Document Object ref
`data` : | The data for the node
`exc` : | Exception Object ref
Returns : | The new TextNode object.

### gdome_doc_createComment ()

    GdomeComment* gdome_doc_createComment       (GdomeDocument *self,
                                                 GdomeDOMString *data,
                                                 GdomeException *exc);

Creates a Comment node whose value is the specified string.

`self` : | Document Object ref
`data` : | The data for the comment contents
`exc` : | Exception Object ref
Returns : | the new Comment object.

### gdome_doc_createCDATASection ()

    GdomeCDATASection* gdome_doc_createCDATASection
                                                (GdomeDocument *self,
                                                 GdomeDOMString *data,
                                                 GdomeException *exc);

Creates a CDATASection node whose value is the specified string.

`self` : | Document Object ref
`data` : | The data for the CDATASection contents
`exc` : | Exception Object ref
Returns : | the new CDATASection object.

### gdome_doc_createProcessingInstruction ()

    GdomeProcessingInstruction* gdome_doc_createProcessingInstruction
                                                (GdomeDocument *self,
                                                 GdomeDOMString *target,
                                                 GdomeDOMString *data,
                                                 GdomeException *exc);

Creates a ProcessingInstruction node given the specified name and data strings.

`self` : | Document Object ref
`target` : | The target part of the processing instruction
`data` : | The data for the node
`exc` : | Exception Object ref
Returns : | The new ProcessingInstruction object.

### gdome_doc_createAttribute ()

    GdomeAttr*  gdome_doc_createAttribute       (GdomeDocument *self,
                                                 GdomeDOMString *name,
                                                 GdomeException *exc);

Creates an Attr of the given `name`. Note that the Attr instance can then be set on an Element using the setAttributeNode method. To create an attribute with a qualified name and namespace URI, use the gdome_doc_createAttributeNS() method.

`self` : | Document Object ref
`name` : | The name of the attribute
`exc` : | Exception Object ref
Returns : | a new Attr object with the nodeName attribute set to `name`, and localName, prefix, and namespaceURI set to `NULL`. The value of the attribute is the empty string.

### gdome_doc_createEntityReference ()

    GdomeEntityReference* gdome_doc_createEntityReference
                                                (GdomeDocument *self,
                                                 GdomeDOMString *name,
                                                 GdomeException *exc);

Creates an EntityReference object. In addition, if the referenced entity is known, the child list of the EntityReference node is made the same as that of the corresponding Entity node.

`self` : | Document Object ref
`name` : | The name of the entity to reference
`exc` : | Exception Object ref
Returns : | the new EntityReference object.

### gdome_doc_getElementsByTagName ()

    GdomeNodeList* gdome_doc_getElementsByTagName
                                                (GdomeDocument *self,
                                                 GdomeDOMString *tagname,
                                                 GdomeException *exc);

`self` : | Document Object ref
`tagname` : | The name of the tag to match on. The special value * matches all tags.
`exc` : | Exception Object ref
Returns : | a NodeList of all the elements with a given tag name in the order in which they are encountered in a preorder traversal of the Document tree.

### gdome_doc_importNode ()

    GdomeNode*  gdome_doc_importNode            (GdomeDocument *self,
                                                 GdomeNode *importedNode,
                                                 GdomeBoolean deep,
                                                 GdomeException *exc);

Imports a node from another document to this document. The returned node has no parent; (parentNode is `NULL`). The source node is not altered or removed from the original document; this method creates a new copy of the source node. `GDOME_DOCUMENT_NODE`, `GDOME_DOCUMENT_TYPE_NODE`, `GDOME_NOTATION_NODE` and `GDOME_ENTITY_NODE` nodes are not supported.

`GDOME_NOT_SUPPORTED_ERR`: Raised if the type of node being imported is not supported.

`self` : | Document Objects ref
`importedNode` : | The node to import.
`deep` : | If `TRUE`, recursively import the subtree under the specified node; if `FALSE`, import only the node itself. This has no effect on Attr, EntityReference, and Notation nodes.
`exc` : | Exception Object ref
Returns : | the imported node that belongs to this Document.

### gdome_doc_createElementNS ()

    GdomeElement* gdome_doc_createElementNS     (GdomeDocument *self,
                                                 GdomeDOMString *namespaceURI,
                                                 GdomeDOMString *qualifiedName,
                                                 GdomeException *exc);

Creates an element of the given qualified name and namespace URI.

`GDOME_NAMESPACE_ERR`: Raised if the `qualifiedName` is malformed, if the `qualifiedName` has a prefix and the `namespaceURI` is `NULL`, or if the `qualifiedName` has a prefix that is "xml" and the `namespaceURI` is different from "http://www.w3.org/XML/1998/namespace".

`self` : | Document Object ref
`namespaceURI` : | The namespace URI of the element to create
`qualifiedName` : | The qualified name of the element to create
`exc` : | Exception Object ref
Returns : | a new Element object with the following attributes: `Node`.nodeName = `qualifiedName`, `Node`.namespaceURI = `namespaceURI`, `Node`.prefix = prefix, extracted from `qualifiedName`, `Node`.localName = localName, extracted from `qualifiedName`, `Element`.tagName = `qualifiedName`.

### gdome_doc_createAttributeNS ()

    GdomeAttr*  gdome_doc_createAttributeNS     (GdomeDocument *self,
                                                 GdomeDOMString *namespaceURI,
                                                 GdomeDOMString *qualifiedName,
                                                 GdomeException *exc);

Creates an attribute of the given qualified name and namespace URI.

`GDOME_NAMESPACE_ERR`: Raised if the `qualifiedName` is malformed, if the `qualifiedName` has a prefix and the `namespaceURI` is `NUKK`, if the `qualifiedName` has a prefix that is "xml" and the `namespaceURI` is different from "http://www.w3.org/XML/1998/namespace", or if the `qualifiedName` is "xmlns" and the `namespaceURI` is different from "http://www.w3.org/2000/xmlns/".

`self` : | Document Object ref
`namespaceURI` : | The namespace URI of the attribute to create
`qualifiedName` : | The qualified name of the attribute to create
`exc` : | Exception Object ref
Returns : | a new Attr object with the following attributes: `Node`.nodeName = `qualifiedName`, `Node`.namespaceURI = `namespaceURI`, `Node`.prefix = prefix, extracted from `qualifiedName`, `Node`.localName = localName, extracted from `qualifiedName`, `Attr`.name = `qualifiedName`, `Node`.nodeValue = the empty string.

### gdome_doc_getElementsByTagNameNS ()

    GdomeNodeList* gdome_doc_getElementsByTagNameNS
                                                (GdomeDocument *self,
                                                 GdomeDOMString *namespaceURI,
                                                 GdomeDOMString *localName,
                                                 GdomeException *exc);

`self` : | Document Objects ref
`namespaceURI` : | The namespace URI of the elements to match on. The special value * matches all namespaces.
`localName` : | The local name of the elements to match on. The special value * matches all local names.
`exc` : | Document Object ref
Returns : | a NodeList of all the descendant elements with a given local name and namespace URI in the order in which they are encountered in a preorder traversal of this Document tree.

### gdome_doc_getElementById ()

    GdomeElement* gdome_doc_getElementById      (GdomeDocument *self,
                                                 GdomeDOMString *elementId,
                                                 GdomeException *exc);

`self` : | Document Object ref
`elementId` : | The unique id value for an element
`exc` : | Exception Object ref
Returns : | the Element whose `ID` is given by `elementId`. If no such element exists, returns `NULL`. Behavior is not defined if more than one element has this `ID`.

### gdome_doc_createEvent ()

    GdomeEvent* gdome_doc_createEvent           (GdomeDocument *self,
                                                 GdomeDOMString *eventType,
                                                 GdomeException *exc);

If the Event interface specified is supported by the implementation this method will return a new Event of the interface type requested. If the Event is to be dispatched via the dispatchEvent method the appropriate event init method must be called after creation in order to initialize the Event's values. As an example, a user wishing to synthesize some kind of MutationEvents would call createEvent with the parameter "MutationEvents". The gdome_mevnt_initMuatationEvent() method could then be called on the newly created MutationEvent to set the specific type of MutationEvent to be dispatched and set its context information.

GDOME_NOT_SUPPORTED_ERR: Raised if the implementation does not support the type of Event interface requested

`self` : | Document Objects ref
`eventType` : | The `eventType` parameter specifies the type of Event interface to be created.
`exc` : | Exception Object ref
Returns : | the newly created Event.

### gdome_doc_ref ()

    void        gdome_doc_ref                   (GdomeDocument *self,
                                                 GdomeException *exc);

Increase the reference count of the specified Node.

`self` : | Node Object ref
`exc` : | Exception Object ref

### gdome_doc_unref ()

    void        gdome_doc_unref                 (GdomeDocument *self,
                                                 GdomeException *exc);

Decrease the reference count of the specified Node. Free the Node structure if the Node will have zero reference.

`self` : | Node Object ref
`exc` : | Exception Object ref

### gdome_doc_query_interface ()

    gpointer    gdome_doc_query_interface       (GdomeDocument *self,
                                                 const char *interface,
                                                 GdomeException *exc);

`self` : | Node Object ref
`interface` : | interface needed
`exc` : | Exception Object ref
Returns : | a reference to this object that implements the `interface` needed, or `NULL` if the `interface` is not supported by this Object.

### gdome_doc_nodeName ()

    GdomeDOMString* gdome_doc_nodeName          (GdomeDocument *self,
                                                 GdomeException *exc);

`self` : | Node Object ref
`exc` : | Exception Object ref
Returns : | the name of this node, depending on its type.

### gdome_doc_nodeValue ()

    GdomeDOMString* gdome_doc_nodeValue         (GdomeDocument *self,
                                                 GdomeException *exc);

`self` : | Node Object ref
`exc` : | Exception Object ref
Returns : | the value of this node, depending on its type.

### gdome_doc_set_nodeValue ()

    void        gdome_doc_set_nodeValue         (GdomeDocument *self,
                                                 GdomeDOMString *nodeValue,
                                                 GdomeException *exc);

Sets The value of this node, depending on its type.

`GDOME_NO_MODIFICATION_ALLOWED_ERR`: Raised when the node is readonly.

`self` : | Node Object ref
`nodeValue` : | The new value for this node.
`exc` : | Exception Object ref

### gdome_doc_nodeType ()

    unsigned short gdome_doc_nodeType           (GdomeDocument *self,
                                                 GdomeException *exc);

`self` : | Node Object ref
`exc` : | Exception Object ref
Returns : | an integer bigger than `0` representing the type of the underlying object or `0` on error.

### gdome_doc_parentNode ()

    GdomeNode*  gdome_doc_parentNode            (GdomeDocument *self,
                                                 GdomeException *exc);

`self` : | Node Object ref
`exc` : | Exception Object ref
Returns : | the parent of this node. All nodes, except Attr, Document, DocumentFragment, Entity, and Notation may have a parent. However, if a node has just been created and not yet added to the tree, or if it has been removed from the tree, this is `NULL`.

### gdome_doc_childNodes ()

    GdomeNodeList* gdome_doc_childNodes         (GdomeDocument *self,
                                                 GdomeException *exc);

`self` : | Node Object ref
`exc` : | Exception Object ref
Returns : | a NodeList that contains all children of this node. If there are no children, this is a NodeList containing no nodes. Note that attributes are not considered to be children of element nodes - use gdome_n_attributes to obtain the attributes.

### gdome_doc_firstChild ()

    GdomeNode*  gdome_doc_firstChild            (GdomeDocument *self,
                                                 GdomeException *exc);

`self` : | Node Object ref
`exc` : | Exception Object ref
Returns : | the first child of this node. If there is no such node, this returns `NULL`.

### gdome_doc_lastChild ()

    GdomeNode*  gdome_doc_lastChild             (GdomeDocument *self,
                                                 GdomeException *exc);

`self` : | Node Object ref
`exc` : | Exception Object ref
Returns : | the last child of this node. If there is no such node, this returns `NULL`.

### gdome_doc_previousSibling ()

    GdomeNode*  gdome_doc_previousSibling       (GdomeDocument *self,
                                                 GdomeException *exc);

`self` : | Node Object ref
`exc` : | Exception Object ref
Returns : | the node immediately preceding this node. If there is no such node, this returns `NULL`.

### gdome_doc_nextSibling ()

    GdomeNode*  gdome_doc_nextSibling           (GdomeDocument *self,
                                                 GdomeException *exc);

`self` : | Node Object ref
`exc` : | Exception Object ref
Returns : | the node immediately following this node. If there is no such node, this returns `NULL`.

### gdome_doc_attributes ()

    GdomeNamedNodeMap* gdome_doc_attributes     (GdomeDocument *self,
                                                 GdomeException *exc);

`self` : | Node Object ref
`exc` : | Exception Object ref
Returns : | a NamedNodeMap containing the attributes of this node (if it is an Element) or `NULL` otherwise.

### gdome_doc_ownerDocument ()

    GdomeDocument* gdome_doc_ownerDocument      (GdomeDocument *self,
                                                 GdomeException *exc);

`self` : | Node Objects ref
`exc` : | Exception Object ref
Returns : | the documment object associated with this node. This is also the Document object used to create new nodes. When this node is a Document or a DocumentType which is not used with any Document yet, this is `NULL`.

### gdome_doc_insertBefore ()

    GdomeNode*  gdome_doc_insertBefore          (GdomeDocument *self,
                                                 GdomeNode *newChild,
                                                 GdomeNode *refChild,
                                                 GdomeException *exc);

Inserts the node `newChild` before the existing child node `refChild`. If `refChild` is `NULL`, insert `newChild` at the end of the list of children. If `newChild` is a DocumentFragment node, all of its children are inserted, in the same order, before `refChild`. If the `newChild` is already in the tree, it is first removed.

`GDOME_HIERARCHY_REQUEST_ERR`: Raised if this node is of a type that does not allow children of the type of the `newChild` node, or if the node to insert is one of this node's ancestors or this node itself. `GDOME_WRONG_DOCUMENT_ERR`: Raised if `newChild` was created from a different document than the one that created this node. `GDOME_NOT_FOUND_ERR`: Raised if `refChild` is not a child of this node. `GDOME_NO_MODIFICATION_ALLOWED_ERR`: Raised when the node is readonly.

`self` : | Node Object ref
`newChild` : | The new node to put in the child list
`refChild` : | the reference node, i.e., the node before which the new node must be inserted.
`exc` : | Exception Object ref
Returns : | the node being inserted.

### gdome_doc_replaceChild ()

    GdomeNode*  gdome_doc_replaceChild          (GdomeDocument *self,
                                                 GdomeNode *newChild,
                                                 GdomeNode *oldChild,
                                                 GdomeException *exc);

Replaces the child node `oldChild` with `newChild` in the list of children, and returns the `oldChild` node. If `newChild` is a DocumentFragment object, `oldChild` is replaced by all of the DocumentFragment children, which are inserted in the same order. If the `newChild` is already in the tree, it is first removed.

`GDOME_HIERARCHY_REQUEST_ERR`: Raised if this node is of a type that does not allow children of the type of the `newChild` node, or if the node to put in is one of this node's ancestors or this node itself. `GDOME_WRONG_DOCUMENT_ERR`: Raised if `newChild` was created from a different document than the one that created this node. `GDOME_NOT_FOUND_ERR`: Raised if `oldChild` is not a child of this node. `GDOME_NO_MODIFICATION_ALLOWED_ERR`: Raised when the node is readonly.

`self` : | Node Object ref
`newChild` : | The new node to put in the child list
`oldChild` : | The node being replaced in the list
`exc` : | Exception Object ref
Returns : | the node replaced.

### gdome_doc_removeChild ()

    GdomeNode*  gdome_doc_removeChild           (GdomeDocument *self,
                                                 GdomeNode *oldChild,
                                                 GdomeException *exc);

Removes the child node indicated by `oldChild` from the list of children, and returns it.

`GDOME_NOT_FOUND_ERR`: Raised if `oldChild` is not a child of this node. `GDOME_NO_MODIFICATION_ALLOWED_ERR`: Raised when the node is readonly.

`self` : | Node Object ref
`oldChild` : | The node being removed
`exc` : | Exception Object ref
Returns : | the node removed.

### gdome_doc_appendChild ()

    GdomeNode*  gdome_doc_appendChild           (GdomeDocument *self,
                                                 GdomeNode *newChild,
                                                 GdomeException *exc);

Adds the node `newChild` to the end of the list of children of this node. If the `newChild` is already in the tree, it is first removed. If it is a DocumentFragment node, the entire contents of the document fragment are moved into the child list of this node

`GDOME_HIERARCHY_REQUEST_ERR`: Raised if this node is of a type that does not allow children of the type of the `newChild` node, or if the node to append is one of this node's ancestors or this node itself. `GDOME_WRONG_DOCUMENT_ERR`: Raised if `newChild` was created from a different document than the one that created this node. `GDOME_NO_MODIFICATION_ALLOWED_ERR`: Raised when the node is readonly.

`self` : | Node Object ref
`newChild` : | The node to add
`exc` : | Exception Object ref
Returns : | the node added.

### gdome_doc_hasChildNodes ()

    GdomeBoolean gdome_doc_hasChildNodes        (GdomeDocument *self,
                                                 GdomeException *exc);

`self` : | Node Object ref
`exc` : | Exception Object ref
Returns : | `TRUE` if this node has any children, `FALSE` otherwise.

### gdome_doc_cloneNode ()

    GdomeNode*  gdome_doc_cloneNode             (GdomeDocument *self,
                                                 GdomeBoolean deep,
                                                 GdomeException *exc);

Makes a duplicate of this node, i.e., serves as a generic copy constructor for nodes. The duplicate node has no parent; (parentNode is `NULL`). `GDOME_DOCUMENT_TYPE_NODE`, `GDOME_NOTATION_NODE` and `GDOME_ENTITY_NODE` nodes are not supported.

`GDOME_NOT_SUPPORTED_ERR`: Raised if the type of node being cloned is not supported.

`self` : | Node Object ref
`deep` : | If true, recursively clone the subtree under the specified node; if false, clone only the node itself (and its attributes, if it is an Element).
`exc` : | Exception Object ref
Returns : | the duplicate node.

### gdome_doc_normalize ()

    void        gdome_doc_normalize             (GdomeDocument *self,
                                                 GdomeException *exc);

Puts all Text nodes in the full depth of the sub-tree underneath this Node, including attribute nodes, into a "normal" form where only structure (e.g., elements, comments, processing instructions, CDATA sections, and entity references) separates Text nodes, i.e., there are neither adjacent Text nodes nor empty Text nodes.

`self` : | Node Object ref
`exc` : | Exception Object ref

### gdome_doc_isSupported ()

    GdomeBoolean gdome_doc_isSupported          (GdomeDocument *self,
                                                 GdomeDOMString *feature,
                                                 GdomeDOMString *version,
                                                 GdomeException *exc);

Tests whether the DOM implementation implements a specific feature and that feature is supported by this node.

`self` : | Node Object ref
`feature` : | The name of the feature to test.
`version` : | This is the version number of the feature to test. In Level 2, version 1, this is the string "2.0". If the version is not specified, supporting any version of the feature will cause the method to return `TRUE`.
`exc` : | Exception Object ref
Returns : | `TRUE` if the specified feature is supported on this node, `FALSE` otherwise.

### gdome_doc_namespaceURI ()

    GdomeDOMString* gdome_doc_namespaceURI      (GdomeDocument *self,
                                                 GdomeException *exc);

`self` : | Node Objects ref
`exc` : | Exception Object ref
Returns : | the namespace URI of this node, or `NULL` if it is unspecified. For nodes of any type other than `GDOME_ELEMENT_NODE` and `GDOME_ATTRIBUTE_NODE` and nodes created with a DOM Level 1 method, this is always `NULL`.

### gdome_doc_prefix ()

    GdomeDOMString* gdome_doc_prefix            (GdomeDocument *self,
                                                 GdomeException *exc);

`self` : | Node Objects ref
`exc` : | Exception Object ref
Returns : | the namespace prefix of this node, or `NULL` if it is unspecified. For nodes of any type other than `GDOME_ELEMENT_NODE` and `GDOME_ATTRIBUTE_NODE` and nodes created with a DOM Level 1 method, this is always `NULL`.

### gdome_doc_set_prefix ()

    void        gdome_doc_set_prefix            (GdomeDocument *self,
                                                 GdomeDOMString *prefix,
                                                 GdomeException *exc);

Sets a new nemaspace prefix for this node.

`GDOME_NO_MODIFICATION_ALLOWED_ERR`: Raised when the node is readonly. `GDOME_NAMESPACE_ERR`: Raised if the specified `prefix` is malformed per the Namespaces in XML specification, if the namespaceURI of this node is `NULL`, if the specified prefix is "xml" and the namespaceURI of this node is different from "http://www.w3.org/XML/1998/namespace", if this node is an attribute and the specified prefix is "xmlns" and the namespaceURI of this node is different from "http://www.w3.org/2000/xmlns/", or if this node is an attribute and the qualifiedName of this node is "xmlns".

`self` : | Node Object ref
`prefix` : | The new prefix for this node.
`exc` : | Exception Object ref

### gdome_doc_localName ()

    GdomeDOMString* gdome_doc_localName         (GdomeDocument *self,
                                                 GdomeException *exc);

`self` : | Node Objects ref
`exc` : | Exception Object ref
Returns : | the local part of the qualified name of this node. For nodes of any type other than `GDOME_ELEMENT_NODE` and `GDOME_ATTRIBUTE_NODE` and nodes created with a DOM Level 1 method, this is always `NULL`.

### gdome_doc_hasAttributes ()

    GdomeBoolean gdome_doc_hasAttributes        (GdomeDocument *self,
                                                 GdomeException *exc);

`self` : | Node Object ref
`exc` : | Exception Object ref
Returns : | `TRUE` if this node has any attributes, `FALSE` otherwise.

### gdome_doc_addEventListener ()

    void        gdome_doc_addEventListener      (GdomeDocument *self,
                                                 GdomeDOMString *type,
                                                 GdomeEventListener *listener,
                                                 GdomeBoolean useCapture,
                                                 GdomeException *exc);

This method allows the registration of event listeners on the event target. If an EventListener is added to an EventTarget while it is processing an event, it will not be triggered by the current actions but may be triggered during a later stage of event flow, such as the bubbling phase. If multiple identical EventListeners are registered on the same EventTarget with the same parameters the duplicate instances are discarded. They do not cause the EventListener to be called twice and since they are discarded they do not need to be removed with the removeEventListener method.

`self` : | Node Object ref
`type` : | the event type for which the user is registering
`listener` : | the listener parameter takes an interface implemented by the user which contains the methods to be called when the event occurs.
`useCapture` : | if `TRUE`, useCapture indicates that the user wishes to initiate capture. After initiating capture, all events of the specified type will be dispatched to the registered EventListener before being dispatched to any EventTargets beneath them in the tree. Events which are bubbling upward through the tree will not trigger an EventListener designated to use capture.
`exc` : | Exception Object ref

### gdome_doc_removeEventListener ()

    void        gdome_doc_removeEventListener   (GdomeDocument *self,
                                                 GdomeDOMString *type,
                                                 GdomeEventListener *listener,
                                                 GdomeBoolean useCapture,
                                                 GdomeException *exc);

This method allows the removal of event listeners from the event target. If an EventListener is removed from an EventTarget while it is processing an event, it will not be triggered by the current actions. EventListeners can never be invoked after being removed. Calling removeEventListener with arguments which do not identify any currently registered EventListener on the EventTarget has no effect.

`self` : | Node Object ref
`type` : | Specifies the event type of the EventListener being removed.
`listener` : | The EventListener parameter indicates the EventListener to be removed.
`useCapture` : | Specifies whether the EventListener being removed was registered as a capturing listener or not. If a listener was registered twice, one with capture and one without, each must be removed separately. Removal of a capturing listener does not affect a non-capturing version of the same listener, and vice versa.
`exc` : | Exception Object ref

### gdome_doc_dispatchEvent ()

    GdomeBoolean gdome_doc_dispatchEvent        (GdomeDocument *self,
                                                 GdomeEvent *evt,
                                                 GdomeException *exc);

This method allows the dispatch of events into the implementations event model. Events dispatched in this manner will have the same capturing and bubbling behavior as events dispatched directly by the implementation. The target of the event is the EventTarget on which dispatchEvent is called.

GDOME_UNSPECIFIED_EVENT_TYPE_ERR: Raised if the Event's type was not specified by initializing the event before dispatchEvent was called. Specification of the Event's type as `NULL` or an empty string will also trigger this exception.

`self` : | Node Object ref
`evt` : | Specifies the event type, behavior, and contextual information to be used in processing the event.
`exc` : | Exception Object ref
Returns : | if preventDefault was called the value is `FALSE`, else the value is `TRUE`.

### gdome_doc_subTreeDispatchEvent ()

    void        gdome_doc_subTreeDispatchEvent  (GdomeDocument *self,
                                                 GdomeEvent *evt,
                                                 GdomeException *exc);

This method allows the dispatch of events into the implementations event model. Events dispatched in this manner will have the same capturing and bubbling behavior as events dispatched directly by the implementation. The target of the event is any nodes in the subtree of the EventTarget on which dispatchEvent is called.

GDOME_UNSPECIFIED_EVENT_TYPE_ERR: Raised if the Event's type was not specified by initializing the event before dispatchEvent was called. Specification of the Event's type as `NULL` or an empty string will also trigger this exception.

`self` : | Node Object ref
`evt` : | Specifies the event type, behavior, and contextual information to be used in processing the event.
`exc` : | Exception Object ref

### gdome_doc_canAppend ()

    GdomeBoolean gdome_doc_canAppend            (GdomeDocument *self,
                                                 GdomeNode *newChild,
                                                 GdomeException *exc);

Tests if a `newChild` can be added in the child list of this node.

`self` : | Node Object ref
`newChild` : | The Node Object ref of the node to test
`exc` : | Exception Object ref
Returns : | `TRUE` if `newChild` can be added, `FALSE` otherwise.

<<< Previous Page | Home | Up | Next Page >>>
GdomeDocumentFragment | GdomeNode