todotxt-tui 0.2.1

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
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110

mod state_categories;
mod state_list;
mod state_preview;
mod widget_base;
mod widget_list;
pub mod widget_trait;
pub mod widget_type;

use crate::{
    config::Config,
    layout::widget::widget_list::WidgetList,
    todo::{ToDo, ToDoCategory, ToDoData},
    ui::UIEvent,
    Result,
};
use crossterm::event::KeyCode;
use state_categories::StateCategories;
use state_list::StateList;
use state_preview::StatePreview;
use std::{
    fmt::Debug,
    sync::{Arc, Mutex},
};
use tui::{widgets::Block, Frame};
use widget_base::WidgetBase;
use widget_type::WidgetType;

pub use widget_trait::State;

/// Alias for the shared mutable reference to a ToDo instance.
pub type RCToDo = Arc<Mutex<ToDo>>;

/// Implement the enum_dispatch macro for the State trait.
#[enum_dispatch(State)]
pub enum Widget {
    List(StateList),
    Category(StateCategories),
    Preview(StatePreview),
}

impl Widget {
    /// Create a new widget based on its type and shared ToDo data.
    ///
    /// This function creates a new widget based on its type and the shared ToDo data.
    ///
    /// # Parameters
    ///
    /// - `widget_type`: The type of widget to create.
    /// - `data`: A shared mutable reference to the ToDo data.
    ///
    /// # Returns
    ///
    /// Returns a new instance of the specified widget type.
    pub fn new(widget_type: WidgetType, data: RCToDo, config: &Config) -> Result<Self> {
        use WidgetType::*;
        Ok(match widget_type {
            List => Self::List(StateList::new(
                WidgetList::new(&widget_type, data, config),
                ToDoData::Pending,
                config,
            )),
            Done => Self::List(StateList::new(
                WidgetList::new(&widget_type, data, config),
                ToDoData::Done,
                config,
            )),
            Project => Self::Category(StateCategories::new(
                WidgetList::new(&widget_type, data, config),
                ToDoCategory::Projects,
                &config.active_color_config,
            )),
            Context => Self::Category(StateCategories::new(
                WidgetList::new(&widget_type, data, config),
                ToDoCategory::Contexts,
                &config.active_color_config,
            )),
            Hashtag => Self::Category(StateCategories::new(
                WidgetList::new(&widget_type, data, config),
                ToDoCategory::Hashtags,
                &config.active_color_config,
            )),
            Preview => Self::Preview(StatePreview::new(
                WidgetBase::new(&widget_type, data, config),
                config,
            )?),
        })
    }

    /// Get the type of the widget.
    ///
    /// This function returns the type of the widget.
    ///
    /// # Returns
    ///
    /// Returns the `WidgetType` of the widget.
    pub fn widget_type(&self) -> WidgetType {
        use WidgetType::*;
        match self {
            Widget::List(list) => list.data_type.into(),
            Widget::Category(categories) => categories.category.into(),
            Widget::Preview(_) => Preview,
        }
    }
}

impl Debug for Widget {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{:#?}", self.widget_type())
    }
}