GdomeComment

Name

GdomeComment -- 

Synopsis



struct      GdomeComment;
GdomeDOMString* gdome_c_data                (GdomeComment *self,
                                             GdomeException *exc);
void        gdome_c_set_data                (GdomeComment *self,
                                             GdomeDOMString *data,
                                             GdomeException *exc);
unsigned long gdome_c_length                (GdomeComment *self,
                                             GdomeException *exc);
GdomeDOMString* gdome_c_substringData       (GdomeComment *self,
                                             unsigned long offset,
                                             unsigned long count,
                                             GdomeException *exc);
void        gdome_c_appendData              (GdomeComment *self,
                                             GdomeDOMString *arg,
                                             GdomeException *exc);
void        gdome_c_insertData              (GdomeComment *self,
                                             unsigned long offset,
                                             GdomeDOMString *arg,
                                             GdomeException *exc);
void        gdome_c_deleteData              (GdomeComment *self,
                                             unsigned long offset,
                                             unsigned long count,
                                             GdomeException *exc);
void        gdome_c_replaceData             (GdomeComment *self,
                                             unsigned long offset,
                                             unsigned long count,
                                             GdomeDOMString *arg,
                                             GdomeException *exc);
void        gdome_c_ref                     (GdomeComment *self,
                                             GdomeException *exc);
void        gdome_c_unref                   (GdomeComment *self,
                                             GdomeException *exc);
void*       gdome_c_query_interface         (GdomeComment *self,
                                             const char *interface,
                                             GdomeException *exc);
GdomeDOMString* gdome_c_nodeName            (GdomeComment *self,
                                             GdomeException *exc);
GdomeDOMString* gdome_c_nodeValue           (GdomeComment *self,
                                             GdomeException *exc);
void        gdome_c_set_nodeValue           (GdomeComment *self,
                                             GdomeDOMString *nodeValue,
                                             GdomeException *exc);
unsigned short gdome_c_nodeType             (GdomeComment *self,
                                             GdomeException *exc);
GdomeNode*  gdome_c_parentNode              (GdomeComment *self,
                                             GdomeException *exc);
GdomeNodeList* gdome_c_childNodes           (GdomeComment *self,
                                             GdomeException *exc);
GdomeNode*  gdome_c_firstChild              (GdomeComment *self,
                                             GdomeException *exc);
GdomeNode*  gdome_c_lastChild               (GdomeComment *self,
                                             GdomeException *exc);
GdomeNode*  gdome_c_previousSibling         (GdomeComment *self,
                                             GdomeException *exc);
GdomeNode*  gdome_c_nextSibling             (GdomeComment *self,
                                             GdomeException *exc);
GdomeNamedNodeMap* gdome_c_attributes       (GdomeComment *self,
                                             GdomeException *exc);
GdomeDocument* gdome_c_ownerDocument        (GdomeComment *self,
                                             GdomeException *exc);
GdomeNode*  gdome_c_insertBefore            (GdomeComment *self,
                                             GdomeNode *newChild,
                                             GdomeNode *refChild,
                                             GdomeException *exc);
GdomeNode*  gdome_c_replaceChild            (GdomeComment *self,
                                             GdomeNode *newChild,
                                             GdomeNode *oldChild,
                                             GdomeException *exc);
GdomeNode*  gdome_c_removeChild             (GdomeComment *self,
                                             GdomeNode *oldChild,
                                             GdomeException *exc);
GdomeNode*  gdome_c_appendChild             (GdomeComment *self,
                                             GdomeNode *newChild,
                                             GdomeException *exc);
GdomeBoolean gdome_c_hasChildNodes          (GdomeComment *self,
                                             GdomeException *exc);
GdomeNode*  gdome_c_cloneNode               (GdomeComment *self,
                                             GdomeBoolean deep,
                                             GdomeException *exc);
void        gdome_c_normalize               (GdomeComment *self,
                                             GdomeException *exc);
GdomeBoolean gdome_c_isSupported            (GdomeComment *self,
                                             GdomeDOMString *feature,
                                             GdomeDOMString *version,
                                             GdomeException *exc);
GdomeDOMString* gdome_c_namespaceURI        (GdomeComment *self,
                                             GdomeException *exc);
GdomeDOMString* gdome_c_prefix              (GdomeComment *self,
                                             GdomeException *exc);
