Trait View

Source

pub trait View {
    const KIND: ViewKind;

    // Required methods
    fn handle_key(&self, key: KeyEvent) -> Vec<Operation>;
    fn handle_operation(
        &mut self,
        op: &Operation,
        settings: &Settings,
    ) -> Option<Event>;
    fn save_state(&mut self, app_state: &mut AppState);
    fn render(&self, frame: &mut Frame<'_>, area: Rect, theme: &Theme);

    // Provided methods
    fn handle_mouse(&self, _mouse: MouseEvent) -> Vec<Operation> { ... }
    fn status_bar(&self, _state: &AppState, _bar: &mut StatusBarBuilder) { ... }
}

Expand description

Every full-screen view implements this trait.

§Responsibilities

handle_key — translate raw input into operations (no mutation)
handle_mouse — translate mouse events into operations (default no-op)
handle_operation — apply operations the view owns; emit an event on success
render — draw the current state to the terminal frame

Views own their slice of state. Nobody mutates a view’s internals except the view itself, through handle_operation.

Required Associated Constants§

Source

const KIND: ViewKind

The kind of this view: ViewKind::Primary or ViewKind::Modal.

Used by the escape logic to decide whether to revert to the last primary view or to ignore the key press.

Required Methods§

Source

fn handle_key(&self, key: KeyEvent) -> Vec<Operation>

Translate a key event into zero or more operations. Must not mutate self — use handle_operation for that.

Source

fn handle_operation( &mut self, op: &Operation, settings: &Settings, ) -> Option<Event>

Apply a single operation if it is relevant to this view.

Returns Some(event) if the operation was applied (so the event loop can broadcast the resulting event to subscribers), or None if this view does not own the operation.

Source