]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/stc/stc.h
deprecate Create() function in favour of CreateThread(); its name is too generic...
[wxWidgets.git] / include / wx / stc / stc.h
index e9cbffab90df55c01cd1ab82692cbe129a792419..e701ed988105e3ba762bd21ee300b4db015ffffd 100644 (file)
 #include "wx/dnd.h"
 #include "wx/stopwatch.h"
 
+#include "wx/textentry.h"
+#if wxUSE_TEXTCTRL
+    #include "wx/textctrl.h"
+#endif // wxUSE_TEXTCTRL
+
 class WXDLLIMPEXP_FWD_CORE wxScrollBar;
 
 // SWIG can't handle "#if" type of conditionals, only "#ifdef"
@@ -1973,7 +1978,7 @@ class  WordList;
 struct SCNotification;
 
 #ifndef SWIG
-extern WXDLLIMPEXP_STC const wxChar* wxSTCNameStr;
+extern WXDLLIMPEXP_DATA_STC(const char) wxSTCNameStr[];
 class  WXDLLIMPEXP_FWD_STC wxStyledTextCtrl;
 class  WXDLLIMPEXP_FWD_STC wxStyledTextEvent;
 #endif
@@ -1981,6 +1986,10 @@ class  WXDLLIMPEXP_FWD_STC wxStyledTextEvent;
 //----------------------------------------------------------------------
 
 class WXDLLIMPEXP_STC wxStyledTextCtrl : public wxControl
