Persistent centered mode (aka "Sticky Centering") (#482)

Fixes #332, #299.

Implements focus modes (refer to README.md for more informatin) and adds a CENTER mode, which when applied causes all windows to center horizontally on window selection.

Focus modes can be toggled via keybinding or a new focus mode icon in the topbar.

README.md

@@ -274,15 +274,15 @@ Keybindings.bindkey("<Super>j", "my-favorite-width",
 
 See `examples/keybindings.js` for more examples.
 
-### Window Position Bar (colored bar segment added to Gnome Top Bar)
+## Window Position Bar (colored bar segment in Top Bar)
 
 
 
 [#476](https://github.com/paperwm/PaperWM/pull/476) added a coloured window position bar to the Gnome Top Bar.  This allows users to visually identify the current selected window position of the scrollable viewport in the current workspace.  This is demonstrated in the following video:
 
 https://user-images.githubusercontent.com/30424662/221416159-464d7512-5174-451b-9035-0ee84f9eb4ec.mp4
 
-The the window position bar can be _disabled_ from `PaperWM extension settings` or via `dconf`, e.g. by executing the following command a terminal: 
+The the window position bar can be _disabled_ from `PaperWM extension settings` or via `dconf`, e.g. by executing the following command in a terminal: 
 
 ```
 dconf write /org/gnome/shell/extensions/paperwm/show-window-position-bar false
@@ -292,6 +292,21 @@ You can style both the coloured position bar and the dimmed "position bar backdr
 
 _Note: PaperWM overrides the default Gnome Top Bar style to be completely transparent so that the dimmed `window-position-bar-backdrop` and`window-position-bar` elements are visible._
 
+## Window Focus Mode ##
+
+[#482](https://github.com/paperwm/PaperWM/pull/482) added the concept of `window focus modes` to PaperWM.  A `focus mode` controls how windows are "focused".  For example, the `CENTER` focus mode causes all windows to be centered horizontally on selection, whereas the `DEFAULT` focus mode is the traditional PaperWM behaviour.
+
+Focus modes can be toggled by user-settable keybinding (default is `Super`+`Shift`+`c`), or by clicking the new focus-mode button in the topbar:
+
+![Focus mode button](media/focus-mode-button.png)
+
+You may prefer to hide the focus mode icon.  You can do so by executing the following command in a terminal:
+
+```
+dconf write /org/gnome/shell/extensions/paperwm/show-focus-mode-icon false
+```
+
+
 ## Fixed Window Size ##
 
 See the [Winprops](#winprops) section for a way to set the default _width_ of windows identified by their `wm_class` window property.

keybindings.js

@@ -160,6 +160,10 @@ function init() {
                                              Scratch),
                         Meta.KeyBindingFlags.PER_WINDOW);
 
+    registerPaperAction("switch-focus-mode",
+                        dynamic_function_ref("switchToNextFocusMode",
+                                             Tiling));
+
     registerPaperAction("develop-set-globals",
                         dynamic_function_ref("setDevGlobals",
                                              Utils));

minimap.js

@@ -122,7 +122,7 @@ var Minimap = class Minimap extends Array {
         }
 
         this.layout();
-        let time = animate ? 0.25 : 0;
+        let time = animate ? prefs.animation_time : 0;
         this.actor.show();
         Tweener.addTween(this.actor,
                          {opacity: 255, time, mode: Clutter.AnimationMode.EASE_OUT_EXPO});
@@ -131,7 +131,7 @@ var Minimap = class Minimap extends Array {
     hide(animate) {
         if (this.destroyed)
             return;
-        let time = animate ? 0.25 : 0;
+        let time = animate ? prefs.animation_time : 0;
         Tweener.addTween(this.actor,
                          {opacity: 0, time, mode: Clutter.AnimationMode.EASE_OUT_EXPO,
                           onComplete: () => this.actor.hide() });

navigator.js

@@ -261,7 +261,7 @@ class NavigatorClass {
         this._block = Main.wm._blockAnimations;
         Main.wm._blockAnimations = true;
         // Meta.disable_unredirect_for_screen(screen);
-        this.space = Tiling.spaces.spaceOf(workspaceManager.get_active_workspace());
+        this.space = Tiling.spaces.getActiveSpace();
 
         this._startWindow = this.space.selectedWindow;
         this.from = this.space;

prefsKeybinding.js

@@ -37,6 +37,7 @@ const actions = {
         'switch-last',
         'live-alt-tab',
         'live-alt-tab-backward',
+        'switch-focus-mode',
         'move-left',
         'move-right',
         'move-up',

resources/ICONS.info

@@ -0,0 +1,9 @@
+SVG icons adapted from `sidebar-show-right-symbolic.svg` and `preferences-desktop-multitasking-symbolic.svg` icons from "GNOME Project" adwaita-icon-theme (https://github.com/GNOME/adwaita-icon-theme).
+
+See http://www.gnome.org for more information.
+
+The icons are licensed under Creative Commons Attribution-Share Alike 3.0 United States License.
+
+To view a copy of the CC-BY-SA licence, visit
+http://creativecommons.org/licenses/by-sa/3.0/ or send a letter to Creative
+Commons, 171 Second Street, Suite 300, San Francisco, California 94105, USA.

schemas/org.gnome.shell.extensions.paperwm.gschema.xml

@@ -108,6 +108,11 @@
         <default><![CDATA[['<Super>t']]]></default>
         <summary>Take the window, dropping it when finished navigating</summary>
     </key>
+
+    <key type="as" name="switch-focus-mode">
+      <default><![CDATA[['<Super><Shift>c']]]></default>
+      <summary>Switch between Window Focus Modes (e.g. default, center)</summary>
+    </key>
 
     <key type="as" name="switch-next">
       <default><![CDATA[['<Super>period']]]></default>
@@ -243,7 +248,7 @@
       </key>
       <key type="b" name="show-top-bar">
           <default>true</default>
-          <summary>Wether to hide the top bar or not</summary>
+          <summary>Show the topbar</summary>
       </key>
       <key type="s" name="color">
           <default>''</default>
@@ -374,6 +379,11 @@
         <summary>Show the window position bar in the topbar</summary>
     </key>
 
+    <key type="b" name="show-focus-mode-icon">
+        <default>true</default>
+        <summary>Show the focus mode icon in the topbar</summary>
+    </key>
+
     <key type="d" name="animation-time">
         <default>0.25</default>
         <summary>Duration of animations in seconds</summary>

settings.js

@@ -35,7 +35,7 @@ var prefs = {};
  'workspace-colors', 'default-background', 'animation-time', 'use-workspace-name',
  'pressure-barrier', 'default-show-top-bar', 'swipe-sensitivity', 'swipe-friction',
  'cycle-width-steps', 'cycle-height-steps', 'topbar-follow-focus', 'minimap-scale', 
- 'winprops', 'show-window-position-bar']
+ 'winprops', 'show-window-position-bar', 'show-focus-mode-icon']
     .forEach((k) => setState(null, k));
 
 prefs.__defineGetter__("minimum_margin", function() { return Math.min(15, this.horizontal_margin) });

stylesheet.css

@@ -1,3 +1,25 @@
+.space-label-wrapper {
+    padding: 0 10px 0 0;
+    background-color: transparent;
+    border-image: none;
+    background-image: none;
+    border: none;
+}
+
+.space-focus-mode-icon {
+    icon-size: 16px;
+    padding: 0 18px 0 18px;
+    margin-left: 3px;
+    background-color: transparent;
+}
+
+.focus-button-tooltip {
+    background-color: rgba(0, 0, 0, 0.7);
+    padding: 8px;
+    border-radius: 8px;
+    font-weight: 600;
+}
+
 .topbar-clear {
     background-color: rgba(0, 0, 0, 0);
 }