wxSplitterWindow mouse capture improvements and cleanup.

[wxWidgets.git] / src / richtext / richtextctrl.cpp

diff --git a/src/richtext/richtextctrl.cpp b/src/richtext/richtextctrl.cpp
index 652150c8a7ffaa559d2d37449ad7103b89c9228a..d51fffcc736044e2aa4bd04027bd2ef20e9d063f 100644 (file)
--- a/src/richtext/richtextctrl.cpp
+++ b/src/richtext/richtextctrl.cpp
@@ -26,6 +26,7 @@
     #include "wx/settings.h"
 #endif
 
     #include "wx/settings.h"
 #endif
 

+#include "wx/timer.h"

 #include "wx/textfile.h"
 #include "wx/ffile.h"
 #include "wx/filename.h"
 #include "wx/textfile.h"
 #include "wx/ffile.h"
 #include "wx/filename.h"


@@ -38,24 +39,24 @@
 #include "wx/app.h"
 WX_CHECK_BUILD_OPTIONS("wxRichTextCtrl")
 
 #include "wx/app.h"
 WX_CHECK_BUILD_OPTIONS("wxRichTextCtrl")
 

-wxDEFINE_EVENT( wxEVT_COMMAND_RICHTEXT_LEFT_CLICK, wxRichTextEvent )
-wxDEFINE_EVENT( wxEVT_COMMAND_RICHTEXT_MIDDLE_CLICK, wxRichTextEvent )
-wxDEFINE_EVENT( wxEVT_COMMAND_RICHTEXT_RIGHT_CLICK, wxRichTextEvent )
-wxDEFINE_EVENT( wxEVT_COMMAND_RICHTEXT_LEFT_DCLICK, wxRichTextEvent )
-wxDEFINE_EVENT( wxEVT_COMMAND_RICHTEXT_RETURN, wxRichTextEvent )
-wxDEFINE_EVENT( wxEVT_COMMAND_RICHTEXT_CHARACTER, wxRichTextEvent )
-wxDEFINE_EVENT( wxEVT_COMMAND_RICHTEXT_DELETE, wxRichTextEvent )
-
-wxDEFINE_EVENT( wxEVT_COMMAND_RICHTEXT_STYLESHEET_REPLACING, wxRichTextEvent )
-wxDEFINE_EVENT( wxEVT_COMMAND_RICHTEXT_STYLESHEET_REPLACED, wxRichTextEvent )
-wxDEFINE_EVENT( wxEVT_COMMAND_RICHTEXT_STYLESHEET_CHANGING, wxRichTextEvent )
-wxDEFINE_EVENT( wxEVT_COMMAND_RICHTEXT_STYLESHEET_CHANGED, wxRichTextEvent )
-
-wxDEFINE_EVENT( wxEVT_COMMAND_RICHTEXT_CONTENT_INSERTED, wxRichTextEvent )
-wxDEFINE_EVENT( wxEVT_COMMAND_RICHTEXT_CONTENT_DELETED, wxRichTextEvent )
-wxDEFINE_EVENT( wxEVT_COMMAND_RICHTEXT_STYLE_CHANGED, wxRichTextEvent )
-wxDEFINE_EVENT( wxEVT_COMMAND_RICHTEXT_SELECTION_CHANGED, wxRichTextEvent )
-wxDEFINE_EVENT( wxEVT_COMMAND_RICHTEXT_BUFFER_RESET, wxRichTextEvent )
+wxDEFINE_EVENT( wxEVT_COMMAND_RICHTEXT_LEFT_CLICK, wxRichTextEvent );
+wxDEFINE_EVENT( wxEVT_COMMAND_RICHTEXT_MIDDLE_CLICK, wxRichTextEvent );
+wxDEFINE_EVENT( wxEVT_COMMAND_RICHTEXT_RIGHT_CLICK, wxRichTextEvent );
+wxDEFINE_EVENT( wxEVT_COMMAND_RICHTEXT_LEFT_DCLICK, wxRichTextEvent );
+wxDEFINE_EVENT( wxEVT_COMMAND_RICHTEXT_RETURN, wxRichTextEvent );
+wxDEFINE_EVENT( wxEVT_COMMAND_RICHTEXT_CHARACTER, wxRichTextEvent );
+wxDEFINE_EVENT( wxEVT_COMMAND_RICHTEXT_DELETE, wxRichTextEvent );
+
+wxDEFINE_EVENT( wxEVT_COMMAND_RICHTEXT_STYLESHEET_REPLACING, wxRichTextEvent );
+wxDEFINE_EVENT( wxEVT_COMMAND_RICHTEXT_STYLESHEET_REPLACED, wxRichTextEvent );
+wxDEFINE_EVENT( wxEVT_COMMAND_RICHTEXT_STYLESHEET_CHANGING, wxRichTextEvent );
+wxDEFINE_EVENT( wxEVT_COMMAND_RICHTEXT_STYLESHEET_CHANGED, wxRichTextEvent );
+
+wxDEFINE_EVENT( wxEVT_COMMAND_RICHTEXT_CONTENT_INSERTED, wxRichTextEvent );
+wxDEFINE_EVENT( wxEVT_COMMAND_RICHTEXT_CONTENT_DELETED, wxRichTextEvent );
+wxDEFINE_EVENT( wxEVT_COMMAND_RICHTEXT_STYLE_CHANGED, wxRichTextEvent );
+wxDEFINE_EVENT( wxEVT_COMMAND_RICHTEXT_SELECTION_CHANGED, wxRichTextEvent );
+wxDEFINE_EVENT( wxEVT_COMMAND_RICHTEXT_BUFFER_RESET, wxRichTextEvent );

 
 #if wxRICHTEXT_USE_OWN_CARET
 
 
 #if wxRICHTEXT_USE_OWN_CARET
 


