Synopsis

struct GladeXML

struct GladeXML {
    GObject parent;

    char *filename;

};

struct GladeXMLClass

struct GladeXMLClass {

    GObjectClass parent_class;

    /* Virtual function: gets the appropriate gtype for the typename.*/
    GType (* lookup_type) (GladeXML*self, const char *gtypename);
};

glade_xml_new ()

GladeXML*   glade_xml_new                   (const char *fname,
                                             const char *root,
                                             const char *domain);

Creates a new GladeXML object (and the corresponding widgets) from the XML file fname. Optionally it will only build the interface from the widget node root (if it is not NULL). This feature is useful if you only want to build say a toolbar or menu from the XML file, but not the window it is embedded in. Note also that the XML parse tree is cached to speed up creating another GladeXML object for the same file

glade_xml_new_from_buffer ()

GladeXML*   glade_xml_new_from_buffer       (const char *buffer,
                                             int size,
                                             const char *root,
                                             const char *domain);

Creates a new GladeXML object (and the corresponding widgets) from the buffer buffer. Optionally it will only build the interface from the widget node root (if it is not NULL). This feature is useful if you only want to build say a toolbar or menu from the XML document, but not the window it is embedded in.

glade_xml_construct ()

gboolean    glade_xml_construct             (GladeXML *self,
                                             const char *fname,
                                             const char *root,
                                             const char *domain);

This routine can be used by bindings (such as gtk--) to help construct a GladeXML object, if it is needed.

glade_xml_signal_connect ()

void        glade_xml_signal_connect        (GladeXML *self,
                                             const char *handlername,
                                             GCallback func);

In the glade interface descriptions, signal handlers are specified for widgets by name. This function allows you to connect a C function to all signals in the GladeXML file with the given signal handler name.

glade_xml_signal_connect_data ()

void        glade_xml_signal_connect_data   (GladeXML *self,
                                             const char *handlername,
                                             GCallback func,
                                             gpointer user_data);

In the glade interface descriptions, signal handlers are specified for widgets by name. This function allows you to connect a C function to all signals in the GladeXML file with the given signal handler name.

It differs from glade_xml_signal_connect since it allows you to specify the data parameter for the signal handler. It is also a small demonstration of how to use glade_xml_signal_connect_full.

glade_xml_signal_autoconnect ()

void        glade_xml_signal_autoconnect    (GladeXML *self);

This function is a variation of glade_xml_signal_connect. It uses gmodule's introspective features (by openning the module NULL) to look at the application's symbol table. From here it tries to match the signal handler names given in the interface description with symbols in the application and connects the signals.

Note that this function will not work correctly if gmodule is not supported on the platform.

glade_xml_get_widget ()

GtkWidget*  glade_xml_get_widget            (GladeXML *self,
                                             const char *name);

This function is used to get a pointer to the GtkWidget corresponding to name in the interface description. You would use this if you have to do anything to the widget after loading.

glade_xml_get_widget_prefix ()

GList*      glade_xml_get_widget_prefix     (GladeXML *self,
                                             const char *name);

This function is used to get a list of pointers to the GtkWidget(s) with names that start with the string name in the interface description. You would use this if you have to do something to all of these widgets after loading.

glade_get_widget_name ()

const char* glade_get_widget_name           (GtkWidget *widget);

Used to get the name of a widget that was generated by a GladeXML object.

glade_get_widget_tree ()

GladeXML*   glade_get_widget_tree           (GtkWidget *widget);

This function is used to get the GladeXML object that built this widget.

GladeXMLConnectFunc ()

void        (*GladeXMLConnectFunc)          (const gchar *handler_name,
                                             GObject *object,
                                             const gchar *signal_name,
                                             const gchar *signal_data,
                                             GObject *connect_object,
                                             gboolean after,
                                             gpointer user_data);

This is the signature of a function used to connect signals. It is used by the glade_xml_signal_connect_full and glade_xml_signal_autoconnect_full functions. It is mainly intented for interpreted language bindings, but could be useful where the programmer wants more control over the signal connection process.

glade_xml_signal_connect_full ()

void        glade_xml_signal_connect_full   (GladeXML *self,
                                             const gchar *handler_name,
                                             GladeXMLConnectFunc func,
                                             gpointer user_data);

This function is similar to glade_xml_signal_connect, except that it allows you to give an arbitrary function that will be used for actually connecting the signals. This is mainly useful for writers of interpreted language bindings, or applications where you need more control over the signal connection process.

glade_xml_signal_autoconnect_full ()

void        glade_xml_signal_autoconnect_full
                                            (GladeXML *self,
                                             GladeXMLConnectFunc func,
                                             gpointer user_data);

This function is similar to glade_xml_signal_connect_full, except that it will try to connect all signals in the interface, not just a single named handler. It can be thought of the interpeted language binding version of glade_xml_signal_autoconnect, except that it does not require gmodule to function correctly.

GladeXMLCustomWidgetHandler ()

GtkWidget*  (*GladeXMLCustomWidgetHandler)  (GladeXML *xml,
                                             gchar *func_name,
                                             gchar *name,
                                             gchar *string1,
                                             gchar *string2,
                                             gint int1,
                                             gint int2,
                                             gpointer user_data);

This prototype is for a function that creates custom widgets.

glade_set_custom_handler ()

void        glade_set_custom_handler        (GladeXMLCustomWidgetHandler handler,
                                             gpointer user_data);

Calling this function allows you to override the default behaviour when a Custom widget is found in an interface. This could be used by a language binding to call some other function, or to limit what functions can be called to create custom widgets.