Remove some out of date comments.

[wxWidgets.git] / src / generic / caret.cpp

diff --git a/src/generic/caret.cpp b/src/generic/caret.cpp
index 21f1231a649b51694dd7497fd82eac4a3fc4b6a6..8e7a8ec86b9d8ce499bb2732b64694f6dc835426 100644 (file)
--- a/src/generic/caret.cpp
+++ b/src/generic/caret.cpp
@@ -1,11 +1,11 @@
 ///////////////////////////////////////////////////////////////////////////////
 ///////////////////////////////////////////////////////////////////////////////

-// Name:        generic/caret.h
-// Purpose:     generic wxCaret class
+// Name:        src/generic/caret.cpp
+// Purpose:     generic wxCaret class implementation

 // Author:      Vadim Zeitlin (original code by Robert Roebling)
 // Modified by:
 // Created:     25.05.99
 // RCS-ID:      $Id$
 // Author:      Vadim Zeitlin (original code by Robert Roebling)
 // Modified by:
 // Created:     25.05.99
 // RCS-ID:      $Id$

-// Copyright:   (c) wxWindows team
+// Copyright:   (c) wxWidgets team

 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 


@@ -17,10 +17,6 @@
 // headers
 // ----------------------------------------------------------------------------
 
 // headers
 // ----------------------------------------------------------------------------
 

-#if 0 //def __GNUG__
-    #pragma implementation "caret.h"
-#endif
-

 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 


@@ -28,9 +24,12 @@
     #pragma hdrstop
 #endif
 
     #pragma hdrstop
 #endif
 

+#if wxUSE_CARET
+

 #ifndef WX_PRECOMP
     #include "wx/window.h"
     #include "wx/dcclient.h"
 #ifndef WX_PRECOMP
     #include "wx/window.h"
     #include "wx/dcclient.h"

+    #include "wx/dcmemory.h"

 #endif //WX_PRECOMP
 
 #include "wx/caret.h"
 #endif //WX_PRECOMP
 
 #include "wx/caret.h"


@@ -47,9 +46,29 @@ static int gs_blinkTime = 500;  // in milliseconds
 // ============================================================================
 
 // ----------------------------------------------------------------------------
 // ============================================================================
 
 // ----------------------------------------------------------------------------

-// wxCaret static functions and data
+// timer stuff

 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 

+wxCaretTimer::wxCaretTimer(wxCaret *caret)
+{
+    m_caret = caret;
+}
+
+void wxCaretTimer::Notify()
+{
+    m_caret->OnTimer();
+}
+
+void wxCaret::OnTimer()
+{
+    // don't blink the caret when we don't have the focus
+    if ( m_hasFocus )
+        Blink();
+}
+
+// ----------------------------------------------------------------------------
+// wxCaret static functions and data
+// ----------------------------------------------------------------------------

 
 int wxCaretBase::GetBlinkTime()
 {
 
 int wxCaretBase::GetBlinkTime()
 {


@@ -67,6 +86,13 @@ void wxCaretBase::SetBlinkTime(int milliseconds)
 
 void wxCaret::InitGeneric()
 {
 
 void wxCaret::InitGeneric()
 {

+    m_hasFocus = true;
+    m_blinkedOut = true;
+#ifndef wxHAS_CARET_USING_OVERLAYS
+    m_xOld =
+    m_yOld = -1;
+    m_bmpUnderCaret.Create(m_width, m_height);
+#endif

 }
 
 wxCaret::~wxCaret()
 }
 
 wxCaret::~wxCaret()


@@ -74,7 +100,8 @@ wxCaret::~wxCaret()
     if ( IsVisible() )
     {
         // stop blinking
     if ( IsVisible() )
     {
         // stop blinking

-        m_timer.Stop();
+        if ( m_timer.IsRunning() )
+            m_timer.Stop();

     }
 }
 
     }
 }
 


@@ -84,10 +111,12 @@ wxCaret::~wxCaret()
 
 void wxCaret::DoShow()
 {
 
 void wxCaret::DoShow()
 {

-    m_timer.Start(GetBlinkTime());
+    int blinkTime = GetBlinkTime();
+    if ( blinkTime )
+        m_timer.Start(blinkTime);

 
 

-    m_blinkedOut = TRUE;
-    Blink();
+    if ( m_blinkedOut )
+        Blink();

 }
 
 void wxCaret::DoHide()
 }
 
 void wxCaret::DoHide()


