added support for 2 extra mouse buttons (patch 1757630)

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

diff --git a/include/wx/textctrl.h b/include/wx/textctrl.h
index 43c6cfda0a97ca7a44eb73eb97e03d5bf8bac079..5494405586165aae7b87d7db2e6dbf3a8acc2c26 100644 (file)
--- a/include/wx/textctrl.h
+++ b/include/wx/textctrl.h
@@ -1,11 +1,11 @@
 ///////////////////////////////////////////////////////////////////////////////
 ///////////////////////////////////////////////////////////////////////////////

-// Name:        textctrl.h
+// Name:        wx/textctrl.h

 // Purpose:     wxTextCtrlBase class - the interface of wxTextCtrl
 // Author:      Vadim Zeitlin
 // Modified by:
 // Created:     13.07.99
 // RCS-ID:      $Id$
 // Purpose:     wxTextCtrlBase class - the interface of wxTextCtrl
 // Author:      Vadim Zeitlin
 // Modified by:
 // Created:     13.07.99
 // RCS-ID:      $Id$

-// Copyright:   (c) wxWidgets team
+// Copyright:   (c) Vadim Zeitlin

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


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

-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #pragma interface "textctrlbase.h"
-#endif
-

 #include "wx/defs.h"
 
 #if wxUSE_TEXTCTRL
 #include "wx/defs.h"
 
 #if wxUSE_TEXTCTRL


@@ -28,30 +24,23 @@
 #include "wx/dynarray.h"        // wxArrayInt
 #include "wx/gdicmn.h"          // wxPoint
 
 #include "wx/dynarray.h"        // wxArrayInt
 #include "wx/gdicmn.h"          // wxPoint
 

-// 16-bit Borland 4.0 doesn't seem to allow multiple inheritance with wxWindow
-// 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 :-(
+// Open Watcom 1.3 does allow only ios::rdbuf() while
+// we want something with streambuf parameter
+// Also, can't use streambuf if making or using a DLL :-(

 
 

-#if (defined(__BORLANDC__)) || defined(__MWERKS__) || \
+#if defined(__WATCOMC__) || \
+    defined(__MWERKS__) || \

     (defined(__WINDOWS__) && (defined(WXUSINGDLL) || defined(WXMAKINGDLL)))
     (defined(__WINDOWS__) && (defined(WXUSINGDLL) || defined(WXMAKINGDLL)))

-    #define NO_TEXT_WINDOW_STREAM
-#endif
-
-#ifndef NO_TEXT_WINDOW_STREAM
-    #if wxUSE_STD_IOSTREAM
-        #include "wx/ioswrap.h"    // derivation: we need the full decls.
-    #else // !wxUSE_STD_IOSTREAM
-        // can't compile this feature in if we don't use streams at all
-        #define NO_TEXT_WINDOW_STREAM
-    #endif // wxUSE_STD_IOSTREAM/!wxUSE_STD_IOSTREAM
-#endif
-
-#if defined(__WXMSW__) && defined(__MINGW32__)
-    #include "wx/msw/winundef.h"
+    #define wxHAS_TEXT_WINDOW_STREAM 0
+#elif wxUSE_STD_IOSTREAM
+    #include "wx/ioswrap.h"
+    #define wxHAS_TEXT_WINDOW_STREAM 1
+#else
+    #define wxHAS_TEXT_WINDOW_STREAM 0

 #endif
 
 #endif
 

-class WXDLLEXPORT wxTextCtrl;
-class WXDLLEXPORT wxTextCtrlBase;
+class WXDLLIMPEXP_FWD_CORE wxTextCtrl;
+class WXDLLIMPEXP_FWD_CORE wxTextCtrlBase;

 
 // ----------------------------------------------------------------------------
 // wxTextCtrl types
 
 // ----------------------------------------------------------------------------
 // wxTextCtrl types


@@ -68,7 +57,7 @@ typedef long wxTextCoord;
 // constants
 // ----------------------------------------------------------------------------
 
 // constants
 // ----------------------------------------------------------------------------
 

