Stick windows to sides of workspaces

ash/wm/property_util.h

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef ASH_WM_PROPERTY_UTIL_H_
 #define ASH_WM_PROPERTY_UTIL_H_
 
 #include "ash/ash_export.h"
+#include "base/basictypes.h"
 
 namespace aura {
 class RootWindow;
 class Window;
 }
 
 namespace gfx {
 class Rect;
 }
 
@@ skipping 36 matching lines @@
 // Sets whether |window| should always be restored to the restore bounds
 // (sometimes the workspace layout manager restores the window to its original
 // bounds instead of the restore bounds. Setting this key overrides that
 // behaviour). The flag is reset to the default value after the window is
 // restored.
 ASH_EXPORT void SetWindowAlwaysRestoresToRestoreBounds(aura::Window* window,
                                                        bool value);
 ASH_EXPORT bool GetWindowAlwaysRestoresToRestoreBounds(
     const aura::Window* window);
 
+// Enum for possible edges that a window is docked on to the dock
+enum DockEdge {
+  DOCK_EDGE_NONE,
+  DOCK_EDGE_LEFT,
+  DOCK_EDGE_RIGHT,
+};

[flackr, 2013/06/03 22:03:43]

I'm not sure if we need to track which edge each window is docked too
individually. The dock should have an alignment and all windows would either be
docked or not docked. When the first window is added to the dock we can use its
bounds to determine the alignment for the dock.

[varkha, 2013/06/04 03:13:50]

I thought this allows to keep the logic of comparing bounds in only one place.
If we use one boolean property we would need to recalculate what we already did.
The performance hit is of course negligible but there would be some code
duplication that I was trying to avoid.

[flackr, 2013/06/04 19:58:10]

At the point when you determine the dock edge, you could call something on the
dock layout manager to set the side the dock is on and then you wouldn't have to
recalculate the side. But I understand the reasoning and leave it up to you.

+
+// Sets whether the specified window is docked near a screen edge.
+// Default is DOCK_EDGE_NONE and may change when a window is moved by user or
+// when the dock alignment is changed.

[flackr, 2013/06/03 22:03:43]

You mean when the shelf alignment is changed right?

[varkha, 2013/06/04 03:13:50]

Done.

+ASH_EXPORT void SetDockEdge(aura::Window* window, DockEdge value);
+ASH_EXPORT DockEdge GetDockEdge(const aura::Window* window);
+
 // Sets whether the specified window is tracked by workspace code. Default is
 // true. If set to false the workspace does not switch the current workspace,
 // nor does it attempt to impose constraints on the bounds of the window. This
 // is intended for tab dragging.
 ASH_EXPORT void SetTrackedByWorkspace(aura::Window* window, bool value);
 ASH_EXPORT bool GetTrackedByWorkspace(const aura::Window* window);
 
 // Makes |window| persist across all workspaces. The default is controlled
 // by SetDefaultPersistsAcrossAllWorkspaces().
 ASH_EXPORT void SetPersistsAcrossAllWorkspaces(
     aura::Window* window,
     WindowPersistsAcrossAllWorkspacesType type);
 ASH_EXPORT bool GetPersistsAcrossAllWorkspaces(aura::Window* window);
 
 // Sets the default value for whether windows persist across all workspaces.
 // The default is false.
 ASH_EXPORT void SetDefaultPersistsAcrossAllWorkspaces(bool value);
 
 // Sets/Gets the RootWindowController for |root_window|.
 ASH_EXPORT void SetRootWindowController(
     aura::RootWindow* root_window,
     internal::RootWindowController* controller);
 ASH_EXPORT internal::RootWindowController* GetRootWindowController(
     const aura::RootWindow* root_window);
 
 }
 
 #endif  // ASH_WM_PROPERTY_UTIL_H_