Add backend descriptions for all backends to the documentation.

[wxWidgets.git] / src / stc / stc.cpp.in

diff --git a/src/stc/stc.cpp.in b/src/stc/stc.cpp.in
index b5d72181357e57c092b3e690c16eb8d856c495ae..2dfa4ec02a43727ee3b8d0e213efb330724536ab 100644 (file)
--- a/src/stc/stc.cpp.in
+++ b/src/stc/stc.cpp.in
@@ -12,9 +12,20 @@
 // Created:     13-Jan-2000
 // RCS-ID:      $Id$
 // Copyright:   (c) 2000 by Total Control Software
 // Created:     13-Jan-2000
 // RCS-ID:      $Id$
 // Copyright:   (c) 2000 by Total Control Software

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /////////////////////////////////////////////////////////////////////////////
 

+/*
+    IMPORTANT: src/stc/stc.cpp is generated by src/stc/gen_iface.py from
+               src/stc/stc.cpp.in, don't edit stc.cpp file as your changes will be
+               lost after the next regeneration, edit stc.cpp.in and rerun the
+               gen_iface.py script instead!
+
+               Parts of this file generated by the script are found in between
+               the special "{{{" and "}}}" markers, the rest of it is copied
+               verbatim from src.h.in.
+ */
+

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


@@ -36,13 +47,13 @@
 #include "wx/tokenzr.h"
 #include "wx/mstream.h"
 #include "wx/image.h"
 #include "wx/tokenzr.h"
 #include "wx/mstream.h"
 #include "wx/image.h"

-#include "wx/file.h"
+#include "wx/ffile.h"

 
 #include "ScintillaWX.h"
 
 //----------------------------------------------------------------------
 
 
 #include "ScintillaWX.h"
 
 //----------------------------------------------------------------------
 

-const wxChar* wxSTCNameStr = wxT("stcwindow");
+const char wxSTCNameStr[] = "stcwindow";

 
 #ifdef MAKELONG
 #undef MAKELONG
 
 #ifdef MAKELONG
 #undef MAKELONG


