Struct egui::widgets::Button

#[must_use = "You should put this widget in an ui with `ui.add(widget);`"]
pub struct Button { /* fields omitted */ }

Clickable button with text.

See also Ui::button.

if ui.add(egui::Button::new("Click mew")).clicked() {
    do_stuff();
}

Implementations

impl Button

pub fn new(text: impl ToString) -> Self

pub fn text_color(self, text_color: Color32) -> Self

pub fn text_color_opt(self, text_color: Option<Color32>) -> Self

pub fn text_style(self, text_style: TextStyle) -> Self

pub fn fill(self, fill: Option<Color32>) -> Self

pub fn small(self) -> Self

Make this a small button, suitable for embedding into text.

pub fn frame(self, frame: bool) -> Self

Turn off the frame

pub fn sense(self, sense: Sense) -> Self

By default, buttons senses clicks. Change this to a drag-button with Sense::drag().

pub fn enabled(self, enabled: bool) -> Self

If you set this to false, the button will be grayed out and un-clickable. enabled(false) has the same effect as calling sense(Sense::hover()).

This is a convenience for Ui::set_enabled.

pub fn wrap(self, wrap: bool) -> Self

If true, the text will wrap at the max_width. By default Self::wrap will be true in vertical layouts and horizontal layouts with wrapping, and false on non-wrapping horizontal layouts.

Note that any \n in the button text will always produce a new line.

Trait Implementations

impl Widget for Button

fn ui(self, ui: &mut Ui) -> Response

Allocate space, interact, paint, and return a Response.