Gtk.PadController¶
- Subclasses:
None
Methods¶
- Inherited:
- Structs:
class |
|
|
|
|
Virtual Methods¶
- Inherited:
Properties¶
- Inherited:
Name |
Type |
Flags |
Short Description |
---|---|---|---|
r/w/co |
|||
r/w/co |
Signals¶
- Inherited:
Fields¶
- Inherited:
Class Details¶
- class Gtk.PadController(**kwargs)¶
- Bases:
- Abstract:
No
- Structure:
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 [iface`Gio`.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.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 [method`Gdk`.DevicePad.get_n_groups] and [method`Gdk`.DevicePad.get_group_n_modes].
Each of the actions that a given button/strip/ring performs for a given mode is defined by a [struct`Gtk`.PadActionEntry]. It contains an action name that will be looked up in the given [iface`Gio`.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
Gtk.PadActionEntry
*pad_actions[] = { {Gtk.PadActionType.BUTTON
, 1, -1, “Invert selection”, “pad-actions.invert-selection” }, … };… action_group =
Gio.SimpleActionGroup.new
(); action =Gio.SimpleAction.new
(“pad-actions.invert-selection”,None
); g_signal_connect (action, “activate”, on_invert_selection_activated,None
);Gio.ActionMap.add_action
(G_ACTION_MAP (action_group), action); … pad_controller =Gtk.PadController.new
(action_group,None
); ```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
.- classmethod new(group, pad)[source]¶
- Parameters:
group (
Gio.ActionGroup
) –GActionGroup
to trigger actions frompad (
Gdk.Device
orNone
) – AGdk.InputSource.TABLET_PAD
device, orNone
to handle all pads
- Returns:
A newly created
GtkPadController
- Return type:
Creates a new
GtkPadController
that will associate events from pad to actions.A
None
pad may be provided so the controller manages all pad devices generically, it is discouraged to mixGtkPadController
objects withNone
and non-None
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 [method`Gtk`.PadController.set_action_entries] or [method`Gtk`.PadController.set_action].Be aware that pad events will only be delivered to ``GtkWindow``s, so adding a pad controller to any other type of widget will not have an effect.
- set_action(type, index, mode, label, action_name)[source]¶
- Parameters:
type (
Gtk.PadActionType
) – the type of pad feature that will trigger this actionindex (
int
) – the 0-indexed button/ring/strip number that will trigger this actionmode (
int
) – the mode that will trigger this action, or -1 for all modes.label (
str
) – Human readable description of this action, this string should be deemed user-visible.action_name (
str
) – action name that will be activated in theGActionGroup
Adds an individual action to self.
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.
- set_action_entries(entries)[source]¶
- Parameters:
entries ([
Gtk.PadActionEntry
]) – the action entries to set on self
A convenience function to add a group of action entries on self.
See [struct`Gtk`.PadActionEntry] and [method`Gtk`.PadController.set_action].
Property Details¶
- Gtk.PadController.props.action_group¶
- Name:
action-group
- Type:
- Default Value:
- Flags:
- Gtk.PadController.props.pad¶
- Name:
pad
- Type:
- Default Value:
- Flags: