GimpActionGroup

GimpActionGroup

Synopsis

                    GimpActionGroup;
                    GimpActionEntry;
                    GimpToggleActionEntry;
                    GimpRadioActionEntry;
                    GimpEnumActionEntry;
                    GimpStringActionEntry;
                    GimpPlugInActionEntry;
GimpActionGroup *   gimp_action_group_new               (Gimp *gimp,
                                                         const gchar *name,
                                                         const gchar *label,
                                                         const gchar *stock_id,
                                                         gpointer user_data,
                                                         GimpActionGroupUpdateFunc update_func);
GList *             gimp_action_groups_from_name        (const gchar *name);
void                gimp_action_group_update            (GimpActionGroup *group,
                                                         gpointer update_data);
void                gimp_action_group_add_actions       (GimpActionGroup *group,
                                                         const gchar *msg_context,
                                                         const GimpActionEntry *entries,
                                                         guint n_entries);
void                gimp_action_group_add_toggle_actions
                                                        (GimpActionGroup *group,
                                                         const gchar *msg_context,
                                                         const GimpToggleActionEntry *entries,
                                                         guint n_entries);
GSList *            gimp_action_group_add_radio_actions (GimpActionGroup *group,
                                                         const gchar *msg_context,
                                                         const GimpRadioActionEntry *entries,
                                                         guint n_entries,
                                                         GSList *radio_group,
                                                         gint value,
                                                         GCallback callback);
void                gimp_action_group_add_enum_actions  (GimpActionGroup *group,
                                                         const gchar *msg_context,
                                                         const GimpEnumActionEntry *entries,
                                                         guint n_entries,
                                                         GCallback callback);
void                gimp_action_group_add_string_actions
                                                        (GimpActionGroup *group,
                                                         const gchar *msg_context,
                                                         const GimpStringActionEntry *entries,
                                                         guint n_entries,
                                                         GCallback callback);
void                gimp_action_group_add_plug_in_actions
                                                        (GimpActionGroup *group,
                                                         const GimpPlugInActionEntry *entries,
                                                         guint n_entries,
                                                         GCallback callback);
void                gimp_action_group_activate_action   (GimpActionGroup *group,
                                                         const gchar *action_name);
void                gimp_action_group_set_action_visible
                                                        (GimpActionGroup *group,
                                                         const gchar *action_name,
                                                         gboolean visible);
void                gimp_action_group_set_action_sensitive
                                                        (GimpActionGroup *group,
                                                         const gchar *action_name,
                                                         gboolean sensitive);
void                gimp_action_group_set_action_active (GimpActionGroup *group,
                                                         const gchar *action_name,
                                                         gboolean active);
void                gimp_action_group_set_action_label  (GimpActionGroup *group,
                                                         const gchar *action_name,
                                                         const gchar *label);
void                gimp_action_group_set_action_tooltip
                                                        (GimpActionGroup *group,
                                                         const gchar *action_name,
                                                         const gchar *tooltip);
const gchar *       gimp_action_group_get_action_tooltip
                                                        (GimpActionGroup *group,
                                                         const gchar *action_name);
void                gimp_action_group_set_action_color  (GimpActionGroup *group,
                                                         const gchar *action_name,
                                                         const GimpRGB *color,
                                                         gboolean set_label);
void                gimp_action_group_set_action_viewable
                                                        (GimpActionGroup *group,
                                                         const gchar *action_name,
                                                         GimpViewable *viewable);
void                gimp_action_group_set_action_hide_empty
                                                        (GimpActionGroup *group,
                                                         const gchar *action_name,
                                                         gboolean hide_empty);
void                gimp_action_group_set_action_always_show_image
                                                        (GimpActionGroup *group,
                                                         const gchar *action_name,
                                                         gboolean always_show_image);

Object Hierarchy

  GObject
   +----GtkActionGroup
         +----GimpActionGroup

Implemented Interfaces

GimpActionGroup implements GtkBuildable.

Properties

  "gimp"                     Gimp*                 : Read / Write / Construct Only
  "label"                    gchar*                : Read / Write / Construct Only
  "stock-id"                 gchar*                : Read / Write / Construct Only

Description

Details

GimpActionGroup

typedef struct _GimpActionGroup GimpActionGroup;


GimpActionEntry

typedef struct {
  const gchar *name;
  const gchar *stock_id;
  const gchar *label;
  const gchar *accelerator;
  const gchar *tooltip;
  GCallback    callback;

  const gchar *help_id;
} GimpActionEntry;


GimpToggleActionEntry

typedef struct {
  const gchar *name;
  const gchar *stock_id;
  const gchar *label;
  const gchar *accelerator;
  const gchar *tooltip;
  GCallback    callback;
  gboolean     is_active;

  const gchar *help_id;
} GimpToggleActionEntry;


GimpRadioActionEntry

typedef struct {
  const gchar *name;
  const gchar *stock_id;
  const gchar *label;
  const gchar *accelerator;
  const gchar *tooltip;
  gint         value;

  const gchar *help_id;
} GimpRadioActionEntry;


GimpEnumActionEntry

typedef struct {
  const gchar *name;
  const gchar *stock_id;
  const gchar *label;
  const gchar *accelerator;
  const gchar *tooltip;
  gint         value;
  gboolean     value_variable;

  const gchar *help_id;
} GimpEnumActionEntry;


GimpStringActionEntry