-extern WXDLLEXPORT_DATA(const wxChar*) wxTextCtrlNameStr;
+extern WXDLLEXPORT_DATA(const wxChar) wxTextCtrlNameStr[];

 
 // this is intentionally not enum to avoid warning fixes with
 // typecasting from enum type to wxTextCoord
 
 // this is intentionally not enum to avoid warning fixes with
 // typecasting from enum type to wxTextCoord


@@ -79,10 +68,6 @@ const wxTextCoord wxInvalidTextCoord    = -2;
 // wxTextCtrl style flags
 // ----------------------------------------------------------------------------
 
 // wxTextCtrl style flags
 // ----------------------------------------------------------------------------
 

-// 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
-

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


@@ -113,11 +98,19 @@ const wxTextCoord wxInvalidTextCoord    = -2;
 // doesn't have focus - use this style to force it to always show it
 #define wxTE_NOHIDESEL      0x2000
 
 // 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
+// use wxHSCROLL to not wrap text at all, wxTE_CHARWRAP to wrap it at any

 // position and wxTE_WORDWRAP to wrap at words boundary
 // position and wxTE_WORDWRAP to wrap at words boundary

+//
+// if no wrapping style is given at all, the control wraps at word boundary

 #define wxTE_DONTWRAP       wxHSCROLL
 #define wxTE_DONTWRAP       wxHSCROLL

-#define wxTE_LINEWRAP       0x4000
-#define wxTE_WORDWRAP       0x0000  // it's just == !wxHSCROLL
+#define wxTE_CHARWRAP       0x4000  // wrap at any position
+#define wxTE_WORDWRAP       0x0001  // wrap only at words boundaries
+#define wxTE_BESTWRAP       0x0000  // this is the default
+
+#if WXWIN_COMPATIBILITY_2_6
+    // obsolete synonym
+    #define wxTE_LINEWRAP       wxTE_CHARWRAP
+#endif // WXWIN_COMPATIBILITY_2_6

 
 // 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
 
 // 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


@@ -130,6 +123,12 @@ const wxTextCoord wxInvalidTextCoord    = -2;
 #define wxTE_CAPITALIZE     0
 #endif
 
 #define wxTE_CAPITALIZE     0
 #endif
 

+// ----------------------------------------------------------------------------
+// wxTextCtrl file types
+// ----------------------------------------------------------------------------
+
+#define wxTEXT_TYPE_ANY     0
+

 // ----------------------------------------------------------------------------
 // wxTextCtrl::HitTest return values
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // wxTextCtrl::HitTest return values
 // ----------------------------------------------------------------------------


@@ -171,7 +170,8 @@ enum wxTextAttrAlignment
 #define wxTEXT_ATTR_FONT_ITALIC             0x0020
 #define wxTEXT_ATTR_FONT_UNDERLINE          0x0040
 #define wxTEXT_ATTR_FONT \
 #define wxTEXT_ATTR_FONT_ITALIC             0x0020
 #define wxTEXT_ATTR_FONT_UNDERLINE          0x0040
 #define wxTEXT_ATTR_FONT \

-  wxTEXT_ATTR_FONT_FACE | wxTEXT_ATTR_FONT_SIZE | wxTEXT_ATTR_FONT_WEIGHT | wxTEXT_ATTR_FONT_ITALIC | wxTEXT_ATTR_FONT_UNDERLINE
+  ( wxTEXT_ATTR_FONT_FACE | wxTEXT_ATTR_FONT_SIZE | wxTEXT_ATTR_FONT_WEIGHT | \
+    wxTEXT_ATTR_FONT_ITALIC | wxTEXT_ATTR_FONT_UNDERLINE )

 #define wxTEXT_ATTR_ALIGNMENT               0x0080
 #define wxTEXT_ATTR_LEFT_INDENT             0x0100
 #define wxTEXT_ATTR_RIGHT_INDENT            0x0200
 #define wxTEXT_ATTR_ALIGNMENT               0x0080
 #define wxTEXT_ATTR_LEFT_INDENT             0x0100
 #define wxTEXT_ATTR_RIGHT_INDENT            0x0200


@@ -194,6 +194,22 @@ public:
     // operations
     void Init();
 
     // operations
     void Init();
 