@@ -85,34 +96,36 @@ static wxColour wxColourFromSpec(const wxString& spec) {
 
 //----------------------------------------------------------------------
 
 
 //----------------------------------------------------------------------
 

-DEFINE_EVENT_TYPE( wxEVT_STC_CHANGE )
-DEFINE_EVENT_TYPE( wxEVT_STC_STYLENEEDED )
-DEFINE_EVENT_TYPE( wxEVT_STC_CHARADDED )
-DEFINE_EVENT_TYPE( wxEVT_STC_SAVEPOINTREACHED )
-DEFINE_EVENT_TYPE( wxEVT_STC_SAVEPOINTLEFT )
-DEFINE_EVENT_TYPE( wxEVT_STC_ROMODIFYATTEMPT )
-DEFINE_EVENT_TYPE( wxEVT_STC_KEY )
-DEFINE_EVENT_TYPE( wxEVT_STC_DOUBLECLICK )
-DEFINE_EVENT_TYPE( wxEVT_STC_UPDATEUI )
-DEFINE_EVENT_TYPE( wxEVT_STC_MODIFIED )
-DEFINE_EVENT_TYPE( wxEVT_STC_MACRORECORD )
-DEFINE_EVENT_TYPE( wxEVT_STC_MARGINCLICK )
-DEFINE_EVENT_TYPE( wxEVT_STC_NEEDSHOWN )
-DEFINE_EVENT_TYPE( wxEVT_STC_PAINTED )
-DEFINE_EVENT_TYPE( wxEVT_STC_USERLISTSELECTION )
-DEFINE_EVENT_TYPE( wxEVT_STC_URIDROPPED )
-DEFINE_EVENT_TYPE( wxEVT_STC_DWELLSTART )
-DEFINE_EVENT_TYPE( wxEVT_STC_DWELLEND )
-DEFINE_EVENT_TYPE( wxEVT_STC_START_DRAG )
-DEFINE_EVENT_TYPE( wxEVT_STC_DRAG_OVER )
-DEFINE_EVENT_TYPE( wxEVT_STC_DO_DROP )
-DEFINE_EVENT_TYPE( wxEVT_STC_ZOOM )
-DEFINE_EVENT_TYPE( wxEVT_STC_HOTSPOT_CLICK )
-DEFINE_EVENT_TYPE( wxEVT_STC_HOTSPOT_DCLICK )
-DEFINE_EVENT_TYPE( wxEVT_STC_CALLTIP_CLICK )
-DEFINE_EVENT_TYPE( wxEVT_STC_AUTOCOMP_SELECTION )
-DEFINE_EVENT_TYPE( wxEVT_STC_INDICATOR_CLICK )
-DEFINE_EVENT_TYPE( wxEVT_STC_INDICATOR_RELEASE )
+wxDEFINE_EVENT( wxEVT_STC_CHANGE, wxStyledTextEvent );
+wxDEFINE_EVENT( wxEVT_STC_STYLENEEDED, wxStyledTextEvent );
+wxDEFINE_EVENT( wxEVT_STC_CHARADDED, wxStyledTextEvent );
+wxDEFINE_EVENT( wxEVT_STC_SAVEPOINTREACHED, wxStyledTextEvent );
+wxDEFINE_EVENT( wxEVT_STC_SAVEPOINTLEFT, wxStyledTextEvent );
+wxDEFINE_EVENT( wxEVT_STC_ROMODIFYATTEMPT, wxStyledTextEvent );
+wxDEFINE_EVENT( wxEVT_STC_KEY, wxStyledTextEvent );
+wxDEFINE_EVENT( wxEVT_STC_DOUBLECLICK, wxStyledTextEvent );
+wxDEFINE_EVENT( wxEVT_STC_UPDATEUI, wxStyledTextEvent );
+wxDEFINE_EVENT( wxEVT_STC_MODIFIED, wxStyledTextEvent );
+wxDEFINE_EVENT( wxEVT_STC_MACRORECORD, wxStyledTextEvent );
+wxDEFINE_EVENT( wxEVT_STC_MARGINCLICK, wxStyledTextEvent );
+wxDEFINE_EVENT( wxEVT_STC_NEEDSHOWN, wxStyledTextEvent );
+wxDEFINE_EVENT( wxEVT_STC_PAINTED, wxStyledTextEvent );
+wxDEFINE_EVENT( wxEVT_STC_USERLISTSELECTION, wxStyledTextEvent );
+wxDEFINE_EVENT( wxEVT_STC_URIDROPPED, wxStyledTextEvent );
+wxDEFINE_EVENT( wxEVT_STC_DWELLSTART, wxStyledTextEvent );
+wxDEFINE_EVENT( wxEVT_STC_DWELLEND, wxStyledTextEvent );
+wxDEFINE_EVENT( wxEVT_STC_START_DRAG, wxStyledTextEvent );
+wxDEFINE_EVENT( wxEVT_STC_DRAG_OVER, wxStyledTextEvent );
+wxDEFINE_EVENT( wxEVT_STC_DO_DROP, wxStyledTextEvent );
+wxDEFINE_EVENT( wxEVT_STC_ZOOM, wxStyledTextEvent );
+wxDEFINE_EVENT( wxEVT_STC_HOTSPOT_CLICK, wxStyledTextEvent );
+wxDEFINE_EVENT( wxEVT_STC_HOTSPOT_DCLICK, wxStyledTextEvent );
+wxDEFINE_EVENT( wxEVT_STC_CALLTIP_CLICK, wxStyledTextEvent );
+wxDEFINE_EVENT( wxEVT_STC_AUTOCOMP_SELECTION, wxStyledTextEvent );
+wxDEFINE_EVENT( wxEVT_STC_INDICATOR_CLICK, wxStyledTextEvent );
+wxDEFINE_EVENT( wxEVT_STC_INDICATOR_RELEASE, wxStyledTextEvent );
+wxDEFINE_EVENT( wxEVT_STC_AUTOCOMP_CANCELLED, wxStyledTextEvent );
+wxDEFINE_EVENT( wxEVT_STC_AUTOCOMP_CHAR_DELETED, wxStyledTextEvent );

 
 
 
 
 
 


@@ -186,6 +199,7 @@ bool wxStyledTextCtrl::Create(wxWindow *parent,
     m_swx = new ScintillaWX(this);
     m_stopWatch.Start();
     m_lastKeyDownConsumed = false;
     m_swx = new ScintillaWX(this);
     m_stopWatch.Start();
     m_lastKeyDownConsumed = false;

+    m_lastWheelTimestamp = 0;

     m_vScrollBar = NULL;
     m_hScrollBar = NULL;
 #if wxUSE_UNICODE
     m_vScrollBar = NULL;
     m_hScrollBar = NULL;
 #if wxUSE_UNICODE


@@ -212,8 +226,8 @@ wxStyledTextCtrl::~wxStyledTextCtrl() {
 
 //----------------------------------------------------------------------
 
 
 //----------------------------------------------------------------------
 

-long wxStyledTextCtrl::SendMsg(int msg, long wp, long lp) {
-
+wxIntPtr wxStyledTextCtrl::SendMsg(int msg, wxUIntPtr wp, wxIntPtr lp) const
+{

     return m_swx->WndProc(msg, wp, lp);
 }
 
     return m_swx->WndProc(msg, wp, lp);
 }
 


@@ -239,13 +253,11 @@ void wxStyledTextCtrl::SetHScrollBar(wxScrollBar* bar)  {
 }
 
 //----------------------------------------------------------------------
 }
 
 //----------------------------------------------------------------------

-// BEGIN generated section.  The following code is automatically generated
-//       by gen_iface.py from the contents of Scintilla.iface.  Do not edit
-//       this file.  Edit stc.cpp.in or gen_iface.py instead and regenerate.
+// Generated methods implementation section {{{

 
 %(METHOD_IMPS)s
 
 
 %(METHOD_IMPS)s
 

-// END of generated section
+//}}}

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


@@ -479,15 +491,6 @@ void wxStyledTextCtrl::SetMargins(int left, int right) {
 }
 
 
 }
 
 

-// Retrieve the start and end positions of the current selection.
-void wxStyledTextCtrl::GetSelection(int* startPos, int* endPos) {
-    if (startPos != NULL)
-        *startPos = SendMsg(SCI_GETSELECTIONSTART);
-    if (endPos != NULL)
-        *endPos = SendMsg(SCI_GETSELECTIONEND);
-}
-
-

 // Retrieve the point in the window where a position is displayed.
 wxPoint wxStyledTextCtrl::PointFromPosition(int pos) {
     int x = SendMsg(SCI_POINTXFROMPOSITION, 0, pos);
 // Retrieve the point in the window where a position is displayed.
 wxPoint wxStyledTextCtrl::PointFromPosition(int pos) {
     int x = SendMsg(SCI_POINTXFROMPOSITION, 0, pos);


@@ -507,67 +510,58 @@ void wxStyledTextCtrl::ScrollToColumn(int column) {
 }
 
 
 }
 
 

+#if wxUSE_TEXTCTRL
+bool wxStyledTextCtrl::DoSaveFile(const wxString& filename, int fileType)
+{
+   bool ok = wxTextAreaBase::DoSaveFile(filename, fileType);
+#else

 bool wxStyledTextCtrl::SaveFile(const wxString& filename)
 {
 bool wxStyledTextCtrl::SaveFile(const wxString& filename)
 {

-    wxFile file(filename, wxFile::write);
-
-    if (!file.IsOpened())
-        return false;
-
-    bool success = file.Write(GetText(), *wxConvCurrent);
-
-    if (success)
+#if wxUSE_FFILE
+    wxFFile file(filename, wxT("w"));
+    bool ok = file.IsOpened() && file.Write(GetValue(), *wxConvCurrent);
+#else
+    bool ok = false;
+#endif // wxUSE_FFILE
+#endif
+    if (ok)
+    {

         SetSavePoint();
         SetSavePoint();

-
-    return success;
+    }
+    return ok;

 }
 
 }
 

+#if wxUSE_TEXTCTRL
+bool wxStyledTextCtrl::DoLoadFile(const wxString& filename, int fileType)
+{
+   bool ok = wxTextAreaBase::DoLoadFile(filename, fileType);
+#else

 bool wxStyledTextCtrl::LoadFile(const wxString& filename)
 {
 bool wxStyledTextCtrl::LoadFile(const wxString& filename)
 {

-    bool success = false;
-    wxFile file(filename, wxFile::read);
-
-    if (file.IsOpened())
+#if wxUSE_FFILE
+    wxFFile file(filename);
+    bool ok = file.IsOpened();
+    if (ok)

     {
     {

-        wxString contents;
-        // get the file size (assume it is not huge file...)
-        ssize_t len = (ssize_t)file.Length();
-
-        if (len > 0)
-        {
-#if wxUSE_UNICODE
-            wxMemoryBuffer buffer(len+1);
-            success = (file.Read(buffer.GetData(), len) == len);
-            if (success) {
-                ((char*)buffer.GetData())[len] = 0;
-                contents = wxString(buffer, *wxConvCurrent, len);
-            }
-#else
-            wxString buffer;
-            success = (file.Read(wxStringBuffer(buffer, len), len) == len);
-            contents = buffer;
-#endif
-        }
-        else
-        {
-            if (len == 0)
-                success = true;  // empty file is ok
-            else
-                success = false; // len == wxInvalidOffset
-        }
-
-        if (success)
+        wxString text;
+        ok = file.ReadAll(&text, *wxConvCurrent);
+        if (ok)

         {
         {

-            SetText(contents);
-            EmptyUndoBuffer();
-            SetSavePoint();
+            SetValue(text);

         }
     }
         }
     }

-
-    return success;
+#else
+    bool ok = false;
+#endif // wxUSE_FFILE
+#endif
+   if (ok)
+   {
+       EmptyUndoBuffer();
+       SetSavePoint();
+   }
+   return ok;

 }
 
 }
 

-

 #if wxUSE_DRAG_AND_DROP
 wxDragResult wxStyledTextCtrl::DoDragOver(wxCoord x, wxCoord y, wxDragResult def) {
         return m_swx->DoDragOver(x, y, def);
 #if wxUSE_DRAG_AND_DROP
 wxDragResult wxStyledTextCtrl::DoDragOver(wxCoord x, wxCoord y, wxDragResult def) {
         return m_swx->DoDragOver(x, y, def);


@@ -594,12 +588,12 @@ bool wxStyledTextCtrl::GetUseAntiAliasing() {
 
 void wxStyledTextCtrl::AddTextRaw(const char* text)
 {
 
 void wxStyledTextCtrl::AddTextRaw(const char* text)
 {

-    SendMsg(SCI_ADDTEXT, strlen(text), (long)text);
+    SendMsg(SCI_ADDTEXT, strlen(text), (sptr_t)text);

 }
 
 void wxStyledTextCtrl::InsertTextRaw(int pos, const char* text)
 {
 }
 
 void wxStyledTextCtrl::InsertTextRaw(int pos, const char* text)
 {

-    SendMsg(SCI_INSERTTEXT, pos, (long)text);
+    SendMsg(SCI_INSERTTEXT, pos, (sptr_t)text);

 }
 
 wxCharBuffer wxStyledTextCtrl::GetCurLineRaw(int* linePos)
 }
 
 wxCharBuffer wxStyledTextCtrl::GetCurLineRaw(int* linePos)


@@ -612,7 +606,7 @@ wxCharBuffer wxStyledTextCtrl::GetCurLineRaw(int* linePos)
     }
 
     wxCharBuffer buf(len);
     }
 
     wxCharBuffer buf(len);

-    int pos = SendMsg(SCI_GETCURLINE, len, (long)buf.data());
+    int pos = SendMsg(SCI_GETCURLINE, len, (sptr_t)buf.data());

     if (linePos)  *linePos = pos;
     return buf;
 }
     if (linePos)  *linePos = pos;
     return buf;
 }


@@ -626,14 +620,14 @@ wxCharBuffer wxStyledTextCtrl::GetLineRaw(int line)
     }
 
     wxCharBuffer buf(len);
     }
 
     wxCharBuffer buf(len);

-    SendMsg(SCI_GETLINE, line, (long)buf.data());
+    SendMsg(SCI_GETLINE, line, (sptr_t)buf.data());

     return buf;
 }
 
 wxCharBuffer wxStyledTextCtrl::GetSelectedTextRaw()
 {
     return buf;
 }
 
 wxCharBuffer wxStyledTextCtrl::GetSelectedTextRaw()
 {

-    int   start;
-    int   end;
+    long   start;
+    long   end;

 
     GetSelection(&start, &end);
     int   len  = end - start;
 
     GetSelection(&start, &end);
     int   len  = end - start;


@@ -643,7 +637,7 @@ wxCharBuffer wxStyledTextCtrl::GetSelectedTextRaw()
     }
 
     wxCharBuffer buf(len);
     }
 
     wxCharBuffer buf(len);

