PromptLine

Struct PromptLine 

Source
pub struct PromptLine { /* private fields */ }
Expand description

A multi purpose text Widget

This Widget will be used by a Prompt-type Mode, which in turn will make use of a PromptMode. These are “ways of interpreting the input”. In Duat, there are 3 built-in PromptModes:

  • RunCommands: Will interpret the prompt as a Duat command to be executed.
  • IncSearch: Will read the prompt as a regex, and modify the active Buffer according to a given IncSearcher.
  • PipeSelections: Will pass each selection to a shell command, replacing the selections with the stdout.

Implementations§

Source§

impl PromptLine

Source

pub fn builder() -> PromptLineBuilder

Returns a [PromptLineBuilder], which can be used to push PromptLines around

Source

pub fn prompt_of<M: PromptMode>(&self) -> Option<Text>

Returns the prompt for a PromptMode if there is any

Source

pub fn set_prompt<M: PromptMode>(&mut self, text: Text)

Sets the prompt for the given PromptMode

Source

pub fn prompt_of_id(&self, id: TypeId) -> Option<Text>

Returns the prompt for a TypeId, if there is any

Trait Implementations§

Source§

impl Widget for PromptLine

Source§

fn update(pa: &mut Pass, handle: &Handle<Self>)

Updates the widget alongside its RwArea in the Handle Read more
Source§

fn needs_update(&self, _: &Pass) -> bool

Tells Duat that this Widget should be updated Read more
Source§

fn text(&self) -> &Text

The text that this widget prints out
Source§

fn text_mut(&mut self) -> &mut Text

A mutable reference to the Text that is printed
Source§

fn get_print_opts(&self) -> PrintOpts

The configuration for how to print Text Read more
Source§

fn on_focus(pa: &mut Pass, handle: &Handle<Self>)
where Self: Sized,

Actions to do whenever this Widget is focused Read more
Source§

fn on_unfocus(pa: &mut Pass, handle: &Handle<Self>)
where Self: Sized,

Actions to do whenever this Widget is unfocused Read more
Source§

fn on_mouse_event(pa: &mut Pass, handle: &Handle<Self>, event: MouseEvent)
where Self: Sized,

How to handle a MouseEvent Read more
Source§

fn print(&self, pa: &Pass, painter: Painter, area: &RwArea)

Prints the widget 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> 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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<W> HookAlias<WidgetCreatedDummy> for W
where W: Widget,

Source§

type Hookable = WidgetCreated<W>

The actual Hookable that this HookAlias is supposed to map to
Source§

type Input<'h> = <WidgetCreated<W> as Hookable>::Input<'h>

Just a shorthand for less boilerplate in the function definition
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, 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.