GLADE_VALID_CREATE_REASON()

#define GLADE_VALID_CREATE_REASON(reason) (reason >= 0 && reason < GLADE_CREATE_REASONS)

GladeActionActivateFunc ()

void
(*GladeActionActivateFunc) (GladeWidgetAdaptor *adaptor,
                            GObject *object,
                            const gchar *action_path);

This delegate function is used to catch actions from the core.

GladeActionSubmenuFunc ()

GtkWidget *
(*GladeActionSubmenuFunc) (GladeWidgetAdaptor *adaptor,
                           GObject *object,
                           const gchar *action_path);

This delegate function is used to create dynamically customized submenus. Called only for actions that don't have children.

GladeAddChildFunc ()

void
(*GladeAddChildFunc) (GladeWidgetAdaptor *adaptor,
                      GObject *container,
                      GObject *child);

Called to add child to container .

GladeAddChildVerifyFunc ()

gboolean
(*GladeAddChildVerifyFunc) (GladeWidgetAdaptor *adaptor,
                            GObject *container,
                            GObject *child,
                            gboolean user_feedback);

Checks whether child can be added to container .

If user_feedback is TRUE and child cannot be added then this shows a notification dialog to the user explaining why.

GladeChildActionActivateFunc ()

void
(*GladeChildActionActivateFunc) (GladeWidgetAdaptor *adaptor,
                                 GObject *container,
                                 GObject *object,
                                 const gchar *action_path);

This delegate function is used to catch packing actions from the core.

GladeChildGetPropertyFunc ()

void
(*GladeChildGetPropertyFunc) (GladeWidgetAdaptor *adaptor,
                              GObject *container,
                              GObject *child,
                              const gchar *property_name,
                              GValue *value);

Called to get the packing property property_name on the child object of container into value .

GladeChildSetPropertyFunc ()

void
(*GladeChildSetPropertyFunc) (GladeWidgetAdaptor *adaptor,
                              GObject *container,
                              GObject *child,
                              const gchar *property_name,
                              const GValue *value);

Called to set the packing property property_name to value on the child object of container .

GladeChildVerifyPropertyFunc ()

gboolean
(*GladeChildVerifyPropertyFunc) (GladeWidgetAdaptor *adaptor,
                                 GObject *container,
                                 GObject *child,
                                 const gchar *property_name,
                                 const GValue *value);

This delegate function is always called whenever setting any properties with the exception of load time, and copy/paste time (basically the two places where we recreate a hierarchy that we already know "works") its basically an optional backend provided boundary checker for properties.

GladeConstructObjectFunc ()

GObject *
(*GladeConstructObjectFunc) (GladeWidgetAdaptor *adaptor,
                             guint n_parameters,
                             GParameter *parameters);

This function is called to construct a GObject instance. (for language bindings that may need to construct a wrapper object).

GladeCreateEditableFunc ()

GladeEditable *
(*GladeCreateEditableFunc) (GladeWidgetAdaptor *adaptor,
                            GladeEditorPageType type);

This is used to allow the backend to override the way an editor page is layed out (note that editor widgets are created on demand and not at startup).

GladeCreateEPropFunc ()

GladeEditorProperty *
(*GladeCreateEPropFunc) (GladeWidgetAdaptor *adaptor,
                         GladePropertyDef *def,
                         gboolean use_command);

Creates a GladeEditorProperty to edit klass

GladeCreateWidgetFunc ()

GladeWidget *
(*GladeCreateWidgetFunc) (GladeWidgetAdaptor *adaptor,
                          const gchar *first_property_name,
                          va_list var_args);

This entry point allows the backend to create a specialized GladeWidget derived object for handling instances in the core.

GladeDependsFunc ()

gboolean
(*GladeDependsFunc) (GladeWidgetAdaptor *adaptor,
                     GladeWidget *widget,
                     GladeWidget *another);

Checks whether widget depends on another to be placed earlier in the glade file.

GladeDestroyObjectFunc ()

void
(*GladeDestroyObjectFunc) (GladeWidgetAdaptor *adaptor,
                           GObject *object);

