Struct GrabBuilder

Source

pub struct GrabBuilder { /* private fields */ }

Expand description

Bulider pattern (see PressStart::grab)

Conclude by calling Self::complete.

Implementations§

Source §

impl GrabBuilder

Source

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

Set cursor icon (default: do not set)

Source

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

Optionally set cursor icon (default: do not set)

Source

pub fn complete(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§

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<S, T> Cast<T> for S
where T: Conv<S>,

Source §

fn cast(self) -> T

Cast from Self to T Read more

Source §

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

Try converting from Self to T Read more

Source §

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

Source §

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

Try approximate conversion from Self to T Read more

Source §

fn cast_approx(self) -> T

Cast approximately from Self to T Read more

Source §

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

Source §

fn cast_trunc(self) -> T

Cast to integer, truncating Read more

Source §

fn cast_nearest(self) -> T

Cast to the nearest integer Read more

Source §

fn cast_floor(self) -> T

Cast the floor to an integer Read more

Source §

fn cast_ceil(self) -> T

Cast the ceiling to an integer Read more

Source §

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

Try converting to integer with truncation Read more

Source §

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

Try converting to the nearest integer Read more

Source §

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

Try converting the floor to an integer Read more

Source §

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

Try convert the ceiling to an integer Read more

Source §

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

Source §

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.

Source §

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.

Source §

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.

Source §

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T> Instrument for T

Source §

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Source §

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Source §

impl<T, U> Into 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> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §