Updated to Scintilla from 1.45 to 1.47

[wxWidgets.git] / include / wx / textctrl.h

diff --git a/include/wx/textctrl.h b/include/wx/textctrl.h
index aa8f5bf48a683d09faed50df23e477f3948e3f34..358e30495861f1f3d5590e91795027d7f39d4a14 100644 (file)
--- a/include/wx/textctrl.h
+++ b/include/wx/textctrl.h
@@ -16,7 +16,7 @@
 // headers
 // ----------------------------------------------------------------------------
 
 // headers
 // ----------------------------------------------------------------------------
 

-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(__APPLE__)

     #pragma interface "textctrlbase.h"
 #endif
 
     #pragma interface "textctrlbase.h"
 #endif
 


@@ -30,14 +30,8 @@
 // and streambuf: it complains about deriving a huge class from the huge class
 // streambuf. !! Also, can't use streambuf if making or using a DLL :-(
 
 // and streambuf: it complains about deriving a huge class from the huge class
 // streambuf. !! Also, can't use streambuf if making or using a DLL :-(
 

-#if (defined(__BORLANDC__)) || defined(__MWERKS__) || defined(_WINDLL) || defined(WXUSINGDLL) || defined(WXMAKINGDLL)
-    #define NO_TEXT_WINDOW_STREAM
-#endif
-
-// the streambuf which is used in the declaration of wxTextCtrlBase below is not compatible
-// with the standard-conforming implementation found in newer egcs versions
-// (that is, the libstdc++ v3 that is shipped with it)
-#if defined(__GNUC__)&&( (__GNUC__>2) ||( (__GNUC__==2)&&(__GNUC_MINOR__>97) ) )
+#if (defined(__BORLANDC__)) || defined(__MWERKS__) || \
+    defined(WXUSINGDLL) || defined(WXMAKINGDLL)

     #define NO_TEXT_WINDOW_STREAM
 #endif
 
     #define NO_TEXT_WINDOW_STREAM
 #endif
 


@@ -51,6 +45,7 @@
 #endif
 
 class WXDLLEXPORT wxTextCtrl;
 #endif
 
 class WXDLLEXPORT wxTextCtrl;

+class WXDLLEXPORT wxTextCtrlBase;

 
 // ----------------------------------------------------------------------------
 // constants
 
 // ----------------------------------------------------------------------------
 // constants


@@ -63,18 +58,27 @@ WXDLLEXPORT_DATA(extern const wxChar*) wxEmptyString;
 // wxTextCtrl style flags
 // ----------------------------------------------------------------------------
 
 // wxTextCtrl style flags
 // ----------------------------------------------------------------------------
 

-// the flag bits 0x0001, 2, 4 and 8 are free but should be used only for the
+// the flag bits 0x0001, and 0x0004 are free but should be used only for the

 // things which don't make sense for a text control used by wxTextEntryDialog
 // because they would otherwise conflict with wxOK, wxCANCEL, wxCENTRE
 // things which don't make sense for a text control used by wxTextEntryDialog
 // because they would otherwise conflict with wxOK, wxCANCEL, wxCENTRE

+
+#define wxTE_NO_VSCROLL     0x0002
+#define wxTE_AUTO_SCROLL    0x0008
+

 #define wxTE_READONLY       0x0010
 #define wxTE_MULTILINE      0x0020
 #define wxTE_PROCESS_TAB    0x0040
 
 #define wxTE_READONLY       0x0010
 #define wxTE_MULTILINE      0x0020
 #define wxTE_PROCESS_TAB    0x0040
 

+// alignment flags
+#define wxTE_LEFT           0x0000                    // 0x0000
+#define wxTE_CENTER         wxALIGN_CENTER_HORIZONTAL // 0x0100
+#define wxTE_RIGHT          wxALIGN_RIGHT             // 0x0200
+#define wxTE_CENTRE         wxTE_CENTER
+

 // this style means to use RICHEDIT control and does something only under wxMSW
 // and Win32 and is silently ignored under all other platforms
 #define wxTE_RICH           0x0080
 // this style means to use RICHEDIT control and does something only under wxMSW
 // and Win32 and is silently ignored under all other platforms
 #define wxTE_RICH           0x0080

