PadController

gtk.pad_controller.PadController is an event controller for the pads found in drawing tablets.

Pads are 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. gtk.pad_controller.PadController is provided to map those to gio.action.Action objects, thus letting the application give them 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 a gtk.pad_action_entry.PadActionEntry. It contains an action name that will be looked up in the given gio.action_group.ActionGroup and activated whenever the specified input element and mode are triggered.

A simple example of gtk.pad_controller.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 (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.variant_type.VariantType.

class PadController : EventController {

this(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(gio.action_group.ActionGroup group, gdk.device.Device pad): Creates a new gtk.pad_controller.PadController that will associate events from pad to actions.

Members

Functions

setAction void setAction(gtk.types.PadActionType type, int index, int mode, string label, string actionName): Adds an individual action to controller.

Inherited Members

From EventController

getCurrentEvent gdk.event.Event getCurrentEvent(): Returns the event that is currently being handled by the controller.
getCurrentEventDevice gdk.device.Device getCurrentEventDevice(): Returns the device of the event that is currently being handled by the controller.
getCurrentEventState gdk.types.ModifierType getCurrentEventState(): Returns the modifier state of the event that is currently being handled by the controller.
getCurrentEventTime uint getCurrentEventTime(): Returns the timestamp of the event that is currently being handled by the controller.
getName string getName(): Gets the name of controller.
getPropagationLimit gtk.types.PropagationLimit getPropagationLimit(): Gets the propagation limit of the event controller.
getPropagationPhase gtk.types.PropagationPhase getPropagationPhase(): Gets the propagation phase at which controller handles events.
getWidget gtk.widget.Widget getWidget(): Returns the gtk.widget.Widget this controller relates to.
reset void reset(): Resets the controller to a clean state.
setName void setName(string name): Sets a name on the controller that can be used for debugging.
setPropagationLimit void setPropagationLimit(gtk.types.PropagationLimit limit): Sets the event propagation limit on the event controller.
setPropagationPhase void setPropagationPhase(gtk.types.PropagationPhase phase): Sets the propagation phase at which a controller handles events.
setStaticName void setStaticName(string name): Sets a name on the controller that can be used for debugging.

gtk pad_controller classes

PadController