Package org.gnome.gtk

Class PadController

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gtk.EventController

org.gnome.gtk.PadController

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public class PadController
extends EventController

GtkPadController 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. GtkPadController is provided to map those to Action objects, thus letting the application give them a more semantic meaning.

Buttons and sensors are not constrained to triggering a single action, some 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 DevicePad.getNGroups() and DevicePad.getGroupNModes(int).

Each of the actions that a given button/strip/ring performs for a given mode is defined by a Gtk.PadActionEntry. It contains an action name that will be looked up in the given ActionGroup 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 (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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PadController.Builder<B extends PadController.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	PadController.PadControllerClass

Nested classes/interfaces inherited from class org.gnome.gtk.EventController

EventController.EventControllerClass, EventController.EventControllerImpl

Nested classes/interfaces inherited from class org.gnome.gobject.GObject

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
PadController(MemorySegment address)	Create a PadController proxy instance for the provided memory address.
PadController(ActionGroup group, @Nullable Device pad)	Creates a new GtkPadController that will associate events from pad to actions.

Method Summary

Modifier and Type	Method	Description
protected PadController	asParent()	Returns this instance as if it were its parent type.
static PadController.Builder<? extends PadController.Builder>	builder()	A PadController.Builder object constructs a PadController with the specified properties.
static Type	getType()	Get the GType of the PadController class
void	setAction(PadActionType type, int index, int mode, String label, String actionName)	Adds an individual action to this PadController.
void	setActionEntries(PadActionEntry[] entries)	A convenience function to add a group of action entries on this PadController.

Methods inherited from class org.gnome.gtk.EventController

getCurrentEvent, getCurrentEventDevice, getCurrentEventState, getCurrentEventTime, getName, getPropagationLimit, getPropagationPhase, getWidget, reset, setName, setPropagationLimit, setPropagationPhase, setStaticName

Methods inherited from class org.gnome.gobject.GObject

addToggleRef, addWeakPointer, bindProperty, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, connect, constructed, disconnect, dispatchPropertiesChanged, dispose, dupData, dupQdata, emit, emitNotify, finalize_, forceFloating, freezeNotify, get, getData, getMemoryLayout, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, newInstance, newInstance, newv, notify, notify, notifyByPspec, onNotify, ref, refSink, removeToggleRef, removeWeakPointer, replaceData, replaceQdata, runDispose, set, setData, setDataFull, setProperty, setProperty, setProperty, setQdata, setQdataFull, setv, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref, withProperties

Methods inherited from class org.gnome.gobject.TypeInstance

callParent, callParent, getPrivate, readGClass, writeGClass

Methods inherited from class io.github.jwharm.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PadController

public PadController(MemorySegment address)

Create a PadController proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

PadController

public PadController(ActionGroup group,
 @Nullable
 @Nullable 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 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 setActionEntries(org.gnome.gtk.PadActionEntry[]) or setAction(org.gnome.gtk.PadActionType, int, int, java.lang.String, java.lang.String).

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 - GActionGroup to trigger actions from

pad - A InputSource.TABLET_PAD device, or null to handle all pads

Method Details

getType

public static Type getType()

Get the GType of the PadController class

Returns:

the GType

asParent

protected PadController asParent()

Returns this instance as if it were its parent type. This is mostly synonymous to the Java super keyword, but will set the native typeclass function pointers to the parent type. When overriding a native virtual method in Java, "chaining up" with super.methodName() doesn't work, because it invokes the overridden function pointer again. To chain up, call asParent().methodName(). This will call the native function pointer of this virtual method in the typeclass of the parent type.

Overrides:

asParent in class EventController

setAction

public void setAction(PadActionType type,
 int index,
 int mode,
 String label,
 String actionName)

Adds an individual action to this PadController.

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 - the type of pad feature that will trigger this action

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

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

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

actionName - action name that will be activated in the GActionGroup

setActionEntries

public void setActionEntries(PadActionEntry[] entries)

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

See Gtk.PadActionEntry and setAction(org.gnome.gtk.PadActionType, int, int, java.lang.String, java.lang.String).

Parameters:

entries - the action entries to set on this PadController

builder

public static PadController.Builder<? extends PadController.Builder> builder()

A PadController.Builder object constructs a PadController with the specified properties. Use the various set...() methods to set properties, and finish construction with PadController.Builder.build().