replace OVERRIDE and FINAL with override and final in ash/
[chromium-blink-merge.git] / ash / wm / app_list_controller.h
blobd772dd5317b4d7facda899dac19a87c80d3fff0a
1 // Copyright (c) 2012 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_APP_LIST_CONTROLLER_H_
6 #define ASH_WM_APP_LIST_CONTROLLER_H_
8 #include "ash/shelf/shelf_icon_observer.h"
9 #include "ash/shell_observer.h"
10 #include "base/basictypes.h"
11 #include "base/compiler_specific.h"
12 #include "base/timer/timer.h"
13 #include "ui/app_list/pagination_model_observer.h"
14 #include "ui/aura/client/focus_change_observer.h"
15 #include "ui/aura/window_observer.h"
16 #include "ui/compositor/layer_animation_observer.h"
17 #include "ui/events/event_handler.h"
18 #include "ui/gfx/rect.h"
19 #include "ui/keyboard/keyboard_controller_observer.h"
20 #include "ui/views/widget/widget_observer.h"
22 namespace app_list {
23 class ApplicationDragAndDropHost;
24 class AppListView;
27 namespace ui {
28 class LocatedEvent;
31 namespace ash {
32 namespace test {
33 class AppListControllerTestApi;
36 // AppListController is a controller that manages app list UI for shell.
37 // It creates AppListView and schedules showing/hiding animation.
38 // While the UI is visible, it monitors things such as app list widget's
39 // activation state and desktop mouse click to auto dismiss the UI.
40 class AppListController : public ui::EventHandler,
41 public aura::client::FocusChangeObserver,
42 public aura::WindowObserver,
43 public ui::ImplicitAnimationObserver,
44 public views::WidgetObserver,
45 public keyboard::KeyboardControllerObserver,
46 public ShellObserver,
47 public ShelfIconObserver,
48 public app_list::PaginationModelObserver {
49 public:
50 AppListController();
51 virtual ~AppListController();
53 // Show/hide app list window. The |window| is used to deterime in
54 // which display (in which the |window| exists) the app list should
55 // be shown.
56 void Show(aura::Window* window);
57 void Dismiss();
59 // Whether app list window is visible (shown or being shown).
60 bool IsVisible() const;
62 // Returns target visibility. This differs from IsVisible() if an animation
63 // is ongoing.
64 bool GetTargetVisibility() const { return is_visible_; }
66 // Returns app list window or NULL if it is not visible.
67 aura::Window* GetWindow();
69 // Returns app list view or NULL if it is not visible.
70 app_list::AppListView* GetView() { return view_; }
72 private:
73 friend class test::AppListControllerTestApi;
75 // If |drag_and_drop_host| is not NULL it will be called upon drag and drop
76 // operations outside the application list.
77 void SetDragAndDropHostOfCurrentAppList(
78 app_list::ApplicationDragAndDropHost* drag_and_drop_host);
80 // Sets the app list view and attempts to show it.
81 void SetView(app_list::AppListView* view);
83 // Forgets the view.
84 void ResetView();
86 // Starts show/hide animation.
87 void ScheduleAnimation();
89 void ProcessLocatedEvent(ui::LocatedEvent* event);
91 // Makes app list bubble update its bounds.
92 void UpdateBounds();
94 // ui::EventHandler overrides:
95 virtual void OnMouseEvent(ui::MouseEvent* event) override;
96 virtual void OnGestureEvent(ui::GestureEvent* event) override;
98 // aura::client::FocusChangeObserver overrides:
99 virtual void OnWindowFocused(aura::Window* gained_focus,
100 aura::Window* lost_focus) override;
102 // aura::WindowObserver overrides:
103 virtual void OnWindowBoundsChanged(aura::Window* root,
104 const gfx::Rect& old_bounds,
105 const gfx::Rect& new_bounds) override;
107 // ui::ImplicitAnimationObserver overrides:
108 virtual void OnImplicitAnimationsCompleted() override;
110 // views::WidgetObserver overrides:
111 virtual void OnWidgetDestroying(views::Widget* widget) override;
113 // KeyboardControllerObserver overrides:
114 virtual void OnKeyboardBoundsChanging(const gfx::Rect& new_bounds) override;
116 // ShellObserver overrides:
117 virtual void OnShelfAlignmentChanged(aura::Window* root_window) override;
119 // ShelfIconObserver overrides:
120 virtual void OnShelfIconPositionsChanged() override;
122 // app_list::PaginationModelObserver overrides:
123 virtual void TotalPagesChanged() override;
124 virtual void SelectedPageChanged(int old_selected, int new_selected) override;
125 virtual void TransitionStarted() override;
126 virtual void TransitionChanged() override;
128 // Whether we should show or hide app list widget.
129 bool is_visible_;
131 // Whether the app list should remain centered.
132 bool is_centered_;
134 // The AppListView this class manages, owned by its widget.
135 app_list::AppListView* view_;
137 // The current page of the AppsGridView of |view_|. This is stored outside of
138 // the view's PaginationModel, so that it persists when the view is destroyed.
139 int current_apps_page_;
141 // Cached bounds of |view_| for snapping back animation after over-scroll.
142 gfx::Rect view_bounds_;
144 // Whether should schedule snap back animation.
145 bool should_snap_back_;
147 DISALLOW_COPY_AND_ASSIGN(AppListController);
150 } // namespace ash
152 #endif // ASH_WM_APP_LIST_CONTROLLER_H_