todotxt-tui 0.3.0

Todo.txt TUI is a highly customizable terminal-based application for managing your todo tasks. It follows the todo.txt format and offers a wide range of configuration options to suit your needs.
Documentation 
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
36
37
38
39
40
41
42
43

use tui::{prelude::Rect, Frame};

use crate::todo::ToDo;

/// A trait for rendering UI components.
///
/// The `Render` trait defines methods for rendering UI components within a TUI (Text-based User Interface).
pub trait Render {
    /// Render the UI component onto a TUI frame.
    ///
    /// This method is called to render the UI component onto a TUI frame.
    ///
    /// # Generic Parameters
    ///
    /// - `B`: The backend type used for rendering the UI component.
    ///
    /// # Parameters
    ///
    /// - `f`: A mutable reference to a TUI frame where the component should be rendered.
    fn render(&self, f: &mut Frame, todo: &ToDo);

    /// Focus the UI component.
    ///
    /// This method is called to give focus to the UI component. Focusing a component
    /// typically means that it can now accept user input and respond to events.
    fn focus(&mut self, todo: &ToDo) -> bool;

    /// Unfocus the UI component.
    ///
    /// This method is called to remove focus from the UI component. An unfocused component
    /// typically does not respond to user input until it is focused again.
    fn unfocus(&mut self);

    /// Update the chunk (area) where the UI component should be rendered.
    ///
    /// This method is called to update the chunk (area) where the UI component should be rendered
    /// within the TUI frame. It allows the component to adapt to changes in size or position.
    ///
    /// # Parameters
    ///
    /// - `chunk`: The new rectangular area (chunk) where the component should be rendered.
    fn update_chunk(&mut self, chunk: Rect);
}