Struct gtk4::PadController

pub struct PadController { /* private fields */ }

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. PadController is provided to map those to 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_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::DevicePad::get_n_groups() and 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 PadActionEntry. It contains an action name that will be looked up in the given gio::ActionGroup and activated whenever the specified input element and mode are triggered.

A simple example of PadController usage: Assigning button 1 in all modes and pad devices to an “invert-selection” action:

⚠️ The following code is in c ⚠️

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.

Properties

action-group

Readable | Writeable | Construct Only

pad

Readable | Writeable | Construct Only

EventController

name

The name for this controller, typically used for debugging purposes.

Readable | Writeable

propagation-limit

The limit for which events this controller will handle.

Readable | Writeable

propagation-phase

The propagation phase at which this controller will handle events.

Readable | Writeable

widget

The widget receiving the GdkEvents that the controller will handle.

Readable

Implements

EventControllerExt, [trait@glib::ObjectExt]

Implementations

impl PadController

pub fn new(group: &impl IsA<ActionGroup>, pad: Option<&Device>) -> PadController

Creates a new PadController 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 mix PadController objects with None and non-None @pad argument on the same toplevel window, as execution order is not guaranteed.

The PadController is created with no mapped actions. In order to map pad events to actions, use set_action_entries() or set_action().

Be aware that pad events will only be delivered to Windows, so adding a pad controller to any other type of widget will not have an effect.

group

GActionGroup to trigger actions from

pad

A GDK_SOURCE_TABLET_PAD device, or None to handle all pads

Returns

A newly created PadController

pub fn builder() -> PadControllerBuilder

Creates a new builder-pattern struct instance to construct PadController objects.

This method returns an instance of PadControllerBuilder which can be used to create PadController objects.

pub fn set_action( &self, type_: PadActionType, index: i32, mode: i32, label: &str, action_name: &str )

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.

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.

action_name

action name that will be activated in the GActionGroup

pub fn set_action_entries(&self, entries: &[PadActionEntry])

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

See PadActionEntry and set_action().

entries

the action entries to set on @self

pub fn action_group(&self) -> Option<ActionGroup>

pub fn pad(&self) -> Option<Device>

Trait Implementations

impl Clone for PadController

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PadController

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for PadController

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for PadController

type ParamSpec = ParamSpecObject

type SetValue = PadController

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, PadController>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for PadController

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for PadController

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for PadController

type Parent = EventController

impl<OT: ObjectType> PartialEq<OT> for PadController

fn eq(&self, other: &OT) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for PadController

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for PadController

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for PadController

impl IsA<EventController> for PadController