Trait meli::components::Component

pub trait Component: Display + Debug + Send + Sync {
    fn draw(&mut self, grid: &mut CellBuffer, area: Area, context: &mut Context);
    fn process_event(
        &mut self, 
        event: &mut UIEvent, 
        context: &mut Context
    ) -> bool;
    fn is_dirty(&self) -> bool;
    fn set_dirty(&mut self, value: bool);
    fn id(&self) -> ComponentId;

    fn is_visible(&self) -> bool { ... }
    fn can_quit_cleanly(&mut self, _context: &Context) -> bool { ... }
    fn kill(&mut self, _id: ComponentId, _context: &mut Context) { ... }
    fn set_id(&mut self, _id: ComponentId) { ... }
    fn get_shortcuts(&self, _context: &Context) -> ShortcutMaps { ... }
    fn get_status(&self, _context: &Context) -> String { ... }
}

Types implementing this Trait can draw on the terminal and receive events. If a type wants to skip drawing if it has not changed anything, it can hold some flag in its fields (eg self.dirty = false) and act upon that in their draw implementation.

Required methods

fn draw(&mut self, grid: &mut CellBuffer, area: Area, context: &mut Context)

fn process_event(&mut self, event: &mut UIEvent, context: &mut Context) -> bool

fn is_dirty(&self) -> bool

fn set_dirty(&mut self, value: bool)

fn id(&self) -> ComponentId

Loading content...

Provided methods

fn is_visible(&self) -> bool

fn can_quit_cleanly(&mut self, _context: &Context) -> bool

fn kill(&mut self, _id: ComponentId, _context: &mut Context)

fn set_id(&mut self, _id: ComponentId)

fn get_shortcuts(&self, _context: &Context) -> ShortcutMaps

fn get_status(&self, _context: &Context) -> String

Loading content...

Implementors

impl Component for KeySelection

fn draw(&mut self, grid: &mut CellBuffer, area: Area, context: &mut Context)

fn process_event(&mut self, event: &mut UIEvent, context: &mut Context) -> bool

fn is_dirty(&self) -> bool

fn set_dirty(&mut self, value: bool)

fn kill(&mut self, _uuid: Uuid, _context: &mut Context)

fn get_shortcuts(&self, context: &Context) -> ShortcutMaps

fn id(&self) -> ComponentId

fn set_id(&mut self, new_id: ComponentId)

impl Component for Field

fn draw(&mut self, grid: &mut CellBuffer, area: Area, context: &mut Context)

fn process_event(&mut self, event: &mut UIEvent, context: &mut Context) -> bool

fn is_dirty(&self) -> bool

fn set_dirty(&mut self, _value: bool)

fn id(&self) -> ComponentId

fn set_id(&mut self, _id: ComponentId)

impl Component for ContactList

fn draw(&mut self, grid: &mut CellBuffer, area: Area, context: &mut Context)

fn process_event(&mut self, event: &mut UIEvent, context: &mut Context) -> bool

fn is_dirty(&self) -> bool

fn set_dirty(&mut self, value: bool)

fn kill(&mut self, uuid: Uuid, context: &mut Context)

fn get_shortcuts(&self, context: &Context) -> ShortcutMaps

fn id(&self) -> ComponentId

fn set_id(&mut self, id: ComponentId)

fn can_quit_cleanly(&mut self, context: &Context) -> bool

fn get_status(&self, context: &Context) -> String

impl Component for ContactManager

fn draw(&mut self, grid: &mut CellBuffer, area: Area, context: &mut Context)

fn process_event(&mut self, event: &mut UIEvent, context: &mut Context) -> bool

fn is_dirty(&self) -> bool

fn set_dirty(&mut self, value: bool)

fn id(&self) -> ComponentId

fn set_id(&mut self, id: ComponentId)

fn can_quit_cleanly(&mut self, context: &Context) -> bool

impl Component for CompactListing

fn draw(&mut self, grid: &mut CellBuffer, area: Area, context: &mut Context)

fn process_event(&mut self, event: &mut UIEvent, context: &mut Context) -> bool

fn is_dirty(&self) -> bool

fn set_dirty(&mut self, value: bool)

fn get_shortcuts(&self, context: &Context) -> ShortcutMaps

fn id(&self) -> ComponentId

