Skip to main content

IconButton

Struct IconButton 

Source
pub struct IconButton<'a, Message> { /* private fields */ }
Available on crate feature icon-button only.
Expand description

An icon button builder. Convert it into an Element to render.

An icon button without a message is rendered disabled.

Implementations§

Source§

impl<'a, Message> IconButton<'a, Message>

Source

pub fn label(self, label: impl IntoFragment<'a>) -> Self

Names the action, such as “Bold”. The label shows as a tooltip on hover unless tooltip turns it off.

Source

pub fn tooltip(self, position: Option<Position>) -> Self

Where the label’s tooltip appears, or None to never show it. Defaults to above the button.

Source

pub fn variant(self, variant: Variant) -> Self

Source

pub fn size(self, size: Size) -> Self

The side length follows the button Size: Sm is 32 pixels, Md is 36 and Lg is 40.

Source

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

Draws the button as switched on, for toggles in a toolbar.

Source

pub fn id(self, id: impl Into<Id>) -> Self

Sets a widget id, for clicking the button in tests.

Source

pub fn on_press(self, message: Message) -> Self

Source

pub fn on_press_maybe(self, message: Option<Message>) -> Self

Source

pub fn is_enabled(&self) -> bool

Source

pub fn is_pressed(&self) -> bool

Source

pub fn label_text(&self) -> Option<&str>

The label, if one is set.

Trait Implementations§

Source§

impl<'a, Message: Debug> Debug for IconButton<'a, Message>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'a, Message: Clone + 'a> From<IconButton<'a, Message>> for Element<'a, Message>

Source§

fn from(icon_button: IconButton<'a, Message>) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

§

impl<'a, Message> Freeze for IconButton<'a, Message>
where Option<Message>: Freeze,

§

impl<'a, Message> RefUnwindSafe for IconButton<'a, Message>
where Option<Message>: RefUnwindSafe,

§

impl<'a, Message> Send for IconButton<'a, Message>
where Option<Message>: Send,

§

impl<'a, Message> Sync for IconButton<'a, Message>
where Option<Message>: Sync,

§

impl<'a, Message> Unpin for IconButton<'a, Message>
where Option<Message>: Unpin,

§

impl<'a, Message> UnsafeUnpin for IconButton<'a, Message>
where Option<Message>: UnsafeUnpin,

§

impl<'a, Message> UnwindSafe for IconButton<'a, Message>
where Option<Message>: UnwindSafe,

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync> ⓘ

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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<State, Message> IntoBoot<State, Message> for State

Source§

fn into_boot(self) -> (State, Task<Message>)

Turns some type into the initial state of some Application.
Source§

impl<T> MaybeClone for T

Source§

impl<T> MaybeDebug for T

Source§

impl<T> MaybeSend for T
where T: Send,

Source§

impl<T> MaybeSync for T
where T: Sync,

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more