Skip to main content

ToolItem

Struct ToolItem 

Source
#[non_exhaustive]
pub struct ToolItem { pub kind: ToolKind, pub key: String, pub icon: Option<String>, pub label: Option<String>, pub name: Option<String>, pub on: bool, pub disabled: bool, }
Expand description

One toolbar entry (toolbar).

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§kind: ToolKind§key: String

The hit key ({id}:{key}).

§icon: Option<String>

The icon’s SVG markup (e.g. icon(body) or an app’s own icon set).

§label: Option<String>§name: Option<String>

The accessible name (and tooltip text); defaults to the label or the key.

§on: bool

Lit: the active tool, or a toggled option.

§disabled: bool

Shown dimmed, no hit.

Implementations§

Source§

impl ToolItem

Source

pub fn button(key: impl Into<String>, icon_svg: impl Into<String>) -> ToolItem

An icon button.

Source

pub fn split(key: impl Into<String>, icon_svg: impl Into<String>) -> ToolItem

A button with a flyout chevron.

Source

pub fn separator() -> ToolItem

A separator.

Source

pub fn fill() -> ToolItem

The free space before an end group.

Source

pub fn label(self, l: impl Into<String>) -> ToolItem

Source

pub fn name(self, n: impl Into<String>) -> ToolItem

Source

pub fn on(self, on: bool) -> ToolItem

Source

pub fn disabled(self, on: bool) -> ToolItem

Trait Implementations§

Source§

impl Clone for ToolItem

Source§

fn clone(&self) -> ToolItem

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ToolItem

Source§

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

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

impl Default for ToolItem

Source§

fn default() -> ToolItem

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.