typedef struct {
  const gchar *name;
  const gchar *stock_id;
  const gchar *label;
  const gchar *accelerator;
  const gchar *tooltip;
  const gchar *value;

  const gchar *help_id;
} GimpStringActionEntry;


GimpPlugInActionEntry

typedef struct {
  const gchar         *name;
  const gchar         *stock_id;
  const gchar         *label;
  const gchar         *accelerator;
  const gchar         *tooltip;
  GimpPlugInProcedure *procedure;

  const gchar         *help_id;
} GimpPlugInActionEntry;


gimp_action_group_new ()

GimpActionGroup *   gimp_action_group_new               (Gimp *gimp,
                                                         const gchar *name,
                                                         const gchar *label,
                                                         const gchar *stock_id,
                                                         gpointer user_data,
                                                         GimpActionGroupUpdateFunc update_func);

Creates a new GimpActionGroup object. The name of the action group is used when associating keybindings with the actions.

gimp :

the Gimp instance this action group belongs to

name :

the name of the action group.

label :

the user visible label of the action group.

stock_id :

the icon of the action group.

user_data :

the user_data for GtkAction callbacks.

update_func :

the function that will be called on gimp_action_group_update().

Returns :

the new GimpActionGroup

gimp_action_groups_from_name ()

GList *             gimp_action_groups_from_name        (const gchar *name);


gimp_action_group_update ()

void                gimp_action_group_update            (GimpActionGroup *group,
                                                         gpointer update_data);


gimp_action_group_add_actions ()

void                gimp_action_group_add_actions       (GimpActionGroup *group,
                                                         const gchar *msg_context,
                                                         const GimpActionEntry *entries,
                                                         guint n_entries);


gimp_action_group_add_toggle_actions ()

void                gimp_action_group_add_toggle_actions
                                                        (GimpActionGroup *group,
                                                         const gchar *msg_context,
                                                         const GimpToggleActionEntry *entries,
                                                         guint n_entries);


gimp_action_group_add_radio_actions ()

GSList *            gimp_action_group_add_radio_actions (GimpActionGroup *group,
                                                         const gchar *msg_context,
                                                         const GimpRadioActionEntry *entries,
                                                         guint n_entries,
                                                         GSList *radio_group,
                                                         gint value,
                                                         GCallback callback);


gimp_action_group_add_enum_actions ()

void                gimp_action_group_add_enum_actions  (GimpActionGroup *group,
                                                         const gchar *msg_context,
                                                         const GimpEnumActionEntry *entries,
                                                         guint n_entries,
                                                         GCallback callback);


gimp_action_group_add_string_actions ()

void                gimp_action_group_add_string_actions
                                                        (GimpActionGroup *group,
                                                         const gchar *msg_context,
                                                         const GimpStringActionEntry *entries,
                                                         guint n_entries,
                                                         GCallback callback);


gimp_action_group_add_plug_in_actions ()

void                gimp_action_group_add_plug_in_actions
                                                        (GimpActionGroup *group,
                                                         const GimpPlugInActionEntry *entries,
                                                         guint n_entries,
                                                         GCallback callback);


gimp_action_group_activate_action ()

void                gimp_action_group_activate_action   (GimpActionGroup *group,
                                                         const gchar *action_name);


gimp_action_group_set_action_visible ()

void                gimp_action_group_set_action_visible
                                                        (GimpActionGroup *group,
                                                         const gchar *action_name,
                                                         gboolean visible);


gimp_action_group_set_action_sensitive ()

void                gimp_action_group_set_action_sensitive
                                                        (GimpActionGroup *group,
                                                         const gchar *action_name,
                                                         gboolean sensitive);


gimp_action_group_set_action_active ()

void                gimp_action_group_set_action_active (GimpActionGroup *group,
                                                         const gchar *action_name,
                                                         gboolean active);


gimp_action_group_set_action_label ()

void                gimp_action_group_set_action_label  (GimpActionGroup *group,
                                                         const gchar *action_name,
                                                         const gchar *label);


gimp_action_group_set_action_tooltip ()

void                gimp_action_group_set_action_tooltip
                                                        (GimpActionGroup *group,
                                                         const gchar *action_name,
                                                         const gchar *tooltip);


gimp_action_group_get_action_tooltip ()

const gchar *       gimp_action_group_get_action_tooltip
                                                        (GimpActionGroup *group,
                                                         const gchar *action_name);


gimp_action_group_set_action_color ()

void                gimp_action_group_set_action_color  (GimpActionGroup *group,
                                                         const gchar *action_name,
                                                         const GimpRGB *color,
                                                         gboolean set_label);


gimp_action_group_set_action_viewable ()

void                gimp_action_group_set_action_viewable
                                                        (GimpActionGroup *group,
                                                         const gchar *action_name,
                                                         GimpViewable *viewable);


gimp_action_group_set_action_hide_empty ()

void                gimp_action_group_set_action_hide_empty
                                                        (GimpActionGroup *group,
                                                         const gchar *action_name,
                                                         gboolean hide_empty);


gimp_action_group_set_action_always_show_image ()

void                gimp_action_group_set_action_always_show_image
                                                        (GimpActionGroup *group,
                                                         const gchar *action_name,
                                                         gboolean always_show_image);

Property Details

The "gimp" property

  "gimp"                     Gimp*                 : Read / Write / Construct Only


The "label" property

  "label"                    gchar*                : Read / Write / Construct Only

Default value: NULL


The "stock-id" property

  "stock-id"                 gchar*                : Read / Write / Construct Only

Default value: NULL