pub struct Spotlight { /* private fields */ }Expand description
A command palette. Create with cx.new(|cx| Spotlight::new(cx)), register
commands with Spotlight::item, and open it from an action.
Implementations§
Source§impl Spotlight
impl Spotlight
pub fn new(cx: &mut Context<'_, Self>) -> Self
Sourcepub fn item(
self,
label: impl Into<SharedString>,
handler: impl Fn(&mut Window, &mut App) + 'static,
) -> Self
pub fn item( self, label: impl Into<SharedString>, handler: impl Fn(&mut Window, &mut App) + 'static, ) -> Self
Register a command with the action to run when it is chosen.
Sourcepub fn item_hint(
self,
label: impl Into<SharedString>,
hint: impl Into<SharedString>,
handler: impl Fn(&mut Window, &mut App) + 'static,
) -> Self
pub fn item_hint( self, label: impl Into<SharedString>, hint: impl Into<SharedString>, handler: impl Fn(&mut Window, &mut App) + 'static, ) -> Self
Register a command with a trailing hint (e.g. a shortcut).
pub fn is_open(&self) -> bool
pub fn open(&mut self, window: &mut Window, cx: &mut Context<'_, Self>)
pub fn close(&mut self, cx: &mut Context<'_, Self>)
Trait Implementations§
Auto Trait Implementations§
impl !RefUnwindSafe for Spotlight
impl !Send for Spotlight
impl !Sync for Spotlight
impl !UnwindSafe for Spotlight
impl Freeze for Spotlight
impl Unpin for Spotlight
impl UnsafeUnpin for Spotlight
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
Mutably borrows from an owned value. Read more
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
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>
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>
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)
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)
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> 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<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more