qframe/widgets/table/
model.rs

1//! What a [`Table`](super::Table) shows: its columns, rows and cells.
2
3use crate::text;
4use crate::widget::Align;
5
6/// How wide a [`Column`] is.
7#[derive(Debug, Clone, Copy, PartialEq, Eq)]
8pub enum ColumnWidth {
9    /// Exactly this many cells.
10    Fixed(u16),
11    /// As wide as its widest cell or its title.
12    Fit,
13    /// A share of the room left by the other columns, by weight.
14    Fill(u16),
15}
16
17/// Which way a sorted column is ordered.
18#[derive(Debug, Clone, Copy, PartialEq, Eq)]
19pub enum SortDirection {
20    /// Smallest first.
21    Ascending,
22    /// Largest first.
23    Descending,
24}
25
26impl SortDirection {
27    /// The other direction.
28    #[must_use]
29    pub fn reversed(self) -> Self {
30        match self {
31            Self::Ascending => Self::Descending,
32            Self::Descending => Self::Ascending,
33        }
34    }
35}
36
37/// A column of a [`Table`](super::Table): a title, a width rule, an alignment and whether it can be sorted.
38#[derive(Debug, Clone, PartialEq, Eq)]
39pub struct Column {
40    pub(super) title: String,
41    pub(super) width: ColumnWidth,
42    pub(super) min: Option<u16>,
43    pub(super) align: Align,
44    pub(super) sortable: bool,
45}
46
47impl Column {
48    /// A left-aligned column that shares the free room equally with other filling columns.
49    #[must_use]
50    pub fn new(title: impl Into<String>) -> Self {
51        Self { title: title.into(), width: ColumnWidth::Fill(1), min: None, align: Align::Start, sortable: false }
52    }
53
54    /// How wide the column is.
55    #[must_use]
56    pub fn width(mut self, width: ColumnWidth) -> Self {
57        self.width = width;
58        self
59    }
60
61    /// The fewest cells a fitting or filling column shrinks to. When the columns' minimums do
62    /// not fit, the table scrolls sideways instead of shrinking further. Filling columns keep
63    /// their title's width by default.
64    #[must_use]
65    pub fn min(mut self, cells: u16) -> Self {
66        self.min = Some(cells);
67        self
68    }
69
70    /// Where cell text sits; `Align::End` for numbers so their digits line up.
71    #[must_use]
72    pub fn align(mut self, align: Align) -> Self {
73        self.align = align;
74        self
75    }
76
77    /// Lets the user sort by this column (needs [`Table::on_sort`](super::Table::on_sort)).
78    #[must_use]
79    pub fn sortable(mut self, sortable: bool) -> Self {
80        self.sortable = sortable;
81        self
82    }
83
84    pub(super) fn title_width(&self) -> u16 {
85        text::width(&self.title).saturating_add(if self.sortable { 2 } else { 0 })
86    }
87}
88
89/// One cell: text, optionally with an icon and a colour.
90#[derive(Debug, Clone, PartialEq, Eq, Default)]
91pub struct TableCell {
92    pub(super) text: String,
93    pub(super) icon: Option<String>,
94    pub(super) icon_color: Option<String>,
95    pub(super) color: Option<String>,
96}
97
98impl TableCell {
99    /// A cell showing `text`.
100    #[must_use]
101    pub fn new(text: impl Into<String>) -> Self {
102        Self { text: text.into(), ..Self::default() }
103    }
104
105    /// Icon key drawn before the text, optionally in theme colour `color`.
106    #[must_use]
107    pub fn icon(mut self, key: impl Into<String>, color: Option<&str>) -> Self {
108        self.icon = Some(key.into());
109        self.icon_color = color.map(str::to_owned);
110        self
111    }
112
113    /// Draws the text in theme colour `token`, e.g. `"success"` next to a status icon.
114    #[must_use]
115    pub fn color(mut self, token: impl Into<String>) -> Self {
116        self.color = Some(token.into());
117        self
118    }
119
120    pub(super) fn width(&self) -> u16 {
121        text::width(&self.text).saturating_add(self.icon.as_ref().map_or(0, |_| 2))
122    }
123}
124
125impl From<&str> for TableCell {
126    fn from(text: &str) -> Self {
127        Self::new(text)
128    }
129}
130
131impl From<String> for TableCell {
132    fn from(text: String) -> Self {
133        Self::new(text)
134    }
135}
136
137/// One row of a [`Table`](super::Table).
138#[derive(Debug, Clone, PartialEq, Eq, Default)]
139pub struct TableRow {
140    pub(super) cells: Vec<TableCell>,
141    pub(super) faint: bool,
142}
143
144impl TableRow {
145    /// A row of `cells`, one per column.
146    #[must_use]
147    pub fn new(cells: impl IntoIterator<Item = impl Into<TableCell>>) -> Self {
148        Self { cells: cells.into_iter().map(Into::into).collect(), faint: false }
149    }
150
151    /// Draws the row faint while keeping it selectable.
152    #[must_use]
153    pub fn faint(mut self, faint: bool) -> Self {
154        self.faint = faint;
155        self
156    }
157}
qframe/widgets/table/model.rs

qframe/widgets/table/
model.rs