-    SendMsg(SCI_GETSELTEXT, 0, (long)buf.data());
+    SendMsg(SCI_GETSELTEXT, 0, (sptr_t)buf.data());

     return buf;
 }
 
     return buf;
 }
 


@@ -665,26 +659,26 @@ wxCharBuffer wxStyledTextCtrl::GetTextRangeRaw(int startPos, int endPos)
     tr.lpstrText = buf.data();
     tr.chrg.cpMin = startPos;
     tr.chrg.cpMax = endPos;
     tr.lpstrText = buf.data();
     tr.chrg.cpMin = startPos;
     tr.chrg.cpMax = endPos;

-    SendMsg(SCI_GETTEXTRANGE, 0, (long)&tr);
+    SendMsg(SCI_GETTEXTRANGE, 0, (sptr_t)&tr);

     return buf;
 }
 
 void wxStyledTextCtrl::SetTextRaw(const char* text)
 {
     return buf;
 }
 
 void wxStyledTextCtrl::SetTextRaw(const char* text)
 {

-    SendMsg(SCI_SETTEXT, 0, (long)text);
+    SendMsg(SCI_SETTEXT, 0, (sptr_t)text);

 }
 
 wxCharBuffer wxStyledTextCtrl::GetTextRaw()
 {
 }
 
 wxCharBuffer wxStyledTextCtrl::GetTextRaw()
 {

-    int len  = GetTextLength();
-    wxCharBuffer buf(len);
-    SendMsg(SCI_GETTEXT, len, (long)buf.data());
+    int len = GetTextLength();
+    wxCharBuffer buf(len); // adds 1 for NUL automatically
+    SendMsg(SCI_GETTEXT, len + 1, (sptr_t)buf.data());

     return buf;
 }
 
 void wxStyledTextCtrl::AppendTextRaw(const char* text)
 {
     return buf;
 }
 
 void wxStyledTextCtrl::AppendTextRaw(const char* text)
 {

-    SendMsg(SCI_APPENDTEXT, strlen(text), (long)text);
+    SendMsg(SCI_APPENDTEXT, strlen(text), (sptr_t)text);

 }
 
 
 }
 
 


