Interface

Gtk-3.0 ▶ Gtk ▶ Actionable ▶ Interface

Interface for implementing Actionable. Contains only the virtual methods that need to be implemented.

interface Interface {
    vfunc_get_action_name(): string;
    vfunc_get_action_target_value(): GLib.Variant;
    vfunc_set_action_name(action_name?: string): void;
    vfunc_set_action_target_value(target_value?: GLib.Variant<any>): void;
}

Hierarchy (View Summary)

Index

Methods

vfunc_get_action_name vfunc_get_action_target_value vfunc_set_action_name vfunc_set_action_target_value

Methods

  • Gets the action name for actionable.

    See gtk_actionable_set_action_name() for more information.

    Returns string

  • 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 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.

    Parameters

    • Optionalaction_name: string

      an action name, or null

    Returns void

  • 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 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).

    Parameters

    Returns void