GtkAction: GTK+ 2 Reference Manual

## GtkAction GtkAction |

## Functions

GtkAction * | gtk_action_new ()
const gchar * | gtk_action_get_name ()
gboolean | gtk_action_is_sensitive ()
gboolean | gtk_action_get_sensitive ()
void | gtk_action_set_sensitive ()
gboolean | gtk_action_is_visible ()
gboolean | gtk_action_get_visible ()
void | gtk_action_set_visible ()
void | gtk_action_activate ()
GtkWidget * | gtk_action_create_icon ()
GtkWidget * | gtk_action_create_menu_item ()
GtkWidget * | gtk_action_create_tool_item ()
GtkWidget * | gtk_action_create_menu ()
void | gtk_action_connect_proxy ()
void | gtk_action_disconnect_proxy ()
GSList * | gtk_action_get_proxies ()
void | gtk_action_connect_accelerator ()
void | gtk_action_disconnect_accelerator ()
void | gtk_action_block_activate ()
void | gtk_action_unblock_activate ()
void | gtk_action_block_activate_from ()
void | gtk_action_unblock_activate_from ()
gboolean | gtk_action_get_always_show_image ()
void | gtk_action_set_always_show_image ()
const gchar * | gtk_action_get_accel_path ()
void | gtk_action_set_accel_path ()
GClosure * | gtk_action_get_accel_closure ()
void | gtk_action_set_accel_group ()
void | gtk_action_set_label ()
const gchar * | gtk_action_get_label ()
void | gtk_action_set_short_label ()
const gchar * | gtk_action_get_short_label ()
void | gtk_action_set_tooltip ()
const gchar * | gtk_action_get_tooltip ()
void | gtk_action_set_stock_id ()
const gchar * | gtk_action_get_stock_id ()
void | gtk_action_set_gicon ()
GIcon * | gtk_action_get_gicon ()
void | gtk_action_set_icon_name ()
const gchar * | gtk_action_get_icon_name ()
void | gtk_action_set_visible_horizontal ()
gboolean | gtk_action_get_visible_horizontal ()
void | gtk_action_set_visible_vertical ()
gboolean | gtk_action_get_visible_vertical ()
void | gtk_action_set_is_important ()
gboolean | gtk_action_get_is_important ()

## Properties

GtkActionGroup * | action-group | Read / Write
gboolean | always-show-image | Read / Write / Construct
GIcon * | gicon | Read / Write
gboolean | hide-if-empty | Read / Write
gchar * | icon-name | Read / Write
gboolean | is-important | Read / Write
gchar * | label | Read / Write
gchar * | name | Read / Write / Construct Only
gboolean | sensitive | Read / Write
gchar * | short-label | Read / Write
gchar * | stock-id | Read / Write
gchar * | tooltip | Read / Write
gboolean | visible | Read / Write
gboolean | visible-horizontal | Read / Write
gboolean | visible-overflown | Read / Write
gboolean | visible-vertical | Read / Write

## Signals

void | activate | No Recursion

## Types and Values

struct | GtkAction

## Object Hierarchy

        GObject
        ╰── GtkAction
            ├── GtkToggleAction
            ╰── GtkRecentAction

## Implemented Interfaces

GtkAction implements GtkBuildable.

## Includes

    #include <gtk/gtk.h>

## Description

## Functions

### gtk_action_new ()

    GtkAction *
    gtk_action_new (const gchar *name,
                    const gchar *label,
                    const gchar *tooltip,
                    const gchar *stock_id);

Since: 2.4

### gtk_action_get_name ()

    const gchar *
    gtk_action_get_name (GtkAction *action);

Since: 2.4

### gtk_action_is_sensitive ()

    gboolean
    gtk_action_is_sensitive (GtkAction *action);

Since: 2.4

### gtk_action_get_sensitive ()

    gboolean
    gtk_action_get_sensitive (GtkAction *action);

Since: 2.4

### gtk_action_set_sensitive ()

    void
    gtk_action_set_sensitive (GtkAction *action,
                              gboolean sensitive);

Since: 2.6

### gtk_action_is_visible ()

    gboolean
    gtk_action_is_visible (GtkAction *action);

Since: 2.4

### gtk_action_get_visible ()

    gboolean
    gtk_action_get_visible (GtkAction *action);

Since: 2.4

### gtk_action_set_visible ()

    void
    gtk_action_set_visible (GtkAction *action,
                            gboolean visible);

Since: 2.6

### gtk_action_activate ()

    void
    gtk_action_activate (GtkAction *action);

Since: 2.4