-#define wxTE_NO_VSCROLL     0x0100
-#define wxTE_AUTO_SCROLL    0x0200
+

 #define wxTE_PROCESS_ENTER  0x0400
 #define wxTE_PASSWORD       0x0800
 
 #define wxTE_PROCESS_ENTER  0x0400
 #define wxTE_PASSWORD       0x0800
 


@@ -84,6 +88,20 @@ WXDLLEXPORT_DATA(extern const wxChar*) wxEmptyString;
 // this is for Win32 richedit controls only so far
 #define wxTE_AUTO_URL       0x1000
 
 // this is for Win32 richedit controls only so far
 #define wxTE_AUTO_URL       0x1000
 

+// by default, the Windows text control doesn't show the selection when it
+// doesn't have focus - use this style to force it to always show it
+#define wxTE_NOHIDESEL      0x2000
+
+// use wxHSCROLL to not wrap text at all, wxTE_LINEWRAP to wrap it at any
+// position and wxTE_WORDWRAP to wrap at words boundary
+#define wxTE_DONTWRAP       wxHSCROLL
+#define wxTE_LINEWRAP       0x4000
+#define wxTE_WORDWRAP       0x0000  // it's just == !wxHSCROLL
+
+// force using RichEdit version 2.0 or 3.0 instead of 1.0 (default) for
+// wxTE_RICH controls - can be used together with or instead of wxTE_RICH
+#define wxTE_RICH2          0x8000
+

 // ----------------------------------------------------------------------------
 // wxTextAttr: a structure containing the visual attributes of a text
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // wxTextAttr: a structure containing the visual attributes of a text
 // ----------------------------------------------------------------------------


@@ -119,6 +137,13 @@ public:
         return !HasTextColour() && !HasBackgroundColour() && !HasFont();
     }
 
         return !HasTextColour() && !HasBackgroundColour() && !HasFont();
     }
 

+    // return the attribute having the valid font and colours: it uses the
+    // attributes set in attr and falls back first to attrDefault and then to
+    // the text control font/colours for those attributes which are not set
+    static wxTextAttr Combine(const wxTextAttr& attr,
+                              const wxTextAttr& attrDef,
+                              const wxTextCtrlBase *text);
+

 private:
     wxColour m_colText,
              m_colBack;
 private:
     wxColour m_colText,
              m_colBack;


@@ -132,7 +157,7 @@ private:
 
 class WXDLLEXPORT wxTextCtrlBase : public wxControl
 #ifndef NO_TEXT_WINDOW_STREAM
 
 class WXDLLEXPORT wxTextCtrlBase : public wxControl
 #ifndef NO_TEXT_WINDOW_STREAM

