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_PANELS_PANEL_LAYOUT_MANAGER_H_
6 #define ASH_WM_PANELS_PANEL_LAYOUT_MANAGER_H_
10 #include "ash/ash_export.h"
11 #include "ash/display/display_controller.h"
12 #include "ash/shelf/shelf_icon_observer.h"
13 #include "ash/shelf/shelf_layout_manager_observer.h"
14 #include "ash/shell_observer.h"
15 #include "ash/wm/window_state_observer.h"
16 #include "base/basictypes.h"
17 #include "base/compiler_specific.h"
18 #include "base/memory/scoped_ptr.h"
19 #include "base/memory/weak_ptr.h"
20 #include "ui/aura/client/activation_change_observer.h"
21 #include "ui/aura/layout_manager.h"
22 #include "ui/aura/window_observer.h"
23 #include "ui/keyboard/keyboard_controller.h"
24 #include "ui/keyboard/keyboard_controller_observer.h"
43 class PanelCalloutWidget;
44 class ShelfLayoutManager;
46 // PanelLayoutManager is responsible for organizing panels within the
47 // workspace. It is associated with a specific container window (i.e.
48 // kShellWindowId_PanelContainer) and controls the layout of any windows
49 // added to that container.
51 // The constructor takes a |panel_container| argument which is expected to set
52 // its layout manager to this instance, e.g.:
53 // panel_container->SetLayoutManager(new PanelLayoutManager(panel_container));
55 class ASH_EXPORT PanelLayoutManager
56 : public aura::LayoutManager,
57 public ShelfIconObserver,
59 public aura::WindowObserver,
60 public aura::client::ActivationChangeObserver,
61 public keyboard::KeyboardControllerObserver,
62 public DisplayController::Observer,
63 public ShelfLayoutManagerObserver,
64 public wm::WindowStateObserver {
66 explicit PanelLayoutManager(aura::Window* panel_container);
67 virtual ~PanelLayoutManager();
69 // Call Shutdown() before deleting children of panel_container.
72 void StartDragging(aura::Window* panel);
73 void FinishDragging();
75 void ToggleMinimize(aura::Window* panel);
77 // Returns the callout widget (arrow) for |panel|.
78 views::Widget* GetCalloutWidgetForPanel(aura::Window* panel);
80 Shelf* shelf() { return shelf_; }
81 void SetShelf(Shelf* shelf);
83 // Overridden from aura::LayoutManager:
84 virtual void OnWindowResized() OVERRIDE;
85 virtual void OnWindowAddedToLayout(aura::Window* child) OVERRIDE;
86 virtual void OnWillRemoveWindowFromLayout(aura::Window* child) OVERRIDE;
87 virtual void OnWindowRemovedFromLayout(aura::Window* child) OVERRIDE;
88 virtual void OnChildWindowVisibilityChanged(aura::Window* child,
89 bool visibile) OVERRIDE;
90 virtual void SetChildBounds(aura::Window* child,
91 const gfx::Rect& requested_bounds) OVERRIDE;
93 // Overridden from ShelfIconObserver
94 virtual void OnShelfIconPositionsChanged() OVERRIDE;
96 // Overridden from ShellObserver
97 virtual void OnShelfAlignmentChanged(aura::Window* root_window) OVERRIDE;
99 // Overridden from ash::wm::WindowStateObserver
100 virtual void OnPostWindowShowTypeChange(wm::WindowState* window_state,
101 wm::WindowShowType old_type) OVERRIDE;
103 // Overridden from aura::WindowObserver
104 virtual void OnWindowVisibilityChanged(aura::Window* window,
105 bool visible) OVERRIDE;
107 // Overridden from aura::client::ActivationChangeObserver
108 virtual void OnWindowActivated(aura::Window* gained_active,
109 aura::Window* lost_active) OVERRIDE;
111 // Overridden from DisplayController::Observer
112 virtual void OnDisplayConfigurationChanged() OVERRIDE;
114 // Overridden from ShelfLayoutManagerObserver
115 virtual void WillChangeVisibilityState(
116 ShelfVisibilityState new_state) OVERRIDE;
119 friend class PanelLayoutManagerTest;
120 friend class PanelWindowResizerTest;
121 friend class DockedWindowResizerTest;
122 friend class DockedWindowLayoutManagerTest;
123 friend class WorkspaceControllerTest;
125 views::Widget* CreateCalloutWidget();
128 PanelInfo() : window(NULL), callout_widget(NULL), slide_in(false) {}
130 bool operator==(const aura::Window* other_window) const {
131 return window == other_window;
134 // A weak pointer to the panel window.
135 aura::Window* window;
136 // The callout widget for this panel. This pointer must be managed
137 // manually as this structure is used in a std::list. See
138 // http://www.chromium.org/developers/smart-pointer-guidelines
139 PanelCalloutWidget* callout_widget;
141 // True on new and restored panel windows until the panel has been
142 // positioned. The first time Relayout is called the panel will slide into
143 // position and this will be set to false.
147 typedef std::list<PanelInfo> PanelList;
149 void MinimizePanel(aura::Window* panel);
150 void RestorePanel(aura::Window* panel);
152 // Called whenever the panel layout might change.
155 // Called whenever the panel stacking order needs to be updated (e.g. focus
156 // changes or a panel is moved).
157 void UpdateStacking(aura::Window* active_panel);
159 // Update the callout arrows for all managed panels.
160 void UpdateCallouts();
162 // Overridden from keyboard::KeyboardControllerObserver:
163 virtual void OnKeyboardBoundsChanging(
164 const gfx::Rect& keyboard_bounds) OVERRIDE;
166 // Parent window associated with this layout manager.
167 aura::Window* panel_container_;
168 // Protect against recursive calls to OnWindowAddedToLayout().
170 // Protect against recursive calls to Relayout().
172 // Ordered list of unowned pointers to panel windows.
173 PanelList panel_windows_;
174 // The panel being dragged.
175 aura::Window* dragged_panel_;
176 // The shelf we are observing for shelf icon changes.
178 // The shelf layout manager being observed for visibility changes.
179 ShelfLayoutManager* shelf_layout_manager_;
181 // When not NULL, the shelf is hidden (i.e. full screen) and this tracks the
182 // set of panel windows which have been temporarily hidden and need to be
183 // restored when the shelf becomes visible again.
184 scoped_ptr<aura::WindowTracker> restore_windows_on_shelf_visible_;
186 // The last active panel. Used to maintain stacking order even if no panels
187 // are currently focused.
188 aura::Window* last_active_panel_;
189 base::WeakPtrFactory<PanelLayoutManager> weak_factory_;
191 DISALLOW_COPY_AND_ASSIGN(PanelLayoutManager);
194 } // namespace internal
197 #endif // ASH_WM_PANELS_PANEL_LAYOUT_MANAGER_H_