Struct broot::command::PanelInput

source ·
pub struct PanelInput {
    pub input_field: InputField,
    /* private fields */
}
Expand description

Wrap the input of a panel, receive events and make commands

Fields§

§input_field: InputField

Implementations§

source§

impl PanelInput

source

pub fn new(area: Area) -> Self

source

pub fn set_content(&mut self, content: &str)

source

pub fn get_content(&self) -> String

source

pub fn display( &mut self, w: &mut W, active: bool, mode: Mode, area: Area, panel_skin: &PanelSkin ) -> Result<(), ProgramError>

source

pub fn on_event( &mut self, w: &mut W, timed_event: TimedEvent, con: &AppContext, sel_info: SelInfo<'_>, app_state: &AppState, mode: Mode, panel_state_type: PanelStateType ) -> Result<Command, ProgramError>

consume the event to

  • maybe change the input
  • build a command then redraw the input field
source

pub fn escape(&mut self, con: &AppContext, mode: Mode) -> Command

escape (bound to the ‘esc’ key)

This function is better called from the on_key method of panel input, when a key triggers it, because then it can also properly deal with completion sequence. When ‘:escape’ is called from a verb’s cmd sequence, then it’s not called on on_key but by the app.

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> 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.

§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

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>,

§

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.