void        gdome_c_set_prefix              (GdomeComment *self,
                                             GdomeDOMString *prefix,
                                             GdomeException *exc);
GdomeDOMString* gdome_c_localName           (GdomeComment *self,
                                             GdomeException *exc);
GdomeBoolean gdome_c_hasAttributes          (GdomeComment *self,
                                             GdomeException *exc);
void        gdome_c_addEventListener        (GdomeComment *self,
                                             GdomeDOMString *type,
                                             GdomeEventListener *listener,
                                             GdomeBoolean useCapture,
                                             GdomeException *exc);
void        gdome_c_removeEventListener     (GdomeComment *self,
                                             GdomeDOMString *type,
                                             GdomeEventListener *listener,
                                             GdomeBoolean useCapture,
                                             GdomeException *exc);
GdomeBoolean gdome_c_dispatchEvent          (GdomeComment *self,
                                             GdomeEvent *evt,
                                             GdomeException *exc);

Description

Details

struct GdomeComment

struct GdomeComment {
	const GdomeCommentVtab *vtab; /* deprecated */
	GdomePrivateList *private;
};


gdome_c_data ()

GdomeDOMString* gdome_c_data                (GdomeComment *self,
                                             GdomeException *exc);

self : The CharacterData Object ref
exc : The Exception Object ref
Returns : the character data of the node that implements this interface.


gdome_c_set_data ()

void        gdome_c_set_data                (GdomeComment *self,
                                             GdomeDOMString *data,
                                             GdomeException *exc);

Sets the data value of this node.

GDOME_NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.

self : The CharacterData Object ref
data : The data value for this node
exc : The Exception Object ref


gdome_c_length ()

unsigned long gdome_c_length                (GdomeComment *self,
                                             GdomeException *exc);

self : The CharacterData Object ref
exc : The GdomeException Object ref
Returns : The number of 16-bit units that are available. This may have the value zero, i.e., CharacterData nodes may be empty.


gdome_c_substringData ()

GdomeDOMString* gdome_c_substringData       (GdomeComment *self,
                                             unsigned long offset,
                                             unsigned long count,
                                             GdomeException *exc);

Extracts a range of data from the node.

GDOME_INDEX_SIZE_ERR: Raised if the specified offset is greater than the number of 16-bit units in data.

self : The CharacterData Object ref
offset : Start offset of substring to extract
count : The number of 16-bit units to extract
exc : The Exception Object ref
Returns : The specified substring. If the sum of offset and count exceeds the length, then all 16-bit units to the end of the data are returned.


gdome_c_appendData ()

void        gdome_c_appendData              (GdomeComment *self,
                                             GdomeDOMString *arg,
                                             GdomeException *exc);

Append the string to the end of the character data of the node. Upon success, data provides access to the concatenation of data and the string specified.

GDOME_NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.

self : The CharacterData Object ref
arg : The string to append
exc : The Exception Object ref


gdome_c_insertData ()

void        gdome_c_insertData              (GdomeComment *self,
                                             unsigned long offset,
                                             GdomeDOMString *arg,
                                             GdomeException *exc);

Insert a string at the specified 16-bit unit offset.

GDOME_INDEX_SIZE_ERR: Raised if the specified offset is greater than the number of 16-bit units in data. GDOME_NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.

self : The CharacterData Object ref
offset : The character offset at which to insert
arg : The string to insert
exc : The Exception Object ref


gdome_c_deleteData ()

void        gdome_c_deleteData              (GdomeComment *self,
                                             unsigned long offset,
                                             unsigned long count,
                                             GdomeException *exc);

Remove a range of 16-bit units from the node. If the sum of offset and count exceeds length then all 16-bit units from offset to the end of the data are deleted. Upon success, data and length reflect the change.

GDOME_INDEX_SIZE_ERR: Raised if the specified offset is greater than the number of 16-bit units in data. GDOME_NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.

self : The CharacterData Object ref
offset : The offset from which to start removing
count : The number of 16-bit units to delete.
exc : The Exception Object ref


gdome_c_replaceData ()

void        gdome_c_replaceData             (GdomeComment *self,
                                             unsigned long offset,
                                             unsigned long count,
                                             GdomeDOMString *arg,
                                             GdomeException *exc);

Replace the characters starting at the specified 16-bit unit offset with the specified string. If the sum of offset and count exceeds length, then all 16-bit units to the end of the data are replaced;

