Gdome2 Reference Manual
<<< Previous PageHomeUpNext Page >>>

GdomeProcessingInstruction

Name

GdomeProcessingInstruction -- Interface ProcessingInstruction implementation.

Synopsis



struct      GdomeProcessingInstruction;
GdomeDOMString* gdome_pi_target             (GdomeProcessingInstruction *self,
                                             GdomeException *exc);
GdomeDOMString* gdome_pi_data               (GdomeProcessingInstruction *self,
                                             GdomeException *exc);
void        gdome_pi_set_data               (GdomeProcessingInstruction *self,
                                             GdomeDOMString *data,
                                             GdomeException *exc);
void        gdome_pi_ref                    (GdomeProcessingInstruction *self,
                                             GdomeException *exc);
void        gdome_pi_unref                  (GdomeProcessingInstruction *self,
                                             GdomeException *exc);
gpointer    gdome_pi_query_interface        (GdomeProcessingInstruction *self,
                                             const char *interface,
                                             GdomeException *exc);
GdomeDOMString* gdome_pi_nodeName           (GdomeProcessingInstruction *self,
                                             GdomeException *exc);
GdomeDOMString* gdome_pi_nodeValue          (GdomeProcessingInstruction *self,
                                             GdomeException *exc);
void        gdome_pi_set_nodeValue          (GdomeProcessingInstruction *self,
                                             GdomeDOMString *nodeValue,
                                             GdomeException *exc);
unsigned short gdome_pi_nodeType            (GdomeProcessingInstruction *self,
                                             GdomeException *exc);
GdomeNode*  gdome_pi_parentNode             (GdomeProcessingInstruction *self,
                                             GdomeException *exc);
GdomeNodeList* gdome_pi_childNodes          (GdomeProcessingInstruction *self,
                                             GdomeException *exc);
GdomeNode*  gdome_pi_firstChild             (GdomeProcessingInstruction *self,
                                             GdomeException *exc);
GdomeNode*  gdome_pi_lastChild              (GdomeProcessingInstruction *self,
                                             GdomeException *exc);
GdomeNode*  gdome_pi_previousSibling        (GdomeProcessingInstruction *self,
                                             GdomeException *exc);
GdomeNode*  gdome_pi_nextSibling            (GdomeProcessingInstruction *self,
                                             GdomeException *exc);
GdomeNamedNodeMap* gdome_pi_attributes      (GdomeProcessingInstruction *self,
                                             GdomeException *exc);
GdomeDocument* gdome_pi_ownerDocument       (GdomeProcessingInstruction *self,
                                             GdomeException *exc);
GdomeNode*  gdome_pi_insertBefore           (GdomeProcessingInstruction *self,
                                             GdomeNode *newChild,
                                             GdomeNode *refChild,
                                             GdomeException *exc);
GdomeNode*  gdome_pi_replaceChild           (GdomeProcessingInstruction *self,
                                             GdomeNode *newChild,
                                             GdomeNode *oldChild,
                                             GdomeException *exc);
GdomeNode*  gdome_pi_removeChild            (GdomeProcessingInstruction *self,
                                             GdomeNode *oldChild,
                                             GdomeException *exc);
GdomeNode*  gdome_pi_appendChild            (GdomeProcessingInstruction *self,
                                             GdomeNode *newChild,
                                             GdomeException *exc);
GdomeBoolean gdome_pi_hasChildNodes         (GdomeProcessingInstruction *self,
                                             GdomeException *exc);
GdomeNode*  gdome_pi_cloneNode              (GdomeProcessingInstruction *self,
                                             GdomeBoolean deep,
                                             GdomeException *exc);
void        gdome_pi_normalize              (GdomeProcessingInstruction *self,
                                             GdomeException *exc);
GdomeBoolean gdome_pi_isSupported           (GdomeProcessingInstruction *self,
                                             GdomeDOMString *feature,
                                             GdomeDOMString *version,
                                             GdomeException *exc);
GdomeDOMString* gdome_pi_namespaceURI       (GdomeProcessingInstruction *self,
                                             GdomeException *exc);
