]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/univ/textctrl.h
use wxTextEntry in wxTextValidator (modified patch 1821743)
[wxWidgets.git] / include / wx / univ / textctrl.h
index 3dbaa38f8ebec9881dff740837f03a73185a23ff..941a60c21dc50f1d650bfaf4088545f7704753b1 100644 (file)
 #ifndef _WX_UNIV_TEXTCTRL_H_
 #define _WX_UNIV_TEXTCTRL_H_
 
 #ifndef _WX_UNIV_TEXTCTRL_H_
 #define _WX_UNIV_TEXTCTRL_H_
 
-#ifdef __GNUG__
-    #pragma interface "univtextctrl.h"
-#endif
-
-class WXDLLEXPORT wxCaret;
-class WXDLLEXPORT wxTextCtrlCommandProcessor;
+class WXDLLIMPEXP_FWD_CORE wxCaret;
+class WXDLLIMPEXP_FWD_CORE wxTextCtrlCommandProcessor;
 
 #include "wx/scrolwin.h"    // for wxScrollHelper
 
 
 #include "wx/scrolwin.h"    // for wxScrollHelper
 
@@ -66,42 +62,18 @@ class WXDLLEXPORT wxTextCtrlCommandProcessor;
 #define wxACTION_TEXT_UNDO          _T("undo")
 #define wxACTION_TEXT_REDO          _T("redo")
 
 #define wxACTION_TEXT_UNDO          _T("undo")
 #define wxACTION_TEXT_REDO          _T("redo")
 
