gtk.pad_controller

Module for [PadController] class

class PadController PadControllerGidBuilder PadControllerGidBuilderImpl

Types 3

classPadController : gtk.event_controller.EventController

#GtkPadController 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 #GAction objects, thus letting the application give those a more semantic meaning.

Buttons and sensors are not constrained to triggering a single action, some [gdk.types.InputSource.TabletPad] 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.device_pad.DevicePad.getNGroups] and [gdk.device_pad.DevicePad.getGroupNModes].

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

A simple example of #GtkPadController 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 #GVariantType.

Methods
GType _getGType()
GType _gType() @property
PadController self()Returns `this`, for use in `with` statements.
PadControllerGidBuilder builder()Get builder for [gtk.pad_controller.PadController] Returns: New builder object
gio.action_group.ActionGroup actionGroup() @property
gdk.device.Device pad() @property
void setAction(gtk.types.PadActionType type, int index, int mode, string label, string actionName)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 ca...
Constructors
this(void * ptr, Flag!"Take" take)
this(gtk.window.Window window, gio.action_group.ActionGroup group, gdk.device.Device pad = null)Creates a new #GtkPadController that will associate events from pad to actions. A null pad may be provided so the controller manages all pad devices generically, it is discouraged to mix #GtkPadCon...
classPadControllerGidBuilderImpl(T) : gtk.event_controller.EventControllerGidBuilderImpl!T
Methods
T actionGroup(gio.action_group.ActionGroup propval)
T pad(gdk.device.Device propval)
classPadControllerGidBuilder : PadControllerGidBuilderImpl!PadControllerGidBuilder

Fluent builder for [gtk.pad_controller.PadController]

Methods
PadController build()