+    // merges the attributes of the base and the overlay objects and returns
+    // the result; the parameter attributes take precedence
+    //
+    // WARNING: the order of arguments is the opposite of Combine()
+    static wxTextAttr Merge(const wxTextAttr& base, const wxTextAttr& overlay)
+    {
+        return Combine(overlay, base, NULL);
+    }
+
+    // merges the attributes of this object and overlay
+    void Merge(const wxTextAttr& overlay)
+    {
+        *this = Merge(*this, overlay);
+    }
+
+

     // operators
     void operator= (const wxTextAttr& attr);
 
     // operators
     void operator= (const wxTextAttr& attr);
 


@@ -261,7 +277,7 @@ private:
 // ----------------------------------------------------------------------------
 
 class WXDLLEXPORT wxTextCtrlBase : public wxControl
 // ----------------------------------------------------------------------------
 
 class WXDLLEXPORT wxTextCtrlBase : public wxControl

-#ifndef NO_TEXT_WINDOW_STREAM
+#if wxHAS_TEXT_WINDOW_STREAM

                                  , public wxSTD streambuf
 #endif
 
                                  , public wxSTD streambuf
 #endif
 


@@ -271,13 +287,18 @@ public:
     // --------
 
     wxTextCtrlBase(){}
     // --------
 
     wxTextCtrlBase(){}

-    ~wxTextCtrlBase(){}
+    virtual ~wxTextCtrlBase(){}

 
     // accessors
     // ---------
 
     virtual wxString GetValue() const = 0;
 
     // accessors
     // ---------
 
     virtual wxString GetValue() const = 0;

-    virtual void SetValue(const wxString& value) = 0;
+    virtual bool IsEmpty() const { return GetValue().empty(); }
+
+    virtual void SetValue(const wxString& value)
+        { DoSetValue(value, SetValue_SendEvent); }
+    virtual void ChangeValue(const wxString& value)
+        { DoSetValue(value); }

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


@@ -305,13 +326,24 @@ public:
     virtual void Replace(long from, long to, const wxString& value) = 0;
     virtual void Remove(long from, long to) = 0;
 
     virtual void Replace(long from, long to, const wxString& value) = 0;
     virtual void Remove(long from, long to) = 0;
 

-    // load/save the controls contents from/to the file
-    virtual bool LoadFile(const wxString& file);
-    virtual bool SaveFile(const wxString& file = wxEmptyString);
+    // load/save the control's contents from/to a file
+    bool LoadFile(const wxString& file, int fileType = wxTEXT_TYPE_ANY) { return DoLoadFile(file, fileType); }
+    bool SaveFile(const wxString& file = wxEmptyString, int fileType = wxTEXT_TYPE_ANY);
+
+    // implementation for loading/saving
+    virtual bool DoLoadFile(const wxString& file, int fileType);
+    virtual bool DoSaveFile(const wxString& file, int fileType);

 
     // sets/clears the dirty flag
     virtual void MarkDirty() = 0;
     virtual void DiscardEdits() = 0;
 
     // sets/clears the dirty flag
     virtual void MarkDirty() = 0;
     virtual void DiscardEdits() = 0;

+    void SetModified(bool modified)
+    {
+        if ( modified )
+            MarkDirty();
+        else
+            DiscardEdits();
+    }

 
     // set the max number of characters which may be entered in a single line
     // text control
 
     // set the max number of characters which may be entered in a single line
     // text control


@@ -377,11 +409,6 @@ public:
     virtual void SelectAll();
     virtual void SetEditable(bool editable) = 0;
 
     virtual void SelectAll();
     virtual void SetEditable(bool editable) = 0;
 

-    // override streambuf method
-#ifndef NO_TEXT_WINDOW_STREAM
-    int overflow(int i);
-#endif // NO_TEXT_WINDOW_STREAM
-

     // stream-like insertion operators: these are always available, whether we
     // were, or not, compiled with streambuf support
     wxTextCtrl& operator<<(const wxString& s);
     // stream-like insertion operators: these are always available, whether we
     // were, or not, compiled with streambuf support
     wxTextCtrl& operator<<(const wxString& s);


