GdomeNodeList

Name

GdomeNodeList -- 

Synopsis



struct      GdomeNodeList;
void        gdome_nl_ref                    (GdomeNodeList *self,
                                             GdomeException *exc);
void        gdome_nl_unref                  (GdomeNodeList *self,
                                             GdomeException *exc);
void*       gdome_nl_query_interface        (GdomeNodeList *self,
                                             const char *interface,
                                             GdomeException *exc);
GdomeNode*  gdome_nl_item                   (GdomeNodeList *self,
                                             unsigned long index,
                                             GdomeException *exc);
unsigned long gdome_nl_length               (GdomeNodeList *self,
                                             GdomeException *exc);

Description

Details

struct GdomeNodeList

struct GdomeNodeList {
	const GdomeNodeListVtab *vtab; /* deprecated */
	GdomePrivateList *private;
};


gdome_nl_ref ()

void        gdome_nl_ref                    (GdomeNodeList *self,
                                             GdomeException *exc);

Increase the reference count of the specified NodeList.

self : NodeList Object ref
exc : Exception Object ref


gdome_nl_unref ()

void        gdome_nl_unref                  (GdomeNodeList *self,
                                             GdomeException *exc);

Decrease the reference count of the specified NodeList. Free the NodeList structure if the specified NodeList will have zero reference.

self : NodeList Object ref
exc : Exception Object ref


gdome_nl_query_interface ()

void*       gdome_nl_query_interface        (GdomeNodeList *self,
                                             const char *interface,
                                             GdomeException *exc);

self : NodeList 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_nl_item ()

GdomeNode*  gdome_nl_item                   (GdomeNodeList *self,
                                             unsigned long index,
                                             GdomeException *exc);

self : NodeList Object ref
index : Index into the collection
exc : Exception Object ref
Returns : the indexth item in the collection. If index is greater than or equal to the number of nodes in the list, this returns NULL.


gdome_nl_length ()

unsigned long gdome_nl_length               (GdomeNodeList *self,
                                             GdomeException *exc);

self : NodeList Object ref
exc : Exception Object ref
Returns : the number of nodes in the list. The range of valid child node indices is 0 to length-1 inclusive.