Skip to main content

PressEvent

Struct PressEvent 

Source
pub struct PressEvent<'alloc> { /* private fields */ }
Expand description

Opaque handle to reusable input data for selection gesture press operations.

Implementations§

Source§

impl<'alloc> PressEvent<'alloc>

Source

pub fn new() -> Result<Self>

Create a new selection gesture press event instance.

Source

pub fn new_with_alloc<'ctx: 'alloc>( alloc: &'alloc Allocator<'ctx>, ) -> Result<Self>

Create a new selection gesture press event instance with a custom allocator.

See the crate-level documentation regarding custom memory management and lifetimes.

Source

pub fn set_position(&mut self, x: f64, y: f64) -> Result<&mut Self>

Set the surface-space pointer position.

Source

pub fn set_repeat_distance(&mut self, value: f64) -> Result<&mut Self>

Set the maximum repeat-click distance in pixels.

Source

pub fn set_time(&mut self, value: Duration) -> Result<&mut Self>

Set the monotonic event time.

If unset, press treats the event as untimed and only single-click behavior is available.

Intervals above u64::MAX nanoseconds in length will be silently truncated.

Source

pub fn set_repeat_interval(&mut self, value: Duration) -> Result<&mut Self>

Set the maximum interval between repeat clicks.

Intervals above u64::MAX nanoseconds in length will be silently truncated.

Source

pub fn set_word_boundary_codepoints( &mut self, value: &[char], ) -> Result<&mut Self>

Set the word-boundary codepoints.

The codepoints are copied into event-owned storage when set. If unset, operations that need word boundaries use Ghostty’s defaults.

Source

pub fn set_behaviors(&mut self, value: &Behaviors) -> Result<&mut Self>

Set the selection behavior table.

If unset, press uses the default behavior table: cell, word, line.

Source

pub fn apply<'t>( &mut self, gesture: &mut Gesture<'_>, terminal: &'t Terminal<'_, '_>, grid_ref: GridRef<'t>, ) -> Result<Option<Selection<'t>>>

Apply a selection gesture press event and return the resulting selection snapshot.

Trait Implementations§

Source§

impl<'alloc> Debug for PressEvent<'alloc>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'alloc> !Send for PressEvent<'alloc>

§

impl<'alloc> !Sync for PressEvent<'alloc>

§

impl<'alloc> Freeze for PressEvent<'alloc>

§

impl<'alloc> RefUnwindSafe for PressEvent<'alloc>

§

impl<'alloc> Unpin for PressEvent<'alloc>

§

impl<'alloc> UnsafeUnpin for PressEvent<'alloc>

§

impl<'alloc> UnwindSafe for PressEvent<'alloc>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.