Struct gtk4::GestureStylus

#[repr(transparent)]
pub struct GestureStylus { /* private fields */ }

GestureStylus is a Gesture specific to stylus input.

The provided signals just relay the basic information of the stylus events.

Implements

GestureSingleExt, GestureExt, EventControllerExt, glib::ObjectExt

Implementations

impl GestureStylus

pub fn new() -> GestureStylus

Creates a new GestureStylus.

Returns

a newly created stylus gesture

pub fn builder() -> GestureStylusBuilder

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

This method returns an instance of GestureStylusBuilder which can be used to create GestureStylus objects.

pub fn axis(&self, axis: AxisUse) -> Option<f64>

Returns the current value for the requested @axis.

This function must be called from the handler of one of the signal::GestureStylus::down, signal::GestureStylus::motion, signal::GestureStylus::up or signal::GestureStylus::proximity signals.

axis

requested device axis

Returns

true if there is a current value for the axis

value

return location for the axis value

pub fn backlog(&self) -> Option<Vec<TimeCoord>>

Returns the accumulated backlog of tracking information.

By default, GTK will limit rate of input events. On stylus input where accuracy of strokes is paramount, this function returns the accumulated coordinate/timing state before the emission of the current [Gtk.GestureStylus::motion] signal.

This function may only be called within a signal::GestureStylus::motion signal handler, the state given in this signal and obtainable through axis() express the latest (most up-to-date) state in motion history.

The @backlog is provided in chronological order.

Returns

true if there is a backlog to unfold in the current state.

backlog

coordinates and times for the backlog events

pub fn device_tool(&self) -> Option<DeviceTool>

Returns the gdk::DeviceTool currently driving input through this gesture.

This function must be called from the handler of one of the signal::GestureStylus::down, signal::GestureStylus::motion, signal::GestureStylus::up or signal::GestureStylus::proximity signals.

Returns

The current stylus tool

pub fn connect_down<F: Fn(&Self, f64, f64) + 'static>( &self, f: F ) -> SignalHandlerId

Emitted when the stylus touches the device.

x

the X coordinate of the stylus event

y

the Y coordinate of the stylus event

pub fn connect_motion<F: Fn(&Self, f64, f64) + 'static>( &self, f: F ) -> SignalHandlerId

Emitted when the stylus moves while touching the device.

x

the X coordinate of the stylus event

y

the Y coordinate of the stylus event

pub fn connect_proximity<F: Fn(&Self, f64, f64) + 'static>( &self, f: F ) -> SignalHandlerId

Emitted when the stylus is in proximity of the device.

x

the X coordinate of the stylus event

y

the Y coordinate of the stylus event

pub fn connect_up<F: Fn(&Self, f64, f64) + 'static>( &self, f: F ) -> SignalHandlerId

Emitted when the stylus no longer touches the device.

x

the X coordinate of the stylus event

y

the Y coordinate of the stylus event

impl GestureStylus

pub fn axes(&self, axes: Vec<AxisUse>) -> Option<Vec<f64>>

Returns the current values for the requested @axes.

This function must be called from the handler of one of the signal::GestureStylus::down, signal::GestureStylus::motion, signal::GestureStylus::up or signal::GestureStylus::proximity signals.

axes

array of requested axes, terminated with gdk::AxisUse::Ignore

Returns

true if there is a current value for the axes

values

return location for the axis values

Trait Implementations

impl Clone for GestureStylus

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 GestureStylus

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

Formats the value using the given formatter.

impl Default for GestureStylus

fn default() -> Self

Returns the “default value” for a type.

impl Display for GestureStylus

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

Formats the value using the given formatter.

impl Hash for GestureStylus

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 GestureStylus

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl ParentClassIs for GestureStylus

type Parent = GestureSingle

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

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 GestureStylus

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 GestureStylus

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for GestureStylus

impl IsA<EventController> for GestureStylus

impl IsA<Gesture> for GestureStylus

impl IsA<GestureSingle> for GestureStylus