src/mac/tooltip.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        tooltip.cpp
   3 // Purpose:     wxToolTip implementation
   4 // Author:      Robert Roebling
   5 // Id:          $Id$
   6 // Copyright:   (c) 1998 Robert Roebling
   7 // Licence:     wxWindows licence
   8 /////////////////////////////////////////////////////////////////////////////
   9
  10 #ifdef __GNUG__
  11     #pragma implementation "tooltip.h"
  12 #endif
  13
  14 #include "wx/setup.h"
  15
  16 #if wxUSE_TOOLTIPS
  17
  18 #include "wx/app.h"
  19 #include "wx/dc.h"
  20 #include "wx/window.h"
  21 #include "wx/tooltip.h"
  22 #include "wx/timer.h"
  23 #include "wx/geometry.h"
  24 #include "wx/mac/aga.h"
  25 #include "wx/mac/uma.h"
  26
  27 //-----------------------------------------------------------------------------
  28 // global data
  29 //-----------------------------------------------------------------------------
  30
  31 class wxMacToolTip
  32 {
  33         public :
  34                 wxMacToolTip( ) ;
  35                 ~wxMacToolTip() ;
  36
  37                 void                    Setup( WindowRef window  , wxString text , wxPoint localPosition ) ;
  38                 long                    GetMark() { return m_mark ; }
  39                 void                    Draw() ;
  40                 void                    Clear() ;
  41                 bool                    IsShown() { return m_shown  ; }
  42         private :
  43
  44                 wxString        m_label ;
  45                 wxPoint m_position ;
  46                 Rect                    m_rect ;
  47                 WindowRef       m_window ;
  48                 PicHandle       m_backpict ;
  49                 bool            m_shown ;
  50                 long            m_mark ;
  51 } ;
  52
  53 class wxMacToolTipTimer : wxTimer
  54 {
  55 public:
  56         wxMacToolTipTimer(wxMacToolTip* tip, int iMilliseconds) ;
  57
  58         void Notify()
  59         {
  60                 if ( m_mark == m_tip->GetMark() )
  61                         m_tip->Draw() ;
  62
  63                 delete this;
  64         }
  65
  66 protected:
  67         wxMacToolTip*   m_tip;
  68         long                    m_mark ;
  69 };
  70
  71 //-----------------------------------------------------------------------------
  72 // wxToolTip
  73 //-----------------------------------------------------------------------------
  74 static long s_ToolTipDelay = 500 ;
  75 static bool s_ShowToolTips = true ;
  76 static wxMacToolTip s_ToolTip ;
  77 static wxWindow* s_LastWindowEntered = NULL ;
  78 static wxRect2DInt s_ToolTipArea ;
  79 static WindowRef s_ToolTipWindowRef = NULL ;
  80 wxToolTip::wxToolTip( const wxString &tip )
  81 {
  82     m_text = tip;
  83     m_window = (wxWindow*) NULL;
  84 }
  85
  86 wxToolTip::~wxToolTip()
  87 {
  88 }
  89
  90 void wxToolTip::SetTip( const wxString &tip )
  91 {
  92      m_text = tip;
  93
  94     if ( m_window )
  95     {
  96         /*
  97         // update it immediately
  98         wxToolInfo ti(GetHwndOf(m_window));
  99         ti.lpszText = (wxChar *)m_text.c_str();
 100
 101         (void)SendTooltipMessage(GetToolTipCtrl(), TTM_UPDATETIPTEXT, 0, &ti);
 102         */
 103     }
 104 }
 105
 106 void wxToolTip::SetWindow( wxWindow *win )
 107 {
 108     m_window = win;
 109 }
 110
 111 void wxToolTip::Enable( bool flag )
 112 {
 113         if ( s_ShowToolTips != flag )
 114         {
 115                 s_ShowToolTips = flag ;
 116                 if ( s_ShowToolTips )
 117                 {
 118                 }
 119                 else
 120                 {
 121                         s_ToolTip.Clear() ;
 122                 }
 123         }
 124 }
 125
 126 void wxToolTip::SetDelay( long msecs )
 127 {
 128         s_ToolTipDelay = msecs ;
 129 }
 130
 131 void wxToolTip::RelayEvent( wxWindow *win , wxMouseEvent &event )
 132 {
 133         if ( s_ShowToolTips )
 134         {
 135                 if ( event.GetEventType() == wxEVT_LEAVE_WINDOW )
 136                 {
 137                         s_ToolTip.Clear() ;
 138                 }
 139                 else if (event.GetEventType() == wxEVT_ENTER_WINDOW || event.GetEventType() == wxEVT_MOTION )
 140                 {
 141                         wxPoint2DInt where( event.m_x , event.m_y ) ;
 142                         if ( s_LastWindowEntered == win && s_ToolTipArea.Contains( where ) )
 143                         {
 144                         }
 145                         else
 146                         {
 147                                 s_ToolTip.Clear() ;
 148                                 s_ToolTipArea = wxRect2DInt( event.m_x - 2 , event.m_y - 2 , 4 , 4 ) ;
 149                                 s_LastWindowEntered = win ;
 150
 151                                 WindowRef window = win->GetMacRootWindow() ;
 152                                 int x = event.m_x ;
 153                                 int y = event.m_y ;
 154                                 wxPoint local( x , y ) ;
 155                                 win->MacClientToRootWindow( &x, &y ) ;
 156                                 wxPoint windowlocal( x , y ) ;
 157                                 s_ToolTip.Setup( window , win->MacGetToolTipString( local ) , windowlocal ) ;
 158                         }
 159                 }
 160         }
 161 }
 162
 163 void wxToolTip::RemoveToolTips()
 164 {
 165         s_ToolTip.Clear() ;
 166 }
 167 // --- mac specific
 168
 169 wxMacToolTipTimer::wxMacToolTipTimer( wxMacToolTip *tip , int msec )
 170 {
 171         m_tip = tip;
 172         m_mark = tip->GetMark() ;
 173         Start(msec, true);
 174 }
 175
 176 wxMacToolTip::wxMacToolTip()
 177 {
 178         m_window = NULL ;
 179         m_backpict = NULL ;
 180         m_mark = 0 ;
 181         m_shown = false ;
 182 }
 183
 184 void wxMacToolTip::Setup( WindowRef window  , wxString text , wxPoint localPosition )
 185 {
 186         m_mark++ ;
 187         Clear() ;
 188         m_position = localPosition ;
 189         m_label = wxMacMakeMacStringFromPC( text ) ;
 190         m_window = window ;
 191         s_ToolTipWindowRef = window ;
 192         m_backpict = NULL ;
 193         new wxMacToolTipTimer( this , s_ToolTipDelay ) ;
 194 }
 195
 196 wxMacToolTip::~wxMacToolTip()
 197 {
 198         if ( m_backpict )
 199                 Clear() ;
 200 }
 201
 202 const short kTipBorder = 2 ;
 203 const short kTipOffset = 5 ;
 204
 205 void wxMacToolTip::Draw()
 206 {
 207         if ( m_label.Length() == 0 )
 208                 return ;
 209
 210         if ( m_window == s_ToolTipWindowRef )
 211         {
 212                 #if TARGET_CARBON
 213                 AGAPortHelper help( GetWindowPort( m_window ) );
 214                 #else
 215                 AGAPortHelper help( ( m_window ) );
 216                 #endif
 217                 m_shown = true ;
 218
 219                 SetOrigin( 0 , 0 ) ;
 220                 TextFont( kFontIDGeneva ) ;
 221                 TextSize( 9 ) ;
 222                 TextFace( 0 ) ;
 223                 FontInfo fontInfo;
 224                 ::GetFontInfo(&fontInfo);
 225                 short lineh = fontInfo.ascent + fontInfo.descent + fontInfo.leading;
 226                 short height = 0 ;
 227         //      short width = TextWidth( m_label , 0 ,m_label.Length() ) ;
 228
 229                 int i = 0 ;
 230                 int length = m_label.Length() ;
 231                 int width = 0 ;
 232                 int thiswidth = 0 ;
 233                 int laststop = 0 ;
 234                 const char *text = m_label ;
 235                 while( i < length )
 236                 {
 237                         if( text[i] == 13 || text[i] == 10)
 238                         {
 239                                 thiswidth = ::TextWidth( text , laststop , i - laststop ) ;
 240                                 if ( thiswidth > width )
 241                                         width = thiswidth ;
 242
 243                                 height += lineh ;
 244                                 laststop = i+1 ;
 245                         }
 246                         i++ ;
 247                 }
 248                 if ( i - laststop > 0 )
 249                 {
 250                         thiswidth = ::TextWidth( text , laststop , i - laststop ) ;
 251                         if ( thiswidth > width )
 252                                 width = thiswidth ;
 253                         height += lineh ;
 254                 }
 255
 256
 257                 m_rect.left = m_position.x + kTipOffset;
 258                 m_rect.top = m_position.y + kTipOffset;
 259                 m_rect.right = m_rect.left + width + 2 * kTipBorder;
 260                 m_rect.bottom = m_rect.top + height + 2 * kTipBorder;
 261                 ClipRect( &m_rect ) ;
 262                 BackColor( whiteColor ) ;
 263                 ForeColor(blackColor ) ;
 264                 m_backpict = OpenPicture(&m_rect);
 265
 266                 CopyBits(GetPortBitMapForCopyBits(GetWindowPort(m_window)),
 267                                    GetPortBitMapForCopyBits(GetWindowPort(m_window)),
 268                                    &m_rect,
 269                                    &m_rect,
 270                                    srcCopy,
 271                                    NULL);
 272
 273                 ClosePicture();
 274                 RGBColor yellow = { 0xFFFF  , 0xFFFF , (153<<8)+153 } ;
 275                 RGBBackColor( &yellow ) ;
 276                 EraseRect( &m_rect ) ;
 277                 FrameRect( &m_rect ) ;
 278                 BackColor( whiteColor ) ;
 279                 ForeColor(blackColor ) ;
 280                 ::MoveTo( m_rect.left + kTipBorder , m_rect.top + fontInfo.ascent + kTipBorder);
 281
 282                 i = 0 ;
 283                 laststop = 0 ;
 284                 height = 0 ;
 285                 while( i < length )
 286                 {
 287                         if( text[i] == 13 || text[i] == 10)
 288                         {
 289                                 ::DrawText( text , laststop , i - laststop ) ;
 290                                 height += lineh ;
 291                                 ::MoveTo( m_rect.left + kTipBorder , m_rect.top + fontInfo.ascent + kTipBorder + height );
 292                                 laststop = i+1 ;
 293                         }
 294                         i++ ;
 295                 }
 296
 297                 ::DrawText( text , laststop , i - laststop ) ;
 298                 ::TextMode( srcOr ) ;
 299         //      DrawText( m_label , 0 , m_label.Length() ) ;
 300         }
 301 }
 302
 303 void wxToolTip::NotifyWindowDelete( WindowRef win )
 304 {
 305         if ( win == s_ToolTipWindowRef )
 306         {
 307                 s_ToolTipWindowRef = NULL ;
 308         }
 309 }
 310
 311 void wxMacToolTip::Clear()
 312 {
 313         m_mark++ ;
 314         if ( !m_shown )
 315                 return ;
 316
 317         if ( m_window == s_ToolTipWindowRef && m_backpict )
 318         {
 319                 #if TARGET_CARBON
 320                 AGAPortHelper help( GetWindowPort(m_window) ) ;
 321                 #else
 322                 AGAPortHelper help( (m_window) ) ;
 323                 #endif
 324                 m_shown = false ;
 325
 326                 SetOrigin( 0 , 0 ) ;
 327                 BackColor( whiteColor ) ;
 328                 ForeColor(blackColor ) ;
 329                 DrawPicture(m_backpict, &m_rect);
 330                 KillPicture(m_backpict);
 331                 m_backpict = NULL ;
 332         }
 333 }
 334
 335 #endif
 336