This function is called to break any additional references to a GObject instance. Note that this function is not responsible for calling g_object_unref() on object , the reference count of object belongs to it's GladeWidget wrapper.

The GtkWidget adaptor will call gtk_widget_destroy() before chaining up in this function.

If your adaptor adds any references in any way at GladePostCreateFunc time or GladeConstructObjectFunc time, then this function must be implemented to also remove that reference.

GladeGetChildrenFunc ()

GList *
(*GladeGetChildrenFunc) (GladeWidgetAdaptor *adaptor,
                         GObject *container);

A function called to get containers children.

GladeGetInternalFunc ()

GObject *
(*GladeGetInternalFunc) (GladeWidgetAdaptor *adaptor,
                         GObject *object,
                         const gchar *internal_name);

Called to lookup child in composite object parent by internal_name .

GladeGetPropertyFunc ()

void
(*GladeGetPropertyFunc) (GladeWidgetAdaptor *adaptor,
                         GObject *object,
                         const gchar *property_name,
                         GValue *value);

Gets value on object for a given GladePropertyDef

GladePostCreateFunc ()

void
(*GladePostCreateFunc) (GladeWidgetAdaptor *adaptor,
                        GObject *object,
                        GladeCreateReason reason);

This function is called exactly once for any project object instance and can be for any GladeCreateReason.

GladeReadWidgetFunc ()

void
(*GladeReadWidgetFunc) (GladeWidgetAdaptor *adaptor,
                        GladeWidget *widget,
                        GladeXmlNode *node);

This function is called to update widget from node .

GladeRemoveChildFunc ()

void
(*GladeRemoveChildFunc) (GladeWidgetAdaptor *adaptor,
                         GObject *container,
                         GObject *child);

Called to remove child from container .

GladeReplaceChildFunc ()

void
(*GladeReplaceChildFunc) (GladeWidgetAdaptor *adaptor,
                          GObject *container,
                          GObject *old_obj,
                          GObject *new_obj);

Called to swap placeholders with project objects in containers.

GladeSetPropertyFunc ()

void
(*GladeSetPropertyFunc) (GladeWidgetAdaptor *adaptor,
                         GObject *object,
                         const gchar *property_name,
                         const GValue *value);

This delegate function is used to apply the property value on the runtime object.

Sets value on object for a given GladePropertyDef

GladeStringFromValueFunc ()

gchar *
(*GladeStringFromValueFunc) (GladeWidgetAdaptor *adaptor,
                             GladePropertyDef *def,
                             const GValue *value);

For normal properties this is used to serialize property values, for custom properties (only when new pspecs are introduced) its needed for value comparisons in boxed pspecs and also to update the UI for undo/redo items etc.

GladeVerifyPropertyFunc ()

gboolean
(*GladeVerifyPropertyFunc) (GladeWidgetAdaptor *adaptor,
                            GObject *object,
                            const gchar *property_name,
                            const GValue *value);

This delegate function is always called whenever setting any properties with the exception of load time, and copy/paste time (basically the two places where we recreate a hierarchy that we already know "works") its basically an optional backend provided boundary checker for properties.

GladeWriteWidgetFunc ()

void
(*GladeWriteWidgetFunc) (GladeWidgetAdaptor *adaptor,
                         GladeWidget *widget,
                         GladeXmlContext *context,
                         GladeXmlNode *node);

This function is called to fill in node from widget .

glade_widget_adaptor_create_widget()

#define             glade_widget_adaptor_create_widget(adaptor, query, ...)

This factory function returns a new GladeWidget of the correct type/class with the properties defined in @... and queries the user if nescisary.

The resulting object will have all default properties applied to it including the overrides specified in the catalog, unless the catalog has specified 'ignore' for that property.

Note that the widget class must be fed twice; once as the leading arg... and also as the property for the GladeWidget

glade_widget_adaptor_create_eprop ()

GladeEditorProperty *
glade_widget_adaptor_create_eprop (GladeWidgetAdaptor *adaptor,
                                   GladePropertyDef *def,
                                   gboolean use_command);