@@ -768,12 +762,21 @@ void wxStyledTextCtrl::OnContextMenu(wxContextMenuEvent& evt) {
 }
 
 
 }
 
 

-void wxStyledTextCtrl::OnMouseWheel(wxMouseEvent& evt) {
-    m_swx->DoMouseWheel(evt.GetWheelRotation(),
-                        evt.GetWheelDelta(),
-                        evt.GetLinesPerAction(),
-                        evt.ControlDown(),
-                        evt.IsPageScroll());
+void wxStyledTextCtrl::OnMouseWheel(wxMouseEvent& evt)
+{
+    // prevent having an event queue with wheel events that cannot be processed
+    // reasonably fast (see ticket #9057)
+    if ( m_lastWheelTimestamp <= evt.GetTimestamp() )
+    {
+        m_lastWheelTimestamp = m_stopWatch.Time();
+        m_swx->DoMouseWheel(evt.GetWheelRotation(),
+                            evt.GetWheelDelta(),
+                            evt.GetLinesPerAction(),
+                            evt.ControlDown(),
+                            evt.IsPageScroll());
+        m_lastWheelTimestamp = m_stopWatch.Time() - m_lastWheelTimestamp;
+        m_lastWheelTimestamp += evt.GetTimestamp();
+    }

 }
 
 
 }
 
 