fn set_id(&mut self, id: ComponentId)

impl Component for ConversationsListing

fn draw(&mut self, grid: &mut CellBuffer, area: Area, context: &mut Context)

fn process_event(&mut self, event: &mut UIEvent, context: &mut Context) -> bool

fn is_dirty(&self) -> bool

fn set_dirty(&mut self, value: bool)

fn get_shortcuts(&self, context: &Context) -> ShortcutMaps

fn id(&self) -> ComponentId

fn set_id(&mut self, id: ComponentId)

impl Component for Listing

fn draw(&mut self, grid: &mut CellBuffer, area: Area, context: &mut Context)

fn process_event(&mut self, event: &mut UIEvent, context: &mut Context) -> bool

fn is_dirty(&self) -> bool

fn set_dirty(&mut self, value: bool)

fn get_shortcuts(&self, context: &Context) -> ShortcutMaps

fn id(&self) -> ComponentId

fn set_id(&mut self, id: ComponentId)

fn get_status(&self, context: &Context) -> String

impl Component for OfflineListing

fn draw(&mut self, grid: &mut CellBuffer, area: Area, context: &mut Context)

fn process_event(&mut self, event: &mut UIEvent, _context: &mut Context) -> bool

fn is_dirty(&self) -> bool

fn set_dirty(&mut self, _value: bool)

fn id(&self) -> ComponentId

fn set_id(&mut self, id: ComponentId)

impl Component for PlainListing

fn draw(&mut self, grid: &mut CellBuffer, area: Area, context: &mut Context)

fn process_event(&mut self, event: &mut UIEvent, context: &mut Context) -> bool

fn is_dirty(&self) -> bool

fn set_dirty(&mut self, value: bool)

fn get_shortcuts(&self, context: &Context) -> ShortcutMaps

fn id(&self) -> ComponentId

fn set_id(&mut self, id: ComponentId)

impl Component for ThreadListing

fn draw(&mut self, grid: &mut CellBuffer, area: Area, context: &mut Context)

fn process_event(&mut self, event: &mut UIEvent, context: &mut Context) -> bool

fn is_dirty(&self) -> bool

fn set_dirty(&mut self, value: bool)

fn get_shortcuts(&self, context: &Context) -> ShortcutMaps

fn id(&self) -> ComponentId

fn set_id(&mut self, id: ComponentId)

impl Component for AccountStatus

fn draw(&mut self, grid: &mut CellBuffer, area: Area, context: &mut Context)

fn process_event(&mut self, event: &mut UIEvent, context: &mut Context) -> bool

fn get_shortcuts(&self, context: &Context) -> ShortcutMaps

fn is_dirty(&self) -> bool

fn set_dirty(&mut self, value: bool)

fn id(&self) -> ComponentId

fn set_id(&mut self, id: ComponentId)

impl Component for Composer

fn draw(&mut self, grid: &mut CellBuffer, area: Area, context: &mut Context)

fn process_event(&mut self, event: &mut UIEvent, context: &mut Context) -> bool

fn is_dirty(&self) -> bool

fn set_dirty(&mut self, value: bool)

fn kill(&mut self, uuid: Uuid, context: &mut Context)

fn get_shortcuts(&self, context: &Context) -> ShortcutMaps

fn id(&self) -> ComponentId

fn set_id(&mut self, id: ComponentId)

fn can_quit_cleanly(&mut self, context: &Context) -> bool

impl Component for EnvelopeView

fn draw(&mut self, grid: &mut CellBuffer, area: Area, context: &mut Context)

fn process_event(&mut self, event: &mut UIEvent, context: &mut Context) -> bool

fn is_dirty(&self) -> bool

fn set_dirty(&mut self, value: bool)

fn id(&self) -> ComponentId

fn kill(&mut self, id: ComponentId, context: &mut Context)

fn set_id(&mut self, id: ComponentId)

impl Component for HtmlView

fn draw(&mut self, grid: &mut CellBuffer, area: Area, context: &mut Context)

fn process_event(&mut self, event: &mut UIEvent, context: &mut Context) -> bool

fn get_shortcuts(&self, context: &Context) -> ShortcutMaps

fn is_dirty(&self) -> bool

fn set_dirty(&mut self, value: bool)

