Struct cushy::widgets::button::Button

pub struct Button {
    pub content: WidgetRef,
    pub on_click: Option<Callback<Option<ButtonClick>>>,
    pub kind: Value<ButtonKind>,
    /* private fields */
}

A clickable button.

Fields

content: WidgetRef

The label to display on the button.

on_click: Option<Callback<Option<ButtonClick>>>

The callback that is invoked when the button is clicked.

kind: Value<ButtonKind>

The kind of button to draw.

Implementations

impl Button

pub fn new(content: impl MakeWidget) -> Self

Returns a new button with the provided label.

pub fn kind(self, kind: impl IntoValue<ButtonKind>) -> Self

Sets the button’s kind and returns self.

pub fn on_click<F>(self, callback: F) -> Self

where F: FnMut(Option<ButtonClick>) + Send + 'static,

Sets the on_click callback and returns self.

This callback will be invoked each time the button is clicked.

pub fn prevent_focus(self) -> Self

Prevents focus being given to this button.

pub fn colors_for_transparent( visual_state: VisualState, context: &WidgetContext<'_>, ) -> ButtonColors

Returns the coloring to apply to a ButtonKind::Transparent button.

Trait Implementations

impl Debug for Button

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

Formats the value using the given formatter.

impl Widget for Button

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

Writes a summary of this widget into fmt.

fn redraw(&mut self, context: &mut GraphicsContext<'_, '_, '_, '_>)

Redraw the contents of this widget.

fn hit_test( &mut self, _location: Point<Px>, _context: &mut EventContext<'_>, ) -> bool

Returns true if this widget should respond to mouse input at location.

fn accept_focus(&mut self, context: &mut EventContext<'_>) -> bool

This widget has been targeted to be focused. If this function returns true, the widget will be focused. If false, Cushy will continue searching for another focus target.

fn mouse_down( &mut self, _location: Point<Px>, _device_id: DeviceId, _button: MouseButton, context: &mut EventContext<'_>, ) -> EventHandling

A mouse button event has occurred at location. Returns whether the event has been handled or not.

fn mouse_drag( &mut self, location: Point<Px>, _device_id: DeviceId, _button: MouseButton, context: &mut EventContext<'_>, )

A mouse button is being held down as the cursor is moved across the widget.

fn mouse_up( &mut self, location: Option<Point<Px>>, _device_id: DeviceId, button: MouseButton, context: &mut EventContext<'_>, )

A mouse button is no longer being pressed.

fn layout( &mut self, available_space: Size<ConstraintLimit>, context: &mut LayoutContext<'_, '_, '_, '_>, ) -> Size<UPx>

Layout this widget and returns the ideal size based on its contents and the available_space.

fn unhover(&mut self, context: &mut EventContext<'_>)

The widget is no longer being hovered.

fn hover( &mut self, _location: Point<Px>, context: &mut EventContext<'_>, ) -> Option<CursorIcon>

The widget is currently has a cursor hovering it at location.

fn focus(&mut self, context: &mut EventContext<'_>)

The widget has received focus for user input.

fn blur(&mut self, context: &mut EventContext<'_>)

The widget is no longer focused for user input.

fn activate(&mut self, context: &mut EventContext<'_>)

The widget has become the active widget.

fn deactivate(&mut self, context: &mut EventContext<'_>)

The widget is no longer active.

fn unmounted(&mut self, context: &mut EventContext<'_>)

The widget has been removed from its parent widget.

fn full_control_redraw(&self) -> bool

Returns true if this widget handles all built-in style components that apply.

fn mounted(&mut self, context: &mut EventContext<'_>)

The widget has been mounted into a parent widget.

fn advance_focus( &mut self, direction: VisualOrder, context: &mut EventContext<'_>, ) -> EventHandling

The widget should switch to the next focusable area within this widget, honoring direction in a consistent manner. Returning HANDLED will cause the search for the next focus widget stop.

fn allow_blur(&mut self, context: &mut EventContext<'_>) -> bool

The widget is about to lose focus. Returning true allows the focus to switch away from this widget.

fn keyboard_input( &mut self, device_id: DeviceId, input: KeyEvent, is_synthetic: bool, context: &mut EventContext<'_>, ) -> EventHandling

A keyboard event has been sent to this widget. Returns whether the event has been handled or not.

fn ime(&mut self, ime: Ime, context: &mut EventContext<'_>) -> EventHandling

An input manager event has been sent to this widget. Returns whether the event has been handled or not.

fn mouse_wheel( &mut self, device_id: DeviceId, delta: MouseScrollDelta, phase: TouchPhase, context: &mut EventContext<'_>, ) -> EventHandling

A mouse wheel event has been sent to this widget. Returns whether the event has been handled or not.

fn root_behavior( &mut self, context: &mut EventContext<'_>, ) -> Option<(RootBehavior, WidgetInstance)>

Returns a reference to a single child widget if this widget is a widget that primarily wraps a single other widget to customize its behavior.