ash/wm/overview/window_selector.h

   1 // Copyright 2013 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.
   4
   5 #ifndef ASH_WM_OVERVIEW_WINDOW_SELECTOR_H_
   6 #define ASH_WM_OVERVIEW_WINDOW_SELECTOR_H_
   7
   8 #include <set>
   9 #include <vector>
  10
  11 #include "ash/ash_export.h"
  12 #include "base/compiler_specific.h"
  13 #include "base/memory/scoped_ptr.h"
  14 #include "base/memory/scoped_vector.h"
  15 #include "base/time/time.h"
  16 #include "ui/aura/window_observer.h"
  17 #include "ui/aura/window_tracker.h"
  18 #include "ui/events/event_handler.h"
  19 #include "ui/gfx/display_observer.h"
  20 #include "ui/views/controls/textfield/textfield_controller.h"
  21 #include "ui/wm/public/activation_change_observer.h"
  22
  23 namespace aura {
  24 class RootWindow;
  25 class Window;
  26 }
  27
  28 namespace gfx {
  29 class Rect;
  30 }
  31
  32 namespace ui {
  33 class LocatedEvent;
  34 }
  35
  36 namespace views {
  37 class Textfield;
  38 class Widget;
  39 }
  40
  41 namespace ash {
  42 class WindowSelectorDelegate;
  43 class WindowSelectorItem;
  44 class WindowSelectorTest;
  45 class WindowGrid;
  46
  47 // The WindowSelector shows a grid of all of your windows, allowing to select
  48 // one by clicking or tapping on it.
  49 class ASH_EXPORT WindowSelector
  50     : public gfx::DisplayObserver,
  51       public aura::WindowObserver,
  52       public aura::client::ActivationChangeObserver,
  53       public views::TextfieldController {
  54  public:
  55   // The distance between the top edge of the screen and the bottom edge of
  56   // the text filtering textfield.
  57   static const int kTextFilterBottomEdge;
  58
  59   enum Direction {
  60     LEFT,
  61     UP,
  62     RIGHT,
  63     DOWN
  64   };
  65
  66   typedef std::vector<aura::Window*> WindowList;
  67   typedef ScopedVector<WindowSelectorItem> WindowSelectorItemList;
  68
  69   WindowSelector(const WindowList& windows,
  70                  WindowSelectorDelegate* delegate);
  71   ~WindowSelector() override;
  72
  73   // Cancels window selection.
  74   void CancelSelection();
  75
  76   // Called when the last window selector item from a grid is deleted.
  77   void OnGridEmpty(WindowGrid* grid);
  78
  79   // gfx::DisplayObserver:
  80   void OnDisplayAdded(const gfx::Display& display) override;
  81   void OnDisplayRemoved(const gfx::Display& display) override;
  82   void OnDisplayMetricsChanged(const gfx::Display& display,
  83                                uint32_t metrics) override;
  84
  85   // aura::WindowObserver:
  86   void OnWindowAdded(aura::Window* new_window) override;
  87   void OnWindowDestroying(aura::Window* window) override;
  88
  89   // aura::client::ActivationChangeObserver:
  90   void OnWindowActivated(aura::Window* gained_active,
  91                          aura::Window* lost_active) override;
  92   void OnAttemptToReactivateWindow(aura::Window* request_active,
  93                                    aura::Window* actual_active) override;
  94
  95   // views::TextfieldController:
  96   void ContentsChanged(views::Textfield* sender,
  97                        const base::string16& new_contents) override;
  98   bool HandleKeyEvent(views::Textfield* sender,
  99                       const ui::KeyEvent& key_event) override;
 100
 101  private:
 102   friend class WindowSelectorTest;
 103
 104   // Begins positioning windows such that all windows are visible on the screen.
 105   void StartOverview();
 106
 107   // Position all of the windows in the overview.
 108   void PositionWindows(bool animate);
 109
 110   // Hide and track all hidden windows not in the overview item list.
 111   void HideAndTrackNonOverviewWindows();
 112
 113   // |focus|, restores focus to the stored window.
 114   void ResetFocusRestoreWindow(bool focus);
 115
 116   // Helper function that moves the selection widget to |direction| on the
 117   // corresponding window grid.
 118   void Move(Direction direction, bool animate);
 119
 120   // Tracks observed windows.
 121   std::set<aura::Window*> observed_windows_;
 122
 123   // Weak pointer to the selector delegate which will be called when a
 124   // selection is made.
 125   WindowSelectorDelegate* delegate_;
 126
 127   // A weak pointer to the window which was focused on beginning window
 128   // selection. If window selection is canceled the focus should be restored to
 129   // this window.
 130   aura::Window* restore_focus_window_;
 131
 132   // True when performing operations that may cause window activations. This is
 133   // used to prevent handling the resulting expected activation.
 134   bool ignore_activations_;
 135
 136   // List of all the window overview grids, one for each root window.
 137   ScopedVector<WindowGrid> grid_list_;
 138
 139   // Tracks windows which were hidden because they were not part of the
 140   // overview.
 141   aura::WindowTracker hidden_windows_;
 142
 143   // Tracks the index of the root window the selection widget is in.
 144   size_t selected_grid_index_;
 145
 146   // The following variables are used for metric collection purposes. All of
 147   // them refer to this particular overview session and are not cumulative:
 148   // The time when overview was started.
 149   base::Time overview_start_time_;
 150
 151   // The number of arrow key presses.
 152   size_t num_key_presses_;
 153
 154   // The number of items in the overview.
 155   size_t num_items_;
 156
 157   // Indicates if we are showing the selection widget.
 158   bool showing_selection_widget_;
 159
 160   // Window text filter widget. As the user writes on it, we filter the items
 161   // in the overview. It is also responsible for handling overview key events,
 162   // such as enter key to select.
 163   scoped_ptr<views::Widget> text_filter_widget_;
 164
 165   // The current length of the string entered into the text filtering textfield.
 166   size_t text_filter_string_length_;
 167
 168   // The number of times the text filtering textfield has been cleared of text
 169   // during this overview mode session.
 170   size_t num_times_textfield_cleared_;
 171
 172   DISALLOW_COPY_AND_ASSIGN(WindowSelector);
 173 };
 174
 175 }  // namespace ash
 176
 177 #endif  // ASH_WM_OVERVIEW_WINDOW_SELECTOR_H_