@@ -1031,6 +1034,14 @@ void wxStyledTextCtrl::NotifyParent(SCNotification* _scn) {
         evt.SetEventType(wxEVT_STC_INDICATOR_RELEASE);
         break;
 
         evt.SetEventType(wxEVT_STC_INDICATOR_RELEASE);
         break;
 

+    case SCN_AUTOCCANCELLED:
+        evt.SetEventType(wxEVT_STC_AUTOCOMP_CANCELLED);
+        break;
+
+    case SCN_AUTOCCHARDELETED:
+        evt.SetEventType(wxEVT_STC_AUTOCOMP_CHAR_DELETED);
+        break;
+

     default:
         return;
     }
     default:
         return;
     }


@@ -1062,8 +1073,8 @@ wxStyledTextEvent::wxStyledTextEvent(wxEventType commandType, int id)
     m_listType = 0;
     m_x = 0;
     m_y = 0;
     m_listType = 0;
     m_x = 0;
     m_y = 0;

-    m_dragAllowMove = false;

 #if wxUSE_DRAG_AND_DROP
 #if wxUSE_DRAG_AND_DROP

+    m_dragFlags = wxDrag_CopyOnly;

     m_dragResult = wxDragNone;
 #endif
 }
     m_dragResult = wxDragNone;
 #endif
 }