Creates a GladeEditorProperty to edit def

glade_widget_adaptor_from_pspec ()

GladeWidgetAdaptor *
glade_widget_adaptor_from_pspec (GladeWidgetAdaptor *adaptor,
                                 GParamSpec *pspec);

Assumes pspec is a property in an object class wrapped by adaptor , this function will search for the specific parent adaptor class which originally introduced pspec .

glade_widget_adaptor_from_catalog ()

GladeWidgetAdaptor *
glade_widget_adaptor_from_catalog (GladeCatalog *catalog,
                                   GladeXmlNode *class_node,
                                   GModule *module);

Dynamically creates a subclass of GladeWidgetAdaptor and subclasses the closest parent adaptor (parent class adapters must be created/registered prior to child classes, otherwise inheritance wont work) and parses in the relevant catalog info.

glade_widget_adaptor_register ()

void
glade_widget_adaptor_register (GladeWidgetAdaptor *adaptor);

Registers adaptor into the Glade core (every supported object type must have a registered adaptor).

glade_widget_adaptor_create_internal ()

GladeWidget *
glade_widget_adaptor_create_internal (GladeWidget *parent,
                                      GObject *internal_object,
                                      const gchar *internal_name,
                                      const gchar *parent_name,
                                      gboolean anarchist,
                                      GladeCreateReason reason);

A convenience function to create a GladeWidget of the prescribed type for internal widgets.

glade_widget_adaptor_create_widget_real ()

GladeWidget *
glade_widget_adaptor_create_widget_real
                               (gboolean query,
                                const gchar *first_property,
                                ...);

The macro glade_widget_adaptor_create_widget() uses this function glade_widget_adaptor_create_widget_real(query , "adaptor", adaptor, @...)

Use glade_widget_adaptor_create_widget() in C as this function is mostly available for languages where macros are not available.

glade_widget_adaptor_get_by_name ()

GladeWidgetAdaptor *
glade_widget_adaptor_get_by_name (const gchar *name);

glade_widget_adaptor_get_by_type ()

GladeWidgetAdaptor *
glade_widget_adaptor_get_by_type (GType type);

glade_widget_adaptor_get_property_def ()

GladePropertyDef *
glade_widget_adaptor_get_property_def (GladeWidgetAdaptor *adaptor,
                                       const gchar *name);

Retrieves the GladePropertyDef for name in adaptor

glade_widget_adaptor_get_pack_property_def ()

GladePropertyDef *
glade_widget_adaptor_get_pack_property_def
                               (GladeWidgetAdaptor *adaptor,
                                const gchar *name);

Retrieves the GladePropertyDef for name in adaptor 's child properties

glade_widget_adaptor_default_params ()

GParameter *
glade_widget_adaptor_default_params (GladeWidgetAdaptor *adaptor,
                                     gboolean construct,
                                     guint *n_params);

glade_widget_adaptor_post_create ()

void
glade_widget_adaptor_post_create (GladeWidgetAdaptor *adaptor,
                                  GObject *object,
                                  GladeCreateReason reason);

An adaptor function to be called after the object is created

glade_widget_adaptor_get_internal_child ()

GObject *
glade_widget_adaptor_get_internal_child
                               (GladeWidgetAdaptor *adaptor,
                                GObject *object,
                                const gchar *internal_name);

Retrieves the internal object internal_name from object

glade_widget_adaptor_set_property ()

void
glade_widget_adaptor_set_property (GladeWidgetAdaptor *adaptor,
                                   GObject *object,
                                   const gchar *property_name,
                                   const GValue *value);

This delegate function is used to apply the property value on the runtime object.

glade_widget_adaptor_get_property ()

void
glade_widget_adaptor_get_property (GladeWidgetAdaptor *adaptor,
                                   GObject *object,
                                   const gchar *property_name,
                                   GValue *value);

Gets value of property_name on object .

glade_widget_adaptor_verify_property ()

gboolean
glade_widget_adaptor_verify_property (GladeWidgetAdaptor *adaptor,
                                      GObject *object,
                                      const gchar *property_name,
                                      const GValue *value);

