Gdome2 Reference Manual | |||
---|---|---|---|
<<< Previous Page | Home | Up | Next Page >>> |
struct GdomeDocument { const GdomeDocumentVtab *vtab; /* deprecated */ GdomePrivateList *private; }; |
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. |
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); |
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.
GdomeDocumentFragment* gdome_doc_createDocumentFragment (GdomeDocument *self, GdomeException *exc); |
Creates an empty DocumentFragment object.
GdomeText* gdome_doc_createTextNode (GdomeDocument *self, GdomeDOMString *data, GdomeException *exc); |
Creates a Text node given the specified string.
GdomeComment* gdome_doc_createComment (GdomeDocument *self, GdomeDOMString *data, GdomeException *exc); |
Creates a Comment node whose value is the specified string.
GdomeCDATASection* gdome_doc_createCDATASection (GdomeDocument *self, GdomeDOMString *data, GdomeException *exc); |
Creates a CDATASection node whose value is the specified string.
GdomeProcessingInstruction* gdome_doc_createProcessingInstruction (GdomeDocument *self, GdomeDOMString *target, GdomeDOMString *data, GdomeException *exc); |
Creates a ProcessingInstruction node given the specified name and data strings.
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.
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.
GdomeNodeList* gdome_doc_getElementsByTagName (GdomeDocument *self, GdomeDOMString *tagname, GdomeException *exc); |
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_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 : | Document Object ref |
Returns : | the imported node that belongs to this Document. |
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. |
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. |
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. |
GdomeElement* gdome_doc_getElementById (GdomeDocument *self, GdomeDOMString *elementId, GdomeException *exc); |
void gdome_doc_ref (GdomeDocument *self, GdomeException *exc); |
Increase the reference count of the specified Node.
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.
void* gdome_doc_query_interface (GdomeDocument *self, const char *interface, GdomeException *exc); |
NOT IMPLEMENTED
GdomeDOMString* gdome_doc_nodeValue (GdomeDocument *self, GdomeException *exc); |
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.
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. |
GdomeNodeList* gdome_doc_childNodes (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); |
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.
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_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.
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.
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_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.
GdomeBoolean gdome_doc_hasChildNodes (GdomeDocument *self, GdomeException *exc); |
GdomeNode* gdome_doc_cloneNode (GdomeDocument *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). |
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.
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. |
GdomeDOMString* gdome_doc_namespaceURI (GdomeDocument *self, GdomeException *exc); |
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, 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"
GdomeDOMString* gdome_doc_localName (GdomeDocument *self, GdomeException *exc); |
GdomeBoolean gdome_doc_hasAttributes (GdomeDocument *self, GdomeException *exc); |
void gdome_doc_addEventListener (GdomeDocument *self, GdomeDOMString *type, |
NOT IMPLEMENTED YET
void gdome_doc_removeEventListener (GdomeDocument *self, GdomeDOMString *type, |
NOT IMPLEMENTED YET
GdomeBoolean gdome_doc_dispatchEvent (GdomeDocument *self, |
NOT IMPLEMENTED YET