Merge lp:~donadigo/screenshot-tool/box-selection into lp:~elementary-apps/screenshot-tool/trunk

[Adam Bieńkowski]

* Use box selection for area selection
* Ignore window struts

This branch changes the current behaviour of area selection to be a selection box rather than a static window which can be moved / resized.

It also fixes the issue with window struts which are now ignored by setting the window type to POPUP.

Previous iterations of this code were using "begin_resize_drag" which didn't really fit the purpose of box selection, so I changed it to manual handling of events much of how it is in the gnome-screenshot.

The diff also features a little bit of codestyle (and logic) fixes.

[lp:~donadigo/screenshot-tool/box-selection]

221. By Adam Bieńkowski on 2016-09-03

Fix area command line argument

222. By Adam Bieńkowski on 2016-09-03

Public back to private

223. By Adam Bieńkowski on 2016-09-03

Actually close on escape from area selection

=== modified file 'src/Screenshot.vala'
--- src/Screenshot.vala	2016-06-24 09:19:54 +0000
+++ src/Screenshot.vala	2016-09-03 19:11:26 +0000
@@ -142,13 +142,7 @@
             } else {
                 window = new ScreenshotWindow.from_cmd (action, delay, grab_pointer, redact);
                 window.set_application (this);
-                window.show_all ();
-
-                if (action != 3) {
-                    window.take_clicked ();
-                } else {
-                    window.present ();
-                }
+                window.take_clicked ();
             }
 
             return 0;

=== modified file 'src/ScreenshotWindow.vala'
--- src/ScreenshotWindow.vala	2016-05-08 03:12:21 +0000
+++ src/ScreenshotWindow.vala	2016-09-03 19:11:26 +0000
@@ -47,9 +47,6 @@
         private bool redact;
         private int delay;
 
-        private Screenshot.Widgets.SelectionArea    selection_area;
-        private Screenshot.Widgets.SaveDialog       save_dialog;
-
         /**
          *  ScreenshotWindow Constructor
          */
