GtkPadController
GtkPadController — Controller for drawing tablet pads
|
|
Includes
#include <gtk/gtk.h>
Description
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_SOURCE_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_device_pad_get_n_groups() and
gdk_device_pad_get_group_n_modes().
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:
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.
Functions
gtk_pad_controller_set_action ()
void
gtk_pad_controller_set_action (GtkPadController *controller,
GtkPadActionType type,
gint index,
gint mode,
const gchar *label,
const gchar *action_name);
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.
The given label
should be considered user-visible, so internationalization
rules apply. Some windowing systems may be able to use those for user
feedback.
Since: 3.22
Types and Values
GtkPadController
typedef struct _GtkPadController GtkPadController;
enum GtkPadActionType
The type of a pad action.
struct GtkPadActionEntry
struct GtkPadActionEntry {
GtkPadActionType type;
gint index;
gint mode;
gchar *label;
gchar *action_name;
};
Struct defining a pad action entry.
Property Details
The “action-group” property
“action-group” GActionGroup *
Action group to launch actions from.
Owner: GtkPadController
Flags: Read / Write / Construct Only
The “pad” property
“pad” GdkDevice *
Pad device to control.
Owner: GtkPadController
Flags: Read / Write / Construct Only