GtkActivatable

GtkActivatable — An interface for activatable widgets

Functions

Properties

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

Types and Values

Object Hierarchy

    GInterface
    ╰── GtkActivatable

Prerequisites

GtkActivatable requires GObject.

Known Implementations

GtkActivatable is implemented by GtkButton, GtkCheckButton, GtkCheckMenuItem, GtkColorButton, GtkFontButton, GtkImageMenuItem, GtkLinkButton, GtkMenuItem, GtkMenuToolButton, GtkOptionMenu, GtkRadioButton, GtkRadioMenuItem, GtkRadioToolButton, GtkRecentChooserMenu, GtkScaleButton, GtkSeparatorMenuItem, GtkSeparatorToolItem, 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.

Example 9. A class fragment implementing GtkActivatable

1

Functions

gtk_activatable_do_set_related_action ()

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

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

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

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

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

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

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 {
  GTypeInterface g_iface;

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

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.

This method can be called with a NULL action at times

 

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.

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.

Flags: Read / Write

Default value: TRUE

Since: 2.16