+                                       , public wxTextEntryBase
+#if wxUSE_TEXTCTRL
+                                       , public wxTextAreaBase
+#endif // wxUSE_TEXTCTRL
 {
 public:
 
@@ -2062,7 +2071,7 @@ public:
     wxMemoryBuffer GetStyledText(int startPos, int endPos);
 
     // Are there any redoable actions in the undo history?
-    bool CanRedo();
+    bool CanRedo() const;
 
     // Retrieve the line number at which a particular marker is located.
     int MarkerLineFromHandle(int handle);
@@ -2081,7 +2090,7 @@ public:
     void SetViewWhiteSpace(int viewWS);
 
     // Find the position from a point within the window.
-    int PositionFromPoint(wxPoint pt);
+    int PositionFromPoint(wxPoint pt) const;
 
     // Find the position from a point within the window but return
     // INVALID_POSITION if not close to text.
@@ -2586,7 +2595,7 @@ public:
     int GetFirstVisibleLine() const;
 
     // Retrieve the contents of a line.
-    wxString GetLine(int line);
+    wxString GetLine(int line) const;
 
     // Returns the number of lines in the document. There is always at least one.
     int GetLineCount() const;
@@ -2606,9 +2615,6 @@ public:
     // Is the document different from when it was last saved?
     bool GetModify() const;
 
-    // Select a range of text.
-    void SetSelection(int start, int end);
-
     // Retrieve the selected text.
     wxString GetSelectedText();
 
@@ -2619,10 +2625,10 @@ public:
     void HideSelection(bool normal);
 
     // Retrieve the line containing a position.
-    int LineFromPosition(int pos);
+    int LineFromPosition(int pos) const;
 
     // Retrieve the position at the start of a line.
-    int PositionFromLine(int line);
+    int PositionFromLine(int line) const;
 
     // Scroll horizontally and vertically.
     void LineScroll(int columns, int lines);
@@ -2637,10 +2643,10 @@ public:
     void SetReadOnly(bool readOnly);
 
     // Will a paste succeed?
-    bool CanPaste();
+    bool CanPaste() const;
 
     // Are there any undoable actions in the undo history?
-    bool CanUndo();
+    bool CanUndo() const;
 
     // Delete the undo history.
     void EmptyUndoBuffer();
@@ -2664,7 +2670,7 @@ public:
     void SetText(const wxString& text);
 
     // Retrieve all the text in the document.
-    wxString GetText();
+    wxString GetText() const;
 
     // Retrieve the number of characters in the document.
     int GetTextLength() const;
@@ -3087,7 +3093,7 @@ public:
     void MoveCaretInsideView();
 
     // How many characters are on a line, not including end of line characters?
-    int LineLength(int line);
+    int LineLength(int line) const;
 
     // Highlight the characters at two positions.
     void BraceHighlight(int pos1, int pos2);
@@ -3538,13 +3544,6 @@ public:
     void SetMargins(int left, int right);
 
 
-    // Retrieve the start and end positions of the current selection.
-#ifdef SWIG
-    void GetSelection(int* OUTPUT, int* OUTPUT);
-#else
-    void GetSelection(int* startPos, int* endPos);
-#endif
-
     // Retrieve the point in the window where a position is displayed.
     wxPoint PointFromPosition(int pos);
 
@@ -3562,7 +3561,7 @@ public:
     // NB: this method is not really const as it can modify the control but it
     //     has to be declared as such as it's called from both const and
     //     non-const methods and we can't distinguish between the two
-    long SendMsg(int msg, long wp=0, long lp=0) const;
+    wxIntPtr SendMsg(int msg, wxUIntPtr wp=0, wxIntPtr lp=0) const;
 
 
     // Set the vertical scrollbar to use instead of the ont that's built-in.
@@ -3576,11 +3575,14 @@ public:
     bool GetLastKeydownProcessed() { return m_lastKeyDownConsumed; }
     void SetLastKeydownProcessed(bool val) { m_lastKeyDownConsumed = val; }
 
+    // if we derive from wxTextAreaBase it already provides these methods
+#if !wxUSE_TEXTCTRL
     // Write the contents of the editor to filename
     bool SaveFile(const wxString& filename);
 
     // Load the contents of filename into the editor
     bool LoadFile(const wxString& filename);
+#endif // !wxUSE_TEXTCTRL
 
 #ifdef STC_USE_DND
     // Allow for simulating a DnD DragOver
@@ -3641,11 +3643,162 @@ public:
 #ifdef SWIG
     %pythoncode "_stc_utf8_methods.py"
 #endif
-//----------------------------------------------------------------------
 
 
+    // implement wxTextEntryBase pure virtual methods
+    // ----------------------------------------------
+
+    virtual void WriteText(const wxString& text) { AddText(text); }
+    virtual wxString GetValue() const { return GetText(); }
+    virtual void Remove(long from, long to)
+    {
+        Replace(from, to, "");
+    }
+    virtual void Replace(long from, long to, const wxString& text)
+    {
+        SetTargetStart(from);
+        SetTargetEnd(to);
+        ReplaceTarget(text);
+    }
+
+    /*
+        These functions are already declared in the generated section.
+
+    virtual void Copy();
+    virtual void Cut();
+    virtual void Paste();
+
+    virtual void Undo();
+    virtual void Redo();
+
+    virtual bool CanUndo() const;
+    virtual bool CanRedo() const;
+
+    */
+
+    virtual void SetInsertionPoint(long pos) { SetCurrentPos(pos); }
+    virtual long GetInsertionPoint() const { return GetCurrentPos(); }
+    virtual long GetLastPosition() const { return GetTextLength(); }
+
+    virtual void SetSelection(long from, long to)
+    {
+        if ( from == -1 && to == -1 )
+        {
+            SelectAll();
+        }
+        else
+        {
+            SetSelectionStart(from);
+            SetSelectionEnd(to);
+        }
+    }
+
+#ifdef SWIG
+    void GetSelection(long* OUTPUT, long* OUTPUT) const;
+#else
+    virtual void GetSelection(long *from, long *to) const
+    {
+        if ( from )
+            *from = GetSelectionStart();
+        if ( to )
+            *to = GetSelectionEnd();
+    }
+
+    // kept for compatibility only
+    void GetSelection(int *from, int *to)
+    {
+        long f, t;
+        GetSelection(&f, &t);
+        if ( from )
+            *from = f;
+        if ( to )
+            *to = t;
+    }
+#endif
+
+    virtual bool IsEditable() const { return !GetReadOnly(); }
+    virtual void SetEditable(bool editable) { SetReadOnly(!editable); }
+
+    // implement wxTextAreaBase pure virtual methods
+    // ---------------------------------------------
+
+    virtual int GetLineLength(long n) const { return GetLine(n).length(); }
+    virtual wxString GetLineText(long n) const { return GetLine(n); }
+    virtual int GetNumberOfLines() const { return GetLineCount(); }
+
+    virtual bool IsModified() const { return GetModify(); }
+    virtual void MarkDirty() { wxFAIL_MSG("not implemented"); }
+    virtual void DiscardEdits() { SetSavePoint(); }
+
+    virtual bool SetStyle(long WXUNUSED(start), long WXUNUSED(end),
+                          const wxTextAttr& WXUNUSED(style))
+    {
+        wxFAIL_MSG("not implemented");
+
+        return false;
+    }
+
+    virtual bool GetStyle(long WXUNUSED(position), wxTextAttr& WXUNUSED(style))
+    {
+        wxFAIL_MSG("not implemented");
+
+        return false;
+    }
+
+    virtual bool SetDefaultStyle(const wxTextAttr& WXUNUSED(style))
+    {
+        wxFAIL_MSG("not implemented");
+
+        return false;
+    }
+
+    virtual long XYToPosition(long x, long y) const
+    {
+        long pos = PositionFromLine(y);
+        pos += x;
+        return pos;
+    }
+
+    virtual bool PositionToXY(long pos, long *x, long *y) const
+    {
+        if ( x )
+            *x = -1; // TODO
+
+        if ( y )
+        {
+            long l = LineFromPosition(pos);
+            if ( l == -1 )
+                return false;
+            *y = l;
+        }
+
+        return true;
+    }
+
+    virtual void ShowPosition(long pos) { GotoPos(pos); }
+
+    // FIXME-VC6: can't use wxWindow here because of "error C2603: illegal
+    //            access declaration: 'wxWindow' is not a direct base of
+    //            'wxStyledTextCtrl'" with VC6
+    using wxControl::HitTest;
+
+    virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt, long *pos) const
+    {
+        const long l = PositionFromPoint(pt);
+        if ( l == -1 )
+            return wxTE_HT_BELOW; // we don't really know where it was
+
+        if ( pos )
+            *pos = l;
+
+        return wxTE_HT_ON_TEXT;
+    }
+
 #ifndef SWIG
 protected:
+    virtual bool DoLoadFile(const wxString& file, int fileType);
+    virtual bool DoSaveFile(const wxString& file, int fileType);
+
     // Event handlers
     void OnPaint(wxPaintEvent& evt);
     void OnScrollWin(wxScrollWinEvent& evt);
@@ -3687,9 +3840,13 @@ protected:
 
     bool                m_lastKeyDownConsumed;
 
+    // the timestamp that consists of the last wheel event
+    // added to the time taken to process that event.
+    long m_lastWheelTimestamp;
+
     friend class ScintillaWX;
     friend class Platform;
-#endif
+#endif // !SWIG
 };
 
 //----------------------------------------------------------------------