Skip to main content

Panel

Struct Panel 

Source
pub struct Panel {
    pub id: PanelId,
    pub areas: Areas,
    pub purpose: PanelPurpose,
    pub input: PanelInput,
    pub last_raw_pattern: Option<String>,
    /* private fields */
}
Expand description

A column on screen containing a stack of states, the top one being visible

Fields§

§id: PanelId§areas: Areas§purpose: PanelPurpose§input: PanelInput§last_raw_pattern: Option<String>

Implementations§

Source§

impl Panel

Source

pub fn new( id: PanelId, state: Box<dyn PanelState>, areas: Areas, con: &AppContext, ) -> Self

Source

pub fn set_error(&mut self, text: String)

Source

pub fn set_message<S: Into<String>>(&mut self, md: S)

Source

pub fn apply_command<'c>( &mut self, w: &'c mut W, cmd: &'c Command, app_state: &mut AppState, app_cmd_context: &'c AppCmdContext<'c>, ) -> Result<CmdResult, ProgramError>

apply a command on the current state, with no effect on screen

Source

pub fn refresh_input_status<'c>( &mut self, app_state: &AppState, app_cmd_context: &'c AppCmdContext<'c>, )

called on focusing the panel and before the display, this updates the status from the command read in the input

Source

pub fn do_pending_task( &mut self, app_state: &mut AppState, screen: Screen, con: &AppContext, dam: &mut Dam, ) -> Result<(), ProgramError>

do the next pending task stopping as soon as there’s an event in the dam

Source

pub fn has_pending_task(&self) -> bool

Source

pub fn add_event( &mut self, w: &mut W, event: &TimedEvent, app_state: &AppState, con: &AppContext, ) -> Result<Command, ProgramError>

return a new command Update the input field

Source

pub fn push_state(&mut self, new_state: Box<dyn PanelState>)

Source

pub fn mut_state(&mut self) -> &mut dyn PanelState

Source

pub fn state(&self) -> &dyn PanelState

Source

pub fn clear_input(&mut self)

Source

pub fn clear_input_invocation(&mut self, con: &AppContext)

remove the verb invocation from the input but keep the filter if there’s one

Source

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

Source

pub fn get_input_content(&self) -> String

Source

pub fn set_input_arg(&mut self, arg: String)

change the argument of the verb in the input, if there’s one

Source

pub fn remove_state(&mut self) -> bool

return true when the element has been removed

Source

pub fn display( &mut self, w: &mut W, disc: &DisplayContext<'_>, ) -> Result<Option<(u16, u16)>, ProgramError>

render the whole panel (state, status, purpose, input, flags)

Auto Trait Implementations§

§

impl Freeze for Panel

§

impl !RefUnwindSafe for Panel

§

impl !Send for Panel

§

impl !Sync for Panel

§

impl Unpin for Panel

§

impl !UnwindSafe for Panel

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

Source§

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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

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
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

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

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

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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