@@ -67,18 +68,30 @@ wxDEFINE_EVENT( wxEVT_COMMAND_RICHTEXT_BUFFER_RESET, wxRichTextEvent )
  * wxRICHTEXT_USE_OWN_CARET is set in richtextbuffer.h.
  */
 
  * wxRICHTEXT_USE_OWN_CARET is set in richtextbuffer.h.
  */
 

+class wxRichTextCaret;
+class wxRichTextCaretTimer: public wxTimer
+{
+  public:
+    wxRichTextCaretTimer(wxRichTextCaret* caret)
+    {
+        m_caret = caret;
+    }
+    virtual void Notify();
+    wxRichTextCaret* m_caret;
+};
+

 class wxRichTextCaret: public wxCaret
 {
 public:
     // ctors
     // -----
         // default - use Create()
 class wxRichTextCaret: public wxCaret
 {
 public:
     // ctors
     // -----
         // default - use Create()

-    wxRichTextCaret() { Init(); }
+    wxRichTextCaret(): m_timer(this)  { Init(); }

         // creates a block caret associated with the given window
     wxRichTextCaret(wxRichTextCtrl *window, int width, int height)
         // creates a block caret associated with the given window
     wxRichTextCaret(wxRichTextCtrl *window, int width, int height)

-        : wxCaret(window, width, height) { Init(); m_richTextCtrl = window; }
+        : wxCaret(window, width, height), m_timer(this) { Init(); m_richTextCtrl = window; }

     wxRichTextCaret(wxRichTextCtrl *window, const wxSize& size)
     wxRichTextCaret(wxRichTextCtrl *window, const wxSize& size)

-        : wxCaret(window, size) { Init(); m_richTextCtrl = window; }
+        : wxCaret(window, size), m_timer(this) { Init(); m_richTextCtrl = window; }

 
     virtual ~wxRichTextCaret();
 
 
     virtual ~wxRichTextCaret();
 


@@ -99,6 +112,8 @@ public:
     bool GetNeedsUpdate() const { return m_needsUpdate; }
     void SetNeedsUpdate(bool needsUpdate = true ) { m_needsUpdate = needsUpdate; }
 
     bool GetNeedsUpdate() const { return m_needsUpdate; }
     void SetNeedsUpdate(bool needsUpdate = true ) { m_needsUpdate = needsUpdate; }
 

+    void Notify();
+

 protected:
     virtual void DoShow();
     virtual void DoHide();
 protected:
     virtual void DoShow();
     virtual void DoHide();


@@ -115,16 +130,17 @@ private:
                   m_yOld;
     bool          m_hasFocus;       // true => our window has focus
     bool          m_needsUpdate;    // must be repositioned
                   m_yOld;
     bool          m_hasFocus;       // true => our window has focus
     bool          m_needsUpdate;    // must be repositioned

-
+    bool          m_flashOn;
+    wxRichTextCaretTimer m_timer;

     wxRichTextCtrl* m_richTextCtrl;
 };
 #endif
 
     wxRichTextCtrl* m_richTextCtrl;
 };
 #endif
 

