Merge lp:~donadigo/granite/saved-state-in-appclass into lp:~elementary-pantheon/granite/granite

[Adam Bieńkowski]

Fixes bug #1475825: Window states are saved inconsistently.

Fixes bug #1475825: Window states are saved inconsistently.

Saving state is implemented directly in Application class. To make window saving it's state simply set the GSettings schema path "settings_schema_id" to where you store your app settings and call add_window () in the application.

Much of the code was taken from the saved-state branch:
https://code.launchpad.net/~elementary-apps/granite/saved-state.

Process of porting apps:
* Remove old, separate saved-state code from the application.
* Add "saved-state" key to schema .xml file.
* Set settings_schema_id to where are the app settings stored.
* Call add_window () in the activate () method.

Example:
public class App : Granite.Application {
   ...

   public App () {
       ...
       settings_schema_id = "org.app";
       ...
   }

   public override void activate () {
       ...
       var window = new Gtk.Window ();
       add_window (window);

       window.show_all ();
       ...
   }
}

[Rico Tzschichholz (ricotz)]

Breaks ABI

[Rico Tzschichholz (ricotz)]

Public fields are a pain while it is hard enough to try keeping ABI-compatibility with vala.

[Zisu Andrei (matzipan)]

Hey Rico, can you advise on what one needs to do to avoid breaking ABI compatibility?

[lp:~donadigo/granite/saved-state-in-appclass]

934. By Adam Bieńkowski on 2016-07-18

Implement saved state in Application class

[Adam Bieńkowski (donadigo)]

@ricotz: is there anyway I can prevent a breakage in the ABI compatibility, and get this branch merged?

[Corentin Noël (tintou)]

Is this necessary ?

[Danielle Foré (danrabbit)]

Since this hasn't seen any movement in a few months, I'm going to mark it as "rejected". You can open a new PR on GitHub :)

Unmerged revisions

934. By Adam Bieńkowski on 2016-07-18

Implement saved state in Application class

=== modified file 'lib/Application.vala'
--- lib/Application.vala	2016-06-09 01:28:31 +0000
+++ lib/Application.vala	2016-07-18 12:15:21 +0000
@@ -35,6 +35,14 @@
      * to create a great deal of an app's functionality.
      */
     public abstract class Application : Gtk.Application {
+        private const string SETTINGS_KEY_NAME = "saved-state";
+
+        private enum WindowState {
+            NORMAL = 0,
+            MAXIMIZED = 1,
+            FULLSCREEN = 2,
+            MAXIMIZED_FULLSCREEN = 3
+        }
 
         public string build_data_dir;
         public string build_pkg_data_dir;
@@ -139,6 +147,33 @@
         public string about_license;
         public License about_license_type;
 
+
+        /**
+         * GSettings schema path to save added Gtk.Window state settings.
+         * This is where "saved-state" key will be created and stored
+         * for added Gtk.Window's: position and their state.
+         * You also need a proper saved-state key in your schema .xml file with the name "saved-state"
+         * with the type '(iiiiu)'
+         * where the types represent in the order of listing:
+         * x-coordinate of the window (the value -1 means centered window),
+         * y-coordinate of the window (the value -1 means centered window),
+         * width of the window,
+         * height of the window,
+         * state of the window (0 = Normal, 1 = Maximized, 2 = Fullscreen, 3 = Maximized and Fullscreen).
+         *
+         * This is an example:
+         * <key name="saved-state" type="(iiiiu)">
+         *     <default>(-1,-1,700,500,0)</default>
+         *     <summary>The saved state of the window.</summary>
+         *     <description>The saved width of the window. The values represent in the respective order:
+         *      x-coordinate of the window (the value -1 means centered window),y-coordinate of the window (the value -1 means centered window),
+         *      width of the window, height of the window, state of the window (0 = Normal, 1 = Maximized, 2 = Fullscreen).</description>
+         * </key>
+         */
+        public string settings_schema_id;
+
+        private HashTable<Gtk.Window, ulong> window_handlers = new HashTable<Gtk.Window, ulong> (null, null);
+
         /**
          * This creates a new Application class
          */
@@ -161,6 +196,9 @@
 
             add_actions ();
 
+            window_added.connect (on_window_added);
+            window_removed.connect (on_window_removed);
+
             // Deprecated
             Granite.app = this;
         }
