PadController

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

class PadController : EventController {

this(void* ptr, Flag!"Take" take);

static GType _getGType();

GType _gType [@property getter];

PadController self();

static PadControllerGidBuilder builder();

gio.action_group.ActionGroup actionGroup [@property getter];

gdk.device.Device pad [@property getter];

this(gtk.window.Window window, gio.action_group.ActionGroup group, gdk.device.Device pad);

void setAction(gtk.types.PadActionType type, int index, int mode, string label, string actionName);

}

Constructors

this this(void* ptr, Flag!"Take" take)
this this(gtk.window.Window window, gio.action_group.ActionGroup group, gdk.device.Device pad): 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 #GtkPadController objects with null and non-null pad argument on the same window, as execution order is not guaranteed.

Members

Functions

self PadController self(): Returns this, for use in with statements.
setAction 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 cases, so the action is triggered on all modes.

Properties

_gType GType _gType [@property getter]
actionGroup gio.action_group.ActionGroup actionGroup [@property getter]
pad gdk.device.Device pad [@property getter]

Static functions

_getGType GType _getGType()
builder PadControllerGidBuilder builder(): Get builder for gtk.pad_controller.PadController

Inherited Members

From EventController

_getGType GType _getGType()
_gType GType _gType [@property getter]
self EventController self(): Returns this, for use in with statements.
builder EventControllerGidBuilder builder(): Get builder for gtk.event_controller.EventController
propagationPhase gtk.types.PropagationPhase propagationPhase [@property getter]: Get propagationPhase property.
propagationPhase gtk.types.PropagationPhase propagationPhase [@property setter]: Set propagationPhase property.
widget gtk.widget.Widget widget [@property getter]: Get widget property.
getPropagationPhase gtk.types.PropagationPhase getPropagationPhase(): Gets the propagation phase at which controller handles events.
getWidget gtk.widget.Widget getWidget(): Returns the #GtkWidget this controller relates to.
handleEvent bool handleEvent(gdk.event.Event event): Feeds an events into controller, so it can be interpreted and the controller actions triggered.
reset void reset(): Resets the controller to a clean state. Every interaction the controller did through #GtkEventController::handle-event will be dropped at this point.
setPropagationPhase void setPropagationPhase(gtk.types.PropagationPhase phase): Sets the propagation phase at which a controller handles events.

gtk pad_controller classes