Struct ButtonFace 

pub struct ButtonFace<'a> { /* private fields */ }

An immediate-mode button: the Button look for a canvas host that owns its own hit-testing. Built fluently: ButtonFace::new(rect, "Save").role(ButtonRole::Primary).hovered(hit).

Size the rect from the face itself, so rect and glyphs agree at every scale: ButtonFace::height for the height, ButtonFace::intrinsic_width for the width, and hit-test with ButtonFace::hit_rect (never smaller than the minimum pointer target).

Implementations

impl<'a> ButtonFace<'a>

pub fn new(rect: Rect, label: &'a str) -> ButtonFace<'a>

pub fn icon_only(rect: Rect, icon: Icon, name: &'a str) -> ButtonFace<'a>

An icon-only face; name is its accessible name.

pub fn role(self, role: ButtonRole) -> ButtonFace<'a>

What the button does; the role decides its whole look.

pub fn tone(self, tone: Tone) -> ButtonFace<'a>

What the face says means something (Tone::Neutral is no tone): the icon and the label take the tone’s colour.

pub fn icon(self, icon: Icon) -> ButtonFace<'a>

pub fn control_size(self, size: ControlSize) -> ButtonFace<'a>

The face’s height and label role.

pub fn shortcut_hint(self, shortcut: Shortcut) -> ButtonFace<'a>

A trailing keyboard shortcut in the platform’s keycap legends.

pub fn detail(self, detail: &'a str) -> ButtonFace<'a>

A fact told at the face’s trailing edge, in the secondary ink: the label then leads.

pub fn toggled(self, on: bool) -> ButtonFace<'a>

A toggle that is on: the face stands on the selection lift.

pub fn hovered(self, v: bool) -> ButtonFace<'a>

pub fn pressed(self, v: bool) -> ButtonFace<'a>

pub fn focused(self, v: bool) -> ButtonFace<'a>

pub fn disabled(self, v: bool) -> ButtonFace<'a>

pub fn accessible_name(self, name: &'a str) -> ButtonFace<'a>

For callers that expose their own accessibility node for the region.

pub fn spoken_name(&self) -> &str

The visible label, or the explicit accessible_name when it’s empty.

pub fn colors( &self, theme: &Theme, ) -> (AlphaColor<Srgb>, Option<AlphaColor<Srgb>>, AlphaColor<Srgb>)

The resolved palette without painting: (fill, edge, ink).

pub fn height(size: ControlSize, theme: &Theme) -> f64

The height of a face of size in theme.

pub fn intrinsic_width(&self, text: &mut TextRenderer, theme: &Theme) -> f64

The narrowest rect width that shows this face’s icon, label and shortcut without eliding.

pub fn icon_rect(&self, text: &mut TextRenderer, theme: &Theme) -> Option<Rect>

Where this face draws its icon: on a labelled face it leads the label, the two centred together. A host that paints its own mark in the icon’s place (a colour swatch over the choice it names) puts it exactly here, so the two never stand side by side. Ignores a shortcut hint.

pub fn hit_rect(&self, theme: &Theme) -> Rect

Where a pointer activates this face: its rect, grown about its centre to the minimum pointer target.

pub fn contains(&self, theme: &Theme, point: Point) -> bool

Whether point activates this face: inside the shape the theme’s painter set draws it as, or else in its hit rect.