### gtk_action_create_icon ()

    GtkWidget *
    gtk_action_create_icon (GtkAction *action,
                            GtkIconSize icon_size);

Since: 2.4

### gtk_action_create_menu_item ()

    GtkWidget *
    gtk_action_create_menu_item (GtkAction *action);

Since: 2.4

### gtk_action_create_tool_item ()

    GtkWidget *
    gtk_action_create_tool_item (GtkAction *action);

Since: 2.4

### gtk_action_create_menu ()

    GtkWidget *
    gtk_action_create_menu (GtkAction *action);

Since: 2.12

### gtk_action_connect_proxy ()

    void
    gtk_action_connect_proxy (GtkAction *action,
                              GtkWidget *proxy);

`gtk_action_connect_proxy` has been deprecated since version 2.16 and should not be used in newly-written code.

Use `gtk_activatable_set_related_action()` instead.

Since: 2.4

### gtk_action_disconnect_proxy ()

    void
    gtk_action_disconnect_proxy (GtkAction *action,
                                 GtkWidget *proxy);

`gtk_action_disconnect_proxy` has been deprecated since version 2.16 and should not be used in newly-written code.

Use `gtk_activatable_set_related_action()` instead.

Since: 2.4

### gtk_action_get_proxies ()

    GSList *
    gtk_action_get_proxies (GtkAction *action);

Since: 2.4

### gtk_action_connect_accelerator ()

    void
    gtk_action_connect_accelerator (GtkAction *action);

Since: 2.4

### gtk_action_disconnect_accelerator ()

    void
    gtk_action_disconnect_accelerator (GtkAction *action);

Since: 2.4

### gtk_action_block_activate ()

    void
    gtk_action_block_activate (GtkAction *action);

`gtk_action_block_activate` is deprecated and should not be used in newly-written code.

Since: 2.16

### gtk_action_unblock_activate ()

    void
    gtk_action_unblock_activate (GtkAction *action);

Since: 2.16

### gtk_action_block_activate_from ()

    void
    gtk_action_block_activate_from (GtkAction *action,
                                    GtkWidget *proxy);

`gtk_action_block_activate_from` has been deprecated since version 2.16 and should not be used in newly-written code.

activatables are now responsible for activating the action directly so this doesnt apply anymore.

Since: 2.4

### gtk_action_unblock_activate_from ()

    void
    gtk_action_unblock_activate_from (GtkAction *action,
                                      GtkWidget *proxy);

`gtk_action_unblock_activate_from` has been deprecated since version 2.16 and should not be used in newly-written code.

activatables are now responsible for activating the action directly so this doesnt apply anymore.

Since: 2.4

### gtk_action_get_always_show_image ()

    gboolean
    gtk_action_get_always_show_image (GtkAction *action);

Since: 2.20

### gtk_action_set_always_show_image ()

    void
    gtk_action_set_always_show_image (GtkAction *action,
                                      gboolean always_show);

Since: 2.20

### gtk_action_get_accel_path ()

    const gchar *
    gtk_action_get_accel_path (GtkAction *action);

Since: 2.6

### gtk_action_set_accel_path ()

    void
    gtk_action_set_accel_path (GtkAction *action,
                               const gchar *accel_path);

Since: 2.4

### gtk_action_get_accel_closure ()

    GClosure *
    gtk_action_get_accel_closure (GtkAction *action);

Since: 2.8

### gtk_action_set_accel_group ()

    void
    gtk_action_set_accel_group (GtkAction *action,
                                GtkAccelGroup *accel_group);

Since: 2.4

### gtk_action_set_label ()

    void
    gtk_action_set_label (GtkAction *action,
                          const gchar *label);

Since: 2.16

### gtk_action_get_label ()

    const gchar *
    gtk_action_get_label (GtkAction *action);

Since: 2.16

### gtk_action_set_short_label ()

    void
    gtk_action_set_short_label (GtkAction *action,
                                const gchar *short_label);

Since: 2.16

### gtk_action_get_short_label ()

    const gchar *
    gtk_action_get_short_label (GtkAction *action);

Since: 2.16

### gtk_action_set_tooltip ()

    void
    gtk_action_set_tooltip (GtkAction *action,
                            const gchar *tooltip);

Since: 2.16

### gtk_action_get_tooltip ()

    const gchar *
    gtk_action_get_tooltip (GtkAction *action);

Since: 2.16

### gtk_action_set_stock_id ()

    void
    gtk_action_set_stock_id (GtkAction *action,
                             const gchar *stock_id);

Since: 2.16

