sigye 0.4.1

A beautiful terminal clock with ASCII art fonts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

//! Display mode trait for extensible mode system.

use std::any::Any;

use crossterm::event::KeyEvent;
use ratatui::Frame;
use sigye_core::DisplayMode;

use crate::context::RenderContext;

/// Trait implemented by each display mode (Clock, Pomodoro, Timer, etc.).
///
/// To add a new display mode:
/// 1. Add a variant to `DisplayMode` in `sigye-core`
/// 2. Create a new file in `modes/` implementing this trait
/// 3. Register it in `modes/mod.rs`
pub trait Mode {
    /// The display mode enum variant this mode corresponds to.
    fn display_mode(&self) -> DisplayMode;

    /// Update mode state (timers, counters, etc.). Called every frame.
    fn update(&mut self, ctx: &mut RenderContext);

    /// Render the mode's UI. Called every frame after update.
    fn render(&self, frame: &mut Frame, ctx: &RenderContext);

    /// Handle a key event. Return `true` if the key was consumed.
    fn handle_key(&mut self, key: KeyEvent, ctx: &mut RenderContext) -> bool;

    /// Return key hint pairs for the mode indicator bar: (key_label, description).
    fn key_hints(&self) -> Vec<(&'static str, &'static str)>;

    /// Downcast support for mode-specific operations.
    fn as_any_mut(&mut self) -> &mut dyn Any;
}