Gtk.PadController

g GObject.Object GObject.Object Gtk.EventController Gtk.EventController GObject.Object->Gtk.EventController Gtk.PadController Gtk.PadController Gtk.EventController->Gtk.PadController

Subclasses:None

Methods

Inherited:Gtk.EventController (5), GObject.Object (37)
Structs:GObject.ObjectClass (5)
class new (window, group, pad)
  set_action (type, index, mode, label, action_name)
  set_action_entries (entries)

Virtual Methods

Inherited:GObject.Object (7)

Properties

Inherited:Gtk.EventController (2)
Name Type Flags Short Description
action-group Gio.ActionGroup r/w/co Action group to launch actions from
pad Gdk.Device r/w/co Pad device to control

Signals

Inherited:GObject.Object (1)

Fields

Inherited:GObject.Object (1)

Class Details

class Gtk.PadController(**kwargs)
Bases:Gtk.EventController
Abstract:No
Structure:Gtk.PadControllerClass

Gtk.PadController is an event controller for the pads found in drawing tablets (The collection of buttons and tactile sensors often found around the stylus-sensitive area).

These buttons and sensors have no implicit meaning, and by default they perform no action, this event controller is provided to map those to Gio.Action objects, thus letting the application give those a more semantic meaning.

Buttons and sensors are not constrained to triggering a single action, some Gdk.InputSource.TABLET_PAD devices feature multiple “modes”, all these input elements have one current mode, which may determine the final action being triggered. Pad devices often divide buttons and sensors into groups, all elements in a group share the same current mode, but different groups may have different modes. See Gdk.DevicePad.get_n_groups() and Gdk.DevicePad.get_group_n_modes().

Each of the actions that a given button/strip/ring performs for a given mode is defined by Gtk.PadActionEntry, it contains an action name that will be looked up in the given Gio.ActionGroup and activated whenever the specified input element and mode are triggered.

A simple example of Gtk.PadController usage, assigning button 1 in all modes and pad devices to an “invert-selection” action:

GtkPadActionEntry *pad_actions[] = {
  { GTK_PAD_ACTION_BUTTON, 1, -1, "Invert selection", "pad-actions.invert-selection" },
  …
};

…
action_group = g_simple_action_group_new ();
action = g_simple_action_new ("pad-actions.invert-selection", NULL);
g_signal_connect (action, "activate", on_invert_selection_activated, NULL);
g_action_map_add_action (G_ACTION_MAP (action_group), action);
…
pad_controller = gtk_pad_controller_new (window, action_group, NULL);

The actions belonging to rings/strips will be activated with a parameter of type %G_VARIANT_TYPE_DOUBLE bearing the value of the given axis, it is required that those are made stateful and accepting this GLib.VariantType.

classmethod new(window, group, pad)[source]
Parameters:
Returns:

A newly created Gtk.PadController

Return type:

Gtk.PadController

Creates a new Gtk.PadController that will associate events from pad to actions. A None pad may be provided so the controller manages all pad devices generically, it is discouraged to mix Gtk.PadController objects with None and non-None pad argument on the same window, as execution order is not guaranteed.

The Gtk.PadController is created with no mapped actions. In order to map pad events to actions, use Gtk.PadController.set_action_entries() or Gtk.PadController.set_action().

New in version 3.22.

set_action(type, index, mode, label, action_name)[source]
Parameters:
  • type (Gtk.PadActionType) – the type of pad feature that will trigger this action
  • index (int) – the 0-indexed button/ring/strip number that will trigger this action
  • mode (int) – the mode that will trigger this action, or -1 for all modes.
  • label (str) – Human readable description of this action, this string should be deemed user-visible.
  • action_name (str) – action name that will be activated in the Gio.ActionGroup

Adds an individual action to self. 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.

New in version 3.22.

set_action_entries(entries)[source]
Parameters:entries ([Gtk.PadActionEntry]) – the action entries to set on self

This is a convenience function to add a group of action entries on self. See Gtk.PadActionEntry and Gtk.PadController.set_action().

New in version 3.22.

Property Details

Gtk.PadController.props.action_group
Name:action-group
Type:Gio.ActionGroup
Default Value:None
Flags:READABLE, WRITABLE, CONSTRUCT_ONLY

Action group to launch actions from

Gtk.PadController.props.pad
Name:pad
Type:Gdk.Device
Default Value:None
Flags:READABLE, WRITABLE, CONSTRUCT_ONLY

Pad device to control