-                                 , public streambuf
+                                 , public wxSTD streambuf

 #endif
 
 {
 #endif
 
 {


@@ -149,6 +174,8 @@ public:
     virtual wxString GetValue() const = 0;
     virtual void SetValue(const wxString& value) = 0;
 
     virtual wxString GetValue() const = 0;
     virtual void SetValue(const wxString& value) = 0;
 

+    virtual wxString GetRange(long from, long to) const;
+

     virtual int GetLineLength(long lineNo) const = 0;
     virtual wxString GetLineText(long lineNo) const = 0;
     virtual int GetNumberOfLines() const = 0;
     virtual int GetLineLength(long lineNo) const = 0;
     virtual wxString GetLineText(long lineNo) const = 0;
     virtual int GetNumberOfLines() const = 0;


@@ -156,9 +183,15 @@ public:
     virtual bool IsModified() const = 0;
     virtual bool IsEditable() const = 0;
 
     virtual bool IsModified() const = 0;
     virtual bool IsEditable() const = 0;
 

+    // more readable flag testing methods
+    bool IsSingleLine() const { return !(GetWindowStyle() & wxTE_MULTILINE); }
+    bool IsMultiLine() const { return !IsSingleLine(); }
+

     // If the return values from and to are the same, there is no selection.
     virtual void GetSelection(long* from, long* to) const = 0;
 
     // If the return values from and to are the same, there is no selection.
     virtual void GetSelection(long* from, long* to) const = 0;
 

+    virtual wxString GetStringSelection() const;
+

     // operations
     // ----------
 
     // operations
     // ----------
 


@@ -174,11 +207,19 @@ public:
     // clears the dirty flag
     virtual void DiscardEdits() = 0;
 
     // clears the dirty flag
     virtual void DiscardEdits() = 0;
 

+    // set the max number of characters which may be entered in a single line
+    // text control
+    virtual void SetMaxLength(unsigned long WXUNUSED(len)) { }
+

     // writing text inserts it at the current position, appending always
     // inserts it at the end
     virtual void WriteText(const wxString& text) = 0;
     virtual void AppendText(const wxString& text) = 0;
 
     // writing text inserts it at the current position, appending always
     // inserts it at the end
     virtual void WriteText(const wxString& text) = 0;
     virtual void AppendText(const wxString& text) = 0;
 

+    // insert the character which would have resulted from this key event,
+    // return TRUE if anything has been inserted
+    virtual bool EmulateKeyPress(const wxKeyEvent& event);
+

     // text control under some platforms supports the text styles: these
     // methods allow to apply the given text style to the given selection or to
     // set/get the style which will be used for all appended text
     // text control under some platforms supports the text styles: these
     // methods allow to apply the given text style to the given selection or to
     // set/get the style which will be used for all appended text


@@ -220,11 +261,9 @@ public:
     virtual void SelectAll();
     virtual void SetEditable(bool editable) = 0;
 
     virtual void SelectAll();
     virtual void SetEditable(bool editable) = 0;
 

-    // streambuf methods
+    // override streambuf method

 #ifndef NO_TEXT_WINDOW_STREAM
     int overflow(int i);
 #ifndef NO_TEXT_WINDOW_STREAM
     int overflow(int i);

-    int sync();
-    int underflow();

 #endif // NO_TEXT_WINDOW_STREAM
 
     // stream-like insertion operators: these are always available, whether we
 #endif // NO_TEXT_WINDOW_STREAM
 
     // stream-like insertion operators: these are always available, whether we


@@ -248,20 +287,15 @@ protected:
 
     // the text style which will be used for any new text added to the control
     wxTextAttr m_defaultStyle;
 
     // the text style which will be used for any new text added to the control
     wxTextAttr m_defaultStyle;

-
-private:
-#ifndef NO_TEXT_WINDOW_STREAM
-#if !wxUSE_IOSTREAMH
-    char *m_streambuf;
-#endif
-#endif

 };
 
 // ----------------------------------------------------------------------------
 // include the platform-dependent class definition
 // ----------------------------------------------------------------------------
 
 };
 
 // ----------------------------------------------------------------------------
 // include the platform-dependent class definition
 // ----------------------------------------------------------------------------
 

-#if defined(__WXUNIVERSAL__)
+#if defined(__WXX11__)
+    #include "wx/x11/textctrl.h"
+#elif defined(__WXUNIVERSAL__)

     #include "wx/univ/textctrl.h"
 #elif defined(__WXMSW__)
     #include "wx/msw/textctrl.h"
     #include "wx/univ/textctrl.h"
 #elif defined(__WXMSW__)
     #include "wx/msw/textctrl.h"


@@ -269,8 +303,6 @@ private:
     #include "wx/motif/textctrl.h"
 #elif defined(__WXGTK__)
     #include "wx/gtk/textctrl.h"
     #include "wx/motif/textctrl.h"
 #elif defined(__WXGTK__)
     #include "wx/gtk/textctrl.h"

-#elif defined(__WXQT__)
-    #include "wx/qt/textctrl.h"

 #elif defined(__WXMAC__)
     #include "wx/mac/textctrl.h"
 #elif defined(__WXPM__)
 #elif defined(__WXMAC__)
     #include "wx/mac/textctrl.h"
 #elif defined(__WXPM__)


@@ -283,20 +315,25 @@ private:
 // wxTextCtrl events
 // ----------------------------------------------------------------------------
 
 // wxTextCtrl events
 // ----------------------------------------------------------------------------
 

