OLD | NEW |
---|---|
1 // Copyright 2015 The Chromium Authors. All rights reserved. | 1 // Copyright 2015 The Chromium Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 #ifndef ASH_COMMON_WINDOW_DIMMER_H_ | 5 #ifndef ASH_COMMON_WINDOW_DIMMER_H_ |
6 #define ASH_COMMON_WINDOW_DIMMER_H_ | 6 #define ASH_COMMON_WINDOW_DIMMER_H_ |
7 | 7 |
8 #include "ash/ash_export.h" | 8 #include "ash/ash_export.h" |
9 #include "base/macros.h" | 9 #include "base/macros.h" |
10 #include "ui/aura/window_observer.h" | 10 #include "ui/aura/window_observer.h" |
11 | 11 |
12 namespace ash { | 12 namespace ash { |
13 | 13 |
14 class WmWindow; | |
15 | |
16 // WindowDimmer creates a window whose opacity is animated by way of | 14 // WindowDimmer creates a window whose opacity is animated by way of |
17 // SetDimOpacity() and whose size matches that of its parent. WindowDimmer is | 15 // SetDimOpacity() and whose size matches that of its parent. WindowDimmer is |
18 // intended to be used in cases where a certain set of windows need to appear | 16 // intended to be used in cases where a certain set of windows need to appear |
19 // partially obscured. This is achieved by creating WindowDimmer, setting the | 17 // partially obscured. This is achieved by creating WindowDimmer, setting the |
20 // opacity, and then stacking window() above the windows that are to appear | 18 // opacity, and then stacking window() above the windows that are to appear |
21 // obscured. The window created by WindowDimmer is owned by the parent, but also | 19 // obscured. |
22 // deleted if WindowDimmer is deleted. It is expected that WindowDimmer is | 20 // |
23 // deleted when the parent window is deleted (such as happens with | 21 // WindowDimmer owns the window it creates, but supports having that window |
24 // WmWindowUserData). | 22 // deleted out from under it (this generally happens if the parent of the |
23 // window is deleted). If WindowDimmer is deleted and the window it created is | |
24 // still valid, then WindowDimmer deletes the window. | |
James Cook
2017/03/09 21:40:39
This is much better, thanks.
| |
25 class ASH_EXPORT WindowDimmer : public aura::WindowObserver { | 25 class ASH_EXPORT WindowDimmer : public aura::WindowObserver { |
26 public: | 26 public: |
27 // Creates a new WindowDimmer. The window() created by WindowDimmer is added | 27 // Creates a new WindowDimmer. The window() created by WindowDimmer is added |
28 // to |parent| and stacked above all other child windows. | 28 // to |parent| and stacked above all other child windows. |
29 explicit WindowDimmer(WmWindow* parent); | 29 explicit WindowDimmer(aura::Window* parent); |
30 ~WindowDimmer() override; | 30 ~WindowDimmer() override; |
31 | 31 |
32 void SetDimOpacity(float target_opacity); | 32 void SetDimOpacity(float target_opacity); |
33 | 33 |
34 WmWindow* parent() { return parent_; } | 34 aura::Window* parent() { return parent_; } |
35 WmWindow* window() { return window_; } | 35 aura::Window* window() { return window_; } |
36 | 36 |
37 // NOTE: WindowDimmer is an observer for both |parent_| and |window_|. | 37 // NOTE: WindowDimmer is an observer for both |parent_| and |window_|. |
38 // aura::WindowObserver: | 38 // aura::WindowObserver: |
39 void OnWindowBoundsChanged(aura::Window* window, | 39 void OnWindowBoundsChanged(aura::Window* window, |
40 const gfx::Rect& old_bounds, | 40 const gfx::Rect& old_bounds, |
41 const gfx::Rect& new_bounds) override; | 41 const gfx::Rect& new_bounds) override; |
42 void OnWindowDestroying(aura::Window* window) override; | 42 void OnWindowDestroying(aura::Window* window) override; |
43 void OnWindowHierarchyChanging(const HierarchyChangeParams& params) override; | 43 void OnWindowHierarchyChanging(const HierarchyChangeParams& params) override; |
44 | 44 |
45 private: | 45 private: |
46 WmWindow* parent_; | 46 aura::Window* parent_; |
47 WmWindow* window_; | 47 // See class description for details on ownership. |
48 aura::Window* window_; | |
48 | 49 |
49 DISALLOW_COPY_AND_ASSIGN(WindowDimmer); | 50 DISALLOW_COPY_AND_ASSIGN(WindowDimmer); |
50 }; | 51 }; |
51 | 52 |
52 } // namespace ash | 53 } // namespace ash |
53 | 54 |
54 #endif // ASH_COMMON_WINDOW_DIMMER_H_ | 55 #endif // ASH_COMMON_WINDOW_DIMMER_H_ |
OLD | NEW |