GDOME_INDEX_SIZE_ERR: Raised if the specified offset is greater than the number of 16-bit units in data. GDOME_NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.

self : The CharacterData Object ref
offset : The offset from which to start replacing
count : The number of 16-bit units to replace.
arg : The String with which the range must be replaced
exc : The GdomeException Object ref


gdome_c_ref ()

void        gdome_c_ref                     (GdomeComment *self,
                                             GdomeException *exc);

Increase the reference count of the specified Node.

self : Node Object ref
exc : Exception Object ref


gdome_c_unref ()

void        gdome_c_unref                   (GdomeComment *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_c_query_interface ()

void*       gdome_c_query_interface         (GdomeComment *self,
                                             const char *interface,
                                             GdomeException *exc);

NOT IMPLEMENTED

self : 
interface : 
exc : 


gdome_c_nodeName ()

GdomeDOMString* gdome_c_nodeName            (GdomeComment *self,
                                             GdomeException *exc);

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


gdome_c_nodeValue ()

GdomeDOMString* gdome_c_nodeValue           (GdomeComment *self,
                                             GdomeException *exc);

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


gdome_c_set_nodeValue ()

void        gdome_c_set_nodeValue           (GdomeComment *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_c_nodeType ()

unsigned short gdome_c_nodeType             (GdomeComment *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_c_parentNode ()

GdomeNode*  gdome_c_parentNode              (GdomeComment *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_c_childNodes ()

GdomeNodeList* gdome_c_childNodes           (GdomeComment *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_c_firstChild ()

GdomeNode*  gdome_c_firstChild              (GdomeComment *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_c_lastChild ()

GdomeNode*  gdome_c_lastChild               (GdomeComment *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_c_previousSibling ()

GdomeNode*  gdome_c_previousSibling         (GdomeComment *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_c_nextSibling ()

GdomeNode*  gdome_c_nextSibling             (GdomeComment *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_c_attributes ()

GdomeNamedNodeMap* gdome_c_attributes       (GdomeComment *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_c_ownerDocument ()

GdomeDocument* gdome_c_ownerDocument        (GdomeComment *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_c_insertBefore ()

GdomeNode*  gdome_c_insertBefore            (GdomeComment *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_c_replaceChild ()

GdomeNode*  gdome_c_replaceChild            (GdomeComment *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_c_removeChild ()

GdomeNode*  gdome_c_removeChild             (GdomeComment *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_c_appendChild ()

GdomeNode*  gdome_c_appendChild             (GdomeComment *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_c_hasChildNodes ()

GdomeBoolean gdome_c_hasChildNodes          (GdomeComment *self,
                                             GdomeException *exc);

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


gdome_c_cloneNode ()

GdomeNode*  gdome_c_cloneNode               (GdomeComment *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_c_normalize ()

void        gdome_c_normalize               (GdomeComment *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_c_isSupported ()

GdomeBoolean gdome_c_isSupported            (GdomeComment *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_c_namespaceURI ()

GdomeDOMString* gdome_c_namespaceURI        (GdomeComment *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_c_prefix ()

GdomeDOMString* gdome_c_prefix              (GdomeComment *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_c_set_prefix ()

void        gdome_c_set_prefix              (GdomeComment *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_c_localName ()

GdomeDOMString* gdome_c_localName           (GdomeComment *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_c_hasAttributes ()

GdomeBoolean gdome_c_hasAttributes          (GdomeComment *self,
                                             GdomeException *exc);

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


gdome_c_addEventListener ()

void        gdome_c_addEventListener        (GdomeComment *self,
                                             GdomeDOMString *type,
                                             GdomeEventListener *listener,
                                             GdomeBoolean useCapture,
                                             GdomeException *exc);

NOT IMPLEMENTED YET

self : 
type : 
listener : 
useCapture : 
exc : 


gdome_c_removeEventListener ()

void        gdome_c_removeEventListener     (GdomeComment *self,
                                             GdomeDOMString *type,
                                             GdomeEventListener *listener,
                                             GdomeBoolean useCapture,
                                             GdomeException *exc);

NOT IMPLEMENTED YET

self : 
type : 
listener : 
useCapture : 
exc : 


gdome_c_dispatchEvent ()

GdomeBoolean gdome_c_dispatchEvent          (GdomeComment *self,
                                             GdomeEvent *evt,
                                             GdomeException *exc);

NOT IMPLEMENTED YET

self : 
evt : 
exc : 
Returns : *