@@ -1097,9 +1108,9 @@ wxStyledTextEvent::wxStyledTextEvent(const wxStyledTextEvent& event):
     m_x =            event.m_x;
     m_y =            event.m_y;
 
     m_x =            event.m_x;
     m_y =            event.m_y;
 

-    m_dragText =     event.m_dragText;
-    m_dragAllowMove =event.m_dragAllowMove;

 #if wxUSE_DRAG_AND_DROP
 #if wxUSE_DRAG_AND_DROP

+    m_dragText =     event.m_dragText;
+    m_dragFlags =    event.m_dragFlags;

     m_dragResult =   event.m_dragResult;
 #endif
 }
     m_dragResult =   event.m_dragResult;
 #endif
 }


@@ -1107,4 +1118,9 @@ wxStyledTextEvent::wxStyledTextEvent(const wxStyledTextEvent& event):
 //----------------------------------------------------------------------
 //----------------------------------------------------------------------
 
 //----------------------------------------------------------------------
 //----------------------------------------------------------------------
 

+/*static*/ wxVersionInfo wxStyledTextCtrl::GetLibraryVersionInfo()
+{
+    return wxVersionInfo("Scintilla", 2, 3, 0, "Scintilla 2.03");
+}
+

 #endif // wxUSE_STC
 #endif // wxUSE_STC