## GtkActivatable

GtkActivatable — An interface for activatable widgets

## Functions

void | gtk_activatable_do_set_related_action ()
GtkAction * | gtk_activatable_get_related_action ()
gboolean | gtk_activatable_get_use_action_appearance ()
void | gtk_activatable_sync_action_properties ()
void | gtk_activatable_set_related_action ()
void | gtk_activatable_set_use_action_appearance ()

## Properties

GtkAction * | related-action | Read / Write
gboolean | use-action-appearance | Read / Write

## Types and Values

| GtkActivatable
struct | GtkActivatableIface

## Object Hierarchy

        GInterface
        ╰── GtkActivatable

## Prerequisites

GtkActivatable requires GObject.

## Known Implementations

GtkActivatable is implemented by GtkButton, GtkCheckButton, GtkCheckMenuItem, GtkColorButton, GtkFontButton, GtkImageMenuItem, GtkLinkButton, GtkLockButton, GtkMenuButton, GtkMenuItem, GtkMenuToolButton, GtkModelButton, GtkRadioButton, GtkRadioMenuItem, GtkRadioToolButton, GtkRecentChooserMenu, GtkScaleButton, GtkSeparatorMenuItem, GtkSeparatorToolItem, GtkSwitch, GtkTearoffMenuItem, GtkToggleButton, GtkToggleToolButton, GtkToolButton, GtkToolItem and GtkVolumeButton.

## Includes

    #include <gtk/gtk.h>

## Description

Activatable widgets can be connected to a GtkAction and reflects the state of its action. A GtkActivatable can also provide feedback through its action, as they are responsible for activating their related actions.

### Implementing GtkActivatable

When extending a class that is already GtkActivatable; it is only necessary to implement the GtkActivatable->`sync_action_properties()` and GtkActivatable->`update()` methods and chain up to the parent implementation, however when introducing a new GtkActivatable class; the “related-action” and “use-action-appearance” properties need to be handled by the implementor. Handling these properties is mostly a matter of installing the action pointer and boolean flag on your instance, and calling `gtk_activatable_do_set_related_action()` and `gtk_activatable_sync_action_properties()` at the appropriate times.

