ui/wm/public/tooltip_client.h

   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
   3 // found in the LICENSE file.
   4
   5 #ifndef UI_WM_PUBLIC_TOOLTIP_CLIENT_H_
   6 #define UI_WM_PUBLIC_TOOLTIP_CLIENT_H_
   7
   8 #include "ui/aura/aura_export.h"
   9 #include "ui/gfx/font.h"
  10
  11 namespace aura {
  12 class Window;
  13 namespace client {
  14
  15 class ScopedTooltipDisabler;
  16
  17 class AURA_EXPORT TooltipClient {
  18  public:
  19   // Informs the shell tooltip manager of change in tooltip for window |target|.
  20   virtual void UpdateTooltip(Window* target) = 0;
  21
  22   // Sets the time after which the tooltip is hidden for Window |target|. If
  23   // |timeout_in_ms| is <= 0, the tooltip is shown indefinitely.
  24   virtual void SetTooltipShownTimeout(Window* target, int timeout_in_ms) = 0;
  25
  26  protected:
  27   // Enables/Disables tooltips. This is treated as a reference count. Consumers
  28   // must use ScopedTooltipDisabler to enable/disabled tooltips.
  29   virtual void SetTooltipsEnabled(bool enable) = 0;
  30
  31  private:
  32   friend class ScopedTooltipDisabler;
  33 };
  34
  35 AURA_EXPORT void SetTooltipClient(Window* root_window,
  36                                   TooltipClient* client);
  37 AURA_EXPORT TooltipClient* GetTooltipClient(Window* root_window);
  38
  39 // Sets the text for the tooltip. The id is used to determine uniqueness when
  40 // the text does not change. For example, if the tooltip text does not change,
  41 // but the id does then the position of the tooltip is updated.
  42 AURA_EXPORT void SetTooltipText(Window* window,
  43                                 base::string16* tooltip_text);
  44 AURA_EXPORT void SetTooltipId(Window* window, void* id);
  45 AURA_EXPORT const base::string16 GetTooltipText(Window* window);
  46 AURA_EXPORT const void* GetTooltipId(Window* window);
  47
  48 }  // namespace client
  49 }  // namespace aura
  50
  51 #endif  // UI_WM_PUBLIC_TOOLTIP_CLIENT_H_