@@ -205,6 +243,56 @@
             return base.run (args);
         }
 
+        private void on_window_added (Gtk.Window window) {
+            if (SettingsSchemaSource.get_default ().lookup (settings_schema_id, true) == null) {
+                return;
+            }
+
+            var settings = new GLib.Settings (settings_schema_id);
+            var tuple = settings.get_value (SETTINGS_KEY_NAME);
+
+            int x, y, width, height;
+            uint state;
+            tuple.@get ("(iiiiu)",
+                        out x,
+                        out y,
+                        out width,
+                        out height,
+                        out state);
+
+            if (x != -1 && y != -1) {
+                window.move (x, y);    
+            }
+            
+            window.set_default_size (width, height);
+            switch ((WindowState)state) {
+                case WindowState.MAXIMIZED:
+                    window.maximize ();
+                    break;
+                case WindowState.FULLSCREEN:
+                    window.fullscreen ();
+                    break;
+                case WindowState.MAXIMIZED_FULLSCREEN:
+                    window.maximize ();
+                    window.fullscreen ();
+                    break;
+                default:
+                    window.unfullscreen ();
+                    window.unmaximize ();
+                    break;
+            }
+
+            window_handlers.insert (window, window.delete_event.connect (on_window_delete_event));
+        }
+
+        private void on_window_removed (Gtk.Window window) {
+            if (!window_handlers.contains (window)) {
+                return;
+            }
+
+            window.disconnect (window_handlers.@get (window));
+        }
+
         protected static bool DEBUG = false;
         protected static bool ABOUT = false;
 
@@ -215,9 +303,9 @@
         };
 
         protected virtual void set_options () {
-
-            if (DEBUG)
+            if (DEBUG) {
                 Logger.DisplayLevel = LogLevel.DEBUG;
+            }
         }
 
         /**
@@ -333,5 +421,43 @@
                 Gtk.main ();
             }
         }
+
+        private WindowState get_window_state (Gtk.Widget widget) {
+            var window = widget.get_window ();
+            if ((window.get_state () & Gdk.WindowState.MAXIMIZED) != 0) {
+                if ((window.get_state () & Gdk.WindowState.FULLSCREEN) != 0) {
+                    return WindowState.MAXIMIZED_FULLSCREEN;
+                } else {
+                    return WindowState.MAXIMIZED;
+                }
+            } else if ((window.get_state () & Gdk.WindowState.FULLSCREEN) != 0) {
+                return WindowState.FULLSCREEN;
+            }
+
+            return WindowState.NORMAL;     
+        }
+
+        private bool on_window_delete_event (Gtk.Widget widget, Gdk.EventAny event) {
+            if (SettingsSchemaSource.get_default ().lookup (settings_schema_id, true) == null
+                || !(widget is Gtk.Window)) {
+                return false;
+            }
+
+            int x, y, width, height;
+
+            ((Gtk.Window)widget).get_size (out width, out height);
+            ((Gtk.Window)widget).get_position (out x, out y);
+
+            var settings = new GLib.Settings (settings_schema_id);
+            var v_x = new GLib.Variant.int32 (x);
+            var v_y = new GLib.Variant.int32 (y);
+            var v_width = new GLib.Variant.int32 (width);
+            var v_height = new GLib.Variant.int32 (height);
+            var v_state = new GLib.Variant.uint32 ((uint32)get_window_state (widget));
+
+            var tuple = new GLib.Variant.tuple ({ v_x, v_y, v_width, v_height, v_state });
+            settings.set_value (SETTINGS_KEY_NAME, tuple);
+            return false;
+        }
     }
 }