#### A class fragment implementing GtkActivatable

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211

    enum {
    ...

    PROP_ACTIVATABLE_RELATED_ACTION,
    PROP_ACTIVATABLE_USE_ACTION_APPEARANCE
    }

    struct _FooBarPrivate
    {

      ...

      GtkAction      *action;
      gboolean        use_action_appearance;
    };

    ...

    static void foo_bar_activatable_interface_init         (GtkActivatableIface  *iface);
    static void foo_bar_activatable_update                 (GtkActivatable       *activatable,
                                       GtkAction            *action,
                                       const gchar          *property_name);
    static void foo_bar_activatable_sync_action_properties (GtkActivatable       *activatable,
                                       GtkAction            *action);
    ...

    static void
    foo_bar_class_init (FooBarClass *klass)
    {

      ...

      g_object_class_override_property (gobject_class, PROP_ACTIVATABLE_RELATED_ACTION, "related-action");
      g_object_class_override_property (gobject_class, PROP_ACTIVATABLE_USE_ACTION_APPEARANCE, "use-action-appearance");

      ...
    }

    static void
    foo_bar_activatable_interface_init (GtkActivatableIface  *iface)
    {
      iface->update = foo_bar_activatable_update;
      iface->sync_action_properties = foo_bar_activatable_sync_action_properties;
    }

    ... Break the reference using gtk_activatable_do_set_related_action()...

    static void
    foo_bar_dispose (GObject *object)
    {
      FooBar *bar = FOO_BAR (object);
      FooBarPrivate *priv = FOO_BAR_GET_PRIVATE (bar);

      ...

      if (priv->action)
        {
          gtk_activatable_do_set_related_action (GTK_ACTIVATABLE (bar), NULL);
          priv->action = NULL;
        }
      G_OBJECT_CLASS (foo_bar_parent_class)->dispose (object);
    }

    ... Handle the “related-action” and “use-action-appearance” properties ...

    static void
    foo_bar_set_property (GObject         *object,
                          guint            prop_id,
                          const GValue    *value,
                          GParamSpec      *pspec)
    {
      FooBar *bar = FOO_BAR (object);
      FooBarPrivate *priv = FOO_BAR_GET_PRIVATE (bar);

      switch (prop_id)
        {

          ...

        case PROP_ACTIVATABLE_RELATED_ACTION:
          foo_bar_set_related_action (bar, g_value_get_object (value));
          break;
        case PROP_ACTIVATABLE_USE_ACTION_APPEARANCE:
          foo_bar_set_use_action_appearance (bar, g_value_get_boolean (value));
          break;
        default:
          G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
          break;
        }
    }

    static void
    foo_bar_get_property (GObject         *object,
                             guint            prop_id,
                             GValue          *value,
                             GParamSpec      *pspec)
    {
      FooBar *bar = FOO_BAR (object);
      FooBarPrivate *priv = FOO_BAR_GET_PRIVATE (bar);

      switch (prop_id)
        {

          ...

        case PROP_ACTIVATABLE_RELATED_ACTION:
          g_value_set_object (value, priv->action);
          break;
        case PROP_ACTIVATABLE_USE_ACTION_APPEARANCE:
          g_value_set_boolean (value, priv->use_action_appearance);
          break;
        default:
          G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
          break;
        }
    }

    static void
    foo_bar_set_use_action_appearance (FooBar   *bar,
                       gboolean  use_appearance)
    {
      FooBarPrivate *priv = FOO_BAR_GET_PRIVATE (bar);

      if (priv->use_action_appearance != use_appearance)
        {
          priv->use_action_appearance = use_appearance;

          gtk_activatable_sync_action_properties (GTK_ACTIVATABLE (bar), priv->action);
        }
    }

    ... call gtk_activatable_do_set_related_action() and then assign the action pointer,
    no need to reference the action here since gtk_activatable_do_set_related_action() already
    holds a reference here for you...
    static void
    foo_bar_set_related_action (FooBar    *bar,
                    GtkAction *action)
    {
      FooBarPrivate *priv = FOO_BAR_GET_PRIVATE (bar);

      if (priv->action == action)
        return;

      gtk_activatable_do_set_related_action (GTK_ACTIVATABLE (bar), action);

      priv->action = action;
    }

    ... Selectively reset and update activatable depending on the use-action-appearance property ...
    static void
    gtk_button_activatable_sync_action_properties (GtkActivatable       *activatable,
                                              GtkAction            *action)
    {
      GtkButtonPrivate *priv = GTK_BUTTON_GET_PRIVATE (activatable);

      if (!action)
        return;

      if (gtk_action_is_visible (action))
        gtk_widget_show (GTK_WIDGET (activatable));
      else
        gtk_widget_hide (GTK_WIDGET (activatable));

      gtk_widget_set_sensitive (GTK_WIDGET (activatable), gtk_action_is_sensitive (action));

      ...

      if (priv->use_action_appearance)
        {
          if (gtk_action_get_stock_id (action))
        foo_bar_set_stock (button, gtk_action_get_stock_id (action));
          else if (gtk_action_get_label (action))
        foo_bar_set_label (button, gtk_action_get_label (action));

          ...

        }
    }

    static void
    foo_bar_activatable_update (GtkActivatable       *activatable,
                       GtkAction            *action,
                       const gchar          *property_name)
    {
      FooBarPrivate *priv = FOO_BAR_GET_PRIVATE (activatable);

      if (strcmp (property_name, "visible") == 0)
        {
          if (gtk_action_is_visible (action))
        gtk_widget_show (GTK_WIDGET (activatable));
          else
        gtk_widget_hide (GTK_WIDGET (activatable));
        }
      else if (strcmp (property_name, "sensitive") == 0)
        gtk_widget_set_sensitive (GTK_WIDGET (activatable), gtk_action_is_sensitive (action));

      ...

      if (!priv->use_action_appearance)
        return;

      if (strcmp (property_name, "stock-id") == 0)
        foo_bar_set_stock (button, gtk_action_get_stock_id (action));
      else if (strcmp (property_name, "label") == 0)
        foo_bar_set_label (button, gtk_action_get_label (action));

      ...
    }

## Functions

### gtk_activatable_do_set_related_action ()

    void
    gtk_activatable_do_set_related_action (GtkActivatable *activatable,
                                           GtkAction *action);

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

This is a utility function for GtkActivatable implementors.

When implementing GtkActivatable you must call this when handling changes of the “related-action”, and you must also use this to break references in GObject->`dispose()`.

