Struct gdk::EventButton

pub struct EventButton(_);

Used for button press and button release events. The type field will be one of EventType::ButtonPress, [EventType::_2buttonPress][crate::EventType::_2buttonPress], [EventType::_3buttonPress][crate::EventType::_3buttonPress] or EventType::ButtonRelease,

Double and triple-clicks result in a sequence of events being received. For double-clicks the order of events will be:

• EventType::ButtonPress
• EventType::ButtonRelease
• EventType::ButtonPress
• [EventType::_2buttonPress][crate::EventType::_2buttonPress]
• EventType::ButtonRelease

Note that the first click is received just like a normal button press, while the second click results in a [EventType::_2buttonPress][crate::EventType::_2buttonPress] being received just after the EventType::ButtonPress.

Triple-clicks are very similar to double-clicks, except that [EventType::_3buttonPress][crate::EventType::_3buttonPress] is inserted after the third click. The order of the events is:

• EventType::ButtonPress
• EventType::ButtonRelease
• EventType::ButtonPress
• [EventType::_2buttonPress][crate::EventType::_2buttonPress]
• EventType::ButtonRelease
• EventType::ButtonPress
• [EventType::_3buttonPress][crate::EventType::_3buttonPress]
• EventType::ButtonRelease

For a double click to occur, the second button press must occur within 1/4 of a second of the first. For a triple click to occur, the third button press must also occur within 1/2 second of the first button press.

Implementations

impl EventButton

pub fn position(&self) -> (f64, f64)

pub fn state(&self) -> ModifierType

pub fn time(&self) -> u32

pub fn button(&self) -> u32

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

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

pub fn root(&self) -> (f64, f64)

Methods from Deref<Target = Event>

pub fn put(&self)

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

pub fn button(&self) -> Option<u32>

pub fn click_count(&self) -> Option<u32>

pub fn coords(&self) -> Option<(f64, f64)>

pub fn keycode(&self) -> Option<u16>

pub fn keyval(&self) -> Option<u32>

pub fn root_coords(&self) -> Option<(f64, f64)>

pub fn scroll_direction(&self) -> Option<ScrollDirection>

pub fn scroll_deltas(&self) -> Option<(f64, f64)>

pub fn is_scroll_stop_event(&self) -> bool

This is supported on crate feature v3_20 only.

pub fn state(&self) -> Option<ModifierType>

pub fn time(&self) -> u32

pub fn window(&self) -> Option<Window>

Returns the associated Window if applicable.

pub fn event_sequence(&self) -> Option<EventSequence>

pub fn triggers_context_menu(&self) -> bool

pub fn seat(&self) -> Option<Seat>

This is supported on crate feature v3_20 only.

pub fn scancode(&mut self) -> i32

This is supported on crate feature v3_22 only.

pub fn is_pointer_emulated(&mut self) -> bool

This is supported on crate feature v3_22 only.

pub fn set_screen(&mut self, screen: Option<&Screen>)

pub fn screen(&self) -> Option<Screen>

pub fn set_device(&mut self, device: Option<&Device>)

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

pub fn set_source_device(&mut self, device: Option<&Device>)

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

pub fn set_device_tool(&mut self, device: Option<&DeviceTool>)

This is supported on crate feature v3_22 only.

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

This is supported on crate feature v3_22 only.

pub fn event_type(&self) -> EventType

Returns the event type.

pub fn is_send_event(&self) -> bool

Returns whether the event was sent explicitly.

pub fn is<T: FromEvent>(&self) -> bool

Returns true if the event type matches T.

pub fn downcast_ref<T: FromEvent>(&self) -> Option<&T>

Tries to downcast to a specific event type.

pub fn downcast_mut<T: FromEvent>(&mut self) -> Option<&mut T>

Tries to downcast to a specific event type.

Trait Implementations

impl AsMut<GdkEventButton> for EventButton

fn as_mut(&mut self) -> &mut GdkEventButton

Performs the conversion.

impl AsRef<GdkEventButton> for EventButton

fn as_ref(&self) -> &GdkEventButton

Performs the conversion.

impl Clone for EventButton

fn clone(&self) -> EventButton

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EventButton

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

Formats the value using the given formatter.

impl Deref for EventButton

type Target = Event

The resulting type after dereferencing.

fn deref(&self) -> &Event

Dereferences the value.

impl DerefMut for EventButton

fn deref_mut(&mut self) -> &mut Event

Mutably dereferences the value.

impl FromEvent for EventButton

fn is(ev: &Event) -> bool

fn from(ev: Event) -> Result<Self, Event>

impl FromGlibPtrBorrow<*mut GdkEventButton> for EventButton

unsafe fn from_glib_borrow(ptr: *mut GdkEventButton) -> Borrowed<Self>

Safety

impl FromGlibPtrFull<*mut GdkEventButton> for EventButton

unsafe fn from_glib_full(ptr: *mut GdkEventButton) -> Self

Safety

impl FromGlibPtrNone<*mut GdkEventButton> for EventButton

unsafe fn from_glib_none(ptr: *mut GdkEventButton) -> Self

Safety

impl Hash for EventButton

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Ord for EventButton

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<EventButton> for EventButton

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

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

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

This method tests for !=.

impl PartialOrd<EventButton> for EventButton

fn partial_cmp(&self, other: &EventButton) -> 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<'a> ToGlibPtr<'a, *const GdkEventButton> for EventButton

type Storage = &'a Self

fn to_glib_none(&'a self) -> Stash<'a, *const GdkEventButton, Self>

Transfer: none.

fn to_glib_container(&'a self) -> Stash<'a, P, Self>

Transfer: container.

fn to_glib_full(&self) -> P

Transfer: full.

impl<'a> ToGlibPtrMut<'a, *mut GdkEventButton> for EventButton

type Storage = &'a mut Self

fn to_glib_none_mut(&'a mut self) -> StashMut<'a, *mut GdkEventButton, Self>

Transfer: none.

impl Eq for EventButton

impl StructuralEq for EventButton

impl StructuralPartialEq for EventButton