Skip to main content

ContextMenuItem

Struct ContextMenuItem 

Source
pub struct ContextMenuItem {
    pub id: String,
    pub label: String,
    pub shortcut: Option<String>,
    pub enabled: bool,
    pub status: Option<bool>,
}
Expand description

An actionable entry in the editor context menu.

The id is what the host receives when the item is selected, so it should be a stable identifier rather than the display text — renaming or translating a label then never breaks the action.

§Examples

use iced_code_editor::ContextMenuItem;

let item = ContextMenuItem::new("format", "Format Document")
    .with_shortcut("Ctrl+Shift+F");

assert_eq!(item.id, "format");
assert_eq!(item.shortcut.as_deref(), Some("Ctrl+Shift+F"));
assert!(item.enabled);

Fields§

§id: String

Stable action identifier emitted when the item is selected.

§label: String

Text displayed for the item.

§shortcut: Option<String>

Optional keyboard shortcut hint displayed beside the label.

§enabled: bool

Whether the item can be selected.

§status: Option<bool>

Current state of a toggle command, None for every other command.

Only the command palette reads it, where it is drawn as an On/Off badge beside the label; the context menu ignores it. Set it on an entry that switches a setting the host owns, and re-register the entries when that setting changes so the badge stays truthful.

Implementations§

Source§

impl ContextMenuItem

Source

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

Creates an enabled context-menu item without a shortcut hint.

§Arguments
  • id - Stable action identifier emitted when the item is selected
  • label - The text shown to the user
§Returns

An enabled item with no shortcut hint

§Examples
use iced_code_editor::ContextMenuItem;

let item = ContextMenuItem::new("rename", "Rename Symbol");
assert_eq!(item.label, "Rename Symbol");
assert!(item.shortcut.is_none());
assert!(item.enabled);
Source

pub fn with_shortcut(self, shortcut: impl Into<String>) -> Self

Sets the keyboard shortcut hint displayed beside this item.

This is only a hint for the user: setting it does not bind the shortcut, which the host application is responsible for handling.

§Arguments
  • shortcut - The shortcut text to display, e.g. Ctrl+Shift+F
§Returns

Self for method chaining

§Examples
use iced_code_editor::ContextMenuItem;

let item = ContextMenuItem::new("format", "Format Document")
    .with_shortcut("Ctrl+Shift+F");
assert_eq!(item.shortcut.as_deref(), Some("Ctrl+Shift+F"));
Source

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

Sets whether this item can be selected.

A disabled item is still drawn, dimmed — use this for an action that is unavailable right now but should stay visible so the menu does not change shape between right-clicks.

§Arguments
  • enabled - Whether the item can be selected
§Returns

Self for method chaining

§Examples
use iced_code_editor::ContextMenuItem;

let item = ContextMenuItem::new("rename", "Rename Symbol")
    .with_enabled(false);
assert!(!item.enabled);
Source

pub fn with_status(self, status: bool) -> Self

Marks this item as a toggle currently in state status.

The command palette then shows an On/Off badge beside the label, so the user can tell what running the command will do without trying it. The value is a snapshot: re-register the entries when the setting changes.

§Arguments
  • status - Whether the setting the item toggles is currently on
§Returns

Self for method chaining

§Examples
use iced_code_editor::ContextMenuItem;

let item = ContextMenuItem::new("format_on_save", "Toggle Format On Save")
    .with_status(true);
assert_eq!(item.status, Some(true));

Trait Implementations§

Source§

impl Clone for ContextMenuItem

Source§

fn clone(&self) -> Self

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 ContextMenuItem

Source§

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

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

impl Eq for ContextMenuItem

Source§

impl From<ContextMenuItem> for ContextMenuEntry

Source§

fn from(item: ContextMenuItem) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for ContextMenuItem

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for ContextMenuItem

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

Source§

fn downcast(&self) -> &T

Source§

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

Source§

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

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
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> 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.
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

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

Source§

impl<T> WasmNotSendSync for T

Source§

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

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