Fix for unhiding the other version of the base class HitTest

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

diff --git a/include/wx/textctrl.h b/include/wx/textctrl.h
index 325205a455b57ecb4e4c611e4ba4854f67a36000..e93198c307f0e8ac482a53cd56c0ca6938965cb9 100644 (file)
--- a/include/wx/textctrl.h
+++ b/include/wx/textctrl.h
@@ -5,7 +5,7 @@
 // Modified by:
 // Created:     13.07.99
 // RCS-ID:      $Id$
 // Modified by:
 // Created:     13.07.99
 // RCS-ID:      $Id$

-// Copyright:   (c) wxWindows team
+// Copyright:   (c) wxWidgets team

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


@@ -25,14 +25,15 @@
 #if wxUSE_TEXTCTRL
 
 #include "wx/control.h"         // the base class
 #if wxUSE_TEXTCTRL
 
 #include "wx/control.h"         // the base class

-#include "wx/dynarray.h"
+#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 :-(
 
 #if (defined(__BORLANDC__)) || defined(__MWERKS__) || \
 
 // 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 :-(
 
 #if (defined(__BORLANDC__)) || defined(__MWERKS__) || \

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

     #define NO_TEXT_WINDOW_STREAM
 #endif
 
     #define NO_TEXT_WINDOW_STREAM
 #endif
 


@@ -48,6 +49,17 @@
 class WXDLLEXPORT wxTextCtrl;
 class WXDLLEXPORT wxTextCtrlBase;
 
 class WXDLLEXPORT wxTextCtrl;
 class WXDLLEXPORT wxTextCtrlBase;
 

+// ----------------------------------------------------------------------------
+// wxTextCtrl types
+// ----------------------------------------------------------------------------
+
+// wxTextPos is the position in the text
+typedef long wxTextPos;
+
+// wxTextCoord is the line or row number (which should have been unsigned but
+// is long for backwards compatibility)
+typedef long wxTextCoord;
+

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


@@ -102,6 +114,21 @@ WXDLLEXPORT_DATA(extern const wxChar*) wxTextCtrlNameStr;
 // wxTE_RICH controls - can be used together with or instead of wxTE_RICH
 #define wxTE_RICH2          0x8000
 
 // wxTE_RICH controls - can be used together with or instead of wxTE_RICH
 #define wxTE_RICH2          0x8000
 

+// ----------------------------------------------------------------------------
+// wxTextCtrl::HitTest return values
+// ----------------------------------------------------------------------------
+
+// the point asked is ...
+enum wxTextCtrlHitTestResult
+{
+    wxTE_HT_UNKNOWN = -2,   // this means HitTest() is simply not implemented
+    wxTE_HT_BEFORE,         // either to the left or upper
+    wxTE_HT_ON_TEXT,        // directly on
+    wxTE_HT_BELOW,          // below [the last line]
+    wxTE_HT_BEYOND          // after [the end of line]
+};
+// ... the character returned
+

 // ----------------------------------------------------------------------------
 // Types for wxTextAttr
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // Types for wxTextAttr
 // ----------------------------------------------------------------------------


@@ -160,7 +187,7 @@ public:
     void SetFont(const wxFont& font, long flags = wxTEXT_ATTR_FONT) { m_font = font; m_flags |= flags; }
     void SetAlignment(wxTextAttrAlignment alignment) { m_textAlignment = alignment; m_flags |= wxTEXT_ATTR_ALIGNMENT; }
     void SetTabs(const wxArrayInt& tabs) { m_tabs = tabs; m_flags |= wxTEXT_ATTR_TABS; }
     void SetFont(const wxFont& font, long flags = wxTEXT_ATTR_FONT) { m_font = font; m_flags |= flags; }
     void SetAlignment(wxTextAttrAlignment alignment) { m_textAlignment = alignment; m_flags |= wxTEXT_ATTR_ALIGNMENT; }
     void SetTabs(const wxArrayInt& tabs) { m_tabs = tabs; m_flags |= wxTEXT_ATTR_TABS; }

-    void SetLeftIndent(int indent) { m_leftIndent = indent; m_flags |= wxTEXT_ATTR_LEFT_INDENT; }
+    void SetLeftIndent(int indent, int subIndent = 0) { m_leftIndent = indent; m_leftSubIndent = subIndent; m_flags |= wxTEXT_ATTR_LEFT_INDENT; }

     void SetRightIndent(int indent) { m_rightIndent = indent; m_flags |= wxTEXT_ATTR_RIGHT_INDENT; }
     void SetFlags(long flags) { m_flags = flags; }
 
     void SetRightIndent(int indent) { m_rightIndent = indent; m_flags |= wxTEXT_ATTR_RIGHT_INDENT; }
     void SetFlags(long flags) { m_flags = flags; }
 


@@ -180,6 +207,7 @@ public:
     wxTextAttrAlignment GetAlignment() const { return m_textAlignment; }
     const wxArrayInt& GetTabs() const { return m_tabs; }
     long GetLeftIndent() const { return m_leftIndent; }
     wxTextAttrAlignment GetAlignment() const { return m_textAlignment; }
     const wxArrayInt& GetTabs() const { return m_tabs; }
     long GetLeftIndent() const { return m_leftIndent; }

+    long GetLeftSubIndent() const { return m_leftSubIndent; }

     long GetRightIndent() const { return m_rightIndent; }
     long GetFlags() const { return m_flags; }
 
     long GetRightIndent() const { return m_rightIndent; }
     long GetFlags() const { return m_flags; }
 