GdomeDOMString* gdome_pi_prefix             (GdomeProcessingInstruction *self,
                                             GdomeException *exc);
void        gdome_pi_set_prefix             (GdomeProcessingInstruction *self,
                                             GdomeDOMString *prefix,
                                             GdomeException *exc);
GdomeDOMString* gdome_pi_localName          (GdomeProcessingInstruction *self,
                                             GdomeException *exc);
GdomeBoolean gdome_pi_hasAttributes         (GdomeProcessingInstruction *self,
                                             GdomeException *exc);
void        gdome_pi_addEventListener       (GdomeProcessingInstruction *self,
                                             GdomeDOMString *type,
                                             GdomeEventListener *listener,
                                             GdomeBoolean useCapture,
                                             GdomeException *exc);
void        gdome_pi_removeEventListener    (GdomeProcessingInstruction *self,
                                             GdomeDOMString *type,
                                             GdomeEventListener *listener,
                                             GdomeBoolean useCapture,
                                             GdomeException *exc);
GdomeBoolean gdome_pi_dispatchEvent         (GdomeProcessingInstruction *self,
                                             GdomeEvent *evt,
                                             GdomeException *exc);
void        gdome_pi_subTreeDispatchEvent   (GdomeProcessingInstruction *self,
                                             GdomeEvent *evt,
                                             GdomeException *exc);
GdomeBoolean gdome_pi_canAppend             (GdomeProcessingInstruction *self,
                                             GdomeNode *newChild,
                                             GdomeException *exc);

Description

The GdomeProcessingInstruction interface represents a "processing instruction", used in XML as a way to keep processor-specific information in the text of the document.

Details

struct GdomeProcessingInstruction

struct GdomeProcessingInstruction {
	gpointer user_data;
};

gdome_pi_target ()

GdomeDOMString* gdome_pi_target             (GdomeProcessingInstruction *self,
                                             GdomeException *exc);

self : ProcessingInstruction Object ref
exc : Exception Object ref
Returns : the target of this processing instruction. XML defines this as being the first token following the markup that begins the processing instruction.

gdome_pi_data ()

GdomeDOMString* gdome_pi_data               (GdomeProcessingInstruction *self,
                                             GdomeException *exc);

self : ProcessingInstruction Object ref
exc : Exception Object ref
Returns : the content of this processing instruction. This is from the first non white space character after the target to the character immediately preceding the %?>.

gdome_pi_set_data ()

void        gdome_pi_set_data               (GdomeProcessingInstruction *self,
                                             GdomeDOMString *data,
                                             GdomeException *exc);

Set the content of this processing instruction.

GDOME_NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.

self : ProcessingInstruction Object ref
data : The string of data to be set
exc : Exception Object ref

gdome_pi_ref ()

void        gdome_pi_ref                    (GdomeProcessingInstruction *self,
                                             GdomeException *exc);

Increase the reference count of the specified Node.

self : Node Object ref
exc : Exception Object ref

gdome_pi_unref ()