-// ----------------------------------------------------------------------------
-// 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;
-
-// ----------------------------------------------------------------------------
-// wxTextCtrl::HitTest return values
-// ----------------------------------------------------------------------------
-
-// the point asked is ...
-enum wxTextCtrlHitTestResult
-{
-    wxTE_HT_BEFORE = -1,    // 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
-
 // ----------------------------------------------------------------------------
 // wxTextCtrl
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 // wxTextCtrl
 // ----------------------------------------------------------------------------
 
-class WXDLLEXPORT wxTextCtrl : public wxTextCtrlBase, public wxScrollHelper
+class WXDLLEXPORT wxTextCtrl : public wxTextCtrlBase,
+                               public wxScrollHelper
 {
 public:
     // creation
     // --------
 
 {
 public:
     // creation
     // --------
 
-    wxTextCtrl() { Init(); }
+    wxTextCtrl() : wxScrollHelper(this) { Init(); }
 
     wxTextCtrl(wxWindow *parent,
                wxWindowID id,
 
     wxTextCtrl(wxWindow *parent,
                wxWindowID id,
@@ -111,6 +83,7 @@ public:
                long style = 0,
                const wxValidator& validator = wxDefaultValidator,
                const wxString& name = wxTextCtrlNameStr)
                long style = 0,
                const wxValidator& validator = wxDefaultValidator,
                const wxString& name = wxTextCtrlNameStr)
+        : wxScrollHelper(this) 
     {
         Init();
 
     {
         Init();
 
@@ -132,7 +105,6 @@ public:
     // ----------------------------------
 
     virtual wxString GetValue() const;
     // ----------------------------------
 
     virtual wxString GetValue() const;
-    virtual void SetValue(const wxString& value);
 
     virtual int GetLineLength(wxTextCoord lineNo) const;
     virtual wxString GetLineText(wxTextCoord lineNo) const;
 
     virtual int GetLineLength(wxTextCoord lineNo) const;
     virtual wxString GetLineText(wxTextCoord lineNo) const;
@@ -152,7 +124,8 @@ public:
     virtual void Replace(wxTextPos from, wxTextPos to, const wxString& value);
     virtual void Remove(wxTextPos from, wxTextPos to);
 
     virtual void Replace(wxTextPos from, wxTextPos to, const wxString& value);
     virtual void Remove(wxTextPos from, wxTextPos to);
 
-    // clears the dirty flag
+    // sets/clears the dirty flag
+    virtual void MarkDirty();
     virtual void DiscardEdits();
 
     // writing text inserts it at the current position, appending always
     virtual void DiscardEdits();
 
     // writing text inserts it at the current position, appending always
@@ -200,8 +173,8 @@ public:
     // -----------------------
 
     // caret stuff
     // -----------------------
 
     // caret stuff
-    virtual void ShowCaret(bool show = TRUE);
-    void HideCaret() { ShowCaret(FALSE); }
+    virtual void ShowCaret(bool show = true);
+    void HideCaret() { ShowCaret(false); }
     void CreateCaret(); // for the current font size
 
     // helpers for cursor movement
     void CreateCaret(); // for the current font size
 
     // helpers for cursor movement
@@ -215,16 +188,10 @@ public:
     void RemoveSelection();
     wxString GetSelectionText() const;
 
     void RemoveSelection();
     wxString GetSelectionText() const;
 
-    // find the character at this position, return 0 if the character is
-    // really there, -1 if the point is before the beginning of the text/line
-    // and the returned character is the first one to follow it or +1 if it the
-    // position is beyond the end of line/text and the returned character is
-    // the last one
-    //
-    // NB: pt is in device coords (not adjusted for the client area origin nor
-    //     for the scrolling)
-    wxTextCtrlHitTestResult HitTest(const wxPoint& pt,
-                                    wxTextCoord *col, wxTextCoord *row) const;
+    virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt, long *pos) const;
+    virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt,
+                                            wxTextCoord *col,
+                                            wxTextCoord *row) const;
 
     // find the character at this position in the given line, return value as
     // for HitTest()
 
     // find the character at this position in the given line, return value as
     // for HitTest()
@@ -251,28 +218,39 @@ public:
     virtual void CalcUnscrolledPosition(int x, int y, int *xx, int *yy) const;
     virtual void CalcScrolledPosition(int x, int y, int *xx, int *yy) const;
 
     virtual void CalcUnscrolledPosition(int x, int y, int *xx, int *yy) const;
     virtual void CalcScrolledPosition(int x, int y, int *xx, int *yy) const;
 
-    // set the right colours and border
-    virtual bool IsContainerWindow() const { return TRUE; }
-    virtual wxBorder GetDefaultBorder() const { return wxBORDER_SUNKEN; }
-
     // perform an action
     virtual bool PerformAction(const wxControlAction& action,
                                long numArg = -1,
                                const wxString& strArg = wxEmptyString);
 
     // perform an action
     virtual bool PerformAction(const wxControlAction& action,
                                long numArg = -1,
                                const wxString& strArg = wxEmptyString);
 
+    static wxInputHandler *GetStdInputHandler(wxInputHandler *handlerDef);
+    virtual wxInputHandler *DoGetStdInputHandler(wxInputHandler *handlerDef)
+    {
+        return GetStdInputHandler(handlerDef);
+    }
+
     // override these methods to handle the caret
     virtual bool SetFont(const wxFont &font);
     // override these methods to handle the caret
     virtual bool SetFont(const wxFont &font);
-    virtual bool Enable(bool enable = TRUE);
+    virtual bool Enable(bool enable = true);
 
     // more readable flag testing methods
 
     // more readable flag testing methods
-    bool IsPassword() const { return (GetWindowStyle() & wxTE_PASSWORD) != 0; }
-    bool WrapLines() const
-        { return !IsSingleLine() && !(GetWindowStyle() & wxHSCROLL); }
+    bool IsPassword() const { return HasFlag(wxTE_PASSWORD); }
+    bool WrapLines() const { return m_wrapLines; }
 
     // only for wxStdTextCtrlInputHandler
     void RefreshSelection();
 
 
     // only for wxStdTextCtrlInputHandler
     void RefreshSelection();
 
+    // override wxScrollHelper method to prevent (auto)scrolling beyond the end
+    // of line
+    virtual bool SendAutoScrollEvents(wxScrollWinEvent& event) const;
+
+    // idle processing
+    virtual void OnInternalIdle();
+
 protected:
 protected:
+    // ensure we have correct default border
+    virtual wxBorder GetDefaultBorder() const { return wxBORDER_SUNKEN; }
+
     // override base class methods
     virtual void DoDrawBorder(wxDC& dc, const wxRect& rect);
     virtual void DoDraw(wxControlRenderer *renderer);
     // override base class methods
     virtual void DoDrawBorder(wxDC& dc, const wxRect& rect);
     virtual void DoDraw(wxControlRenderer *renderer);
@@ -280,6 +258,9 @@ protected:
     // calc the size from the text extent
     virtual wxSize DoGetBestClientSize() const;
 
     // calc the size from the text extent
     virtual wxSize DoGetBestClientSize() const;
 
+    // implements Set/ChangeValue()
+    virtual void DoSetValue(const wxString& value, int flags = 0);
+
     // common part of all ctors
     void Init();
 
     // common part of all ctors
     void Init();
 
@@ -326,7 +307,7 @@ protected:
     wxRect GetRealTextArea() const;
 
     // refresh the text in the given (in logical coords) rect
     wxRect GetRealTextArea() const;
 
     // refresh the text in the given (in logical coords) rect
-    void RefreshTextRect(const wxRect& rect, bool textOnly = TRUE);
+    void RefreshTextRect(const wxRect& rect, bool textOnly = true);
 
     // refresh the line wrap marks for the given range of lines (inclusive)
     void RefreshLineWrapMarks(wxTextCoord rowFirst, wxTextCoord rowLast);
 
     // refresh the line wrap marks for the given range of lines (inclusive)
     void RefreshLineWrapMarks(wxTextCoord rowFirst, wxTextCoord rowLast);
@@ -361,7 +342,7 @@ protected:
                                 wxCoord *widthReal = NULL) const;
 
     // get the start and end of the selection for this line: if the line is
                                 wxCoord *widthReal = NULL) const;
 
     // get the start and end of the selection for this line: if the line is
-    // outside the selection, both will be -1 and FALSE will be returned
+    // outside the selection, both will be -1 and false will be returned
     bool GetSelectedPartOfLine(wxTextCoord line,
                                wxTextPos *start, wxTextPos *end) const;
 
     bool GetSelectedPartOfLine(wxTextCoord line,
                                wxTextPos *start, wxTextPos *end) const;
 
@@ -408,7 +389,7 @@ protected:
                                      wxTextCoord *colStart,
                                      wxTextCoord *colEnd,
                                      wxTextCoord *colRowStart,
                                      wxTextCoord *colStart,
                                      wxTextCoord *colEnd,
                                      wxTextCoord *colRowStart,
-                                     bool devCoords = TRUE) const;
+                                     bool devCoords = true) const;
 
     // HitTest() version which takes the logical text coordinates and not the
     // device ones
 
     // HitTest() version which takes the logical text coordinates and not the
     // device ones
