Class: Gtk::PadController

Inherits:
EventController show all
Defined in:
(unknown)

Instance Method Summary collapse

Methods inherited from EventController

#current_event, #current_event_device, #current_event_state, #current_event_time, #name, #name=, #propagation_limit, #propagation_limit=, #propagation_phase, #propagation_phase=, #reset, #static_name=, #widget, #widget=

Constructor Details

#initialize(group, pad) ⇒ Gtk::PadController

Creates a new GtkPadController that will associate events from pad to actions.

A nil pad may be provided so the controller manages all pad devices generically, it is discouraged to mix GtkPadController objects with nil and non-nil pad argument on the same toplevel window, as execution order is not guaranteed.

The GtkPadController is created with no mapped actions. In order to map pad events to actions, use [methodGtk.PadController.set_action_entries] or [methodGtk.PadController.set_action].

Be aware that pad events will only be delivered to GtkWindows, so adding a pad controller to any other type of widget will not have an effect.

Parameters:

  • group (Gio::ActionGroup) —

    GActionGroup to trigger actions from

  • pad (Gdk::Device) —

    A %GDK_SOURCE_TABLET_PAD device, or nil to handle all pads

Instance Method Details

#action_group ⇒ Gio::ActionGroup

Returns action-group.

Returns:

  • (Gio::ActionGroup) —

    action-group

#action_group=(action_group) ⇒ Gio::ActionGroup

Parameters:

  • action_group (Gio::ActionGroup)

Returns:

  • (Gio::ActionGroup) —

    action-group

  • (Gio::ActionGroup) —

    action-group

#pad ⇒ Gdk::Device

Returns pad.

Returns:

  • (Gdk::Device) —

    pad

#pad=(pad) ⇒ Gdk::Device

Parameters:

  • pad (Gdk::Device)

Returns:

  • (Gdk::Device) —

    pad

  • (Gdk::Device) —

    pad

#set_action(type, index, mode, label, action_name) ⇒ nil

Adds an individual action to controller.

This action will only be activated if the given button/ring/strip number in index is interacted while the current mode is mode. -1 may be used for simple cases, so the action is triggered on all modes.

The given label should be considered user-visible, so internationalization rules apply. Some windowing systems may be able to use those for user feedback.

Parameters:

  • type (Gtk::PadActionType) —

    the type of pad feature that will trigger this action

  • index (Integer) —

    the 0-indexed button/ring/strip number that will trigger this action

  • mode (Integer) —

    the mode that will trigger this action, or -1 for all modes.

  • label (String) —

    Human readable description of this action, this string should be deemed user-visible.

  • action_name (String) —

    action name that will be activated in the GActionGroup

Returns:

  • (nil)

#set_action_entries(entries, n_entries) ⇒ nil

A convenience function to add a group of action entries on controller.

See [structGtk.PadActionEntry] and [methodGtk.PadController.set_action].

Parameters:

  • entries (Array<Gtk::PadActionEntry>) —

    the action entries to set on controller

  • n_entries (Integer) —

    the number of elements in entries

Returns:

  • (nil)