Module: Gtk::Actionable

Defined in:
(unknown)

Overview

This interface provides a convenient way of associating widgets with actions on a Gtk::ApplicationWindow or #GtkApplication.

It primarily consists of two properties: Gtk::Actionable:action-name and Gtk::Actionable:action-target. There are also some convenience APIs for setting these properties.

The action will be looked up in action groups that are found among the widgets ancestors. Most commonly, these will be the actions with the “win.” or “app.” prefix that are associated with the Gtk::ApplicationWindow or Gtk::Application, but other action groups that are added with gtk_widget_insert_action_group() will be consulted as well.

Instance Method Summary collapse

Instance Method Details

#action_name ⇒ String

Gets the action name for actionable.

See gtk_actionable_set_action_name() for more information.

Returns:

  • (String) —

    the action name, or nil if none is set

#action_name=(action_name) ⇒ nil

Specifies the name of the action with which this widget should be associated. If action_name is nil then the widget will be unassociated from any previous action.

Usually this function is used when the widget is located (or will be located) within the hierarchy of a Gtk::ApplicationWindow.

Names are of the form “win.save” or “app.quit” for actions on the containing Gtk::ApplicationWindow or its associated #GtkApplication, respectively. This is the same form used for actions in the #GMenu associated with the window.

Parameters:

  • action_name (String) —

    an action name, or nil

Returns:

  • (nil)

#action_target_value ⇒ GLib::Variant

Gets the current target value of actionable.

See gtk_actionable_set_action_target_value() for more information.

Returns:

  • (GLib::Variant) —

    the current target value

#action_target_value=(target_value) ⇒ nil

Sets the target value of an actionable widget.

If target_value is nil then the target value is unset.

The target value has two purposes. First, it is used as the parameter to activation of the action associated with the Gtk::Actionable widget. Second, it is used to determine if the widget should be rendered as “active” — the widget is active if the state is equal to the given target.

Consider the example of associating a set of buttons with a #GAction with string state in a typical “radio button” situation. Each button will be associated with the same action, but with a different target value for that action. Clicking on a particular button will activate the action with the target of that button, which will typically cause the action’s state to change to that value. Since the action’s state is now equal to the target value of the button, the button will now be rendered as active (and the other buttons, with different targets, rendered inactive).

Parameters:

  • target_value (GLib::Variant) —

    a #GVariant to set as the target value, or nil

Returns:

  • (nil)

#detailed_action_name=(detailed_action_name) ⇒ nil

Sets the action-name and associated string target value of an actionable widget.

detailed_action_name is a string in the format accepted by g_action_parse_detailed_name().

(Note that prior to version 3.22.25, this function is only usable for actions with a simple “s” target, and detailed_action_name must be of the form ‘“action::target”` where `action` is the action name and `target` is the string to use as the target.)

Parameters:

  • detailed_action_name (String) —

    the detailed action name

Returns:

  • (nil)

#set_action_target(format_string, array) ⇒ nil

Sets the target of an actionable widget.

This is a convenience function that calls g_variant_new() for format_string and uses the result to call gtk_actionable_set_action_target_value().

If you are setting a string-valued target and want to set the action name at the same time, you can use gtk_actionable_set_detailed_action_name ().

Parameters:

  • format_string (String) —

    a GVariant format string

  • array (Array) —

    arguments appropriate for format_string

Returns:

  • (nil)