include/wx/private/richtooltip.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/private/richtooltip.h
   3 // Purpose:     wxRichToolTipImpl declaration.
   4 // Author:      Vadim Zeitlin
   5 // Created:     2011-10-18
   6 // Copyright:   (c) 2011 Vadim Zeitlin <vadim@wxwidgets.org>
   7 // Licence:     wxWindows licence
   8 ///////////////////////////////////////////////////////////////////////////////
   9
  10 #ifndef _WX_PRIVATE_RICHTOOLTIP_H_
  11 #define _WX_PRIVATE_RICHTOOLTIP_H_
  12
  13 #include "wx/richtooltip.h"
  14
  15 // ----------------------------------------------------------------------------
  16 // wxRichToolTipImpl: defines wxRichToolTip implementation.
  17 // ----------------------------------------------------------------------------
  18
  19 class wxRichToolTipImpl
  20 {
  21 public:
  22     // This is implemented in a platform-specific way.
  23     static wxRichToolTipImpl* Create(const wxString& title,
  24                                      const wxString& message);
  25
  26     // These methods simply mirror the public wxRichToolTip ones.
  27     virtual void SetBackgroundColour(const wxColour& col,
  28                                      const wxColour& colEnd) = 0;
  29     virtual void SetCustomIcon(const wxIcon& icon) = 0;
  30     virtual void SetStandardIcon(int icon) = 0;
  31     virtual void SetTimeout(unsigned milliseconds,
  32                             unsigned millisecondsShowdelay = 0) = 0;
  33     virtual void SetTipKind(wxTipKind tipKind) = 0;
  34     virtual void SetTitleFont(const wxFont& font) = 0;
  35
  36     virtual void ShowFor(wxWindow* win, const wxRect* rect = NULL) = 0;
  37
  38     virtual ~wxRichToolTipImpl() { }
  39
  40 protected:
  41     wxRichToolTipImpl() { }
  42 };
  43
  44 #endif // _WX_PRIVATE_RICHTOOLTIP_H_