@@ -205,6 +233,9 @@ private:
     wxTextAttrAlignment m_textAlignment;
     wxArrayInt          m_tabs; // array of int: tab stops in 1/10 mm
     int                 m_leftIndent; // left indent in 1/10 mm
     wxTextAttrAlignment m_textAlignment;
     wxArrayInt          m_tabs; // array of int: tab stops in 1/10 mm
     int                 m_leftIndent; // left indent in 1/10 mm

+    int                 m_leftSubIndent; // left indent for all but the first 
+                                         // line in a paragraph relative to the
+                                         // first line, in 1/10 mm

     int                 m_rightIndent; // right indent in 1/10 mm
 };
 
     int                 m_rightIndent; // right indent in 1/10 mm
 };
 


@@ -262,7 +293,8 @@ public:
     virtual bool LoadFile(const wxString& file);
     virtual bool SaveFile(const wxString& file = wxEmptyString);
 
     virtual bool LoadFile(const wxString& file);
     virtual bool SaveFile(const wxString& file = wxEmptyString);
 

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

     virtual void DiscardEdits() = 0;
 
     // set the max number of characters which may be entered in a single line
     virtual void DiscardEdits() = 0;
 
     // set the max number of characters which may be entered in a single line


@@ -294,6 +326,15 @@ public:
 
     virtual void ShowPosition(long pos) = 0;
 
 
     virtual void ShowPosition(long pos) = 0;
 

+    // find the character at position given in pixels
+    //
+    // NB: pt is in device coords (not adjusted for the client area origin nor
+    //     scrolling)
+    virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt, long *pos) const;
+    virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt,
+                                            wxTextCoord *col,
+                                            wxTextCoord *row) const;
+

     // Clipboard operations
     virtual void Copy() = 0;
     virtual void Cut() = 0;
     // Clipboard operations
     virtual void Copy() = 0;
     virtual void Cut() = 0;


@@ -335,12 +376,9 @@ public:
     wxTextCtrl& operator<<(const wxChar c);
 
     // do the window-specific processing after processing the update event
     wxTextCtrl& operator<<(const wxChar c);
 
     // do the window-specific processing after processing the update event

-    virtual void DoUpdateWindowUI(wxUpdateUIEvent& event) ;
+    virtual void DoUpdateWindowUI(wxUpdateUIEvent& event);

 
 

-    // obsolete functions
-#if WXWIN_COMPATIBILITY
-    bool Modified() const { return IsModified(); }
-#endif
+    virtual bool ShouldInheritColours() const { return false; }

 
 protected:
     // the name of the last file loaded with LoadFile() which will be used by
 
 protected:
     // the name of the last file loaded with LoadFile() which will be used by


@@ -426,10 +464,10 @@ public:
 
 typedef void (wxEvtHandler::*wxTextUrlEventFunction)(wxTextUrlEvent&);
 
 
 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_MAXLEN(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TEXT_MAXLEN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ),
+#define EVT_TEXT(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TEXT_UPDATED, id, -1, (wxObjectEventFunction) (wxEventFunction)  wxStaticCastEvent( wxCommandEventFunction, & fn ), (wxObject *) NULL ),
+#define EVT_TEXT_ENTER(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TEXT_ENTER, id, -1, (wxObjectEventFunction) (wxEventFunction)  wxStaticCastEvent( wxCommandEventFunction, & fn ), (wxObject *) NULL ),
+#define EVT_TEXT_URL(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TEXT_URL, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction)  wxStaticCastEvent( wxTextUrlEventFunction, & fn ), (wxObject *) NULL ),
+#define EVT_TEXT_MAXLEN(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TEXT_MAXLEN, id, -1, (wxObjectEventFunction) (wxEventFunction)  wxStaticCastEvent( wxCommandEventFunction, & fn ), (wxObject *) NULL ),

 
 #ifndef NO_TEXT_WINDOW_STREAM
 
 
 #ifndef NO_TEXT_WINDOW_STREAM
 


@@ -440,14 +478,26 @@ typedef void (wxEvtHandler::*wxTextUrlEventFunction)(wxTextUrlEvent&);
 
 class WXDLLEXPORT wxStreamToTextRedirector
 {
 
 class WXDLLEXPORT wxStreamToTextRedirector
 {

-public:
-    wxStreamToTextRedirector(wxTextCtrl *text, wxSTD ostream *ostr = NULL)
-        : m_ostr(ostr ? *ostr : wxSTD cout)
+private:
+    void Init(wxTextCtrl *text)

     {
         m_sbufOld = m_ostr.rdbuf();
         m_ostr.rdbuf(text);
     }
 
     {
         m_sbufOld = m_ostr.rdbuf();
         m_ostr.rdbuf(text);
     }
 

+public:
+    wxStreamToTextRedirector(wxTextCtrl *text)
+        : m_ostr(wxSTD cout)
+    {
+        Init(text);
+    }
+
+    wxStreamToTextRedirector(wxTextCtrl *text, wxSTD ostream *ostr)
+        : m_ostr(*ostr)
+    {
+        Init(text);
+    }
+

     ~wxStreamToTextRedirector()
     {
         m_ostr.rdbuf(m_sbufOld);
     ~wxStreamToTextRedirector()
     {
         m_ostr.rdbuf(m_sbufOld);