termint 0.8.1

Library for colored printing and Terminal User Interfaces
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

/// Stores the state of the [`Table`](crate::widgets::Table).
///
/// It includes:
/// - Scroll offset = based on rows, e.g. 5 means 5th row is first visible.
/// - Selected = optional ID of the selected row (starting from 0)
/// - Selected column = optional ID of the selected column (starting from 0)
///
/// # Example
///
/// This creates table state with scroll offset of 3 rows, 5th row and 2nd
/// column as selected.
///
/// ```rust
/// use termint::prelude::*;
/// use std::{cell::RefCell, rc::Rc};
///
/// // Create the state itself
/// let state = TableState::new(3).selected(5).selected_column(2);
///
/// // Wrap in Rc<RefCell<..>> for the table
/// let wrapped_state = Rc::new(RefCell::new(state));
/// ```
#[derive(Debug, Default, Clone, PartialEq, Eq, Hash)]
pub struct TableState {
    pub offset: usize,
    pub selected: Option<usize>,
    pub selected_column: Option<usize>,
}

impl TableState {
    /// Creates new [`TableState`] with the given scroll offset.
    ///
    /// This creates the state with no selected row or column.
    #[must_use]
    pub fn new(offset: usize) -> Self {
        Self {
            offset,
            ..Default::default()
        }
    }

    /// Creates new [`TableState`] with the given selected row.
    ///
    /// Scroll offset is set to 0 and no column is selected.
    ///
    /// The `selected` is any type convertible to `Option<usize>`.
    pub fn with_selected<T>(selected: T) -> Self
    where
        T: Into<Option<usize>>,
    {
        Self {
            selected: selected.into(),
            ..Default::default()
        }
    }

    /// Creates new [`TableState`] with the given selected column.
    ///
    /// Scroll offset is set to 0 and no row is selected.
    ///
    /// The `selected` is any type convertible to `Option<usize>`.
    pub fn with_selected_column<T>(selected: T) -> Self
    where
        T: Into<Option<usize>>,
    {
        Self {
            selected_column: selected.into(),
            ..Default::default()
        }
    }

    /// Sets the selected row index.
    ///
    /// The `selected` is any type convertible to `Option<usize>`. This allows
    /// unselecting the row as well.
    #[must_use]
    pub fn selected<T>(mut self, selected: T) -> Self
    where
        T: Into<Option<usize>>,
    {
        self.selected = selected.into();
        self
    }

    /// Sets the selected column index.
    ///
    /// The `selected` is any type convertible to `Option<usize>`. This allows
    /// unselecting the column as well.
    #[must_use]
    pub fn selected_column<T>(mut self, selected: T) -> Self
    where
        T: Into<Option<usize>>,
    {
        self.selected_column = selected.into();
        self
    }
}