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

# GdomeEntity

## Name

GdomeEntity -- Interface Entity implementation.

## Synopsis

    struct      GdomeEntity;
    GdomeDOMString* gdome_ent_publicId          (GdomeEntity *self,
                                                 GdomeException *exc);
    GdomeDOMString* gdome_ent_systemId          (GdomeEntity *self,
                                                 GdomeException *exc);
    GdomeDOMString* gdome_ent_notationName      (GdomeEntity *self,
                                                 GdomeException *exc);
    void        gdome_ent_ref                   (GdomeEntity *self,
                                                 GdomeException *exc);
    void        gdome_ent_unref                 (GdomeEntity *self,
                                                 GdomeException *exc);
    gpointer    gdome_ent_query_interface       (GdomeEntity *self,
                                                 const char *interface,
                                                 GdomeException *exc);
    GdomeDOMString* gdome_ent_nodeName          (GdomeEntity *self,
                                                 GdomeException *exc);
    GdomeDOMString* gdome_ent_nodeValue         (GdomeEntity *self,
                                                 GdomeException *exc);
    void        gdome_ent_set_nodeValue         (GdomeEntity *self,
                                                 GdomeDOMString *nodeValue,
                                                 GdomeException *exc);
    unsigned short gdome_ent_nodeType           (GdomeEntity *self,
                                                 GdomeException *exc);
    GdomeNode*  gdome_ent_parentNode            (GdomeEntity *self,
                                                 GdomeException *exc);
    GdomeNodeList* gdome_ent_childNodes         (GdomeEntity *self,
                                                 GdomeException *exc);
    GdomeNode*  gdome_ent_firstChild            (GdomeEntity *self,
                                                 GdomeException *exc);
    GdomeNode*  gdome_ent_lastChild             (GdomeEntity *self,
                                                 GdomeException *exc);
    GdomeNode*  gdome_ent_previousSibling       (GdomeEntity *self,
                                                 GdomeException *exc);
    GdomeNode*  gdome_ent_nextSibling           (GdomeEntity *self,
                                                 GdomeException *exc);
    GdomeNamedNodeMap* gdome_ent_attributes     (GdomeEntity *self,
                                                 GdomeException *exc);
    GdomeDocument* gdome_ent_ownerDocument      (GdomeEntity *self,
                                                 GdomeException *exc);
    GdomeNode*  gdome_ent_insertBefore          (GdomeEntity *self,
                                                 GdomeNode *newChild,
                                                 GdomeNode *refChild,
                                                 GdomeException *exc);
    GdomeNode*  gdome_ent_replaceChild          (GdomeEntity *self,
                                                 GdomeNode *newChild,
                                                 GdomeNode *oldChild,
                                                 GdomeException *exc);
    GdomeNode*  gdome_ent_removeChild           (GdomeEntity *self,
                                                 GdomeNode *oldChild,
                                                 GdomeException *exc);
    GdomeNode*  gdome_ent_appendChild           (GdomeEntity *self,
                                                 GdomeNode *newChild,
                                                 GdomeException *exc);
    GdomeBoolean gdome_ent_hasChildNodes        (GdomeEntity *self,
                                                 GdomeException *exc);
    GdomeNode*  gdome_ent_cloneNode             (GdomeEntity *self,
                                                 GdomeBoolean deep,
                                                 GdomeException *exc);
    void        gdome_ent_normalize             (GdomeEntity *self,
                                                 GdomeException *exc);
    GdomeBoolean gdome_ent_isSupported          (GdomeEntity *self,
                                                 GdomeDOMString *feature,
                                                 GdomeDOMString *version,
                                                 GdomeException *exc);
    GdomeDOMString* gdome_ent_namespaceURI      (GdomeEntity *self,
                                                 GdomeException *exc);
    GdomeDOMString* gdome_ent_prefix            (GdomeEntity *self,
                                                 GdomeException *exc);
    void        gdome_ent_set_prefix            (GdomeEntity *self,
                                                 GdomeDOMString *prefix,
                                                 GdomeException *exc);
    GdomeDOMString* gdome_ent_localName         (GdomeEntity *self,
                                                 GdomeException *exc);
    GdomeBoolean gdome_ent_hasAttributes        (GdomeEntity *self,
                                                 GdomeException *exc);
    void        gdome_ent_addEventListener      (GdomeEntity *self,
                                                 GdomeDOMString *type,
                                                 GdomeEventListener *listener,
                                                 GdomeBoolean useCapture,
                                                 GdomeException *exc);
    void        gdome_ent_removeEventListener   (GdomeEntity *self,
                                                 GdomeDOMString *type,
                                                 GdomeEventListener *listener,
                                                 GdomeBoolean useCapture,
                                                 GdomeException *exc);
    GdomeBoolean gdome_ent_dispatchEvent        (GdomeEntity *self,
                                                 GdomeEvent *evt,
                                                 GdomeException *exc);
    void        gdome_ent_subTreeDispatchEvent  (GdomeEntity *self,
                                                 GdomeEvent *evt,
                                                 GdomeException *exc);
    GdomeBoolean gdome_ent_canAppend            (GdomeEntity *self,
                                                 GdomeNode *newChild,
                                                 GdomeException *exc);

## Description

This interface represents an entity, either parsed or unparsed, in an XML document. Note that this models the entity itself not the entity declaration.

The gdome_ent_nodeName() method that is inherited from GdomeNode contains the name of the entity.