This delegate function is always called whenever setting any properties with the exception of load time, and copy/paste time (basically the two places where we recreate a hierarchy that we already know "works") its basically an optional backend provided boundary checker for properties.

glade_widget_adaptor_add ()

void
glade_widget_adaptor_add (GladeWidgetAdaptor *adaptor,
                          GObject *container,
                          GObject *child);

Adds child to container .

glade_widget_adaptor_remove ()

void
glade_widget_adaptor_remove (GladeWidgetAdaptor *adaptor,
                             GObject *container,
                             GObject *child);

Removes child from container .

glade_widget_adaptor_get_children ()

GList *
glade_widget_adaptor_get_children (GladeWidgetAdaptor *adaptor,
                                   GObject *container);

Lists the children of container .

glade_widget_adaptor_has_child ()

gboolean
glade_widget_adaptor_has_child (GladeWidgetAdaptor *adaptor,
                                GObject *container,
                                GObject *child);

glade_widget_adaptor_child_set_property ()

void
glade_widget_adaptor_child_set_property
                               (GladeWidgetAdaptor *adaptor,
                                GObject *container,
                                GObject *child,
                                const gchar *property_name,
                                const GValue *value);

Sets child 's packing property identified by property_name to value .

glade_widget_adaptor_child_get_property ()

void
glade_widget_adaptor_child_get_property
                               (GladeWidgetAdaptor *adaptor,
                                GObject *container,
                                GObject *child,
                                const gchar *property_name,
                                GValue *value);

Gets child 's packing property identified by property_name .

glade_widget_adaptor_child_verify_property ()

gboolean
glade_widget_adaptor_child_verify_property
                               (GladeWidgetAdaptor *adaptor,
                                GObject *container,
                                GObject *child,
                                const gchar *property_name,
                                const GValue *value);

This delegate function is always called whenever setting any properties with the exception of load time, and copy/paste time (basically the two places where we recreate a hierarchy that we already know "works") its basically an optional backend provided boundary checker for properties.

glade_widget_adaptor_replace_child ()

void
glade_widget_adaptor_replace_child (GladeWidgetAdaptor *adaptor,
                                    GObject *container,
                                    GObject *old_obj,
                                    GObject *new_obj);

Replaces old_obj with new_obj in container while positioning new_obj where old_obj was and assigning it appropriate packing property values.

glade_widget_adaptor_read_child ()

void
glade_widget_adaptor_read_child (GladeWidgetAdaptor *adaptor,
                                 GladeWidget *widget,
                                 GladeXmlNode *node);

This function is called to update load a child widget from node when loading xml files (will recurse into glade_widget_read())

glade_widget_adaptor_read_widget ()

void
glade_widget_adaptor_read_widget (GladeWidgetAdaptor *adaptor,
                                  GladeWidget *widget,
                                  GladeXmlNode *node);

This function is called to update widget from node when loading xml files.

glade_widget_adaptor_write_child ()

void
glade_widget_adaptor_write_child (GladeWidgetAdaptor *adaptor,
                                  GladeWidget *widget,
                                  GladeXmlContext *context,
                                  GladeXmlNode *node);

This function is called to write the child widget to node when writing xml files (takes care of packing and recurses into glade_widget_write())

glade_widget_adaptor_write_widget ()

void
glade_widget_adaptor_write_widget (GladeWidgetAdaptor *adaptor,
                                   GladeWidget *widget,
                                   GladeXmlContext *context,
                                   GladeXmlNode *node);

This function is called to write widget to node when writing xml files.

glade_widget_adaptor_query ()

gboolean
glade_widget_adaptor_query (GladeWidgetAdaptor *adaptor);

glade_widget_adaptor_get_packing_default ()

const gchar *
glade_widget_adaptor_get_packing_default
                               (GladeWidgetAdaptor *child_adaptor,
                                GladeWidgetAdaptor *container_adaptor,
                                const gchar *id);

Gets the default value for property_id on a widget governed by child_adaptor when parented in a widget governed by parent_adaptor

