enum GladeCreateReason

typedef enum
{
	GLADE_CREATE_USER = 0,
	GLADE_CREATE_COPY,
	GLADE_CREATE_LOAD,
	GLADE_CREATE_REBUILD,
	GLADE_CREATE_REASONS
} GladeCreateReason;

These are the reasons your GladePostCreateFunc can be called.

GWA_IS_FIXED()

#define             GWA_IS_FIXED(obj)

Checks whether this widget adaptor should be handled as a free-form container

GWA_IS_TOPLEVEL()

#define             GWA_IS_TOPLEVEL(obj)

Checks whether this widget class has been marked as a toplevel one.

GWA_USE_PLACEHOLDERS()

#define             GWA_USE_PLACEHOLDERS(obj)

Checks whether this widget class has been marked to use placeholders in child widget operations

GWA_DEFAULT_WIDTH()

#define             GWA_DEFAULT_WIDTH(obj)

GWA_DEFAULT_HEIGHT()

#define             GWA_DEFAULT_HEIGHT(obj)

GWA_GET_CLASS()

#define             GWA_GET_CLASS(type)

Shorthand for referencing glade adaptor classes from the plugin eg. GWA_GET_CLASS (GTK_TYPE_CONTAINER)->post_create (adaptor...

GWA_GET_OCLASS()

#define GWA_GET_OCLASS(type) ((GObjectClass*)GWA_GET_CLASS(type))

Same as GWA_GET_CLASS but casted to GObjectClass

GLADE_VALID_CREATE_REASON()

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

GLADE_TYPE_CREATE_REASON

#define GLADE_TYPE_CREATE_REASON (glade_create_reason_get_type())

GladeSetPropertyFunc ()

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

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

Sets value on object for a given GladePropertyClass

GladeGetPropertyFunc ()

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

Gets value on object for a given GladePropertyClass

GladeVerifyPropertyFunc ()

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

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

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.

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.

GladeChildVerifyPropertyFunc ()

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

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

GladeGetChildrenFunc ()

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

A function called to get containers children.

GladeAddChildFunc ()

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

Called to add child to parent.

GladeRemoveChildFunc ()

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

Called to remove child from parent.

GladeReplaceChildFunc ()

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

Called to swap placeholders with project objects in containers.

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.

GladeGetInternalFunc ()

GObject *           (*GladeGetInternalFunc)             (GladeWidgetAdaptor *adaptor,
                                                         GObject *parent,
                                                         const gchar *name);

Called to lookup child in composite object parent by name.

GladeActionActivateFunc ()

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

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

GladeChildActionActivateFunc ()

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

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

GladeReadWidgetFunc ()

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

This function is called to update widget from node.

GladeWriteWidgetFunc ()

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

This function is called to fill in node from widget.

GladeCreateEPropFunc ()

GladeEditorProperty * (*GladeCreateEPropFunc)           (GladeWidgetAdaptor *adaptor,
                                                         GladePropertyClass *klass,
                                                         gboolean use_command);

Creates a GladeEditorProperty to edit klass

GladeStringFromValueFunc ()

gchar *             (*GladeStringFromValueFunc)         (GladeWidgetAdaptor *adaptor,
                                                         GladePropertyClass *klass,
                                                         const GValue *value,
                                                         GladeProjectFormat fmt);

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.

GladeWidgetAdaptor

typedef struct {
	GObject      parent_instance;

	GType        type;         /* GType of the widget */

	gchar       *name;         /* Name of the widget, for example GtkButton */


	gchar       *generic_name; /* Used to generate names of new widgets, for
				    * example "button" so that we generate button1,
				    * button2, buttonX ..
				    */
				    
	gchar       *icon_name;    /* icon name to use for widget class */
	gchar       *missing_icon; /* the name of the missing icon if it was not found */

	gchar       *title;        /* Translated class name used in the UI */

	GList       *properties;   /* List of GladePropertyClass objects.
				    * [see glade-property.h] this list contains
				    * properties about the widget that we are going
				    * to modify. Like "title", "label", "rows" .
				    * Each property creates an input in the propety
				    * editor.
				    */
	GList       *packing_props; /* List of GladePropertyClass objects that describe
				     * properties for child objects packing definition -
				     * note there may be more than one type of child supported
				     * by a widget and thus they may have different sets
				     * of properties for each type - this association is
				     * managed on the GladePropertyClass proper.
				     */
  
	GList       *signals;        /* List of GladeSignalClass objects */

        GList       *child_packings; /* Default packing property values */

	GList       *actions;        /* A list of GWActionClass */
	
	GList       *packing_actions;/* A list of GWActionClass for child objects */

	GladeWidgetAdaptorPrivate *priv;
} GladeWidgetAdaptor;

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

this macro returns the newly created GladeWidget

glade_widget_adaptor_create_eprop ()

GladeEditorProperty * glade_widget_adaptor_create_eprop (GladeWidgetAdaptor *adaptor,
                                                         GladePropertyClass *klass,
                                                         gboolean use_command);

Creates a GladeEditorProperty to edit klass

glade_widget_adaptor_from_pclass()

#define             glade_widget_adaptor_from_pclass(pclass)

glade_widget_adaptor_from_pspec ()

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

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);

Dynamicly creates a subclass of GladeWidgetAdaptor and subclasses the closest parent adaptor (parent class adapters must be creates/registerd prior to child classes, otherwise inheritance wont work) and parses in the relevent 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 convenienve 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,
                                                         ...);

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_class ()

GladePropertyClass * glade_widget_adaptor_get_property_class
                                                        (GladeWidgetAdaptor *adaptor,
                                                         const gchar *name);

Retrieves the GladePropertyClass for name in adaptor

glade_widget_adaptor_get_pack_property_class ()

GladePropertyClass * glade_widget_adaptor_get_pack_property_class
                                                        (GladeWidgetAdaptor *adaptor,
                                                         const gchar *name);

Retrieves the GladePropertyClass 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 delagate 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 delagate function is always called whenever setting any properties with the exception of load time, and copy/paste time (basicly the two places where we recreate a hierarchy that we already know "works") its basicly an optional backend provided boundry 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 delagate function is always called whenever setting any properties with the exception of load time, and copy/paste time (basicly the two places where we recreate a hierarchy that we already know "works") its basicly an optional backend provided boundry 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 ()

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,
                                                         GladePropertyClass *klass,
                                                         const GValue *value,
                                                         GladeProjectFormat fmt);

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.