fn id(&self) -> ComponentId

fn set_id(&mut self, id: ComponentId)

impl Component for MailView

fn draw(&mut self, grid: &mut CellBuffer, area: Area, context: &mut Context)

fn process_event(&mut self, event: &mut UIEvent, context: &mut Context) -> bool

fn is_dirty(&self) -> bool

fn set_dirty(&mut self, value: bool)

fn get_shortcuts(&self, context: &Context) -> ShortcutMaps

fn id(&self) -> ComponentId

fn set_id(&mut self, id: ComponentId)

fn kill(&mut self, id: ComponentId, context: &mut Context)

impl Component for ThreadView

fn draw(&mut self, grid: &mut CellBuffer, area: Area, context: &mut Context)

fn process_event(&mut self, event: &mut UIEvent, context: &mut Context) -> bool

fn is_dirty(&self) -> bool

fn set_dirty(&mut self, value: bool)

fn get_shortcuts(&self, context: &Context) -> ShortcutMaps

fn id(&self) -> ComponentId

fn set_id(&mut self, id: ComponentId)

fn kill(&mut self, id: ComponentId, context: &mut Context)

impl Component for DbusNotifications

fn draw(&mut self, _grid: &mut CellBuffer, _area: Area, _context: &mut Context)

fn process_event(&mut self, event: &mut UIEvent, context: &mut Context) -> bool

fn set_dirty(&mut self, _value: bool)

fn is_dirty(&self) -> bool

fn id(&self) -> ComponentId

fn set_id(&mut self, _id: ComponentId)

impl Component for NotificationCommand

fn draw(&mut self, _grid: &mut CellBuffer, _area: Area, _context: &mut Context)

fn process_event(&mut self, event: &mut UIEvent, context: &mut Context) -> bool

fn id(&self) -> ComponentId

fn is_dirty(&self) -> bool

fn set_dirty(&mut self, _value: bool)

fn set_id(&mut self, _id: ComponentId)

impl Component for SVGScreenshotFilter

fn draw(&mut self, _grid: &mut CellBuffer, _area: Area, context: &mut Context)

fn process_event(&mut self, event: &mut UIEvent, _context: &mut Context) -> bool

fn set_dirty(&mut self, _value: bool)

fn is_dirty(&self) -> bool

fn id(&self) -> ComponentId

fn set_id(&mut self, _id: ComponentId)

impl Component for AutoComplete

fn draw(&mut self, grid: &mut CellBuffer, area: Area, context: &mut Context)

fn process_event(
    &mut self,
    _event: &mut UIEvent,
    _context: &mut Context
) -> bool

fn is_dirty(&self) -> bool

fn set_dirty(&mut self, value: bool)

fn id(&self) -> ComponentId

fn set_id(&mut self, id: ComponentId)

impl Component for HSplit

fn draw(&mut self, grid: &mut CellBuffer, area: Area, context: &mut Context)

fn process_event(&mut self, event: &mut UIEvent, context: &mut Context) -> bool

fn is_dirty(&self) -> bool

fn set_dirty(&mut self, value: bool)

fn get_shortcuts(&self, context: &Context) -> ShortcutMaps

fn id(&self) -> ComponentId

fn set_id(&mut self, id: ComponentId)

impl Component for Pager

fn draw(&mut self, grid: &mut CellBuffer, area: Area, context: &mut Context)

fn process_event(&mut self, event: &mut UIEvent, context: &mut Context) -> bool

fn is_dirty(&self) -> bool

fn set_dirty(&mut self, value: bool)

fn get_shortcuts(&self, context: &Context) -> ShortcutMaps

fn id(&self) -> ComponentId

fn set_id(&mut self, id: ComponentId)

impl Component for ProgressSpinner

fn draw(&mut self, grid: &mut CellBuffer, area: Area, context: &mut Context)

fn process_event(&mut self, event: &mut UIEvent, _context: &mut Context) -> bool

fn set_dirty(&mut self, new_val: bool)

fn is_dirty(&self) -> bool

fn id(&self) -> ComponentId

fn set_id(&mut self, id: ComponentId)

impl Component for RawBuffer

fn draw(&mut self, grid: &mut CellBuffer, area: Area, context: &mut Context)

fn process_event(&mut self, event: &mut UIEvent, _context: &mut Context) -> bool

