Skip to main content

Action

Struct Action 

Source
pub struct Action {
    pub id: Arc<str>,
    pub label: Arc<str>,
    pub icon: Option<Arc<str>>,
    pub shortcut: Option<KeyChord>,
    pub enabled: bool,
    pub checked: Option<bool>,
}
Expand description

A high-level user-invokable command. One Action ties together the menu item, toolbar button, and keyboard shortcut that all do the same thing - the model Qt’s QAction and GTK 4’s GAction use.

Lives in ActionRegistry (or a similar resource) per the OS plan (section 470). Backends translate the action into a menu item, hotkey, or toolbar button as appropriate.

Fields§

§id: Arc<str>

Stable id used to dispatch ActionInvoked { id } and to look the action up across hot-reloads.

§label: Arc<str>

Human-visible label.

§icon: Option<Arc<str>>

Optional icon identifier (asset path or theme name).

§shortcut: Option<KeyChord>

Optional keyboard shortcut.

§enabled: bool

true when the action can be invoked.

§checked: Option<bool>

Some(true|false) for a check / radio action; None for a plain action.

Implementations§

Source§

impl Action

Source

pub fn new(id: impl Into<Arc<str>>, label: impl Into<Arc<str>>) -> Self

Construct a plain enabled action with no shortcut, icon, or check state.

Source

pub fn with_shortcut(self, chord: impl Into<KeyChord>) -> Self

Builder: set the keyboard shortcut.

Source

pub fn with_icon(self, icon: impl Into<Arc<str>>) -> Self

Builder: set the icon.

Source

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

Builder: set the enabled flag.

Source

pub fn checked(self, on: bool) -> Self

Builder: turn into a check action with the supplied initial state.

Trait Implementations§

Source§

impl Clone for Action

Source§

fn clone(&self) -> Action

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 Action

Source§

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

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

impl From<&str> for Action

Source§

fn from(entry: &str) -> Self

Read one id:label entry of an action spec. An entry with no : uses its whole text as both id and label, and a lone - is the separator.

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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.