-IMPLEMENT_DYNAMIC_CLASS( wxRichTextCtrl, wxControl )
+IMPLEMENT_DYNAMIC_CLASS( wxRichTextCtrl, wxTextCtrlBase )

 
 IMPLEMENT_DYNAMIC_CLASS( wxRichTextEvent, wxNotifyEvent )
 
 
 IMPLEMENT_DYNAMIC_CLASS( wxRichTextEvent, wxNotifyEvent )
 

-BEGIN_EVENT_TABLE( wxRichTextCtrl, wxControl )
+BEGIN_EVENT_TABLE( wxRichTextCtrl, wxTextCtrlBase )

     EVT_PAINT(wxRichTextCtrl::OnPaint)
     EVT_ERASE_BACKGROUND(wxRichTextCtrl::OnEraseBackground)
     EVT_IDLE(wxRichTextCtrl::OnIdle)
     EVT_PAINT(wxRichTextCtrl::OnPaint)
     EVT_ERASE_BACKGROUND(wxRichTextCtrl::OnEraseBackground)
     EVT_IDLE(wxRichTextCtrl::OnIdle)


@@ -196,7 +212,9 @@ wxRichTextCtrl::wxRichTextCtrl(wxWindow* parent,
 bool wxRichTextCtrl::Create( wxWindow* parent, wxWindowID id, const wxString& value, const wxPoint& pos, const wxSize& size, long style,
                              const wxValidator& validator, const wxString& name)
 {
 bool wxRichTextCtrl::Create( wxWindow* parent, wxWindowID id, const wxString& value, const wxPoint& pos, const wxSize& size, long style,
                              const wxValidator& validator, const wxString& name)
 {

-    if (!wxControl::Create(parent, id, pos, size,
+    style |= wxVSCROLL;
+
+    if (!wxTextCtrlBase::Create(parent, id, pos, size,

                            style|wxFULL_REPAINT_ON_RESIZE,
                            validator, name))
         return false;
                            style|wxFULL_REPAINT_ON_RESIZE,
                            validator, name))
         return false;


@@ -206,6 +224,9 @@ bool wxRichTextCtrl::Create( wxWindow* parent, wxWindowID id, const wxString& va
         SetFont(wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT));
     }
 
         SetFont(wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT));
     }
 

+    // No physical scrolling, so we can preserve margins
+    EnableScrolling(false, false);
+

     if (style & wxTE_READONLY)
         SetEditable(false);
 
     if (style & wxTE_READONLY)
         SetEditable(false);
 


@@ -365,7 +386,18 @@ void wxRichTextCtrl::OnPaint(wxPaintEvent& WXUNUSED(event))
             SetupScrollbars();
         }
 
             SetupScrollbars();
         }
 