@@ -189,33 +186,15 @@
              */
             all.toggled.connect (() => {
                 capture_mode = CaptureType.SCREEN;
-
-                if (selection_area != null) {
-                    selection_area.destroy ();
-                    selection_area = null;
-                }
             });
 
             curr_window.toggled.connect (() => {
                 capture_mode = CaptureType.CURRENT_WINDOW;
-
-                if (selection_area != null) {
-                    selection_area.destroy ();
-                    selection_area = null;
-                }
             });
 
             selection.toggled.connect (() => {
                 capture_mode = CaptureType.AREA;
-
-                if (selection_area == null) {
-                    selection_area = new Screenshot.Widgets.SelectionArea ();
-				    selection_area.show_all ();
-                } else
-                    selection_area.present ();
-
-                set_transient_for (selection_area);
-                present();
+                present ();
             });
 
             pointer_switch.notify["active"].connect (() => {
@@ -241,84 +220,69 @@
             take_btn.clicked.connect (take_clicked);
             cancel_btn.clicked.connect (cancel_clicked);
 
-            focus_in_event.connect (() => {
-                if (selection_area != null && selection_area.is_visible ()) {
-                    selection_area.present ();
-                    this.present ();
-                } else {
-                    this.present ();
-                }
-
-                return false;
-            });
-
             // Pack the main grid into the window
             Gtk.Box content = get_content_area () as Gtk.Box;
             content.add (grid);
         }
 
-        private bool grab_save (Gdk.Window win, bool extra_time) {
+        private bool grab_save (Gdk.Window? win, bool extra_time) {
             if (extra_time) {
                 redact_text (true);
-                Timeout.add (1000, () => {
-                    grab_save (win, false);
-                    return false;
+                Timeout.add_seconds (1, () => {
+                    return grab_save (win, false);
                 });
 
                 return false;
             }
 
-            Timeout.add (250, () => {
-                selection_area.set_opacity (1);
-                this.set_opacity (1);
-                return false;
-            });
-
-            Gdk.Pixbuf      screenshot;
-            Gdk.Rectangle   win_rect;
-            int             width, height;
-
-            win_rect = Gdk.Rectangle ();
-
-            width = win.get_width ();
-            height = win.get_height ();
-
-            screenshot = Gdk.pixbuf_get_from_window (win, 0, 0, width, height);
-
-            win_rect.x = 0;
-            win_rect.y = 0;
-            win_rect.width = width;
-            win_rect.height = height;
-
+            var win_rect = Gdk.Rectangle ();
+            var root = Gdk.get_default_root_window ();
+
+            if (win == null) {
+                win = root;  
+            }
+
+            Gdk.Pixbuf? screenshot;
             if (capture_mode == CaptureType.AREA) {
-
-                screenshot = new Gdk.Pixbuf.subpixbuf (screenshot, selection_area.x, selection_area.y, selection_area.w, selection_area.h);
-
-                win_rect.x = selection_area.x;
-                win_rect.y = selection_area.y;
-                win_rect.width = selection_area.w;
-                win_rect.height = selection_area.h;
+                Gdk.Rectangle selection_rect;
+                win.get_frame_extents (out selection_rect);
+
+                screenshot = new Gdk.Pixbuf.subpixbuf (Gdk.pixbuf_get_from_window (root, 0, 0, root.get_width (), root.get_height ()),
+                                                    selection_rect.x, selection_rect.y, selection_rect.width, selection_rect.height);
+
+                win_rect.x = selection_rect.x;
+                win_rect.y = selection_rect.y;
+                win_rect.width = selection_rect.width;
+                win_rect.height = selection_rect.height;
+            } else {
+                int width = win.get_width ();
+                int height = win.get_height ();
+
+                screenshot = Gdk.pixbuf_get_from_window (win, 0, 0, width, height);
+
+                win_rect.x = 0;
+                win_rect.y = 0;
+                win_rect.width = width;
+                win_rect.height = height;
+            }
+
+            if (screenshot == null) {
+                show_error_dialog ();
+                return false;
             }
 
             if (mouse_pointer) {
-
-                Gdk.Cursor      cursor;
-                Gdk.Pixbuf      cursor_pixbuf;
-
-                cursor = new Gdk.Cursor.for_display (Gdk.Display.get_default (), Gdk.CursorType.LEFT_PTR);
-                cursor_pixbuf = cursor.get_image ();
+                var cursor = new Gdk.Cursor.for_display (Gdk.Display.get_default (), Gdk.CursorType.LEFT_PTR);
+                var cursor_pixbuf = cursor.get_image ();
 
                 if (cursor_pixbuf != null) {
-
-                    Gdk.DeviceManager   manager;
-                    Gdk.Device          device;
-                    Gdk.Rectangle       cursor_rect;
-                    int                 cx, cy;
-
-                    manager = Gdk.Display.get_default ().get_device_manager ();
-                    device = manager.get_client_pointer ();
+                    var manager = Gdk.Display.get_default ().get_device_manager ();
+                    var device = manager.get_client_pointer ();
+
+                    int cx, cy;
                     win.get_device_position (device, out cx, out cy, null);
-                    cursor_rect = Gdk.Rectangle ();
+
+                    var cursor_rect = Gdk.Rectangle ();
 
                     cursor_rect.x = cx + win_rect.x;
                     cursor_rect.y = cy + win_rect.y;
@@ -335,12 +299,11 @@
                 redact_text (false);
             }
 
-            save_dialog = new Screenshot.Widgets.SaveDialog (screenshot, settings, this);
-
+            var save_dialog = new Screenshot.Widgets.SaveDialog (screenshot, settings, this);
             save_dialog.save_response.connect ((response, folder_dir, output_name, format) => {
                 save_dialog.destroy ();
 
-                if (response == true) {
+                if (response) {
                     string[] formats = {".png", ".jpg", ".jpeg",".bmp", ".tiff"};
                     string output = output_name;                    
 
@@ -353,16 +316,11 @@
                     try {
                         screenshot.save (file_name, format);
 
-                        if (close_on_save == true) {
+                        if (close_on_save) {
                             this.destroy ();
                         }
                     } catch (GLib.Error e) {
-                        Gtk.MessageDialog dialog = new Gtk.MessageDialog (this, Gtk.DialogFlags.MODAL, Gtk.MessageType.ERROR,
-                            Gtk.ButtonsType.CLOSE, _("Could not capture screenshot"));
-                        dialog.secondary_text = _("Image not saved");
-                        dialog.deletable = false;
-                        dialog.run ();
-                        dialog.destroy ();
+                        show_error_dialog ();
                         debug (e.message);
                     }
                 }
@@ -376,6 +334,8 @@
                 this.destroy ();
             });
 
+            save_dialog.show_all ();
+
             return false;
         }
 
@@ -394,18 +354,12 @@
         }
 
         private void capture_screen () {
-            Gdk.Window win = null;
-
-            win = Gdk.get_default_root_window();
-
-            this.set_opacity (0);
             this.hide ();
-            Timeout.add (delay * 1000 - (redact? 1000 : 0), () => {
+
+            Timeout.add_seconds (delay - (redact ? 1 : 0), () => {
                 this.present ();
-                grab_save (win, redact);
-                return false;
+                return grab_save (null, redact);
             });
-
         }
 
         private void capture_window () {
@@ -415,9 +369,8 @@
 
             screen = Gdk.Screen.get_default ();
 
-            this.set_opacity (0);
             this.hide ();
-            Timeout.add (delay * 1000 - (redact? 1000 : 0), () => {
+            Timeout.add_seconds (delay - (redact ? 1 : 0), () => {
                 list = screen.get_window_stack ();
                 foreach (Gdk.Window item in list) {
                     if (screen.get_active_window () == item) {
@@ -427,17 +380,15 @@
 
                 this.present ();
 
-                if (win != null)
+                if (win != null) {
                     grab_save (win, redact);
-                else {
+                } else {
                     Gtk.MessageDialog dialog = new Gtk.MessageDialog (this, Gtk.DialogFlags.MODAL, Gtk.MessageType.ERROR,
-                    Gtk.ButtonsType.CLOSE, _("Could not capture screenshot"));
+                                                                    Gtk.ButtonsType.CLOSE, _("Could not capture screenshot"));
                     dialog.secondary_text = _("Couldn't find an active window");
                     dialog.deletable = false;
                     dialog.run ();
                     dialog.destroy ();
-
-                    this.set_opacity (1);
                 }
 
                 return false;
@@ -445,22 +396,37 @@
         }
 
         private void capture_area () {
-            Gdk.Window win = null;
-
-            win = Gdk.get_default_root_window();
-
-            selection_area.set_opacity (0);
-            selection_area.hide ();
-            this.set_opacity (0);
+            var selection_area = new Screenshot.Widgets.SelectionArea ();
+            selection_area.show_all ();
             this.hide ();
 
-            Timeout.add (delay * 1000 - (redact? 1000 : 0), () => {
-                this.present ();
-                selection_area.present ();
-                grab_save (win, redact);
-
-                return false;
-            });
+            selection_area.cancelled.connect (() => {
+                selection_area.close ();
+                if (close_on_save) {
+                    this.destroy ();
+                } else {
+                    this.present ();
+                }
+            });
+
+            var win = selection_area.get_window ();
+
+            selection_area.captured.connect (() => {
+                selection_area.close ();
+                Timeout.add_seconds (delay - (redact ? 1 : 0), () => {
+                    this.present ();
+                    return grab_save (win, redact);
+                });
+            });
+        }
+
+        private void show_error_dialog () {
+            var dialog = new Gtk.MessageDialog (this, Gtk.DialogFlags.MODAL, Gtk.MessageType.ERROR,
+                                                Gtk.ButtonsType.CLOSE, _("Could not capture screenshot"));
+            dialog.secondary_text = _("Image not saved");
+            dialog.deletable = false;
+            dialog.run ();
+            dialog.destroy ();
         }
 
         private void redact_text (bool redact) {

=== modified file 'src/Widgets/SaveDialog.vala'
--- src/Widgets/SaveDialog.vala	2016-07-29 23:27:41 +0000
+++ src/Widgets/SaveDialog.vala	2016-09-03 19:11:26 +0000
@@ -50,7 +50,6 @@
                 folder_dir = settings.get_string ("folder-dir");
 
             build (pixbuf, settings, parent);
-            show_all ();
             name_entry.grab_focus ();
         }
 

=== modified file 'src/Widgets/SelectionArea.vala'
--- src/Widgets/SelectionArea.vala	2016-03-09 14:14:00 +0000
+++ src/Widgets/SelectionArea.vala	2016-09-03 19:11:26 +0000
@@ -17,122 +17,135 @@
 ***/
 
 namespace Screenshot.Widgets {
-
-    /**
-     *  Code stolen from Eidete program with some adjustments.
-     */
     public class SelectionArea : Granite.Widgets.CompositedWindow {
-
-        private int[,] pos;
-
-        public int x;
-        public int y;
-        public int w;
-        public int h;
+        public signal void captured ();
+        public signal void cancelled ();
+
+        private Gdk.Point start_point;
+
+        private bool dragging = false;
+
+        construct {
+            type = Gtk.WindowType.POPUP;
+        }
 
         public SelectionArea () {
-
             stick ();
             set_resizable (true);
             set_deletable (false);
             set_has_resize_grip (false);
-            set_default_geometry (640, 480);
-            set_type_hint (Gdk.WindowTypeHint.DIALOG);
-            events = Gdk.EventMask.BUTTON_MOTION_MASK | Gdk.EventMask.BUTTON1_MOTION_MASK |
-                     Gdk.EventMask.BUTTON_PRESS_MASK | Gdk.EventMask.BUTTON_RELEASE_MASK ;
             set_skip_taskbar_hint (true);
             set_skip_pager_hint (true);
-
-            button_press_event.connect ((e) => {
-                Gdk.WindowEdge [] dir = {Gdk.WindowEdge.NORTH_WEST,
-                                         Gdk.WindowEdge.NORTH,Gdk.WindowEdge.NORTH_EAST,
-                                         Gdk.WindowEdge.EAST,Gdk.WindowEdge.SOUTH_EAST,Gdk.WindowEdge.SOUTH,
-                                         Gdk.WindowEdge.SOUTH_WEST,Gdk.WindowEdge.WEST};
-
-                for (var i=0;i<8;i++){
-                    if (in_quad (pos[i,0]-12, pos[i,1]-10, 24, 24, (int) e.x, (int) e.y)){
-                        begin_resize_drag (dir[i], (int) e.button, (int) e.x_root, (int) e.y_root, e.time);
-
-                        return false;
-                    }
-                }
-                begin_move_drag ((int) e.button, (int) e.x_root, (int) e.y_root, e.time);
-
-                return false;
-            });
-
-            configure_event.connect ((e) => {
-
-                /**
-                 *  Check if coordinates are out of the screen and check
-                 *  if coordinate + width/height is out of the screen, then
-                 *  adjust coordinates to keep width and height (and aspect
-                 *  ratio) intact.
-                 */
-                if(e.x < 0 || e.x > e.window.get_screen().get_width()) {
-                    x = 0;
-                } else if (e.x + e.width > e.window.get_screen().get_width() && e.width < e.window.get_screen().get_width()) {
-                    x = e.window.get_screen().get_width() - e.width;
-                } else {
-                    x = e.x;
-                }
-
-                if(e.y < 0) {
-                    y = 0;
-                } else if (e.y + e.height >= e.window.get_screen().get_height() && e.height < e.window.get_screen().get_height()) {
-                    y = e.window.get_screen().get_height() - e.height - 1;
-                } else {
-                    y = e.y;
-                }
-
-                /**
-                 *  Just in case an edge is still outside of the screen
-                 *  we'll modify the width/height if thats the case.
-                 */
-                if (x + e.width > e.window.get_screen().get_width()) {
-                    w = e.window.get_screen ().get_width() - x;
-                } else {
-                    w = e.width;
-                }
-
-                if(y + e.height > e.window.get_screen().get_height()) {
-                    h = e.window.get_screen().get_height() - y;
-                } else {
-                    h = e.height;
-                }
-
-                return false;
-            });
-        }
-
-        private bool in_quad (int qx, int qy, int qh, int qw, int x, int y){
-            return ((x>qx) && (x<(qx+qw)) && (y>qy) && (y<qy+qh));
-        }
-
-        public override bool draw (Cairo.Context ctx){
-
-            int w = this.get_allocated_width    ();
-            int h = this.get_allocated_height   ();
-            int r = 12;
-
-            pos = {{1, 1},      // upper left
-                   {w/2, 1},    // upper midpoint
-                   {w-1, 1},    // upper right
-                   {w-1, h/2},  // right midpoint
-                   {w-1, h-1},  // lower right
-                   {w/2, h-1},  // lower midpoint
-                   {1, h-1},    // lower left
-                   {1, h/2}};   // left midpoint
+            set_keep_above (true);
+
+            var screen = get_screen ();
+            set_default_size (screen.get_width (), screen.get_height ());
+        }
+
+        public override bool button_press_event (Gdk.EventButton e) {
+            if (dragging || e.button != 1) {
+                return true;
+            }
+
+            dragging = true;
+
+            start_point.x = (int)e.x_root;
+            start_point.y = (int)e.y_root;
+
+            return true;            
+        }
+
+        public override bool button_release_event (Gdk.EventButton e) {
+            if (!dragging || e.button != 1) {
+                return true;
+            }
+
+            dragging = false;
+            captured ();
+
+            return true;            
+        }
+
+        public override bool motion_notify_event (Gdk.EventMotion e) {
+            if (!dragging) {
+                return true;
+            }
+
+            int x = start_point.x;
+            int y = start_point.y;
+
+            int width = (x - (int)e.x_root).abs ();
+            int height = (y - (int)e.y_root).abs ();
+            if (width < 1 || height < 1) {
+                return true;
+            }
+
+            x = int.min (x, (int)e.x_root);
+            y = int.min (y, (int)e.y_root);
+
+            move (x, y);
+            resize (width, height);
+
+            return true;            
+        }
+
+        public override bool key_press_event (Gdk.EventKey e) {
+            if (e.keyval == Gdk.Key.Escape) {
+                cancelled ();
+            }
+
+            return true;            
+        }
+
+        public override void show_all () {
+            base.show_all ();
+            var manager = Gdk.Display.get_default ().get_device_manager ();
+            var pointer = manager.get_client_pointer ();
+            var keyboard = pointer.get_associated_device ();
+            var window = get_window ();
+
+            var status = pointer.grab (window,
+                        Gdk.GrabOwnership.NONE,
+                        false,
+                        Gdk.EventMask.BUTTON_PRESS_MASK | Gdk.EventMask.BUTTON_RELEASE_MASK | Gdk.EventMask.POINTER_MOTION_MASK,
+                        new Gdk.Cursor.for_display (window.get_display (), Gdk.CursorType.CROSSHAIR),
+                        Gtk.get_current_event_time ());
+
+            if (status != Gdk.GrabStatus.SUCCESS) {
+                pointer.ungrab (Gtk.get_current_event_time ());
+            }
+
+            if (keyboard != null) {
+                status = keyboard.grab (window,
+                        Gdk.GrabOwnership.NONE,
+                        false,
+                        Gdk.EventMask.KEY_PRESS_MASK,
+                        null,
+                        Gtk.get_current_event_time ());
+
+                if (status != Gdk.GrabStatus.SUCCESS) {
+                    keyboard.ungrab (Gtk.get_current_event_time ());
+                }                
+            }
+        }
+
+        public new void close () {
+            get_window ().set_cursor (null);
+            base.close ();
+        }
+
+        public override bool draw (Cairo.Context ctx) {
+            if (!dragging) {
+                return true;
+            }
+
+            int w = get_allocated_width ();
+            int h = get_allocated_height ();
 
             ctx.rectangle (0, 0, w, h);
             ctx.set_source_rgba (0.1, 0.1, 0.1, 0.2);
             ctx.fill ();
 
-            for (var i=0;i<8;i++){
-                ctx.arc (pos[i,0], pos[i,1], r, 0.0, 2*3.14);
-                ctx.set_source_rgb (0.7, 0.7, 0.7);
-                ctx.fill ();
-            }
             ctx.rectangle (0, 0, w, h);
             ctx.set_source_rgb (0.7, 0.7, 0.7);
             ctx.set_line_width (1.0);