void        gdome_pi_unref                  (GdomeProcessingInstruction *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_pi_query_interface ()

gpointer    gdome_pi_query_interface        (GdomeProcessingInstruction *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_pi_nodeName ()

GdomeDOMString* gdome_pi_nodeName           (GdomeProcessingInstruction *self,
                                             GdomeException *exc);

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

gdome_pi_nodeValue ()

GdomeDOMString* gdome_pi_nodeValue          (GdomeProcessingInstruction *self,
                                             GdomeException *exc);

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

gdome_pi_set_nodeValue ()

void        gdome_pi_set_nodeValue          (GdomeProcessingInstruction *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_pi_nodeType ()

unsigned short gdome_pi_nodeType            (GdomeProcessingInstruction *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_pi_parentNode ()

GdomeNode*  gdome_pi_parentNode             (GdomeProcessingInstruction *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_pi_childNodes ()

GdomeNodeList* gdome_pi_childNodes          (GdomeProcessingInstruction *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.

GdomeProcessingInstruction *self, GdomeException *exc);

self : ProcessingInstruction Object ref
exc : Exception Object ref
Returns : the content of this processing instruction. This is from the first non white space character after the target to the character immediately preceding the %?>.

gdome_pi_set_data ()

void        gdome_pi_set_data               (GdomeProcessingInstruction *self,
                                             GdomeDOMString *data,
                                             GdomeException *exc);

Set the content of this processing instruction.

GDOME_NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.

self : ProcessingInstruction Object ref
data : The string of data to be set
exc : Exception Object ref

gdome_pi_ref ()

void        gdome_pi_ref                    (GdomeProcessingInstruction *self,
                                             GdomeException *exc);

Increase the reference count of the specified Node.

self : Node Object ref
exc : Exception Object ref

gdome_pi_unref ()

void        gdome_pi_unref                  (GdomeProcessingInstruction *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_pi_query_interface ()

gpointer    gdome_pi_query_interface        (GdomeProcessingInstruction *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_pi_nodeName ()

GdomeDOMString* gdome_pi_nodeName           (GdomeProcessingInstruction *self,
                                             GdomeException *exc);

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

gdome_pi_nodeValue ()

GdomeDOMString* gdome_pi_nodeValue          (GdomeProcessingInstruction *self,
                                             GdomeException *exc);

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

gdome_pi_set_nodeValue ()

void        gdome_pi_set_nodeValue          (GdomeProcessingInstruction *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_pi_nodeType ()

unsigned short gdome_pi_nodeType            (GdomeProcessingInstruction *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_pi_parentNode ()

GdomeNode*  gdome_pi_parentNode             (GdomeProcessingInstruction *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_pi_childNodes ()

GdomeNodeList* gdome_pi_childNodes          (GdomeProcessingInstruction *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.

GdomeProcessingInstruction *self, GdomeException *exc);

self : ProcessingInstruction Object ref
exc : Exception Object ref
Returns : the content of this processing instruction. This is from the first non white space character after the target to the character immediately preceding the %?>.

gdome_pi_set_data ()

void        gdome_pi_set_data               (GdomeProcessingInstruction *self,
                                             GdomeDOMString *data,
                                             GdomeException *exc);

Set the content of this processing instruction.

GDOME_NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.

self : ProcessingInstruction Object ref
data : The string of data to be set
exc : Exception Object ref

gdome_pi_ref ()

void        gdome_pi_ref                    (GdomeProcessingInstruction *self,
                                             GdomeException *exc);

Increase the reference count of the specified Node.

self : Node Object ref
exc : Exception Object ref

gdome_pi_unref ()

void        gdome_pi_unref                  (GdomeProcessingInstruction *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_pi_query_interface ()

gpointer    gdome_pi_query_interface        (GdomeProcessingInstruction *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_pi_nodeName ()

GdomeDOMString* gdome_pi_nodeName           (GdomeProcessingInstruction *self,
                                             GdomeException *exc);

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

gdome_pi_nodeValue ()

GdomeDOMString* gdome_pi_nodeValue          (GdomeProcessingInstruction *self,
                                             GdomeException *exc);

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

gdome_pi_set_nodeValue ()

void        gdome_pi_set_nodeValue          (GdomeProcessingInstruction *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_pi_nodeType ()

unsigned short gdome_pi_nodeType            (GdomeProcessingInstruction *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_pi_parentNode ()

GdomeNode*  gdome_pi_parentNode             (GdomeProcessingInstruction *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_pi_childNodes ()

GdomeNodeList* gdome_pi_childNodes          (GdomeProcessingInstruction *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.

GdomeProcessingInstruction *self, GdomeException *exc);

self : ProcessingInstruction Object ref
exc : Exception Object ref
Returns : the content of this processing instruction. This is from the first non white space character after the target to the character immediately preceding the %?>.

gdome_pi_set_data ()

void        gdome_pi_set_data               (GdomeProcessingInstruction *self,
                                             GdomeDOMString *data,
                                             GdomeException *exc);

Set the content of this processing instruction.

GDOME_NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.

self : ProcessingInstruction Object ref
data : The string of data to be set
exc : Exception Object ref

gdome_pi_ref ()