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_WM_PUBLIC_TOOLTIP_CLIENT_H_ | 5 #ifndef UI_WM_PUBLIC_TOOLTIP_CLIENT_H_ |
6 #define UI_WM_PUBLIC_TOOLTIP_CLIENT_H_ | 6 #define UI_WM_PUBLIC_TOOLTIP_CLIENT_H_ |
7 | 7 |
8 #include "ui/aura/aura_export.h" | 8 #include "ui/aura/aura_export.h" |
9 #include "ui/gfx/font.h" | 9 #include "ui/gfx/font.h" |
10 | 10 |
11 namespace aura { | 11 namespace aura { |
12 class Window; | 12 class Window; |
13 namespace client { | 13 namespace client { |
14 | 14 |
15 class ScopedTooltipDisabler; | 15 class ScopedTooltipDisabler; |
16 | 16 |
17 class AURA_EXPORT TooltipClient { | 17 class AURA_EXPORT TooltipClient { |
18 public: | 18 public: |
19 // Informs the shell tooltip manager of change in tooltip for window |target|. | 19 // Informs the shell tooltip manager of change in tooltip for window |target|. |
20 virtual void UpdateTooltip(Window* target) = 0; | 20 // The |force| parameter orders the manager to perform the update |
| 21 // regardless of any internal conditions. |
| 22 virtual void UpdateTooltip(Window* target, bool force) = 0; |
21 | 23 |
22 // Sets the time after which the tooltip is hidden for Window |target|. If | 24 // Sets the time after which the tooltip is hidden for Window |target|. If |
23 // |timeout_in_ms| is <= 0, the tooltip is shown indefinitely. | 25 // |timeout_in_ms| is <= 0, the tooltip is shown indefinitely. |
24 virtual void SetTooltipShownTimeout(Window* target, int timeout_in_ms) = 0; | 26 virtual void SetTooltipShownTimeout(Window* target, int timeout_in_ms) = 0; |
25 | 27 |
26 protected: | 28 protected: |
27 // Enables/Disables tooltips. This is treated as a reference count. Consumers | 29 // Enables/Disables tooltips. This is treated as a reference count. Consumers |
28 // must use ScopedTooltipDisabler to enable/disabled tooltips. | 30 // must use ScopedTooltipDisabler to enable/disabled tooltips. |
29 virtual void SetTooltipsEnabled(bool enable) = 0; | 31 virtual void SetTooltipsEnabled(bool enable) = 0; |
30 | 32 |
31 private: | 33 private: |
32 friend class ScopedTooltipDisabler; | 34 friend class ScopedTooltipDisabler; |
33 }; | 35 }; |
34 | 36 |
35 AURA_EXPORT void SetTooltipClient(Window* root_window, | 37 AURA_EXPORT void SetTooltipClient(Window* root_window, |
36 TooltipClient* client); | 38 TooltipClient* client); |
37 AURA_EXPORT TooltipClient* GetTooltipClient(Window* root_window); | 39 AURA_EXPORT TooltipClient* GetTooltipClient(Window* root_window); |
38 | 40 |
39 AURA_EXPORT void SetTooltipText(Window* window, base::string16* tooltip_text); | 41 AURA_EXPORT void SetTooltipText(Window* window, base::string16* tooltip_text); |
40 AURA_EXPORT const base::string16 GetTooltipText(Window* window); | 42 AURA_EXPORT const base::string16 GetTooltipText(Window* window); |
41 | 43 |
42 } // namespace client | 44 } // namespace client |
43 } // namespace aura | 45 } // namespace aura |
44 | 46 |
45 #endif // UI_WM_PUBLIC_TOOLTIP_CLIENT_H_ | 47 #endif // UI_WM_PUBLIC_TOOLTIP_CLIENT_H_ |
OLD | NEW |