GdomeEntity

Name

GdomeEntity -- 

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);
void*       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);

Description

Details

struct GdomeEntity

struct GdomeEntity {
	const GdomeEntityVtab *vtab; /* deprecated */
	GdomePrivateList *private;
};


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 ()

void*       gdome_ent_query_interface       (GdomeEntity *self,
                                             const char *interface,
                                             GdomeException *exc);

NOT IMPLEMENTED

self : 
interface : 
exc : 


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.


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_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_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_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);

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 : 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_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, 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);

NOT IMPLEMENTED YET

self : 
type : 
listener : 
useCapture : 
exc : 


gdome_ent_removeEventListener ()

void        gdome_ent_removeEventListener   (GdomeEntity *self,
                                             GdomeDOMString *type,
                                             GdomeEventListener *listener,
                                             GdomeBoolean useCapture,
                                             GdomeException *exc);

NOT IMPLEMENTED YET

self : 
type : 
listener : 
useCapture : 
exc : 


gdome_ent_dispatchEvent ()

GdomeBoolean gdome_ent_dispatchEvent        (GdomeEntity *self,
                                             GdomeEvent *evt,
                                             GdomeException *exc);

NOT IMPLEMENTED YET

self : 
evt : 
exc : 
Returns : *