@@ -417,7 +398,7 @@ protected:
                                            wxTextCoord *row) const;
 
     // get the line and the row in this line corresponding to the given row,
                                            wxTextCoord *row) const;
 
     // get the line and the row in this line corresponding to the given row,
-    // return TRUE if ok and FALSE if row is out of range
+    // return true if ok and false if row is out of range
     //
     // NB: this function can only be called for controls which wrap lines
     bool GetLineAndRow(wxTextCoord row,
     //
     // NB: this function can only be called for controls which wrap lines
     bool GetLineAndRow(wxTextCoord row,
@@ -458,10 +439,6 @@ protected:
     void OnChar(wxKeyEvent& event);
     void OnSize(wxSizeEvent& event);
 
     void OnChar(wxKeyEvent& event);
     void OnSize(wxSizeEvent& event);
 
-    // overrdie wxScrollHelper method to prevent (auto)scrolling beyond the end
-    // of line
-    virtual bool SendAutoScrollEvents(wxScrollWinEvent& event) const;
-
     // return the struct containing control-type dependent data
     struct wxTextSingleLineData& SData() { return *m_data.sdata; }
     struct wxTextMultiLineData& MData() { return *m_data.mdata; }
     // return the struct containing control-type dependent data
     struct wxTextSingleLineData& SData() { return *m_data.sdata; }
     struct wxTextMultiLineData& MData() { return *m_data.mdata; }
@@ -475,8 +452,6 @@ protected:
     bool DoCut();
     bool DoPaste();
 
     bool DoCut();
     bool DoPaste();
 
-    // idle processing
-    virtual void OnInternalIdle();
 private:
     // all these methods are for multiline text controls only
 
 private:
     // all these methods are for multiline text controls only
 
@@ -487,7 +462,7 @@ private:
     inline const wxArrayString& GetLines() const;
     inline size_t GetLineCount() const;
 
     inline const wxArrayString& GetLines() const;
     inline size_t GetLineCount() const;
 
-    // replace a line (returns TRUE if the number of rows in thel ine changed)
+    // replace a line (returns true if the number of rows in thel ine changed)
     bool ReplaceLine(wxTextCoord line, const wxString& text);
 
     // remove a line
     bool ReplaceLine(wxTextCoord line, const wxString& text);
 
     // remove a line
@@ -524,7 +499,8 @@ private:
     // flags
     bool m_isModified:1,
          m_isEditable:1,
     // flags
     bool m_isModified:1,
          m_isEditable:1,
-         m_hasCaret:1;
+         m_hasCaret:1,
+         m_wrapLines:1; // can't be changed after creation
 
     // the rectangle (in client coordinates) to draw text inside
     wxRect m_rectText;
 
     // the rectangle (in client coordinates) to draw text inside
     wxRect m_rectText;
@@ -550,33 +526,8 @@ private:
 
     DECLARE_EVENT_TABLE()
     DECLARE_DYNAMIC_CLASS(wxTextCtrl)
 
     DECLARE_EVENT_TABLE()
     DECLARE_DYNAMIC_CLASS(wxTextCtrl)
-};
-
-// ----------------------------------------------------------------------------
-// wxStdTextCtrlInputHandler: this control handles only the mouse/kbd actions
-// common to Win32 and GTK, platform-specific things are implemented elsewhere
-// ----------------------------------------------------------------------------
-
-class WXDLLEXPORT wxStdTextCtrlInputHandler : public wxStdInputHandler
-{
-public:
-    wxStdTextCtrlInputHandler(wxInputHandler *inphand);
-
-    virtual bool HandleKey(wxInputConsumer *consumer,
-                           const wxKeyEvent& event,
-                           bool pressed);
-    virtual bool HandleMouse(wxInputConsumer *consumer,
-                             const wxMouseEvent& event);
-    virtual bool HandleMouseMove(wxInputConsumer *consumer,
-                                 const wxMouseEvent& event);
-    virtual bool HandleFocus(wxInputConsumer *consumer, const wxFocusEvent& event);
-
-protected:
-    // get the position of the mouse click
-    static wxTextPos HitTest(const wxTextCtrl *text, const wxPoint& pos);
 
 
-    // capture data
-    wxTextCtrl *m_winCapture;
+    friend class wxWrappedLineData;
 };
 
 #endif // _WX_UNIV_TEXTCTRL_H_
 };
 
 #endif // _WX_UNIV_TEXTCTRL_H_