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