fn is_dirty(&self) -> bool

fn set_dirty(&mut self, value: bool)

fn id(&self) -> ComponentId

impl Component for StatusBar

fn draw(&mut self, grid: &mut CellBuffer, area: Area, context: &mut Context)

fn process_event(&mut self, event: &mut UIEvent, context: &mut Context) -> bool

fn is_dirty(&self) -> bool

fn set_dirty(&mut self, value: bool)

fn get_shortcuts(&self, context: &Context) -> ShortcutMaps

fn id(&self) -> ComponentId

fn set_id(&mut self, id: ComponentId)

fn can_quit_cleanly(&mut self, context: &Context) -> bool

impl Component for Tabbed

fn draw(&mut self, grid: &mut CellBuffer, area: Area, context: &mut Context)

fn process_event(&mut self, event: &mut UIEvent, context: &mut Context) -> bool

fn is_dirty(&self) -> bool

fn set_dirty(&mut self, value: bool)

fn id(&self) -> ComponentId

fn set_id(&mut self, id: ComponentId)

fn get_shortcuts(&self, context: &Context) -> ShortcutMaps

fn can_quit_cleanly(&mut self, context: &Context) -> bool

impl Component for VSplit

fn draw(&mut self, grid: &mut CellBuffer, area: Area, context: &mut Context)

fn process_event(&mut self, event: &mut UIEvent, context: &mut Context) -> bool

fn is_dirty(&self) -> bool

fn set_dirty(&mut self, value: bool)

fn get_shortcuts(&self, context: &Context) -> ShortcutMaps

fn id(&self) -> ComponentId

fn set_id(&mut self, id: ComponentId)

impl Component for UIConfirmationDialog

fn draw(&mut self, grid: &mut CellBuffer, area: Area, context: &mut Context)

fn process_event(&mut self, event: &mut UIEvent, context: &mut Context) -> bool

fn get_shortcuts(&self, context: &Context) -> ShortcutMaps

fn is_dirty(&self) -> bool

fn set_dirty(&mut self, value: bool)

fn id(&self) -> ComponentId

fn set_id(&mut self, id: ComponentId)

impl<'_, '_> Component for EditAttachmentsRefMut<'_, '_>

fn draw(&mut self, grid: &mut CellBuffer, area: Area, context: &mut Context)

fn process_event(&mut self, event: &mut UIEvent, context: &mut Context) -> bool

fn is_dirty(&self) -> bool

fn set_dirty(&mut self, value: bool)

fn kill(&mut self, _uuid: Uuid, _context: &mut Context)

fn get_shortcuts(&self, _context: &Context) -> ShortcutMaps

fn id(&self) -> ComponentId

fn set_id(&mut self, new_id: ComponentId)

impl<T> Component for ButtonWidget<T> where
    T: 'static + Debug + Copy + Default + Send + Sync, 

fn draw(&mut self, grid: &mut CellBuffer, area: Area, context: &mut Context)

fn process_event(&mut self, event: &mut UIEvent, _context: &mut Context) -> bool

fn is_dirty(&self) -> bool

fn set_dirty(&mut self, value: bool)

fn id(&self) -> ComponentId

fn set_id(&mut self, id: ComponentId)

impl<T: 'static + PartialEq + Debug + Clone + Sync + Send> Component for UIDialog<T>

fn draw(&mut self, grid: &mut CellBuffer, area: Area, context: &mut Context)

fn process_event(&mut self, event: &mut UIEvent, context: &mut Context) -> bool

fn get_shortcuts(&self, context: &Context) -> ShortcutMaps

fn is_dirty(&self) -> bool

fn set_dirty(&mut self, value: bool)

fn id(&self) -> ComponentId

fn set_id(&mut self, id: ComponentId)

impl<T: 'static + Debug + Copy + Default + Send + Sync> Component for FormWidget<T>

fn draw(&mut self, grid: &mut CellBuffer, area: Area, context: &mut Context)

fn process_event(&mut self, event: &mut UIEvent, context: &mut Context) -> bool

fn is_dirty(&self) -> bool

fn set_dirty(&mut self, value: bool)

fn id(&self) -> ComponentId

fn set_id(&mut self, id: ComponentId)

Loading content...