glade_widget_adaptor_is_container ()

gboolean
glade_widget_adaptor_is_container (GladeWidgetAdaptor *adaptor);

Checks whether or not this adaptor has support to interface with child objects.

glade_widget_adaptor_action_add ()

gboolean
glade_widget_adaptor_action_add (GladeWidgetAdaptor *adaptor,
                                 const gchar *action_path,
                                 const gchar *label,
                                 const gchar *stock,
                                 gboolean important);

Add an action to adaptor . If the action is present then it overrides label and stock

glade_widget_adaptor_pack_action_add ()

gboolean
glade_widget_adaptor_pack_action_add (GladeWidgetAdaptor *adaptor,
                                      const gchar *action_path,
                                      const gchar *label,
                                      const gchar *stock,
                                      gboolean important);

Add a packing action to adaptor . If the action is present then it overrides label and stock

glade_widget_adaptor_action_remove ()

gboolean
glade_widget_adaptor_action_remove (GladeWidgetAdaptor *adaptor,
                                    const gchar *action_path);

Remove an adaptor 's action.

glade_widget_adaptor_pack_action_remove ()

gboolean
glade_widget_adaptor_pack_action_remove
                               (GladeWidgetAdaptor *adaptor,
                                const gchar *action_path);

Remove an adaptor 's packing action.

glade_widget_adaptor_pack_actions_new ()

GList *
glade_widget_adaptor_pack_actions_new (GladeWidgetAdaptor *adaptor);

Create a list of packing actions.

glade_widget_adaptor_action_activate ()

void
glade_widget_adaptor_action_activate (GladeWidgetAdaptor *adaptor,
                                      GObject *object,
                                      const gchar *action_path);

An adaptor function to be called on widget actions.

glade_widget_adaptor_child_action_activate ()

void
glade_widget_adaptor_child_action_activate
                               (GladeWidgetAdaptor *adaptor,
                                GObject *container,
                                GObject *object,
                                const gchar *action_path);

An adaptor function to be called on widget actions.

glade_widget_adaptor_string_from_value ()

gchar *
glade_widget_adaptor_string_from_value
                               (GladeWidgetAdaptor *adaptor,
                                GladePropertyDef *def,
                                const GValue *value);

For normal properties this is used to serialize property values, for custom properties its still needed to update the UI for undo/redo items etc.

glade_widget_adaptor_action_submenu ()

GtkWidget *
glade_widget_adaptor_action_submenu (GladeWidgetAdaptor *adaptor,
                                     GObject *object,
                                     const gchar *action_path);

This delegate function is used to create dynamically customized submenus. Called only for actions that don't have children.

glade_widget_adaptor_actions_new ()

GList *
glade_widget_adaptor_actions_new (GladeWidgetAdaptor *adaptor);

Create a list of actions.

glade_widget_adaptor_add_verify ()

gboolean
glade_widget_adaptor_add_verify (GladeWidgetAdaptor *adaptor,
                                 GObject *container,
                                 GObject *child,
                                 gboolean user_feedback);

Checks whether child can be added to parent .

If user_feedback is TRUE and child cannot be added then this shows a notification dialog to the user explaining why.

glade_widget_adaptor_construct_object ()

GObject *
glade_widget_adaptor_construct_object (GladeWidgetAdaptor *adaptor,
                                       guint n_parameters,
                                       GParameter *parameters);

This function is called to construct a GObject instance for a GladeWidget of the said adaptor . (provided for language bindings that may need to construct a wrapper object).

glade_widget_adaptor_create_editable ()

GladeEditable *
glade_widget_adaptor_create_editable (GladeWidgetAdaptor *adaptor,
                                      GladeEditorPageType type);

This is used to allow the backend to override the way an editor page is layed out (note that editor widgets are created on demand and not at startup).

glade_widget_adaptor_create_eprop_by_name ()

GladeEditorProperty *
glade_widget_adaptor_create_eprop_by_name
                               (GladeWidgetAdaptor *adaptor,
                                const gchar *property_id,
                                gboolean packing,
                                gboolean use_command);

