Skip to main content

OnClick

Struct OnClick 

Source
pub struct OnClick<W> { /* private fields */ }
Expand description

Wraps a widget so a callback fires when it is clicked.

The wrapper renders the inner widget, then renders a companion button whose label is click_label; when that button reports clicked, the callback runs. This keeps the immediate-mode contract (no retained state) while still offering an ergonomic .on_click combinator. Use OnClick::probe in tests to drive the callback directly.

Implementations§

Source§

impl<W: Widget> OnClick<W>

Source

pub fn probe(&mut self, response: &ButtonResponse) -> bool

Manually deliver a ButtonResponse; invokes the callback when response.clicked is set. Returns whether the callback fired.

Trait Implementations§

Source§

impl<W: Widget> Widget for OnClick<W>

Source§

fn render(&mut self, ui: &mut dyn UiCtx)

Render the widget into ui.

Auto Trait Implementations§

§

impl<W> Freeze for OnClick<W>
where W: Freeze,

§

impl<W> !RefUnwindSafe for OnClick<W>

§

impl<W> !Send for OnClick<W>

§

impl<W> !Sync for OnClick<W>

§

impl<W> Unpin for OnClick<W>
where W: Unpin,

§

impl<W> UnsafeUnpin for OnClick<W>
where W: UnsafeUnpin,

§

impl<W> !UnwindSafe for OnClick<W>

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.
Source§

impl<W> WidgetExt for W
where W: Widget,

Source§

fn padding(self, padding: Padding) -> Padded<Self>

Wrap with Padding.
Source§

fn margin(self, margin: Margin) -> Margined<Self>

Wrap with Margin.
Source§

fn background(self, background: Color) -> Backgrounded<Self>

Wrap with a background Color.
Source§

fn border(self, border: Border) -> Bordered<Self>

Wrap with a Border.
Source§

fn on_click( self, label: impl Into<String>, callback: impl FnMut() + 'static, ) -> OnClick<Self>

Attach a click callback, surfaced through a companion button labelled label.
Source§

fn on_hover( self, label: impl Into<String>, callback: impl FnMut(bool) + 'static, ) -> OnHover<Self>

Attach a hover callback, surfaced through a companion button labelled label.