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_CURSOR_CLIENT_H_ | 5 #ifndef UI_AURA_CLIENT_CURSOR_CLIENT_H_ |
6 #define UI_AURA_CLIENT_CURSOR_CLIENT_H_ | 6 #define UI_AURA_CLIENT_CURSOR_CLIENT_H_ |
7 | 7 |
8 #include "ui/aura/aura_export.h" | 8 #include "ui/aura/aura_export.h" |
9 #include "ui/gfx/native_widget_types.h" | 9 #include "ui/gfx/native_widget_types.h" |
10 | 10 |
11 namespace aura { | 11 namespace aura { |
12 class Window; | 12 class Window; |
13 namespace client { | 13 namespace client { |
14 | 14 |
15 // An interface that receives cursor change events. | 15 // An interface that receives cursor change events. |
16 class AURA_EXPORT CursorClient { | 16 class AURA_EXPORT CursorClient { |
17 public: | 17 public: |
18 // Notes that |window| has requested the change to |cursor|. | 18 // Notes that |window| has requested the change to |cursor|. |
19 virtual void SetCursor(gfx::NativeCursor cursor) = 0; | 19 virtual void SetCursor(gfx::NativeCursor cursor) = 0; |
20 | 20 |
21 // Changes the visibility of the cursor. | 21 // Changes the visibility of the cursor. Mouse events keep being sent even |
22 // when the cursor is invisible, | |
22 virtual void ShowCursor(bool show) = 0; | 23 virtual void ShowCursor(bool show) = 0; |
23 | 24 |
24 // Gets whether the cursor is visible. | 25 // Gets whether the cursor is visible. |
25 virtual bool IsCursorVisible() const = 0; | 26 virtual bool IsCursorVisible() const = 0; |
26 | 27 |
28 // Enables or disables the cursor. When cursor is disabled, no mouse events | |
29 // are sent. | |
30 virtual void EnableCursor(bool enabled) = 0; | |
sky
2012/12/17 16:35:38
This class has inconsistently named methods and th
mazda
2012/12/18 02:49:32
I change the interface to the former ones.
| |
31 | |
32 // Returns true if the cursor is enabled. | |
33 virtual bool IsCursorEnabled() const = 0; | |
34 | |
27 // Sets the device scale factor of the cursor. | 35 // Sets the device scale factor of the cursor. |
28 virtual void SetDeviceScaleFactor(float device_scale_factor) = 0; | 36 virtual void SetDeviceScaleFactor(float device_scale_factor) = 0; |
29 | 37 |
30 // Locks the cursor change. The cursor type and cursor visibility never change | 38 // Locks the cursor change. The cursor type and cursor visibility never change |
31 // as long as lock is held by anyone. | 39 // as long as lock is held by anyone. |
32 virtual void LockCursor() = 0; | 40 virtual void LockCursor() = 0; |
33 | 41 |
34 // Unlocks the cursor change. If all the locks are released, the cursor type | 42 // Unlocks the cursor change. If all the locks are released, the cursor type |
35 // and visibility are restored to the ones set by the lastest call of | 43 // and visibility are restored to the ones set by the lastest call of |
36 // SetCursor and ShowCursor. | 44 // SetCursor and ShowCursor. |
37 virtual void UnlockCursor() = 0; | 45 virtual void UnlockCursor() = 0; |
38 | 46 |
39 protected: | 47 protected: |
40 virtual ~CursorClient() {} | 48 virtual ~CursorClient() {} |
41 }; | 49 }; |
42 | 50 |
43 // Sets/Gets the activation client for the specified window. | 51 // Sets/Gets the activation client for the specified window. |
44 AURA_EXPORT void SetCursorClient(Window* window, | 52 AURA_EXPORT void SetCursorClient(Window* window, |
45 CursorClient* client); | 53 CursorClient* client); |
46 AURA_EXPORT CursorClient* GetCursorClient(Window* window); | 54 AURA_EXPORT CursorClient* GetCursorClient(Window* window); |
47 | 55 |
48 } // namespace client | 56 } // namespace client |
49 } // namespace aura | 57 } // namespace aura |
50 | 58 |
51 #endif // UI_AURA_CLIENT_CURSOR_CLIENT_H_ | 59 #endif // UI_AURA_CLIENT_CURSOR_CLIENT_H_ |
OLD | NEW |