fltk/
table.rs

1use crate::prelude::*;
2use crate::utils::FlString;
3use fltk_sys::table::*;
4use std::ffi::{CStr, CString};
5
6/// Creates a table
7/// For a simpler boilerplate-less table, check the [fltk-table crate](https://crates.io/crates/fltk-table)
8#[derive(Debug)]
9pub struct Table {
10    inner: crate::widget::WidgetTracker,
11    is_derived: bool,
12}
13
14crate::macros::widget::impl_widget_ext!(Table, Fl_Table);
15crate::macros::widget::impl_widget_base!(Table, Fl_Table);
16crate::macros::widget::impl_widget_default!(Table, Fl_Table);
17crate::macros::group::impl_group_ext!(Table, Fl_Table);
18crate::macros::table::impl_table_ext!(Table, Fl_Table);
19
20/// Defines the `TableContext`
21#[repr(i32)]
22#[derive(Debug, Copy, Clone, PartialEq, Eq)]
23pub enum TableContext {
24    /// No context
25    None = 0,
26    /// start of page context
27    StartPage = 0x01,
28    /// End of page context
29    EndPage = 0x02,
30    /// Row header context
31    RowHeader = 0x04,
32    /// Column header context
33    ColHeader = 0x08,
34    /// Cell context
35    Cell = 0x10,
36    /// Table context
37    Table = 0x20,
38    /// Row-Column resize context
39    RcResize = 0x40,
40}
41
42/// Defines the `TableResizeFlag`
43#[repr(i32)]
44#[derive(Debug, Copy, Clone, PartialEq, Eq)]
45pub enum TableResizeFlag {
46    /// Non resizable
47    None = 0,
48    /// Resizes on the left of the column
49    ColLeft = 1,
50    /// Resizes on the right of the column
51    ColRight = 2,
52    /// Resizes to above the row
53    RowAbove = 3,
54    /// Resizes to below the row
55    RowBelow = 4,
56}
57
58/// Creates a table row
59#[derive(Debug)]
60pub struct TableRow {
61    inner: crate::widget::WidgetTracker,
62    is_derived: bool,
63}
64
65crate::macros::widget::impl_widget_ext!(TableRow, Fl_Table_Row);
66crate::macros::widget::impl_widget_base!(TableRow, Fl_Table_Row);
67crate::macros::widget::impl_widget_default!(TableRow, Fl_Table_Row);
68crate::macros::group::impl_group_ext!(TableRow, Fl_Table_Row);
69crate::macros::table::impl_table_ext!(TableRow, Fl_Table_Row);
70
71/// Defines the table row select mode
72#[repr(i32)]
73#[derive(Debug, Clone, Copy, PartialEq, Eq)]
74pub enum TableRowSelectMode {
75    /// Disable select
76    None,
77    /// Select single elements
78    Single,
79    /// Select several elements
80    Multi,
81}
82
83crate::macros::widget::impl_widget_type!(TableRowSelectMode);
84
85/// Defines the table row select flag
86#[repr(i32)]
87#[derive(Debug, Clone, Copy, PartialEq, Eq)]
88pub enum TableRowSelectFlag {
89    /// Deselect on click
90    Deselect,
91    /// Select on click
92    Select,
93    /// Toggle selection on click
94    Toggle,
95}
96
97impl TableRow {
98    /// Returns whether a row was selected
99    pub fn row_selected(&mut self, row: i32) -> bool {
100        unsafe { Fl_Table_Row_row_selected(self.inner.widget() as _, row) != 0 }
101    }
102
103    /// Selects a row
104    /// # Errors
105    /// Errors on failure to select row
106    pub fn select_row(
107        &mut self,
108        row: i32,
109        selection_flag: TableRowSelectFlag,
110    ) -> Result<(), FltkError> {
111        unsafe {
112            match Fl_Table_Row_select_row(self.inner.widget() as _, row, selection_flag as i32) {
113                1 => Ok(()),
114                0 | -1 => Err(FltkError::Internal(FltkErrorKind::TableError)),
115                _ => unreachable!(),
116            }
117        }
118    }
119
120    /// Selects all rows
121    pub fn select_all_rows(&mut self, selection_flag: TableRowSelectFlag) {
122        unsafe { Fl_Table_Row_select_all_rows(self.inner.widget() as _, selection_flag as i32) }
123    }
124
125    /// Set the row count, redraws the table.
126    pub fn set_rows(&mut self, n: i32) {
127        unsafe { Fl_Table_Row_set_rows(self.inner.widget() as _, n) }
128    }
129
130    /// Clear setting the row count to 0.
131    pub fn clear_rows(&mut self) {
132        unsafe { Fl_Table_Row_clear_rows(self.inner.widget() as _) }
133    }
134}