+        wxRect clipRect(availableSpace);
+        clipRect.x += GetBuffer().GetLeftMargin();
+        clipRect.y += GetBuffer().GetTopMargin();
+        clipRect.width -= (GetBuffer().GetLeftMargin() + GetBuffer().GetRightMargin());
+        clipRect.height -= (GetBuffer().GetTopMargin() + GetBuffer().GetBottomMargin());
+        clipRect.SetPosition(GetLogicalPoint(clipRect.GetPosition()));
+        dc.SetClippingRegion(clipRect);
+

         GetBuffer().Draw(dc, GetBuffer().GetRange(), GetInternalSelectionRange(), drawingArea, 0 /* descent */, 0 /* flags */);
         GetBuffer().Draw(dc, GetBuffer().GetRange(), GetInternalSelectionRange(), drawingArea, 0 /* descent */, 0 /* flags */);

+
+        dc.DestroyClippingRegion();
+

 #if wxRICHTEXT_USE_OWN_CARET
         if (GetCaret()->IsVisible())
         {
 #if wxRICHTEXT_USE_OWN_CARET
         if (GetCaret()->IsVisible())
         {


@@ -978,7 +1010,8 @@ void wxRichTextCtrl::OnChar(wxKeyEvent& event)
 #ifdef __WXMAC__
                 if (event.CmdDown())
 #else
 #ifdef __WXMAC__
                 if (event.CmdDown())
 #else

-                if (event.CmdDown() || event.AltDown())
+                // Fixes AltGr+key with European input languages on Windows
+                if ((event.CmdDown() && !event.AltDown()) || (event.AltDown() && !event.CmdDown()))

 #endif
                 {
                     event.Skip();
 #endif
                 {
                     event.Skip();


@@ -1231,6 +1264,27 @@ bool wxRichTextCtrl::ScrollIntoView(long position, int keyCode)
     bool scrolled = false;
 
     wxSize clientSize = GetClientSize();
     bool scrolled = false;
 
     wxSize clientSize = GetClientSize();

+    clientSize.y -= GetBuffer().GetBottomMargin();
+
+    if (GetWindowStyle() & wxRE_CENTRE_CARET)
+    {
+        int y = rect.y - GetClientSize().y/2;
+        int yUnits = (int) (0.5 + ((float) y)/(float) ppuY);
+        if (y >= 0 && (y + clientSize.y) < GetBuffer().GetCachedSize().y)
+        {
+            if (startYUnits != yUnits)
+            {
+                SetScrollbars(ppuX, ppuY, sxUnits, syUnits, 0, yUnits);
+                scrolled = true;
+            }
+#if !wxRICHTEXT_USE_OWN_CARET
+            if (scrolled)
+#endif
+                PositionCaret();
+
+            return scrolled;
+        }
+    }

 
     // Going down
     if (keyCode == WXK_DOWN || keyCode == WXK_NUMPAD_DOWN ||
 
     // Going down
     if (keyCode == WXK_DOWN || keyCode == WXK_NUMPAD_DOWN ||


@@ -1255,11 +1309,11 @@ bool wxRichTextCtrl::ScrollIntoView(long position, int keyCode)
                 scrolled = true;
             }
         }
                 scrolled = true;
             }
         }

-        else if (rect.y < startY)
+        else if (rect.y < (startY + GetBuffer().GetTopMargin()))

         {
             // Make it scroll so this item is at the top
             // of the window
         {
             // Make it scroll so this item is at the top
             // of the window

-            int y = rect.y ;
+            int y = rect.y - GetBuffer().GetTopMargin();

             int yUnits = (int) (0.5 + ((float) y)/(float) ppuY);
 
             if (startYUnits != yUnits)
             int yUnits = (int) (0.5 + ((float) y)/(float) ppuY);
 
             if (startYUnits != yUnits)


@@ -1275,11 +1329,11 @@ bool wxRichTextCtrl::ScrollIntoView(long position, int keyCode)
              keyCode == WXK_HOME || keyCode == WXK_NUMPAD_HOME ||
              keyCode == WXK_PAGEUP || keyCode == WXK_NUMPAD_PAGEUP )
     {
              keyCode == WXK_HOME || keyCode == WXK_NUMPAD_HOME ||
              keyCode == WXK_PAGEUP || keyCode == WXK_NUMPAD_PAGEUP )
     {

-        if (rect.y < startY)
+        if (rect.y < (startY + GetBuffer().GetBottomMargin()))

         {
             // Make it scroll so this item is at the top
             // of the window
         {
             // Make it scroll so this item is at the top
             // of the window

-            int y = rect.y ;
+            int y = rect.y - GetBuffer().GetTopMargin();

             int yUnits = (int) (0.5 + ((float) y)/(float) ppuY);
 
             if (startYUnits != yUnits)
             int yUnits = (int) (0.5 + ((float) y)/(float) ppuY);
 
             if (startYUnits != yUnits)


@@ -1333,8 +1387,9 @@ bool wxRichTextCtrl::IsPositionVisible(long pos) const
 
     wxRect rect = line->GetRect();
     wxSize clientSize = GetClientSize();
 
     wxRect rect = line->GetRect();
     wxSize clientSize = GetClientSize();

+    clientSize.y -= GetBuffer().GetBottomMargin();

 
 

-    return (rect.GetBottom() > startY) && (rect.GetTop() < (startY + clientSize.y));
+    return (rect.GetBottom() > (startY + GetBuffer().GetTopMargin())) && (rect.GetTop() < (startY + clientSize.y));

 }
 
 void wxRichTextCtrl::SetCaretPosition(long position, bool showAtLineStart)
 }
 
 void wxRichTextCtrl::SetCaretPosition(long position, bool showAtLineStart)


@@ -1982,7 +2037,7 @@ void wxRichTextCtrl::SetupScrollbars(bool atTop)
     int pixelsPerUnit = 5;
     wxSize clientSize = GetClientSize();
 
     int pixelsPerUnit = 5;
     wxSize clientSize = GetClientSize();
 

-    int maxHeight = GetBuffer().GetCachedSize().y;
+    int maxHeight = GetBuffer().GetCachedSize().y + GetBuffer().GetTopMargin();

 
     // Round up so we have at least maxHeight pixels
     int unitsY = (int) (((float)maxHeight/(float)pixelsPerUnit) + 0.5);
 
     // Round up so we have at least maxHeight pixels
     int unitsY = (int) (((float)maxHeight/(float)pixelsPerUnit) + 0.5);


@@ -2258,7 +2313,7 @@ wxRichTextCtrl::HitTest(const wxPoint& pt,
 // set/get the controls text
 // ----------------------------------------------------------------------------
 
 // set/get the controls text
 // ----------------------------------------------------------------------------
 

-wxString wxRichTextCtrl::GetValue() const
+wxString wxRichTextCtrl::DoGetValue() const

 {
     return GetBuffer().GetText();
 }
 {
     return GetBuffer().GetText();
 }


@@ -2525,11 +2580,6 @@ void wxRichTextCtrl::SetSelection(long from, long to)
         to = GetLastPosition()+1;
     }
 
         to = GetLastPosition()+1;
     }
 

-    DoSetSelection(from, to);
-}
-
-void wxRichTextCtrl::DoSetSelection(long from, long to, bool WXUNUSED(scrollCaret))
-{

     if (from == to)
     {
         SelectNone();
     if (from == to)
     {
         SelectNone();


@@ -2834,7 +2884,7 @@ bool wxRichTextCtrl::GetUncombinedStyle(long position, wxTextAttr& style)
 /// Set font, and also the buffer attributes
 bool wxRichTextCtrl::SetFont(const wxFont& font)
 {
 /// Set font, and also the buffer attributes
 bool wxRichTextCtrl::SetFont(const wxFont& font)
 {

-    wxControl::SetFont(font);
+    wxTextCtrlBase::SetFont(font);

 
     wxTextAttr attr = GetBuffer().GetAttributes();
     attr.SetFont(font);
 
     wxTextAttr attr = GetBuffer().GetAttributes();
     attr.SetFont(font);


@@ -2883,6 +2933,12 @@ void wxRichTextCtrl::PositionCaret()
             GetCaret()->Hide();
             if (GetCaret()->GetSize() != newSz)
                 GetCaret()->SetSize(newSz);
             GetCaret()->Hide();
             if (GetCaret()->GetSize() != newSz)
                 GetCaret()->SetSize(newSz);

+
+            int halfSize = newSz.y/2;
+            // If the caret is beyond the margin, hide it by moving it out of the way
+            if (((pt.y + halfSize) < GetBuffer().GetTopMargin()) || ((pt.y + halfSize) > (GetClientSize().y - GetBuffer().GetBottomMargin())))
+                pt.y = -200;
+

             GetCaret()->Move(pt);
             GetCaret()->Show();
         }
             GetCaret()->Move(pt);
             GetCaret()->Show();
         }


@@ -3440,10 +3496,13 @@ void wxRichTextCaret::Init()
     m_yOld = -1;
     m_richTextCtrl = NULL;
     m_needsUpdate = false;
     m_yOld = -1;
     m_richTextCtrl = NULL;
     m_needsUpdate = false;

+    m_flashOn = true;

 }
 
 wxRichTextCaret::~wxRichTextCaret()
 {
 }
 
 wxRichTextCaret::~wxRichTextCaret()
 {

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

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


@@ -3452,11 +3511,19 @@ wxRichTextCaret::~wxRichTextCaret()
 
 void wxRichTextCaret::DoShow()
 {
 
 void wxRichTextCaret::DoShow()
 {

+    m_flashOn = true;
+    
+    if (!m_timer.IsRunning())
+        m_timer.Start(GetBlinkTime());
+

     Refresh();
 }
 
 void wxRichTextCaret::DoHide()
 {
     Refresh();
 }
 
 void wxRichTextCaret::DoHide()
 {

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

     Refresh();
 }
 
     Refresh();
 }
 


@@ -3533,17 +3600,25 @@ void wxRichTextCaret::DoDraw(wxDC *dc)
     dc->SetBrush(*(m_hasFocus ? wxBLACK_BRUSH : wxTRANSPARENT_BRUSH));
     dc->SetPen(*wxBLACK_PEN);
 
     dc->SetBrush(*(m_hasFocus ? wxBLACK_BRUSH : wxTRANSPARENT_BRUSH));
     dc->SetPen(*wxBLACK_PEN);
 

-    // VZ: unfortunately, the rectangle comes out a pixel smaller when this is
-    //     done under wxGTK - no idea why
-    //dc->SetLogicalFunction(wxINVERT);
-

     wxPoint pt(m_x, m_y);
 
     if (m_richTextCtrl)
     {
         pt = m_richTextCtrl->GetLogicalPoint(pt);
     }
     wxPoint pt(m_x, m_y);
 
     if (m_richTextCtrl)
     {
         pt = m_richTextCtrl->GetLogicalPoint(pt);
     }

-    dc->DrawRectangle(pt.x, pt.y, m_width, m_height);
+    if (IsVisible() && m_flashOn)
+        dc->DrawRectangle(pt.x, pt.y, m_width, m_height);
+}
+
+void wxRichTextCaret::Notify()
+{
+    m_flashOn = !m_flashOn;
+    Refresh();
+}
+
+void wxRichTextCaretTimer::Notify()
+{
+    m_caret->Notify();

 }
 #endif
     // wxRICHTEXT_USE_OWN_CARET
 }
 #endif
     // wxRICHTEXT_USE_OWN_CARET