Feature: Mirror Selection Tool

crates/rnote-engine/src/engine/mod.rs

@@ -754,30 +754,20 @@ impl Engine {
             | self.update_rendering_current_viewport()
     }
 
-    pub fn mirror_horizontal_selection(&mut self) -> Option<WidgetFlags> {
-        self.store
-            .mirror_stroke(
-                &self.store.selection_keys_as_rendered(),
-                MirrorOrientation::Horizontal,
-            )
-            .map(|widget_flags| {
-                widget_flags
-                    | self.record(Instant::now())
-                    | self.update_content_rendering_current_viewport()
-            })
+    pub fn mirror_horizontal_selection(&mut self) -> WidgetFlags {
+        self.store.mirror_stroke(
+            &self.store.selection_keys_as_rendered(),
+            MirrorOrientation::Horizontal,
+        ) | self.record(Instant::now())
+            | self.update_content_rendering_current_viewport()
     }
 
-    pub fn mirror_vertical_selection(&mut self) -> Option<WidgetFlags> {
-        self.store
-            .mirror_stroke(
-                &self.store.selection_keys_as_rendered(),
-                MirrorOrientation::Vertical,
-            )
-            .map(|widget_flags| {
-                widget_flags
-                    | self.record(Instant::now())
-                    | self.update_content_rendering_current_viewport()
-            })
+    pub fn mirror_vertical_selection(&mut self) -> WidgetFlags {
+        self.store.mirror_stroke(
+            &self.store.selection_keys_as_rendered(),
+            MirrorOrientation::Vertical,
+        ) | self.record(Instant::now())
+            | self.update_content_rendering_current_viewport()
     }
 
     pub fn select_with_bounds(

crates/rnote-engine/src/store/stroke_comp.rs

@@ -305,30 +305,26 @@ impl StrokeStore {
         &mut self,
         keys: &[StrokeKey],
         orientation: MirrorOrientation,
-    ) -> Option<WidgetFlags> {
+    ) -> WidgetFlags {
         let mut widget_flags = WidgetFlags::default();
 
         if keys.is_empty() {
-            return Some(widget_flags);
+            return widget_flags;
         }
 
-        let mut stroke_contains_text = false;
-        keys.iter().for_each(|&key| {
-            if let Some(stroke) = Arc::make_mut(&mut self.stroke_components)
-                .get_mut(key)
-                .map(Arc::make_mut)
-            {
-                match stroke {
-                    Stroke::TextStroke(_text_stroke) => {
-                        stroke_contains_text = true;
-                    }
-                    _ => {}
-                }
-            }
+        let stroke_contains_text = keys.iter().any(|&key| {
+            matches!(
+                Arc::make_mut(&mut self.stroke_components)
+                    .get_mut(key)
+                    .map(Arc::make_mut),
+                Some(Stroke::TextStroke(_))
+            )
         });
 
         if stroke_contains_text {
-            return None;
+            widget_flags.popup_message =
+                Some("Mirroring selections containing text is not supported".to_string());
+            return widget_flags;
         }
 
         let all_stroke_bounds = self.strokes_bounds(keys);
@@ -363,7 +359,7 @@ impl StrokeStore {
             if let (Some(min_component), Some(max_component)) = (min_component, max_component) {
                 (min_component + max_component) / 2.0
             } else {
-                return Some(widget_flags);
+                return widget_flags;
             };
 
         keys.iter().for_each(|&key| {
@@ -379,7 +375,7 @@ impl StrokeStore {
         widget_flags.redraw = true;
         widget_flags.store_modified = true;
 
-        Some(widget_flags)
+        widget_flags
     }
 
     /// Invert the stroke, text and fill color of the given keys.

crates/rnote-engine/src/widgetflags.rs

@@ -26,6 +26,10 @@ pub struct WidgetFlags {
     /// Meaning, when enabled instead of key events, text events are then emitted
     /// for regular unicode text. Used when writing text with the typewriter.
     pub enable_text_preprocessing: Option<bool>,
+    /// If Some, a popup message is sent to the user, through a dispatch_toast_text message.
+    /// Intended to notify the user that an operation they performed could not be completed
+    /// or is not possible
+    pub popup_message: Option<String>,
 }
 
 impl Default for WidgetFlags {
@@ -42,6 +46,7 @@ impl Default for WidgetFlags {
             hide_undo: None,
             hide_redo: None,
             enable_text_preprocessing: None,
+            popup_message: None,
         }
     }
 }
@@ -74,5 +79,8 @@ impl std::ops::BitOrAssign for WidgetFlags {
         if rhs.enable_text_preprocessing.is_some() {
             self.enable_text_preprocessing = rhs.enable_text_preprocessing;
         }
+        if rhs.popup_message.is_some() {
+            self.popup_message = rhs.popup_message.clone();
+        }
     }
 }

crates/rnote-ui/src/appwindow/actions.rs

@@ -1,5 +1,5 @@
 // Imports
-use crate::{RnAppWindow, RnCanvas, config, dialogs, overlays};
+use crate::{RnAppWindow, RnCanvas, config, dialogs};
 use gettextrs::gettext;
 use gtk4::gio::InputStream;
 use gtk4::graphene;
@@ -478,14 +478,8 @@ impl RnAppWindow {
                 let Some(canvas) = appwindow.active_tab_canvas() else {
                     return;
                 };
-                if let Some(widget_flags) = canvas.engine_mut().mirror_horizontal_selection() {
-                    appwindow.handle_widget_flags(widget_flags, &canvas);
-                } else {
-                    appwindow.overlays().dispatch_toast_text(
-                        &gettext("Mirroring selections containing text is not supported"),
-                        overlays::TEXT_TOAST_TIMEOUT_DEFAULT,
-                    );
-                }
+                let widget_flags = canvas.engine_mut().mirror_horizontal_selection();
+                appwindow.handle_widget_flags(widget_flags, &canvas);
             }
         ));
 
@@ -497,14 +491,8 @@ impl RnAppWindow {
                 let Some(canvas) = appwindow.active_tab_canvas() else {
                     return;
                 };
-                if let Some(widget_flags) = canvas.engine_mut().mirror_vertical_selection() {
-                    appwindow.handle_widget_flags(widget_flags, &canvas);
-                } else {
-                    appwindow.overlays().dispatch_toast_text(
-                        &gettext("Mirroring selections containing text is not supported"),
-                        overlays::TEXT_TOAST_TIMEOUT_DEFAULT,
-                    );
-                }
+                let widget_flags = canvas.engine_mut().mirror_vertical_selection();
+                appwindow.handle_widget_flags(widget_flags, &canvas);
             }
         ));
 

crates/rnote-ui/src/appwindow/mod.rs

@@ -6,7 +6,7 @@ mod imp;
 // Imports
 use crate::{
     FileType, RnApp, RnCanvas, RnCanvasWrapper, RnMainHeader, RnOverlays, RnSidebar, config,
-    dialogs, env,
+    dialogs, env, overlays,
 };
 use adw::{prelude::*, subclass::prelude::*};
 use core::cell::{Ref, RefMut};
@@ -335,6 +335,12 @@ impl RnAppWindow {
         if let Some(enable_text_preprocessing) = widget_flags.enable_text_preprocessing {
             canvas.set_text_preprocessing(enable_text_preprocessing);
         }
+        if let Some(popup_message) = widget_flags.popup_message {
+            self.overlays().dispatch_toast_text(
+                &gettext(popup_message),
+                overlays::TEXT_TOAST_TIMEOUT_DEFAULT,
+            );
+        }
     }
 
     /// Get the active (selected) tab page.