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: StringStable action identifier emitted when the item is selected.
label: StringText displayed for the item.
shortcut: Option<String>Optional keyboard shortcut hint displayed beside the label.
enabled: boolWhether 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
impl ContextMenuItem
Sourcepub fn new(id: impl Into<String>, label: impl Into<String>) -> Self
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 selectedlabel- 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);Sourcepub fn with_shortcut(self, shortcut: impl Into<String>) -> Self
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"));Sourcepub fn with_enabled(self, enabled: bool) -> Self
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);Sourcepub fn with_status(self, status: bool) -> Self
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
impl Clone for ContextMenuItem
Source§impl Debug for ContextMenuItem
impl Debug for ContextMenuItem
impl Eq for ContextMenuItem
Source§impl From<ContextMenuItem> for ContextMenuEntry
impl From<ContextMenuItem> for ContextMenuEntry
Source§fn from(item: ContextMenuItem) -> Self
fn from(item: ContextMenuItem) -> Self
Source§impl PartialEq for ContextMenuItem
impl PartialEq for ContextMenuItem
impl StructuralPartialEq for ContextMenuItem
Auto Trait Implementations§
impl Forget for ContextMenuItem
impl Freeze for ContextMenuItem
impl RefUnwindSafe for ContextMenuItem
impl Send for ContextMenuItem
impl Sync for ContextMenuItem
impl Unpin for ContextMenuItem
impl UnsafeUnpin for ContextMenuItem
impl UnwindSafe for ContextMenuItem
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
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>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
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)
fn as_any(&self) -> &(dyn Any + 'static)
&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)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&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
impl<T> DowncastSync for T
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key and return true if they are equal.Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<State, Message> IntoBoot<State, Message> for State
impl<State, Message> IntoBoot<State, Message> for State
Source§fn into_boot(self) -> (State, Task<Message>)
fn into_boot(self) -> (State, Task<Message>)
Application.