@@ -102,11 +131,75 @@ void wxCaret::DoHide()
 
 void wxCaret::DoMove()
 {
 
 void wxCaret::DoMove()
 {

-    if ( IsVisible() && !m_blinkedOut )
+#ifdef wxHAS_CARET_USING_OVERLAYS
+    m_overlay.Reset();
+#endif
+    if ( IsVisible() )
+    {
+        if ( !m_blinkedOut )
+        {
+            // hide it right now and it will be shown the next time it blinks
+            Blink();
+
+            // but if the caret is not blinking, we should blink it back into
+            // visibility manually
+            if ( !m_timer.IsRunning() )
+                Blink();
+        }
+    }
+    //else: will be shown at the correct location when it is shown
+}
+
+void wxCaret::DoSize()
+{
+    int countVisible = m_countVisible;
+    if (countVisible > 0)
+    {
+        m_countVisible = 0;
+        DoHide();
+    }
+#ifdef wxHAS_CARET_USING_OVERLAYS
+    m_overlay.Reset();
+#else
+    // Change bitmap size
+    m_bmpUnderCaret = wxBitmap(m_width, m_height);
+#endif
+    if (countVisible > 0)
+    {
+        m_countVisible = countVisible;
+        DoShow();
+    }
+}
+
+// ----------------------------------------------------------------------------
+// handling the focus
+// ----------------------------------------------------------------------------
+
+void wxCaret::OnSetFocus()
+{
+    m_hasFocus = true;
+
+    if ( IsVisible() )
+        Refresh();
+}
+
+void wxCaret::OnKillFocus()
+{
+    m_hasFocus = false;
+
+    if ( IsVisible() )

     {
     {

+        // the caret must be shown - otherwise, if it is hidden now, it will
+        // stay so until the focus doesn't return because it won't blink any
+        // more
+
+        // hide it first if it isn't hidden ...
+        if ( !m_blinkedOut )
+            Blink();
+
+        // .. and show it in the new style

         Blink();
     }
         Blink();
     }

-    //else: will be shown at the correct location next time it blinks

 }
 
 // ----------------------------------------------------------------------------
 }
 
 // ----------------------------------------------------------------------------


@@ -117,24 +210,77 @@ void wxCaret::Blink()
 {
     m_blinkedOut = !m_blinkedOut;
 
 {
     m_blinkedOut = !m_blinkedOut;
 

-    wxClientDC dc(GetWindow());
-    if ( !m_blinkedOut )
+    Refresh();
+}
+
+void wxCaret::Refresh()
+{
+    wxClientDC dcWin(GetWindow());
+// this is the new code, switch to 0 if this gives problems
+#ifdef wxHAS_CARET_USING_OVERLAYS
+    wxDCOverlay dcOverlay( m_overlay, &dcWin, m_x, m_y, m_width , m_height );
+    if ( m_blinkedOut )
+    {
+        dcOverlay.Clear();
+    }
+    else
+    {
+        DoDraw( &dcWin, GetWindow() );
+    }
+#else
+    wxMemoryDC dcMem;
+    dcMem.SelectObject(m_bmpUnderCaret);
+    if ( m_blinkedOut )

     {
     {

-        DoDraw(&dc);
+        // restore the old image
+        dcWin.Blit(m_xOld, m_yOld, m_width, m_height,
+                   &dcMem, 0, 0);
+        m_xOld =
+        m_yOld = -1;

     }
     else
     {
     }
     else
     {

-        // FIXME can't be less efficient than this... (+1 needed!)
-        wxRect rect(m_x, m_y, m_width + 1, m_height + 1);
-        GetWindow()->Refresh(FALSE, &rect);
+        if ( m_xOld == -1 && m_yOld == -1 )
+        {
+            // save the part we're going to overdraw
+            dcMem.Blit(0, 0, m_width, m_height,
+                       &dcWin, m_x, m_y);
+
+            m_xOld = m_x;
+            m_yOld = m_y;
+        }
+        //else: we already saved the image below the caret, don't do it any
+        //      more
+
+        // and draw the caret there
+        DoDraw(&dcWin, GetWindow());

     }
     }

+#endif

 }
 
 }
 

-void wxCaret::DoDraw(wxDC *dc)
+void wxCaret::DoDraw(wxDC *dc, wxWindow* win)

 {
 {

-    dc->SetPen( *wxBLACK_PEN );
-    dc->DrawLine( m_x, m_y, m_x+m_width, m_y );
-    dc->DrawLine( m_x, m_y+m_height, m_x+m_width, m_y+m_height );
-    dc->DrawLine( m_x+(m_width/2), m_y, m_x+(m_width/2), m_y+m_height );
-//  dc->DrawLine( m_x+(m_width/2)+1, m_y, m_x+(m_width/2)+1, m_y+m_height );
+    wxPen pen(*wxBLACK_PEN);
+    wxBrush brush(*wxBLACK_BRUSH);
+    if (win)
+    {
+        wxColour backgroundColour(win->GetBackgroundColour());
+        if (backgroundColour.Red() < 100 &&
+            backgroundColour.Green() < 100 &&
+            backgroundColour.Blue() < 100)
+        {
+            pen = *wxWHITE_PEN;
+            brush = *wxWHITE_BRUSH;
+        }
+    }
+    dc->SetPen( pen );
+    dc->SetBrush(m_hasFocus ? brush : *wxTRANSPARENT_BRUSH);
+
+    // VZ: unfortunately, the rectangle comes out a pixel smaller when this is
+    //     done under wxGTK - no idea why
+    //dc->SetLogicalFunction(wxINVERT);
+
+    dc->DrawRectangle(m_x, m_y, m_width, m_height);

 }
 }

+
+#endif // wxUSE_CARET