An XML processor may choose to completely expand entities before the structure model is passed to the DOM; in this case there will be no EntityReference nodes in the document tree. You can do that with the `GDOME_LOAD_SUBSTITUTE_ENTITIES` flag in methods that load document (i.e. gdome_di_createDocFromUri()).

The DOM Level 2 does not support editing GdomeEntity nodes; if a user wants to make changes to the contents of an GdomeEntity, every related GdomeEntityReference node has to be replaced in the structure model by a clone of the GdomeEntity 's contents, and then the desired changes must be made to each of those clones instead. GdomeEntity nodes and all their descendants are readonly.

An GdomeEntity node does not have any parent.

## Details

### struct GdomeEntity

    struct GdomeEntity {
    	gpointer user_data;
    };

### gdome_ent_publicId ()

    GdomeDOMString* gdome_ent_publicId          (GdomeEntity *self,
                                                 GdomeException *exc);

`self` : | The Entity Object ref
`exc` : | The Exception Object ref
Returns : | the public identifier associated with the entity, if specified. If the public identifier was not specified, this is `NULL`.

### gdome_ent_systemId ()

    GdomeDOMString* gdome_ent_systemId          (GdomeEntity *self,
                                                 GdomeException *exc);

`self` : | The Entity Object ref
`exc` : | The Exception Object ref
Returns : | the system identifier associated with the entity, if specified. If the system identifier was not specified, this is `NULL`.

### gdome_ent_notationName ()

    GdomeDOMString* gdome_ent_notationName      (GdomeEntity *self,
                                                 GdomeException *exc);

`self` : | The Entity Object ref
`exc` : | The Exception Object ref
Returns : | for unparsed entities, the name of the notation for the entity. For parsed entities, this is `NULL`.

### gdome_ent_ref ()

    void        gdome_ent_ref                   (GdomeEntity *self,
                                                 GdomeException *exc);

Increase the reference count of the specified Node.

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

### gdome_ent_unref ()

    void        gdome_ent_unref                 (GdomeEntity *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_ent_query_interface ()

    gpointer    gdome_ent_query_interface       (GdomeEntity *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_ent_nodeName ()

    GdomeDOMString* gdome_ent_nodeName          (GdomeEntity *self,
                                                 GdomeException *exc);

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

### gdome_ent_nodeValue ()

    GdomeDOMString* gdome_ent_nodeValue         (GdomeEntity *self,
                                                 GdomeException *exc);

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

### gdome_ent_set_nodeValue ()

    void        gdome_ent_set_nodeValue         (GdomeEntity *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_ent_nodeType ()

    unsigned short gdome_ent_nodeType           (GdomeEntity *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_ent_parentNode ()

    GdomeNode*  gdome_ent_parentNode            (GdomeEntity *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_ent_childNodes ()

    GdomeNodeList* gdome_ent_childNodes         (GdomeEntity *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_ent_firstChild ()

    GdomeNode*  gdome_ent_firstChild            (GdomeEntity *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_ent_lastChild ()

    GdomeNode*  gdome_ent_lastChild             (GdomeEntity *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_ent_previousSibling ()

    GdomeNode*  gdome_ent_previousSibling       (GdomeEntity *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_ent_nextSibling ()

    GdomeNode*  gdome_ent_nextSibling           (GdomeEntity *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_ent_attributes ()

    GdomeNamedNodeMap* gdome_ent_attributes     (GdomeEntity *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_ent_ownerDocument ()

    GdomeDocument* gdome_ent_ownerDocument      (GdomeEntity *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_ent_insertBefore ()

    GdomeNode*  gdome_ent_insertBefore          (GdomeEntity *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_ent_replaceChild ()

    GdomeNode*  gdome_ent_replaceChild          (GdomeEntity *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_ent_removeChild ()

    GdomeNode*  gdome_ent_removeChild           (GdomeEntity *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_ent_appendChild ()

    GdomeNode*  gdome_ent_appendChild           (GdomeEntity *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_ent_hasChildNodes ()

    GdomeBoolean gdome_ent_hasChildNodes        (GdomeEntity *self,
                                                 GdomeException *exc);

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

### gdome_ent_cloneNode ()

    GdomeNode*  gdome_ent_cloneNode             (GdomeEntity *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_ent_normalize ()

    void        gdome_ent_normalize             (GdomeEntity *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_ent_isSupported ()

    GdomeBoolean gdome_ent_isSupported          (GdomeEntity *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_ent_namespaceURI ()

    GdomeDOMString* gdome_ent_namespaceURI      (GdomeEntity *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_ent_prefix ()

    GdomeDOMString* gdome_ent_prefix            (GdomeEntity *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_ent_set_prefix ()

    void        gdome_ent_set_prefix            (GdomeEntity *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_ent_localName ()

    GdomeDOMString* gdome_ent_localName         (GdomeEntity *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_ent_hasAttributes ()

    GdomeBoolean gdome_ent_hasAttributes        (GdomeEntity *self,
                                                 GdomeException *exc);

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

### gdome_ent_addEventListener ()

    void        gdome_ent_addEventListener      (GdomeEntity *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_ent_removeEventListener ()

    void        gdome_ent_removeEventListener   (GdomeEntity *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_ent_dispatchEvent ()

    GdomeBoolean gdome_ent_dispatchEvent        (GdomeEntity *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_ent_subTreeDispatchEvent ()

    void        gdome_ent_subTreeDispatchEvent  (GdomeEntity *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_ent_canAppend ()

    GdomeBoolean gdome_ent_canAppend            (GdomeEntity *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 >>>
GdomeNotation | GdomeEntityReference