src/generic/caret.cpp

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        generic/caret.cpp
   3 // Purpose:     generic wxCaret class implementation
   4 // Author:      Vadim Zeitlin (original code by Robert Roebling)
   5 // Modified by:
   6 // Created:     25.05.99
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) wxWidgets team
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 // ============================================================================
  13 // declarations
  14 // ============================================================================
  15
  16 // ----------------------------------------------------------------------------
  17 // headers
  18 // ----------------------------------------------------------------------------
  19
  20 // For compilers that support precompilation, includes "wx.h".
  21 #include "wx/wxprec.h"
  22
  23 #ifdef __BORLANDC__
  24     #pragma hdrstop
  25 #endif
  26
  27 #if wxUSE_CARET
  28
  29 #ifndef WX_PRECOMP
  30     #include "wx/window.h"
  31     #include "wx/dcclient.h"
  32     #include "wx/dcmemory.h"
  33 #endif //WX_PRECOMP
  34
  35 #include "wx/caret.h"
  36
  37 // ----------------------------------------------------------------------------
  38 // global variables for this module
  39 // ----------------------------------------------------------------------------
  40
  41 // the blink time (common to all carets for MSW compatibility)
  42 static int gs_blinkTime = 500;  // in milliseconds
  43
  44 // ============================================================================
  45 // implementation
  46 // ============================================================================
  47
  48 // ----------------------------------------------------------------------------
  49 // timer stuff
  50 // ----------------------------------------------------------------------------
  51
  52 wxCaretTimer::wxCaretTimer(wxCaret *caret)
  53 {
  54     m_caret = caret;
  55 }
  56
  57 void wxCaretTimer::Notify()
  58 {
  59     m_caret->OnTimer();
  60 }
  61
  62 void wxCaret::OnTimer()
  63 {
  64     // don't blink the caret when we don't have the focus
  65     if ( m_hasFocus )
  66         Blink();
  67 }
  68
  69 // ----------------------------------------------------------------------------
  70 // wxCaret static functions and data
  71 // ----------------------------------------------------------------------------
  72
  73 int wxCaretBase::GetBlinkTime()
  74 {
  75     return gs_blinkTime;
  76 }
  77
  78 void wxCaretBase::SetBlinkTime(int milliseconds)
  79 {
  80     gs_blinkTime = milliseconds;
  81 }
  82
  83 // ----------------------------------------------------------------------------
  84 // initialization and destruction
  85 // ----------------------------------------------------------------------------
  86
  87 void wxCaret::InitGeneric()
  88 {
  89     m_hasFocus = true;
  90     m_blinkedOut = true;
  91 #if wxUSE_OVERLAY == 0
  92     m_xOld =
  93     m_yOld = -1;
  94     m_bmpUnderCaret.Create(m_width, m_height);
  95 #endif
  96 }
  97
  98 wxCaret::~wxCaret()
  99 {
 100     if ( IsVisible() )
 101     {
 102         // stop blinking
 103         if ( m_timer.IsRunning() )
 104             m_timer.Stop();
 105     }
 106 }
 107
 108 // ----------------------------------------------------------------------------
 109 // showing/hiding/moving the caret (base class interface)
 110 // ----------------------------------------------------------------------------
 111
 112 void wxCaret::DoShow()
 113 {
 114     int blinkTime = GetBlinkTime();
 115     if ( blinkTime )
 116         m_timer.Start(blinkTime);
 117
 118     if ( m_blinkedOut )
 119         Blink();
 120 }
 121
 122 void wxCaret::DoHide()
 123 {
 124     m_timer.Stop();
 125
 126     if ( !m_blinkedOut )
 127     {
 128         Blink();
 129     }
 130 }
 131
 132 void wxCaret::DoMove()
 133 {
 134     if ( IsVisible() )
 135     {
 136         if ( !m_blinkedOut )
 137         {
 138             // hide it right now and it will be shown the next time it blinks
 139             Blink();
 140
 141             // but if the caret is not blinking, we should blink it back into
 142             // visibility manually
 143             if ( !m_timer.IsRunning() )
 144                 Blink();
 145         }
 146     }
 147     //else: will be shown at the correct location when it is shown
 148 }
 149
 150 void wxCaret::DoSize()
 151 {
 152     int countVisible = m_countVisible;
 153     if (countVisible > 0)
 154     {
 155         m_countVisible = 0;
 156         DoHide();
 157     }
 158 #if wxUSE_OVERLAY == 0
 159     // Change bitmap size
 160     m_bmpUnderCaret = wxBitmap(m_width, m_height);
 161 #endif
 162     if (countVisible > 0)
 163     {
 164         m_countVisible = countVisible;
 165         DoShow();
 166     }
 167 }
 168
 169 // ----------------------------------------------------------------------------
 170 // handling the focus
 171 // ----------------------------------------------------------------------------
 172
 173 void wxCaret::OnSetFocus()
 174 {
 175     m_hasFocus = true;
 176
 177     if ( IsVisible() )
 178         Refresh();
 179 }
 180
 181 void wxCaret::OnKillFocus()
 182 {
 183     m_hasFocus = false;
 184
 185     if ( IsVisible() )
 186     {
 187         // the caret must be shown - otherwise, if it is hidden now, it will
 188         // stay so until the focus doesn't return because it won't blink any
 189         // more
 190
 191         // hide it first if it isn't hidden ...
 192         if ( !m_blinkedOut )
 193             Blink();
 194
 195         // .. and show it in the new style
 196         Blink();
 197     }
 198 }
 199
 200 // ----------------------------------------------------------------------------
 201 // drawing the caret
 202 // ----------------------------------------------------------------------------
 203
 204 void wxCaret::Blink()
 205 {
 206     m_blinkedOut = !m_blinkedOut;
 207
 208     Refresh();
 209 }
 210
 211 void wxCaret::Refresh()
 212 {
 213     wxClientDC dcWin(GetWindow());
 214 // this is the new code, switch to 0 if this gives problems
 215 #if wxUSE_OVERLAY
 216     wxDCOverlay dcOverlay( m_overlay, &dcWin, m_x, m_y, m_width , m_height );
 217     if ( m_blinkedOut )
 218     {
 219         dcOverlay.Clear();
 220     }
 221     else
 222     {
 223         DoDraw( &dcWin );
 224     }
 225 #else
 226     wxMemoryDC dcMem;
 227     dcMem.SelectObject(m_bmpUnderCaret);
 228     if ( m_blinkedOut )
 229     {
 230         // restore the old image
 231         dcWin.Blit(m_xOld, m_yOld, m_width, m_height,
 232                    &dcMem, 0, 0);
 233         m_xOld =
 234         m_yOld = -1;
 235     }
 236     else
 237     {
 238         if ( m_xOld == -1 && m_yOld == -1 )
 239         {
 240             // save the part we're going to overdraw
 241
 242             int x = m_x,
 243                 y = m_y;
 244 #if defined(__WXGTK__) && !defined(__WX_DC_BLIT_FIXED__)
 245             wxPoint pt = dcWin.GetDeviceOrigin();
 246             x += pt.x;
 247             y += pt.y;
 248 #endif // broken wxGTK wxDC::Blit
 249             dcMem.Blit(0, 0, m_width, m_height,
 250                        &dcWin, x, y);
 251
 252             m_xOld = m_x;
 253             m_yOld = m_y;
 254         }
 255         //else: we already saved the image below the caret, don't do it any
 256         //      more
 257
 258         // and draw the caret there
 259         DoDraw(&dcWin);
 260     }
 261 #endif
 262 }
 263
 264 void wxCaret::DoDraw(wxDC *dc)
 265 {
 266     dc->SetPen( *wxBLACK_PEN );
 267
 268     dc->SetBrush(*(m_hasFocus ? wxBLACK_BRUSH : wxTRANSPARENT_BRUSH));
 269     dc->SetPen(*wxBLACK_PEN);
 270
 271     // VZ: unfortunately, the rectangle comes out a pixel smaller when this is
 272     //     done under wxGTK - no idea why
 273     //dc->SetLogicalFunction(wxINVERT);
 274
 275     dc->DrawRectangle(m_x, m_y, m_width, m_height);
 276 }
 277
 278 #endif // wxUSE_CARET