This function adds a reference to the currently set related action for you, it also makes sure the GtkActivatable->`update()` method is called when the related GtkAction properties change and registers to the action’s proxy list.

> Be careful to call this before setting the local copy of the GtkAction property, since this function uses `gtk_activatable_get_related_action()` to retrieve the previous action.

#### Parameters

activatable | a GtkActivatable |
action | the GtkAction to set |

Since: 2.16

### gtk_activatable_get_related_action ()

    GtkAction *
    gtk_activatable_get_related_action (GtkActivatable *activatable);

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

Gets the related GtkAction for `activatable` .

#### Parameters

activatable | a GtkActivatable |

#### Returns

the related GtkAction if one is set.

[transfer none]

Since: 2.16

### gtk_activatable_get_use_action_appearance ()

    gboolean
    gtk_activatable_get_use_action_appearance
                                   (GtkActivatable *activatable);

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

Gets whether this activatable should reset its layout and appearance when setting the related action or when the action changes appearance.

#### Parameters

activatable | a GtkActivatable |

#### Returns

whether `activatable` uses its actions appearance.

Since: 2.16

### gtk_activatable_sync_action_properties ()

    void
    gtk_activatable_sync_action_properties
                                   (GtkActivatable *activatable,
                                    GtkAction *action);

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

This is called to update the activatable completely, this is called internally when the “related-action” property is set or unset and by the implementing class when “use-action-appearance” changes.

#### Parameters

activatable | a GtkActivatable |
action | the related GtkAction or `NULL`. | [allow-none]

Since: 2.16

### gtk_activatable_set_related_action ()

    void
    gtk_activatable_set_related_action (GtkActivatable *activatable,
                                        GtkAction *action);

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

Sets the related action on the `activatable` object.

> GtkActivatable implementors need to handle the “related-action” property and call `gtk_activatable_do_set_related_action()` when it changes.

#### Parameters

activatable | a GtkActivatable |
action | the GtkAction to set |

Since: 2.16

### gtk_activatable_set_use_action_appearance ()

    void
    gtk_activatable_set_use_action_appearance
                                   (GtkActivatable *activatable,
                                    gboolean use_appearance);

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

Sets whether this activatable should reset its layout and appearance when setting the related action or when the action changes appearance

> GtkActivatable implementors need to handle the “use-action-appearance” property and call `gtk_activatable_sync_action_properties()` to update `activatable` if needed.

#### Parameters

activatable | a GtkActivatable |
use_appearance | whether to use the actions appearance |

Since: 2.16

## Types and Values

### GtkActivatable

    typedef struct _GtkActivatable GtkActivatable;

### struct GtkActivatableIface

    struct GtkActivatableIface {
      /* virtual table */
      void   (* update)                   (GtkActivatable *activatable,
    		                       GtkAction      *action,
    		                       const gchar    *property_name);
      void   (* sync_action_properties)   (GtkActivatable *activatable,
    		                       GtkAction      *action);
    };

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

> This method can be called with a `NULL` action at times.

#### Members

`update` () | Called to update the activatable when its related action’s properties change. You must check the “use-action-appearance” property only apply action properties that are meant to effect the appearance accordingly. |
`sync_action_properties` () | Called to update the activatable completely, this is called internally when “related-action” property is set or unset and by the implementor when “use-action-appearance” changes. |

Since: 2.16

## Property Details

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

      “related-action”           GtkAction *

The action that this activatable will activate and receive updates from for various states and possibly appearance.

> GtkActivatable implementors need to handle the this property and call `gtk_activatable_do_set_related_action()` when it changes.

`GtkActivatable:related-action` has been deprecated since version 3.10 and should not be used in newly-written code.

Flags: Read / Write

Since: 2.16

### The `“use-action-appearance”` property

      “use-action-appearance”    gboolean

Whether this activatable should reset its layout and appearance when setting the related action or when the action changes appearance.

See the GtkAction documentation directly to find which properties should be ignored by the GtkActivatable when this property is `FALSE`.

> GtkActivatable implementors need to handle this property and call `gtk_activatable_sync_action_properties()` on the activatable widget when it changes.

`GtkActivatable:use-action-appearance` has been deprecated since version 3.10 and should not be used in newly-written code.

Flags: Read / Write

Default value: TRUE

Since: 2.16