+#if !WXWIN_COMPATIBILITY_EVENT_TYPES
+

 BEGIN_DECLARE_EVENT_TYPES()
     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_UPDATED, 7)
     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_ENTER, 8)
     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_URL, 13)
 BEGIN_DECLARE_EVENT_TYPES()
     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_UPDATED, 7)
     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_ENTER, 8)
     DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_URL, 13)

+    DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_MAXLEN, 14)

 END_DECLARE_EVENT_TYPES()
 
 END_DECLARE_EVENT_TYPES()
 

+#endif // !WXWIN_COMPATIBILITY_EVENT_TYPES
+

 class WXDLLEXPORT wxTextUrlEvent : public wxCommandEvent
 {
 public:
     wxTextUrlEvent(int id, const wxMouseEvent& evtMouse,
                    long start, long end)
 class WXDLLEXPORT wxTextUrlEvent : public wxCommandEvent
 {
 public:
     wxTextUrlEvent(int id, const wxMouseEvent& evtMouse,
                    long start, long end)

-        : wxCommandEvent(wxEVT_COMMAND_TEXT_URL, id),
-          m_evtMouse(evtMouse)
-        { m_start = start; m_end = end; }
+        : wxCommandEvent(wxEVT_COMMAND_TEXT_URL, id)
+        , m_evtMouse(evtMouse), m_start(start), m_end(end)
+        { }

 
     // get the mouse event which happend over the URL
     const wxMouseEvent& GetMouseEvent() const { return m_evtMouse; }
 
     // get the mouse event which happend over the URL
     const wxMouseEvent& GetMouseEvent() const { return m_evtMouse; }


@@ -320,7 +357,7 @@ private:
 
 public:
     // for wxWin RTTI only, don't use
 
 public:
     // for wxWin RTTI only, don't use

-    wxTextUrlEvent() { }
+    wxTextUrlEvent() : m_evtMouse(), m_start(0), m_end(0) { }

 };
 
 typedef void (wxEvtHandler::*wxTextUrlEventFunction)(wxTextUrlEvent&);
 };
 
 typedef void (wxEvtHandler::*wxTextUrlEventFunction)(wxTextUrlEvent&);


@@ -328,6 +365,39 @@ typedef void (wxEvtHandler::*wxTextUrlEventFunction)(wxTextUrlEvent&);
 #define EVT_TEXT(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TEXT_UPDATED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
 #define EVT_TEXT_ENTER(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TEXT_ENTER, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
 #define EVT_TEXT_URL(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TEXT_URL, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) (wxTextUrlEventFunction) & fn, (wxObject *) NULL ),
 #define EVT_TEXT(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TEXT_UPDATED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
 #define EVT_TEXT_ENTER(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TEXT_ENTER, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
 #define EVT_TEXT_URL(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TEXT_URL, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) (wxTextUrlEventFunction) & fn, (wxObject *) NULL ),

+#define EVT_TEXT_MAXLEN(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TEXT_MAXLEN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
+
+#ifndef NO_TEXT_WINDOW_STREAM
+
+// ----------------------------------------------------------------------------
+// wxStreamToTextRedirector: this class redirects all data sent to the given
+// C++ stream to the wxTextCtrl given to its ctor during its lifetime.
+// ----------------------------------------------------------------------------
+
+class WXDLLEXPORT wxStreamToTextRedirector
+{
+public:
+    wxStreamToTextRedirector(wxTextCtrl *text, wxSTD ostream *ostr = NULL)
+        : m_ostr(ostr ? *ostr : wxSTD cout)
+    {
+        m_sbufOld = m_ostr.rdbuf();
+        m_ostr.rdbuf(text);
+    }
+
+    ~wxStreamToTextRedirector()
+    {
+        m_ostr.rdbuf(m_sbufOld);
+    }
+
+private:
+    // the stream we're redirecting
+    wxSTD ostream&   m_ostr;
+
+    // the old streambuf (before we changed it)
+    wxSTD streambuf *m_sbufOld;
+};
+
+#endif // !NO_TEXT_WINDOW_STREAM

 
 #endif // wxUSE_TEXTCTRL
 
 
 #endif // wxUSE_TEXTCTRL