Creates a GladeEditorProperty to edit GladePropertyDef name in adaptor

glade_widget_adaptor_depends ()

gboolean
glade_widget_adaptor_depends (GladeWidgetAdaptor *adaptor,
                              GladeWidget *widget,
                              GladeWidget *another);

Checks whether widget depends on another to be placed earlier in the glade file.

glade_widget_adaptor_destroy_object ()

void
glade_widget_adaptor_destroy_object (GladeWidgetAdaptor *adaptor,
                                     GObject *object);

This function is called to destroy a GObject instance.

glade_widget_adaptor_get_book ()

const gchar *
glade_widget_adaptor_get_book (GladeWidgetAdaptor *adaptor);

glade_widget_adaptor_get_catalog ()

const gchar *
glade_widget_adaptor_get_catalog (GladeWidgetAdaptor *adaptor);

glade_widget_adaptor_get_display_name ()

const gchar *
glade_widget_adaptor_get_display_name (GladeWidgetAdaptor *adaptor);

glade_widget_adaptor_get_generic_name ()

const gchar *
glade_widget_adaptor_get_generic_name (GladeWidgetAdaptor *adaptor);

glade_widget_adaptor_get_icon_name ()

const gchar *
glade_widget_adaptor_get_icon_name (GladeWidgetAdaptor *adaptor);

glade_widget_adaptor_get_missing_icon ()

const gchar *
glade_widget_adaptor_get_missing_icon (GladeWidgetAdaptor *adaptor);

glade_widget_adaptor_get_name ()

const gchar *
glade_widget_adaptor_get_name (GladeWidgetAdaptor *adaptor);

glade_widget_adaptor_get_object_type ()

GType
glade_widget_adaptor_get_object_type (GladeWidgetAdaptor *adaptor);

glade_widget_adaptor_get_packing_props ()

const GList *
glade_widget_adaptor_get_packing_props
                               (GladeWidgetAdaptor *adaptor);

glade_widget_adaptor_get_parent_adaptor ()

GladeWidgetAdaptor *
glade_widget_adaptor_get_parent_adaptor
                               (GladeWidgetAdaptor *adaptor);

glade_widget_adaptor_get_properties ()

const GList *
glade_widget_adaptor_get_properties (GladeWidgetAdaptor *adaptor);

glade_widget_adaptor_get_signal_def ()

GladeSignalDef *
glade_widget_adaptor_get_signal_def (GladeWidgetAdaptor *adaptor,
                                     const gchar *name);

Looks up signal class name on adaptor .

glade_widget_adaptor_get_signals ()

const GList *
glade_widget_adaptor_get_signals (GladeWidgetAdaptor *adaptor);

glade_widget_adaptor_get_title ()

const gchar *
glade_widget_adaptor_get_title (GladeWidgetAdaptor *adaptor);

glade_widget_adaptor_has_internal_children ()

gboolean
glade_widget_adaptor_has_internal_children
                               (GladeWidgetAdaptor *adaptor);

glade_widget_adaptor_list_adaptors ()

GList *
glade_widget_adaptor_list_adaptors (void);

Compiles a list of all registered adaptors.

glade_widget_adaptor_write_widget_after ()

void
glade_widget_adaptor_write_widget_after
                               (GladeWidgetAdaptor *adaptor,
                                GladeWidget *widget,
                                GladeXmlContext *context,
                                GladeXmlNode *node);

This function is called to write widget to node when writing xml files (after writing children)

enum GladeCreateReason

These are the reasons your GladePostCreateFunc can be called.

GLADE_TYPE_CREATE_REASON

#define GLADE_TYPE_CREATE_REASON (glade_create_reason_get_type ())

GLADE_WIDGET_ADAPTOR_INSTANTIABLE_PREFIX

#define GLADE_WIDGET_ADAPTOR_INSTANTIABLE_PREFIX "GladeInstantiable"

Class prefix used for abstract classes (ie GtkBin -> GladeInstantiableGtkBin)

GladeWidgetAdaptor

typedef struct _GladeWidgetAdaptor GladeWidgetAdaptor;