Add RowSelectionChanged action.

Author: hydra

demos/shared/src/sparse/ui.rs

@@ -1,3 +1,4 @@
+use std::collections::BTreeSet;
 use crate::sparse::{CellKind, CellKindChoice, SparseMapRenderer, SparseMapSource, generate_data};
 use egui::{Response, Ui};
 use egui_deferred_table::{Action, DeferredTable, apply_reordering};
@@ -70,6 +71,8 @@ struct UiState {
 
     row_ordering_input: String,
     column_ordering_input: String,
+
+    row_selections: BTreeSet<usize>,
 }
 
 pub fn show_table(ui: &mut Ui, state: &mut SparseTableState) -> (Response, Vec<Action>) {
@@ -121,6 +124,9 @@ pub fn handle_actions(actions: Vec<Action>, state: &mut SparseTableState) {
                 state.ui_state.row_ordering_input =
                     list_to_string(state.renderer.row_ordering.as_mut().unwrap());
             }
+            Action::RowSelectionChanged { selection } => {
+                state.ui_state.row_selections = selection;
+            }
         }
     }
 }
@@ -229,6 +235,14 @@ pub fn show_controls(ui: &mut Ui, state: &mut SparseTableState) {
                 );
             }
         });
+
+        ui.separator();
+
+        egui::Frame::group(ui.style()).show(ui, |ui| {
+            ui.label("Row selections");
+            ui.label(format!("{:?}", state.ui_state.row_selections));
+        });
+
     });
 
     ui.horizontal(|ui| {

demos/shared/src/spreadsheet/ui.rs

@@ -79,6 +79,7 @@ impl SpreadsheetState {
             .column_parameters(column_params)
             .row_parameters(row_params)
             .highlight_hovered_cell()
+            .selectable_rows_disabled()
             .show_and_edit(ui, &mut self.data_source, &mut self.renderer, &mut self.editor, &mut self.edit_state)
     }
 }
@@ -123,6 +124,11 @@ pub fn handle_actions(actions: Vec<Action>, state: &mut SpreadsheetState) {
                 state.data_source.move_row(from, to);
                 state.value.take();
             }
+            Action::RowSelectionChanged { selection } => {
+                let _ = selection;
+                // row selection currently disabled
+                unreachable!()
+            }
         }
     }
 }

src/lib.rs

@@ -234,6 +234,7 @@ impl<'a, DataSource> DeferredTable<'a, DataSource> {
         let minimum_resize_size = (style.interaction.resize_grab_radius_side * 2.0) + 2.0;
 
         let mut clear_drag_state = false;
+        let mut request_row_selection_changed_action = false;
 
         // TODO allow these to be overridden
         let default_column_parameters = AxisParameters::default();
@@ -879,9 +880,12 @@ impl<'a, DataSource> DeferredTable<'a, DataSource> {
                                 if response.clicked() {
                                     match cell_kind {
                                         CellKind::RowHeader => {
-                                            match row_was_selected {
-                                                true => { temp_state.row_selections.remove(&mapped_row_index); },
-                                                false => { temp_state.row_selections.insert(mapped_row_index); },
+                                            if self.parameters.selectable_rows {
+                                                match row_was_selected {
+                                                    true => { temp_state.row_selections.remove(&mapped_row_index); },
+                                                    false => { temp_state.row_selections.insert(mapped_row_index); },
+                                                }
+                                                request_row_selection_changed_action = true;
                                             }
                                         }
                                         // TODO selectable columns?
@@ -1169,6 +1173,19 @@ impl<'a, DataSource> DeferredTable<'a, DataSource> {
             temp_state.drag_state = None;
         }
 
+        if request_row_selection_changed_action {
+            let potentially_visible_selections = temp_state
+                .row_selections
+                .iter()
+                .filter(|&mapped_row_id| *mapped_row_id < dimensions.row_count)
+                .cloned()
+                .collect::<BTreeSet<_>>();
+
+            actions.push(Action::RowSelectionChanged {
+                selection: potentially_visible_selections,
+            });
+        }
+
         let repaint = match drag_action.take() {
             None => false,
             Some(DragAction::SetWidth(index, new_width)) => {
@@ -1195,7 +1212,7 @@ impl<'a, DataSource> DeferredTable<'a, DataSource> {
         opaque_faint_bg_color: Color32,
         opaque_faint_selected_bg_color: Color32,
         ui: &mut Ui,
-        mut row_counter: usize,
+        row_counter: usize,
         row_was_selected: bool,
     ) -> Color32 {
         if row_was_selected {
@@ -1400,6 +1417,11 @@ pub enum Action {
         from: usize,
         to: usize,
     },
+
+    /// Generated when the user selected or deselects one or more rows.
+    RowSelectionChanged {
+        selection: BTreeSet<usize>,
+    },
 }
 
 #[derive(Debug, Default, Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord)]