Struct gtk4::EventControllerMotion

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

EventControllerMotion is an event controller tracking the pointer position.

The event controller offers enter and leave signals, as well as is-pointer and contains-pointer properties which are updated to reflect changes in the pointer position as it moves over the widget.

Properties

contains-pointer

Whether the pointer is in the controllers widget or a descendant.

See also is-pointer.

When handling crossing events, this property is updated before enter, but after leave is emitted.

Readable

is-pointer

Whether the pointer is in the controllers widget itself, as opposed to in a descendent widget.

See also contains-pointer.

When handling crossing events, this property is updated before enter, but after leave is emitted.

Readable

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

Signals

enter

Signals that the pointer has entered the widget.

leave

Signals that the pointer has left the widget.

motion

Emitted when the pointer moves inside the widget.

Implements

EventControllerExt, glib::ObjectExt

Implementations

impl EventControllerMotion

pub fn new() -> EventControllerMotion

Creates a new event controller that will handle motion events.

Returns

a new EventControllerMotion

pub fn builder() -> EventControllerMotionBuilder

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

This method returns an instance of EventControllerMotionBuilder which can be used to create EventControllerMotion objects.

pub fn contains_pointer(&self) -> bool

Returns if a pointer is within @self or one of its children.

Returns

true if a pointer is within @self or one of its children

pub fn is_pointer(&self) -> bool

Returns if a pointer is within @self, but not one of its children.

Returns

true if a pointer is within @self but not one of its children

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

Signals that the pointer has entered the widget.

x

coordinates of pointer location

y

coordinates of pointer location

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

Signals that the pointer has left the widget.

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

Emitted when the pointer moves inside the widget.

x

the x coordinate

y

the y coordinate

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

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

Trait Implementations

impl Clone for EventControllerMotion

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 EventControllerMotion

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

Formats the value using the given formatter.

impl Default for EventControllerMotion

fn default() -> Self

Returns the “default value” for a type.

impl Display for EventControllerMotion

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

Formats the value using the given formatter.

impl HasParamSpec for EventControllerMotion

type ParamSpec = ParamSpecObject

type SetValue = EventControllerMotion

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for EventControllerMotion

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 EventControllerMotion

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 EventControllerMotion

type Parent = EventController

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

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 EventControllerMotion

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 EventControllerMotion

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for EventControllerMotion

impl IsA<EventController> for EventControllerMotion