1 // Copyright 2014 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
5 #ifndef ASH_WM_OVERVIEW_WINDOW_GRID_H_
6 #define ASH_WM_OVERVIEW_WINDOW_GRID_H_
10 #include "ash/wm/overview/window_selector.h"
11 #include "base/macros.h"
12 #include "base/memory/scoped_ptr.h"
13 #include "ui/aura/window_observer.h"
25 class WindowSelectorItem;
27 // Represents a grid of windows in the Overview Mode in a particular root
28 // window, and manages a selection widget that can be moved with the arrow keys.
29 // The idea behind the movement strategy is that it should be possible to access
30 // any window pressing a given arrow key repeatedly.
31 // +-------+ +-------+ +-------+
33 // +-------+ +-------+ +-------+
34 // +-------+ +-------+ +-------+
36 // +-------+ +-------+ +-------+
41 // - Going right to left
42 // 0, 1, 2, 3, 4, 5, 6
43 // - Going "top" to "bottom"
44 // 0, 3, 6, 1, 4, 2, 5
45 // The selector is switched to the next window grid (if available) or wrapped if
46 // it reaches the end of its movement sequence.
47 class ASH_EXPORT WindowGrid : public aura::WindowObserver {
49 WindowGrid(aura::Window* root_window,
50 const std::vector<aura::Window*>& window_list,
51 WindowSelector* window_selector);
52 virtual ~WindowGrid();
54 // Positions all the windows in the grid.
55 void PositionWindows(bool animate);
57 // Updates |selected_index_| according to the specified |direction| and calls
58 // MoveSelectionWidget(). Returns |true| if the new selection index is out of
59 // this window grid bounds.
60 bool Move(WindowSelector::Direction direction);
62 // Returns the target selected window, or NULL if there is none selected.
63 WindowSelectorItem* SelectedWindow() const;
65 // Returns true if a window is contained in any of the WindowSelectorItems
67 bool Contains(const aura::Window* window) const;
69 // Returns true if the grid has no more windows.
70 bool empty() const { return window_list_.empty(); }
72 // Returns how many window selector items are in the grid.
73 size_t size() const { return window_list_.size(); }
75 // Returns true if the selection widget is active.
76 bool is_selecting() const { return selection_widget_ != NULL; }
78 // Returns the root window in which the grid displays the windows.
79 const aura::Window* root_window() const { return root_window_; }
81 const std::vector<WindowSelectorItem*>& window_list() const {
82 return window_list_.get();
85 // aura::WindowObserver:
86 virtual void OnWindowDestroying(aura::Window* window) OVERRIDE;
87 // TODO(nsatragno): Handle window bounds changed in WindowSelectorItem.
88 virtual void OnWindowBoundsChanged(aura::Window* window,
89 const gfx::Rect& old_bounds,
90 const gfx::Rect& new_bounds) OVERRIDE;
93 friend class WindowSelectorTest;
95 // Internal function to initialize the selection widget.
96 void InitSelectionWidget(WindowSelector::Direction direction);
98 // Moves the selection widget to the specified |direction|.
99 void MoveSelectionWidget(WindowSelector::Direction direction,
100 bool recreate_selection_widget,
103 // Moves the selection widget to the targeted window.
104 void MoveSelectionWidgetToTarget(bool animate);
106 // Returns the target bounds of the currently selected item.
107 const gfx::Rect GetSelectionBounds() const;
109 // Root window the grid is in.
110 aura::Window* root_window_;
112 // Pointer to the window selector that spawned this grid.
113 WindowSelector* window_selector_;
115 // Vector containing all the windows in this grid.
116 ScopedVector<WindowSelectorItem> window_list_;
118 // Vector containing the observed windows.
119 std::set<aura::Window*> observed_windows_;
121 // Widget that indicates to the user which is the selected window.
122 scoped_ptr<views::Widget> selection_widget_;
124 // Current selected window position.
125 size_t selected_index_;
127 // Number of columns in the grid.
130 DISALLOW_COPY_AND_ASSIGN(WindowGrid);
135 #endif // ASH_WM_OVERVIEW_WINDOW_GRID_H_