class: Actionable

[19:7] extends: object

Provides a way to associate widgets with actions. It primarily consists of two properties: [property@Gtk.Actionable:action-name] and [property@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 GtkApplicationWindow or GtkApplication, but other action groups that are added with [method@Gtk.Widget.insert_action_group] will be consulted as well.

Members

• handleObj
• lib
• retainedCallbacks
• signalHandlerNames
• signalSetterHandlers

Methods

• Actionable (Handle = null)

  Creates a new Actionable by wrapping a native handle or another wrapper.

  • @p Handle is the native handle or another wrapper whose handle to adopt.

• toNativeHandle (Source)

  Normalizes a constructor argument into a raw pointer carrier. Accepts a raw NativeHandle, a raw NativeBuffer returned from fn.call(...), another generated wrapper exposing handle(), or null. Returns null when the argument carries no pointer.

  • @p Source is the raw handle, raw buffer, wrapper, or null.
  • @r A raw pointer carrier or null when no pointer is present.

• getLib ()

  Returns the opened native library for this generated wrapper.

  • @r The opened native library.

• handle ()

  Returns the wrapped NativeHandle.

  • @r The wrapped NativeHandle.

• isNull ()

  Returns true when the wrapped handle is null.

  • @r A bool.

• describe ()

  Returns a small string for debugging generated wrappers.

  • @r A string.

• getProperty (string Name)

  Reads one generated property by name.

• setProperty (string Name, Value)

  Writes one generated property by name.

• setActionname (string Value)

  The name of the action with which this widget should be associated.

  • @p Value is the new property value.
  • @r None.

• setActiontarget (object Value)

  The target value of the actionable widget's action.

  • @p Value is the new property value.
  • @r None.

• get_action_name ()

  Gets the action name for @actionable.

• get_action_target_value ()

  Gets the current target value of @actionable.

• set_action_name (string action_name)

  Specifies the name of the action with which this widget should be associated. If @action_name is %NULL 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 GtkApplicationWindow. Names are of the form “win.save” or “app.quit” for actions on the containing [class@ApplicationWindow] or its associated [class@Application], respectively. This is the same form used for actions in the [class@Gio.Menu] associated with the window.

  • @p action_name is an action name.
  • @r None.

• set_action_target_value (object target_value)

  Sets the target value of an actionable widget. If @target_value is %NULL 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 GtkActionable 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 [iface@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).

  • @p target_value is a [struct@GLib.Variant] to set as the target value.
  • @r None.

• set_detailed_action_name (string 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 [func@Gio.Action.parse_detailed_name].

  • @p detailed_action_name is the detailed action name.
  • @r None.

class: ActionableMeta

[218:14] static extends: object

Generated metadata helpers for Actionable interface surfaces.

Methods

• properties ()

  Returns property metadata for Actionable.

  • @r A list.