Added arrow key navigation to Overview Mode

ash/wm/overview/window_overview.h

 // Copyright 2013 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_OVERVIEW_WINDOW_OVERVIEW_H_
 #define ASH_WM_OVERVIEW_WINDOW_OVERVIEW_H_
 
+#include <vector>
+
 #include "base/compiler_specific.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/memory/scoped_vector.h"
 #include "base/time/time.h"
 #include "ui/aura/window_tracker.h"
 #include "ui/events/event_handler.h"
 #include "ui/gfx/display_observer.h"
 #include "ui/gfx/rect.h"
+#include "ui/gfx/vector2d.h"
 
 namespace aura {
 class Window;
 namespace client {
 class CursorClient;
 }
 }  // namespace aura
 
 namespace ui {
 class LocatedEvent;
 }
 
 namespace views {
 class Widget;
 }
 
 namespace ash {
 
 class WindowSelector;
 class WindowSelectorItem;
 
+// Represents a grid of windows in OM. Useful for arrow key navigation.

[tdanderson, 2014/04/29 14:46:27]

"OM" -> "Overview Mode"

[Nina, 2014/04/29 18:31:40]

Done.

+struct WindowGrid {
+  size_t rows;
+  size_t columns;
+  size_t windows;
+  aura::Window* root_window;
+  std::vector<std::vector<WindowSelectorItem*> > window_matrix;
+};
+
+// Represents the position of the cursor in the screen.
+struct ArrowCursor {
+  size_t x;
+  size_t y;
+  bool primary_display;
+};
+
 // The WindowOverview shows a grid of all of your windows and allows selecting
 // a window by clicking or tapping on it. It also displays a selection widget
 // used to indicate the current selection when alt-tabbing between windows.
 class WindowOverview : public ui::EventHandler,
                        public gfx::DisplayObserver {
  public:
   typedef ScopedVector<WindowSelectorItem> WindowSelectorItemList;
 
   // Enters an overview mode displaying |windows| and dispatches methods
   // on |window_selector| when a window is selected or selection is canceled.
   // If |single_root_window| is not NULL, all windows will be positioned on the
   // given root window.
   WindowOverview(WindowSelector* window_selector,
                  WindowSelectorItemList* windows,
                  aura::Window* single_root_window);
   virtual ~WindowOverview();
 
-  // Sets the selected window to be the window in position |index|.
+  // Sets the selected window to be the window in position |index|, according to
+  // MRU order.
   void SetSelection(size_t index);
 
   // Dispatched when the list of windows has changed.
   void OnWindowsChanged();
 
   // Moves the overview to only |root_window|.
   void MoveToSingleRootWindow(aura::Window* root_window);
 
   // ui::EventHandler:
   virtual void OnKeyEvent(ui::KeyEvent* event) OVERRIDE;
   virtual void OnMouseEvent(ui::MouseEvent* event) OVERRIDE;
   virtual void OnScrollEvent(ui::ScrollEvent* event) OVERRIDE;
   virtual void OnTouchEvent(ui::TouchEvent* event) OVERRIDE;
 
   // gfx::DisplayObserver:
   virtual void OnDisplayBoundsChanged(const gfx::Display& display) OVERRIDE;
   virtual void OnDisplayAdded(const gfx::Display& display) OVERRIDE;
   virtual void OnDisplayRemoved(const gfx::Display& display) OVERRIDE;
 
  private:
+  enum Direction {
+    DOWN,
+    UP,
+    RIGHT,
+    LEFT,
+    NONE
+  };

[tdanderson, 2014/04/29 14:46:27]

space

[Nina, 2014/04/29 18:31:40]

Done.

+  // Moves the selection widget to the specified window |target| fading out in
+  // the specified |fade_out_direction|.
+  void MoveSelectionWidget(WindowSelectorItem* target,
+                           gfx::Vector2d* fade_out_direction);
+
   // Returns the target of |event| or NULL if the event is not targeted at
   // any of the windows in the selector.
   aura::Window* GetEventTarget(ui::LocatedEvent* event);
 
   // Returns the top-level window selected by targeting |window| or NULL if
   // no overview window was found for |window|.
   aura::Window* GetTargetedWindow(aura::Window* window);
 
   // Hide and track all hidden windows not in overview.
   void HideAndTrackNonOverviewWindows();
 
   // Position all of the windows based on the current selection mode.
   void PositionWindows(bool animate);
   // Position all of the windows from |root_window| on |root_window|.
   void PositionWindowsFromRoot(aura::Window* root_window, bool animate);
   // Position all of the |windows| to fit on the |root_window|.
   void PositionWindowsOnRoot(aura::Window* root_window,
                              const std::vector<WindowSelectorItem*>& windows,
                              bool animate);
 
   // Creates the selection widget.
-  void InitializeSelectionWidget();
+  void InitializeSelectionWidget(aura::Window* root_window);
 
-  // Returns the bounds for the selection widget for the windows_ at |index|.
-  gfx::Rect GetSelectionBounds(size_t index);
+  // Moves the selection widget one step in a certain direction. Called when
+  // pressing an arrow key.
+  void MoveSelector(Direction direction);
+
+  // "Resets" the selection widget when recreating the overview after a window
+  // is closed, moving it to a new position.
+  void ResetSelectionWidget();
+
+  // Returns the bounds for the selection widget for the specified |window|

[tdanderson, 2014/04/29 14:46:27]

. at end

+  gfx::Rect GetSelectionBounds(WindowSelectorItem* window);
+
+  // Return a window by index, either by |mru| order or spatial order.
+  WindowSelectorItem* GetWindowByIndex(size_t index, bool mru);
 
   // Weak pointer to the window selector which owns this class.
   WindowSelector* window_selector_;
 
   // A weak pointer to the collection of windows in the overview wrapped by a
   // helper class which restores their state and helps transform them to other
   // root windows.
   WindowSelectorItemList* windows_;
 
   // Widget indicating which window is currently selected.
   scoped_ptr<views::Widget> selection_widget_;
 
-  // Index of the currently selected window. This is used to determine when the
-  // selection changes rows and use a different animation.
-  size_t selection_index_;
+  // Pointer to the currently selected window. This is used for the arrow key

[tdanderson, 2014/04/29 14:46:27]

Indicate in the comment that this is NULL if no window is currently selected.

+  // navigation.
+  ash::WindowSelectorItem* selected_window_;

[tdanderson, 2014/04/29 14:46:27]

ash:: not needed

 
   // If NULL, each root window displays an overview of the windows in that
   // display. Otherwise, all windows are in a single overview on
   // |single_root_window_|.
   aura::Window* single_root_window_;
 
   // The time when overview was started.
   base::Time overview_start_time_;
 
   // The cursor client used to lock the current cursor during overview.
   aura::client::CursorClient* cursor_client_;
 
   // Tracks windows which were hidden because they were not part of the
   // overview.
   aura::WindowTracker hidden_windows_;
 
+  // Each grid represents the arrangement of windows in the screen while in
+  // overview mode.
+  WindowGrid main_grid_;
+  WindowGrid secondary_grid_;
+
+  // Used to store the location of the cursor used to select with the arrow
+  // keys.
+  ArrowCursor arrow_cursor_;

[tdanderson, 2014/04/29 14:46:27]

When I hear "arrow cursor" I think of an arrow-shaped mouse cursor, so for that
reason I don't like this name. I'd prefer if we used the term "selection widget"
consistently.

[Nina, 2014/04/29 18:31:40]

Done.

+
   DISALLOW_COPY_AND_ASSIGN(WindowOverview);
 };
 
 }  // namespace ash
 
 #endif  // ASH_WM_OVERVIEW_WINDOW_OVERVIEW_H_