![]() |
![]() |
![]() |
GNOME Data Access manual | ![]() |
---|---|---|---|---|
Top | Description |
GdaReportItemPrivate; GdaReportItem * gda_report_item_new (GdaReportValid *valid, const gchar *name); GdaReportItem * gda_report_item_new_from_dom (xmlNodePtr node); gboolean gda_report_item_remove (GdaReportItem *item); gboolean gda_report_item_add_previous (GdaReportItem *item, GdaReportItem *new_item); gboolean gda_report_item_add_next (GdaReportItem *item, GdaReportItem *new_item); gboolean gda_report_item_add_child (GdaReportItem *parent, GdaReportItem *child); gboolean gda_report_item_replace (GdaReportItem *item, GdaReportItem *new_item); xmlNodePtr gda_report_item_to_dom (GdaReportItem *item); gchar * gda_report_item_get_item_type (GdaReportItem *item); gboolean gda_report_item_set_attribute (GdaReportItem *item, const gchar *name, const gchar *value); gchar * gda_report_item_get_attribute (GdaReportItem *item, const gchar *name); gchar * gda_report_item_get_inherit_attribute (GdaReportItem *item, const gchar *name); GdaReportItem * gda_report_item_get_child_by_id (GdaReportItem *parent, const gchar *id); GdaReportItem * gda_report_item_get_first_child (GdaReportItem *parent); GdaReportItem * gda_report_item_get_next_child (GdaReportItem *parent, GdaReportItem *item); gboolean gda_report_item_set_content (GdaReportItem *item, const gchar *content); gchar * gda_report_item_get_content (GdaReportItem *item); gboolean gda_report_item_belongs_to_report_document (GdaReportItem *item); GdaReportItem * gda_report_item_get_report (GdaReportItem *item);
typedef struct { xmlNodePtr node; GdaReportValid *valid; } GdaReportItemPrivate;
GdaReportItem * gda_report_item_new (GdaReportValid *valid, const gchar *name);
Creates a new item with the given name, and using the given GdaReportValid object
|
a GdaReportValid object |
|
name of the item to be created |
Returns : |
the new GdaReportItem or NULL if there is some problem |
GdaReportItem * gda_report_item_new_from_dom (xmlNodePtr node);
Creates a new item from a given xml node
|
a xmlNodePtr, assumed to be a valid gda-report element |
Returns : |
the new GdaReportItem or NULL if there is some problem |
gboolean gda_report_item_remove (GdaReportItem *item);
Remove the current item from the report
|
the GdaReportItem to be removed |
Returns : |
TRUE if all is ok, FALSE otherwise |
gboolean gda_report_item_add_previous (GdaReportItem *item, GdaReportItem *new_item);
Sets new_item as the previous sibling of item
|
the referential GdaReportItem |
|
the GdaReportItem to be added |
Returns : |
TRUE if all is ok, FALSE otherwise |
gboolean gda_report_item_add_next (GdaReportItem *item, GdaReportItem *new_item);
Sets new_item as the next sibling of item
|
the referential GdaReportItem |
|
the GdaReportItem to be added |
Returns : |
TRUE if all is ok, FALSE otherwise |
gboolean gda_report_item_add_child (GdaReportItem *parent, GdaReportItem *child);
Sets child item as a child of parent item
|
a GdaReportItem |
|
an already created GdaReportItem |
Returns : |
TRUE if all is ok, FALSE otherwise |
gboolean gda_report_item_replace (GdaReportItem *item, GdaReportItem *new_item);
Replace item for new_item
|
the GdaReportItem to be replaced |
|
the new GdaReportItem |
Returns : |
TRUE if all is ok, FALSE otherwise |
xmlNodePtr gda_report_item_to_dom (GdaReportItem *item);
|
a GdaReportItem |
Returns : |
the xml representation of the item, or NULL if there is some problem |
gchar * gda_report_item_get_item_type (GdaReportItem *item);
|
a GdaReportItem object |
Returns : |
the type of the item |
gboolean gda_report_item_set_attribute (GdaReportItem *item, const gchar *name, const gchar *value);
Validates the attribute and the value and, if all is right, sets the given value to the attribute of given item
|
a GdaReportItem object |
|
name of the attribute to be set |
|
value to be set |
Returns : |
TRUE if all is ok, FALSE otherwise |
gchar * gda_report_item_get_attribute (GdaReportItem *item, const gchar *name);
|
a GdaReportItem object |
|
an attribute name |
Returns : |
the value of given attribute in given item. If attribute is not set, but a default value is defined in the DTD, this defaults value is returned. If there is some problem, or attribute is not defined and there is no default value, NULL is returned |
gchar * gda_report_item_get_inherit_attribute (GdaReportItem *item, const gchar *name);
Searches for the attribute in all ancestors of the item
|
a GdaReportItem object |
|
an attribute name |
Returns : |
the value of the attribute in the first ancestor where found, or NULL if not found or there is some problem |
GdaReportItem * gda_report_item_get_child_by_id (GdaReportItem *parent, const gchar *id);
Searches recursively for a child item with the given Id
|
a GdaReportItem object |
|
the id of the searched child item |
Returns : |
the child item if found, or NULL otherwise |
GdaReportItem * gda_report_item_get_first_child (GdaReportItem *parent);
|
a GdaReportItem object |
Returns : |
the first child item found, or NULL if no child exists |
GdaReportItem * gda_report_item_get_next_child (GdaReportItem *parent, GdaReportItem *item);
|
a GdaReportItem object |
|
the previous item to the searched one |
Returns : |
next child item to the given child item |
gboolean gda_report_item_set_content (GdaReportItem *item, const gchar *content);
|
|
|
|
Returns : |
gchar * gda_report_item_get_content (GdaReportItem *item);
|
|
Returns : |
gboolean gda_report_item_belongs_to_report_document (GdaReportItem *item);
|
|
Returns : |