tui-additions 0.4.4

Additions to the Rust TUI crate
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

use super::{FrameworkClean, ItemInfo};
use crossterm::event::KeyEvent;
use dyn_clone::DynClone;
use ratatui::{layout::Rect, Frame};
use std::{any::Any, collections::HashMap, error::Error};

/// Trait every item on `State` should implment
///
/// Only include functions if you want to change
#[allow(unused)]
pub trait FrameworkItem: DynClone + Any {
    /// If the item is selectable (if not the cursor will not be able to hover or select that item)
    fn selectable(&self) -> bool {
        true
    }

    /// Select the item, if `Ok(())` is return means select is successful, or else it failed
    fn select(&mut self, framework: &mut FrameworkClean) -> bool {
        true
    }

    /// Deselect the item, if `Ok(())` is return means deselect is successful, or else it failed
    fn deselect(&mut self, framework: &mut FrameworkClean) -> bool {
        true
    }
    fn render(
        &mut self,
        frame: &mut Frame,
        framework: &mut FrameworkClean,
        area: Rect,
        popup_render: bool,
        info: ItemInfo,
    ) {
    }

    /// Runs when `Framework.load_item()` is called
    fn load_item(
        &mut self,
        framework: &mut FrameworkClean,
        info: ItemInfo,
    ) -> Result<(), Box<dyn Error>> {
        Ok(())
    }

    /// Handles key event
    fn key_event(
        &mut self,
        framework: &mut FrameworkClean,
        key: KeyEvent,
        info: ItemInfo,
    ) -> Result<(), Box<dyn Error>> {
        Ok(())
    }

    fn mouse_event(
        &mut self,
        framework: &mut FrameworkClean,
        x: u16,
        y: u16,
        absolute_x: u16,
        absolute_y: u16,
    ) -> bool {
        false
    }

    /// mouse passthrough is an event that runs before mouse event
    fn mouse_passthrough(
        &mut self,
        framework: &mut FrameworkClean,
        selected: bool,
        x: u16,
        y: u16,
        absolute_x: u16,
        absolute_y: u16,
    ) -> bool {
        false
    }

    fn message(
        &mut self,
        framework: &mut FrameworkClean,
        data: HashMap<String, Box<dyn Any>>,
    ) -> bool {
        false
    }
}

impl Clone for Box<dyn FrameworkItem> {
    fn clone(&self) -> Self {
        dyn_clone::clone_box(&**self)
    }
}