Libglade Build

Name

Libglade Build — Routines used by widget building routines

Synopsis


#include <glade/glade.h>
#include <glade/glade-build.h>


GtkWidget*  (*GladeNewFunc)                 (GladeXML *xml,
                                             GNode *node);
void        (*GladeBuildChildrenFunc)       (GladeXML *xml,
                                             GtkWidget *w,
                                             GNode *node,
                                             const char *longname);
GtkWidget*  glade_xml_build_widget          (GladeXML *self,
                                             GNode *node,
                                             const char *parent_long);
void        glade_xml_set_common_params     (GladeXML *self,
                                             GtkWidget *widget,
                                             GNode *node,
                                             const char *parent_long,
                                             const char *widget_class);
struct      GladeWidgetBuildData;
void        glade_register_widgets          (const GladeWidgetBuildData *widgets);

gchar*      glade_xml_relative_file         (GladeXML *self,
                                             const gchar *filename);
gint        glade_enum_from_string          (GtkType type,
                                             const char *string);
GtkAdjustment* glade_get_adjustment         (GNode *gnode);
void        glade_standard_build_children   (GladeXML *self,
                                             GtkWidget *w,
                                             GNode *node,
                                             const char *longname);

char*       glade_xml_gettext               (GladeXML *xml,
                                             const char *msgid);

Description

These functions are used by the routines that are responsible for building the actual widgets from the XML node data structures.

Details

GladeNewFunc ()

GtkWidget*  (*GladeNewFunc)                 (GladeXML *xml,
                                             GNode *node);

This function signature should be used by functions that build particular widget types. The function should create the new widget and set any non standard widget parameters (ie. don't set visibility, size, etc), as this is handled by glade_xml_build_widget, which calls these functions.

xml : The GladeXML object.
node : the GNode holding the xmlNode for this widget.
Returns : the new widget.


GladeBuildChildrenFunc ()

void        (*GladeBuildChildrenFunc)       (GladeXML *xml,
                                             GtkWidget *w,
                                             GNode *node,
                                             const char *longname);

This function signature should be used by functions that are responsible for adding children to a container widget. To create each child widget, glade_xml_build_widget should be called. The GNode for the child widget will be a child of this widget's GNode.

xml : the GladeXML object.
w : this widget.
node : the GNode holding the xmlNode for this widget.
longname : the long name for this widget.


glade_xml_build_widget ()

GtkWidget*  glade_xml_build_widget          (GladeXML *self,
                                             GNode *node,
                                             const char *parent_long);

This function is not intended for people who just use libglade. Instead it is for people extending it (it is designed to be called in the child build routine defined for the parent widget). It first checks the type of the widget from the class tag, then calls the corresponding widget creation routine. This routine sets up all the settings specific to that type of widget. Then general widget settings are performed on the widget. Then it sets up accelerators for the widget, and extracts any signal information for the widget. Then it checks to see if there are any child widget nodes for this widget, and if so calls the widget's build routine, which will create the children with this function and add them to the widget in the appropriate way. Finally it returns the widget.

self : the GladeXML object.
node : the GNode holding the xmlNode of the child
parent_long : the long name of the parent object.
Returns : the newly created widget.


glade_xml_set_common_params ()

void        glade_xml_set_common_params     (GladeXML *self,
                                             GtkWidget *widget,
                                             GNode *node,
                                             const char *parent_long,
                                             const char *widget_class);

This function sets the common parameters on a widget, and is responsible for inserting it into the GladeXML object's internal structures. It will also add the children to this widget. Usually this function is only called by glade_xml_build_widget, but is exposed for difficult cases, such as setting up toolbar buttons and the like.

self : the GladeXML widget.
widget : the widget to set parameters on.
node : the XML node for this widget.
parent_long : the long name of the parent widget.
widget_class : the class of this widget, or NULL to guess the class.


struct GladeWidgetBuildData

typedef struct {
  char *name;
  GladeNewFunc new;
  GladeBuildChildrenFunc build_children;
} GladeWidgetBuildData;


glade_register_widgets ()

void        glade_register_widgets          (const GladeWidgetBuildData *widgets);

This function is used to register new sets of widget building functions. each member of widgets contains the widget name, a function to build a widget of that type, and optionally a function to build the children of this widget. The child building routine would call glade_xml_build_widget on each child node to create the child before packing it.

This function is mainly useful for addon widget modules for libglade (it would get called from the glade_init_module function).

widgets : a NULL terminated array of GladeWidgetBuildData structures.


glade_xml_relative_file ()

gchar*      glade_xml_relative_file         (GladeXML *self,
                                             const gchar *filename);

This function resolves a relative pathname, using the directory of the XML file as a base. If the pathname is absolute, then the original filename is returned.

self : the GladeXML object.
filename : the filename.
Returns : the filename. The result must be g_free'd.


glade_enum_from_string ()

gint        glade_enum_from_string          (GtkType type,
                                             const char *string);

This helper routine is designed to be used by widget build routines to convert the string representations of enumeration values found in the XML descriptions to the integer values that can be used to configure the widget.

type : the GtkType for this flag or enum type.
string : the string representation of the enum value.
Returns : the integer value for this enumeration, or 0 if it couldn't be found.


glade_get_adjustment ()

GtkAdjustment* glade_get_adjustment         (GNode *gnode);

This utility routine is used to create an adjustment object for a widget.

gnode : the XML node for the widget.
Returns : the newly created GtkAdjustment.


glade_standard_build_children ()

void        glade_standard_build_children   (GladeXML *self,
                                             GtkWidget *w,
                                             GNode *node,
                                             const char *longname);

This is the standard child building function. It simply calls gtk_container_add on each child to add them to the parent. It is implemented here, as it should be useful to many GTK+ based widget sets.

self : the GladeXML object.
w : the container widget.
node : the node for this widget.
longname : the long name for this widget.


glade_xml_gettext ()

char*       glade_xml_gettext               (GladeXML *xml,
                                             const char *msgid);

This function is a wrapper for gettext, that uses the translation domain requested by the user of the function, or the default if no domain has been specified. This should be used for translatable strings in all widget building routines.

xml : the GladeXML widget.
msgid : the string to translate.
Returns : the translated string