Struct Icon 

pub struct Icon { /* private fields */ }

A glyph from the bundled catalog.

Implementations

impl Icon

pub fn new(glyph: Glyph) -> Self

A glyph that repeats an adjacent label, and is not announced.

pub fn spinning(self, ident: impl Into<Ident>) -> Self

Turns the glyph, for a state that is still running.

This exists because the alternative kept being chosen by accident: a rotation glyph is the obvious drawing for “working”, and a rotation glyph that does not rotate reads as one that has jammed. Whichever component reports running work, it reports it the same way through here.

The identity is asked for rather than derived because a decorative glyph has none, and an animation needs something stable to run under.

pub fn breathing(self, ident: impl Into<Ident>) -> Self

Breathes the glyph, for a state that is deliberating rather than getting through work. The quieter of the two claims.

pub fn named( ident: impl Into<Ident>, glyph: Glyph, name: impl Into<SharedString>, ) -> Self

A glyph that is the only thing saying what it means.

The name is a constructor argument rather than an option for the same reason IconButton’s is: a picture nobody can name is a picture nobody can address.

pub fn tone(self, tone: IconTone) -> Self

pub fn muted(self) -> Self

pub fn faint(self) -> Self

pub fn on_accent(self) -> Self

pub fn accent(self) -> Self

pub fn danger(self) -> Self

pub fn warning(self) -> Self

pub fn success(self) -> Self

pub fn info(self) -> Self

pub fn follow_direction(self, follow: bool) -> Self

Whether the active reading direction may flip this glyph.

On by default, and the glyph still decides: only a Directional drawing ever flips. Turning it off is for a caller that has already rotated the glyph into another meaning, where a horizontal flip would land it somewhere neither reading direction points.

pub fn resolved_size(&self, theme: &Theme) -> f32

The painted edge length, in pixels, at the active theme and size.

pub fn resolved_color(&self, theme: &Theme) -> Hsla

pub fn flips_in(&self, direction: LayoutDirection) -> bool

Whether this glyph would be drawn flipped in direction.

Trait Implementations

impl Clone for Icon

fn clone(&self) -> Icon

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Icon

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

Formats the value using the given formatter.

impl IntoElement for Icon

type Element = ViewElement<Icon>

The specific type of element into which the implementing type is converted. Useful for converting other types into elements automatically, like Strings

fn into_element(self) -> Self::Element

Convert self into a type that implements Element.

fn into_any_element(self) -> AnyElement

Convert self into a dynamically-typed AnyElement.

impl RenderOnce for Icon

fn render(self, _window: &mut Window, cx: &mut App) -> impl IntoElement

Render this component into an element tree. Note that this method takes ownership of self, as compared to Render::render() method which takes a mutable reference.

impl Sizable for Icon

fn control_size(self, size: ControlSize) -> Self

fn xs(self) -> Self

fn small(self) -> Self

fn medium(self) -> Self

fn large(self) -> Self