OLD | NEW |
1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. | 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 | 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 UI_AURA_CLIENT_STACKING_CLIENT_H_ | 5 #ifndef UI_AURA_CLIENT_STACKING_CLIENT_H_ |
6 #define UI_AURA_CLIENT_STACKING_CLIENT_H_ | 6 #define UI_AURA_CLIENT_STACKING_CLIENT_H_ |
7 | 7 |
8 #include "ui/aura/aura_export.h" | 8 #include "ui/aura/aura_export.h" |
9 | 9 |
10 namespace gfx { | 10 namespace gfx { |
11 class Rect; | 11 class Rect; |
12 } | 12 } |
13 | 13 |
14 namespace aura { | 14 namespace aura { |
15 class Window; | 15 class Window; |
16 namespace client { | 16 namespace client { |
17 | 17 |
18 // An interface implemented by an object that stacks windows. | 18 // An interface implemented by an object that stacks windows. |
19 class AURA_EXPORT StackingClient { | 19 class AURA_EXPORT StackingClient { |
20 public: | 20 public: |
21 virtual ~StackingClient() {} | 21 virtual ~StackingClient() {} |
22 | 22 |
23 // Called by the Window when its parent is set to NULL, returns the window | 23 // Called by the Window when it looks for a default parent. Returns the |
24 // that |window| should be added to instead. |context| provides a Window | 24 // window that |window| should be added to instead. |context| provides a |
25 // (generally a RootWindow) that can be used to determine which desktop type | 25 // Window (generally a RootWindow) that can be used to determine which |
26 // the default parent should be chosen from. | 26 // desktop type the default parent should be chosen from. NOTE: this may |
27 // NOTE: this may have side effects. It should only be used when |window| is | 27 // have side effects. It should only be used when |window| is going to be |
28 // going to be immediately added. | 28 // immediately added. |
| 29 // |
| 30 // TODO(erg): Remove |context|, and maybe after oshima's patch lands, |
| 31 // |bounds|. |
29 virtual Window* GetDefaultParent( | 32 virtual Window* GetDefaultParent( |
30 Window* context, | 33 Window* context, |
31 Window* window, | 34 Window* window, |
32 const gfx::Rect& bounds) = 0; | 35 const gfx::Rect& bounds) = 0; |
33 }; | 36 }; |
34 | 37 |
35 // Set/Get the default stacking client. | 38 // Set/Get the default stacking client. |
36 AURA_EXPORT void SetStackingClient(StackingClient* stacking_client); | 39 AURA_EXPORT void SetStackingClient(StackingClient* stacking_client); |
37 AURA_EXPORT StackingClient* GetStackingClient(); | 40 StackingClient* GetStackingClient(); |
38 | 41 |
39 // Set/Get a stacking client for a specific window. Setting the stacking client | 42 // Set/Get a stacking client for a specific window. Setting the stacking client |
40 // sets the stacking client on the window's RootWindow, not the window itself. | 43 // sets the stacking client on the window's RootWindow, not the window itself. |
41 // Likewise getting obtains it from the window's RootWindow. If |window| is | 44 // Likewise getting obtains it from the window's RootWindow. If |window| is |
42 // non-NULL it must be in a RootWindow. If |window| is NULL, the default | 45 // non-NULL it must be in a RootWindow. If |window| is NULL, the default |
43 // stacking client is used. | 46 // stacking client is used. |
44 AURA_EXPORT void SetStackingClient(Window* window, | 47 AURA_EXPORT void SetStackingClient(Window* window, |
45 StackingClient* stacking_client); | 48 StackingClient* stacking_client); |
46 AURA_EXPORT StackingClient* GetStackingClient(Window* window); | 49 StackingClient* GetStackingClient(Window* window); |
47 | 50 |
48 } // namespace client | 51 } // namespace client |
49 } // namespace aura | 52 } // namespace aura |
50 | 53 |
51 #endif // UI_AURA_CLIENT_STACKING_CLIENT_H_ | 54 #endif // UI_AURA_CLIENT_STACKING_CLIENT_H_ |
OLD | NEW |