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 <memory> | |
9 | |
8 #include "ash/ash_export.h" | 10 #include "ash/ash_export.h" |
9 #include "base/macros.h" | 11 #include "base/macros.h" |
10 #include "ui/aura/window_observer.h" | 12 #include "ui/aura/window_observer.h" |
11 | 13 |
12 namespace ash { | 14 namespace ash { |
13 | 15 |
14 class WmWindow; | |
15 | |
16 // WindowDimmer creates a window whose opacity is animated by way of | 16 // WindowDimmer creates a window whose opacity is animated by way of |
17 // SetDimOpacity() and whose size matches that of its parent. WindowDimmer is | 17 // 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 | 18 // 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 | 19 // partially obscured. This is achieved by creating WindowDimmer, setting the |
20 // opacity, and then stacking window() above the windows that are to appear | 20 // 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 | 21 // obscured. The window created by WindowDimmer is owned by the parent, but also |
22 // deleted if WindowDimmer is deleted. It is expected that WindowDimmer is | 22 // deleted if WindowDimmer is deleted. It is expected that WindowDimmer is |
23 // deleted when the parent window is deleted (such as happens with | 23 // deleted when the parent window is deleted. |
24 // WmWindowUserData). | |
25 class ASH_EXPORT WindowDimmer : public aura::WindowObserver { | 24 class ASH_EXPORT WindowDimmer : public aura::WindowObserver { |
26 public: | 25 public: |
27 // Creates a new WindowDimmer. The window() created by WindowDimmer is added | 26 // Creates a new WindowDimmer. The window() created by WindowDimmer is added |
28 // to |parent| and stacked above all other child windows. | 27 // to |parent| and stacked above all other child windows. |
29 explicit WindowDimmer(WmWindow* parent); | 28 explicit WindowDimmer(aura::Window* parent); |
30 ~WindowDimmer() override; | 29 ~WindowDimmer() override; |
31 | 30 |
32 void SetDimOpacity(float target_opacity); | 31 void SetDimOpacity(float target_opacity); |
33 | 32 |
34 WmWindow* parent() { return parent_; } | 33 aura::Window* parent() { return parent_; } |
35 WmWindow* window() { return window_; } | 34 aura::Window* window() { return window_.get(); } |
36 | 35 |
37 // NOTE: WindowDimmer is an observer for both |parent_| and |window_|. | 36 // NOTE: WindowDimmer is an observer for both |parent_| and |window_|. |
38 // aura::WindowObserver: | 37 // aura::WindowObserver: |
39 void OnWindowBoundsChanged(aura::Window* window, | 38 void OnWindowBoundsChanged(aura::Window* window, |
40 const gfx::Rect& old_bounds, | 39 const gfx::Rect& old_bounds, |
41 const gfx::Rect& new_bounds) override; | 40 const gfx::Rect& new_bounds) override; |
42 void OnWindowDestroying(aura::Window* window) override; | 41 void OnWindowDestroying(aura::Window* window) override; |
43 void OnWindowHierarchyChanging(const HierarchyChangeParams& params) override; | 42 void OnWindowHierarchyChanging(const HierarchyChangeParams& params) override; |
44 | 43 |
45 private: | 44 private: |
46 WmWindow* parent_; | 45 aura::Window* parent_; |
47 WmWindow* window_; | 46 |
47 // See class description for details on ownership. | |
48 std::unique_ptr<aura::Window> window_; | |
James Cook
2017/03/09 18:39:27
The code might be a little clearer if this was dim
sky
2017/03/09 20:39:04
This has been removed.
| |
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 |