Interface Actionable

All Superinterfaces:
Proxy
All Known Implementing Classes:
Actionable.Actionable$Impl, ActionRow, Banner, Button, ButtonRow, CheckButton, ComboRow, EntryRow, ExpanderRow, LinkButton, ListBoxRow, LockButton, PasswordEntryRow, PreferencesRow, SpinRow, SplitButton, StyleSchemeChooserButton, StyleSchemePreview, Switch, SwitchRow, TabButton, ToggleButton
@Generated("org.javagi.JavaGI") public interface Actionable extends Proxy

Provides a way to associate widgets with actions.

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 GtkApplicationWindow or GtkApplication, but other action groups that are added with Widget.insertActionGroup(String, ActionGroup) will be consulted as well.

  • Method Details

    • getType

      static @Nullable Type getType()
      Get the GType of the Actionable class.
      Returns:
      the GType

    • getActionName

      default @Nullable String getActionName()
      Gets the action name for actionable.
      Returns:
      the action name

    • getActionTargetValue

      default @Nullable Variant getActionTargetValue()
      Gets the current target value of actionable.
      Returns:
      the current target value

    • setActionName

      default void setActionName(@Nullable String actionName)

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

      If actionName 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 ApplicationWindow or its associated Application, respectively. This is the same form used for actions in the Menu associated with the window.

      Parameters:
      actionName - an action name

    • setActionTarget

      default void setActionTarget(String formatString, Object... varargs)

      Sets the target of an actionable widget.

      This is a convenience function that calls Variant(String, Object...) for formatString and uses the result to call setActionTargetValue(Variant).

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

      Parameters:
      formatString - a GLib.Variant format string
      varargs - arguments appropriate for formatString

    • setActionTargetValue

      default void setActionTargetValue(@Nullable Variant targetValue)

      Sets the target value of an actionable widget.

      If targetValue 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 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).

      Parameters:
      targetValue - a GLib.Variant to set as the target value

    • setDetailedActionName

      default void setDetailedActionName(String detailedActionName)

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

      detailedActionName is a string in the format accepted by Action#parseDetailedName.

      Parameters:
      detailedActionName - the detailed action name