Gtk.Actionable

g GObject.GInterface GObject.GInterface Gtk.Actionable Gtk.Actionable GObject.GInterface->Gtk.Actionable

Implementations:
 Gtk.Button, Gtk.ListBoxRow, Gtk.MenuItem, Gtk.Switch, Gtk.ToolButton

Methods

  get_action_name ()
  get_action_target_value ()
  set_action_name (action_name)
  set_action_target_value (target_value)
  set_detailed_action_name (detailed_action_name)

Virtual Methods

  do_get_action_name ()
  do_get_action_target_value ()
  do_set_action_name (action_name)
  do_set_action_target_value (target_value)

Properties

Name Type Flags Short Description
action-name str r/w The name of the associated action, like ‘app.quit’
action-target GLib.Variant r/w The parameter for action invocations

Signals

None

Fields

None

Class Details

class Gtk.Actionable
Bases:GObject.GInterface
Structure:Gtk.ActionableInterface

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

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.

New in version 3.4.

get_action_name()[source]
Returns:the action name, or None if none is set
Return type:str or None

Gets the action name for self.

See Gtk.Actionable.set_action_name() for more information.

New in version 3.4.

get_action_target_value()[source]
Returns:the current target value
Return type:GLib.Variant

Gets the current target value of self.

See Gtk.Actionable.set_action_target_value() for more information.

New in version 3.4.

set_action_name(action_name)[source]
Parameters:action_name (str or None) – an action name, or None

Specifies the name of the action with which this widget should be associated. If action_name is None 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 Gtk.Application, respectively. This is the same form used for actions in the Gio.Menu associated with the window.

New in version 3.4.

set_action_target_value(target_value)[source]
Parameters:target_value (GLib.Variant or None) – a GLib.Variant to set as the target value, or None

Sets the target value of an actionable widget.

If target_value is None 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 Gio.Action 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).

New in version 3.4.

set_detailed_action_name(detailed_action_name)[source]
Parameters:detailed_action_name (str) – the detailed action name

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

detailed_action_name is a string in the format accepted by Gio.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.)

New in version 3.4.

do_get_action_name() virtual
Returns:the action name, or None if none is set
Return type:str or None

Gets the action name for actionable.

See Gtk.Actionable.set_action_name() for more information.

New in version 3.4.

do_get_action_target_value() virtual
Returns:the current target value
Return type:GLib.Variant

Gets the current target value of actionable.

See Gtk.Actionable.set_action_target_value() for more information.

New in version 3.4.

do_set_action_name(action_name) virtual
Parameters:action_name (str or None) – an action name, or None

Specifies the name of the action with which this widget should be associated. If action_name is None 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 Gtk.Application, respectively. This is the same form used for actions in the Gio.Menu associated with the window.

New in version 3.4.

do_set_action_target_value(target_value) virtual
Parameters:target_value (GLib.Variant or None) – a GLib.Variant to set as the target value, or None

Sets the target value of an actionable widget.

If target_value is None 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 Gio.Action 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).

New in version 3.4.

Property Details

Gtk.Actionable.props.action_name
Name:action-name
Type:str
Default Value:None
Flags:READABLE, WRITABLE

The name of the associated action, like ‘app.quit’

Gtk.Actionable.props.action_target
Name:action-target
Type:GLib.Variant
Default Value:None
Flags:READABLE, WRITABLE

The parameter for action invocations