### gtk_action_get_stock_id ()

    const gchar *
    gtk_action_get_stock_id (GtkAction *action);

Since: 2.16

### gtk_action_set_gicon ()

    void
    gtk_action_set_gicon (GtkAction *action,
                          GIcon *icon);

Since: 2.16

### gtk_action_get_gicon ()

    GIcon *
    gtk_action_get_gicon (GtkAction *action);

Since: 2.16

### gtk_action_set_icon_name ()

    void
    gtk_action_set_icon_name (GtkAction *action,
                              const gchar *icon_name);

Since: 2.16

### gtk_action_get_icon_name ()

    const gchar *
    gtk_action_get_icon_name (GtkAction *action);

Since: 2.16

### gtk_action_set_visible_horizontal ()

    void
    gtk_action_set_visible_horizontal (GtkAction *action,
                                       gboolean visible_horizontal);

Since: 2.16

### gtk_action_get_visible_horizontal ()

    gboolean
    gtk_action_get_visible_horizontal (GtkAction *action);

Since: 2.16

### gtk_action_set_visible_vertical ()

    void
    gtk_action_set_visible_vertical (GtkAction *action,
                                     gboolean visible_vertical);

Since: 2.16

### gtk_action_get_visible_vertical ()

    gboolean
    gtk_action_get_visible_vertical (GtkAction *action);

Since: 2.16

### gtk_action_set_is_important ()

    void
    gtk_action_set_is_important (GtkAction *action,
                                 gboolean is_important);

Since: 2.16

### gtk_action_get_is_important ()

    gboolean
    gtk_action_get_is_important (GtkAction *action);

Since: 2.16

## Types and Values

### struct GtkAction

    struct GtkAction;

## Property Details

### The `“action-group”` property

      “action-group”             GtkActionGroup *

The GtkActionGroup this GtkAction is associated with, or NULL (for internal use).

Flags: Read / Write

### The `“always-show-image”` property

      “always-show-image”        gboolean

Whether the image will always be shown.

Flags: Read / Write / Construct

Default value: FALSE

Since: 2.20

### The `“gicon”` property

      “gicon”                    GIcon *

The GIcon being displayed.

Flags: Read / Write

Since: 2.16

### The `“hide-if-empty”` property

      “hide-if-empty”            gboolean

When TRUE, empty menu proxies for this action are hidden.

Flags: Read / Write

Default value: TRUE

### The `“icon-name”` property

      “icon-name”                gchar *

The name of the icon from the icon theme.

Flags: Read / Write

Default value: NULL

Since: 2.10

### The `“is-important”` property

      “is-important”             gboolean

Whether the action is considered important. When TRUE, toolitem proxies for this action show text in GTK_TOOLBAR_BOTH_HORIZ mode.

Flags: Read / Write

Default value: FALSE

### The `“label”` property

      “label”                    gchar *

The label used for menu items and buttons that activate this action.

Flags: Read / Write

Default value: NULL

### The `“name”` property

      “name”                     gchar *

A unique name for the action.

Flags: Read / Write / Construct Only

Default value: NULL

### The `“sensitive”` property

      “sensitive”                gboolean

Whether the action is enabled.

Flags: Read / Write

Default value: TRUE

### The `“short-label”` property

      “short-label”              gchar *

A shorter label that may be used on toolbar buttons.

Flags: Read / Write

Default value: NULL

### The `“stock-id”` property

      “stock-id”                 gchar *

The stock icon displayed in widgets representing this action.

Flags: Read / Write

Default value: NULL

### The `“tooltip”` property

      “tooltip”                  gchar *

A tooltip for this action.

Flags: Read / Write

Default value: NULL

### The `“visible”` property

      “visible”                  gboolean

Whether the action is visible.

Flags: Read / Write

Default value: TRUE

### The `“visible-horizontal”` property

      “visible-horizontal”       gboolean

Whether the toolbar item is visible when the toolbar is in a horizontal orientation.

Flags: Read / Write

Default value: TRUE

### The `“visible-overflown”` property

      “visible-overflown”        gboolean

When TRUE, toolitem proxies for this action are represented in the toolbar overflow menu.

Flags: Read / Write

Default value: TRUE

Since: 2.6

### The `“visible-vertical”` property

      “visible-vertical”         gboolean

Whether the toolbar item is visible when the toolbar is in a vertical orientation.

Flags: Read / Write

Default value: TRUE

## Signal Details

### The `“activate”` signal

    void
    user_function (GtkAction *action,
                   gpointer   user_data)

Flags: No Recursion

Since: 2.4