GI.Gtk.Objects.PadController

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 InputSourceTabletPad 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 devicePadGetNGroups and devicePadGetGroupNModes.

Each of the actions that a given button/strip/ring performs for a given mode is defined by a [structgtk.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:

c code

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.

Exported types

newtype PadController

Memory-managed wrapper type.

Constructors

PadController (ManagedPtr PadController)

Instances

Eq PadController

Defined in GI.Gtk.Objects.PadController

Methods

(==) :: PadController -> PadController -> Bool

(/=) :: PadController -> PadController -> Bool

GObject PadController

Defined in GI.Gtk.Objects.PadController

ManagedPtrNewtype PadController

Defined in GI.Gtk.Objects.PadController

Methods

toManagedPtr :: PadController -> ManagedPtr PadController

TypedObject PadController

Defined in GI.Gtk.Objects.PadController

Methods

glibType :: IO GType

HasParentTypes PadController

Defined in GI.Gtk.Objects.PadController

IsGValue (Maybe PadController)

Convert PadController to and from GValue. See toGValue and fromGValue.

Defined in GI.Gtk.Objects.PadController

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe PadController -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe PadController)

type ParentTypes PadController

Defined in GI.Gtk.Objects.PadController

type ParentTypes PadController = '[EventController, Object]

class (GObject o, IsDescendantOf PadController o) => IsPadController o

Type class for types which can be safely cast to PadController, for instance with toPadController.

Instances

(GObject o, IsDescendantOf PadController o) => IsPadController o

Defined in GI.Gtk.Objects.PadController

toPadController :: (MonadIO m, IsPadController o) => o -> m PadController

Cast to PadController, for types for which this is known to be safe. For general casts, use castTo.

Methods

Click to display all available methods, including inherited ones

Methods

bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, ref, refSink, reset, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getCurrentEvent, getCurrentEventDevice, getCurrentEventState, getCurrentEventTime, getData, getName, getPropagationLimit, getPropagationPhase, getProperty, getQdata, getWidget.

Setters

setAction, setActionEntries, setData, setDataFull, setName, setPropagationLimit, setPropagationPhase, setProperty, setStaticName.

new

padControllerNew

Arguments

:: (HasCallStack, MonadIO m, IsActionGroup a, IsDevice b)

=> a

group: GActionGroup to trigger actions from

-> Maybe b

pad: A InputSourceTabletPad device, or Nothing to handle all pads

-> m PadController

Returns: A newly created GtkPadController

Creates a new GtkPadController that will associate events from pad to actions.

A Nothing pad may be provided so the controller manages all pad devices generically, it is discouraged to mix GtkPadController objects with Nothing and non-Nothing 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 padControllerSetActionEntries or padControllerSetAction.

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.

setAction

padControllerSetAction

Arguments

:: (HasCallStack, MonadIO m, IsPadController a)

=> a

controller: a GtkPadController

-> PadActionType

type: the type of pad feature that will trigger this action

-> Int32

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

-> Int32

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

-> Text

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

-> Text

actionName: action name that will be activated in the GActionGroup

-> m ()

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.

setActionEntries

padControllerSetActionEntries

Arguments

:: (HasCallStack, MonadIO m, IsPadController a)

=> a

controller: a GtkPadController

-> [PadActionEntry]

entries: the action entries to set on controller

-> m ()

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

See [structgtk.PadActionEntry] and padControllerSetAction.

Properties

actionGroup

No description available in the introspection data.

constructPadControllerActionGroup :: (IsPadController o, MonadIO m, IsActionGroup a) => a -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “action-group” property. This is rarely needed directly, but it is used by new.

getPadControllerActionGroup :: (MonadIO m, IsPadController o) => o -> m (Maybe ActionGroup)

Get the value of the “action-group” property. When overloading is enabled, this is equivalent to

get padController #actionGroup

pad

No description available in the introspection data.

constructPadControllerPad :: (IsPadController o, MonadIO m, IsDevice a) => a -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “pad” property. This is rarely needed directly, but it is used by new.

getPadControllerPad :: (MonadIO m, IsPadController o) => o -> m (Maybe Device)

Get the value of the “pad” property. When overloading is enabled, this is equivalent to

get padController #pad