Struct kas_core::event::GrabBuilder

impl GrabBuilder

pub fn with_mode(self, mode: GrabMode) -> Self

Set grab mode (default: GrabMode::Grab)

pub fn with_icon(self, icon: CursorIcon) -> Self

Set cursor icon (default: do not set)

pub fn with_opt_icon(self, icon: Option<CursorIcon>) -> Self

Optionally set cursor icon (default: do not set)

pub fn with_cx(self, cx: &mut EventCx<'_>) -> IsUsed

Complete the grab, providing the EventCx

In case of an existing grab for the same source,

If the Id differs this fails (returns Unused)
If the MouseButton differs this fails (technically this is a different source, but simultaneous grabs of multiple mouse buttons are not supported).
If one grab is a pan and the other is not, this fails
GrabMode::Click may be upgraded to GrabMode::Grab
Changing from one pan mode to another is an error
Mouse button repetitions may be increased; decreasing is an error
A CursorIcon may be set
The depress target is re-set to the grabbing widget

Note: error conditions are only checked in debug builds. These cases may need revision.

Auto Trait Implementations§

impl UnwindSafe for GrabBuilder

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<S, T> Cast<T> for S
where T: Conv<S>,

fn cast(self) -> T

Cast from Self to T Read more

fn try_cast(self) -> Result<T, Error>

Try converting from Self to T Read more

impl<S, T> CastApprox<T> for S
where T: ConvApprox<S>,

fn try_cast_approx(self) -> Result<T, Error>

Try approximate conversion from Self to T Read more

fn cast_approx(self) -> T

Cast approximately from Self to T Read more

impl<S, T> CastFloat<T> for S
where T: ConvFloat<S>,

fn cast_trunc(self) -> T

Cast to integer, truncating Read more

fn cast_nearest(self) -> T

Cast to the nearest integer Read more

fn cast_floor(self) -> T

Cast the floor to an integer Read more

fn cast_ceil(self) -> T

Cast the ceiling to an integer Read more

fn try_cast_trunc(self) -> Result<T, Error>

Try converting to integer with truncation Read more

fn try_cast_nearest(self) -> Result<T, Error>

Try converting to the nearest integer Read more

fn try_cast_floor(self) -> Result<T, Error>

Try converting the floor to an integer Read more

fn try_cast_ceil(self) -> Result<T, Error>

Try convert the ceiling to an integer Read more

impl<T> Downcast for T
where T: Any,

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.