@@ -391,12 +418,31 @@ public:
     wxTextCtrl& operator<<(double d);
     wxTextCtrl& operator<<(const wxChar c);
 
     wxTextCtrl& operator<<(double d);
     wxTextCtrl& operator<<(const wxChar c);
 

+    // generate the wxEVT_COMMAND_TEXT_UPDATED event, like SetValue() does
+    void SendTextUpdatedEvent();
+

     // do the window-specific processing after processing the update event
     virtual void DoUpdateWindowUI(wxUpdateUIEvent& event);
 
     virtual bool ShouldInheritColours() const { return false; }
 
 protected:
     // do the window-specific processing after processing the update event
     virtual void DoUpdateWindowUI(wxUpdateUIEvent& event);
 
     virtual bool ShouldInheritColours() const { return false; }
 
 protected:

+    // override streambuf method
+#if wxHAS_TEXT_WINDOW_STREAM
+    int overflow(int i);
+#endif // wxHAS_TEXT_WINDOW_STREAM
+
+    // flags for DoSetValue(): common part of SetValue() and ChangeValue() and
+    // also used to implement WriteText() in wxMSW
+    enum
+    {
+        SetValue_SendEvent = 1,
+        SetValue_SelectionOnly = 2
+    };
+
+    virtual void DoSetValue(const wxString& value, int flags = 0) = 0;
+
+

     // the name of the last file loaded with LoadFile() which will be used by
     // SaveFile() by default
     wxString m_filename;
     // the name of the last file loaded with LoadFile() which will be used by
     // SaveFile() by default
     wxString m_filename;


@@ -405,6 +451,7 @@ protected:
     wxTextAttr m_defaultStyle;
 
     DECLARE_NO_COPY_CLASS(wxTextCtrlBase)
     wxTextAttr m_defaultStyle;
 
     DECLARE_NO_COPY_CLASS(wxTextCtrlBase)

+    DECLARE_ABSTRACT_CLASS(wxTextCtrlBase)

 };
 
 // ----------------------------------------------------------------------------
 };
 
 // ----------------------------------------------------------------------------


@@ -421,8 +468,10 @@ protected:
     #include "wx/msw/textctrl.h"
 #elif defined(__WXMOTIF__)
     #include "wx/motif/textctrl.h"
     #include "wx/msw/textctrl.h"
 #elif defined(__WXMOTIF__)
     #include "wx/motif/textctrl.h"

-#elif defined(__WXGTK__)
+#elif defined(__WXGTK20__)

     #include "wx/gtk/textctrl.h"
     #include "wx/gtk/textctrl.h"

+#elif defined(__WXGTK__)
+    #include "wx/gtk1/textctrl.h"

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


@@ -497,7 +546,7 @@ typedef void (wxEvtHandler::*wxTextUrlEventFunction)(wxTextUrlEvent&);
 #define EVT_TEXT_URL(id, fn) wx__DECLARE_TEXTURLEVT(URL, id, fn)
 #define EVT_TEXT_MAXLEN(id, fn) wx__DECLARE_TEXTEVT(MAXLEN, id, fn)
 
 #define EVT_TEXT_URL(id, fn) wx__DECLARE_TEXTURLEVT(URL, id, fn)
 #define EVT_TEXT_MAXLEN(id, fn) wx__DECLARE_TEXTEVT(MAXLEN, id, fn)
 

-#ifndef NO_TEXT_WINDOW_STREAM
+#if wxHAS_TEXT_WINDOW_STREAM

 
 // ----------------------------------------------------------------------------
 // wxStreamToTextRedirector: this class redirects all data sent to the given
 
 // ----------------------------------------------------------------------------
 // wxStreamToTextRedirector: this class redirects all data sent to the given


@@ -539,7 +588,7 @@ private:
     wxSTD streambuf *m_sbufOld;
 };
 
     wxSTD streambuf *m_sbufOld;
 };
 

-#endif // !NO_TEXT_WINDOW_STREAM
+#endif // wxHAS_TEXT_WINDOW_STREAM

 
 #endif // wxUSE_TEXTCTRL
 
 
 #endif // wxUSE_TEXTCTRL