Added (and documented) GetTraceMasks so userspace can probe the currently

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

diff --git a/include/wx/msw/textctrl.h b/include/wx/msw/textctrl.h
index 3e66b4a49e7f0dcf7cb704edc878236fe2eefbb5..283e86b826bc5470be8e791f48dfaa196ca1f997 100644 (file)
--- a/include/wx/msw/textctrl.h
+++ b/include/wx/msw/textctrl.h
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

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

 // Purpose:     wxTextCtrl class
 // Author:      Julian Smart
 // Modified by:
 // Purpose:     wxTextCtrl class
 // Author:      Julian Smart
 // Modified by:


@@ -16,20 +16,13 @@
     #pragma interface "textctrl.h"
 #endif
 
     #pragma interface "textctrl.h"
 #endif
 

-// can we use RICHEDIT class for wxTextCtrl implementation?
-#if defined(__WIN95__) && !defined(__TWIN32__) && !defined(__WXWINE__)
-    #define wxUSE_RICHEDIT 1
-#else
-    #define wxUSE_RICHEDIT 0
-#endif
-

 class WXDLLEXPORT wxTextCtrl : public wxTextCtrlBase
 {
 public:
     // creation
     // --------
 
 class WXDLLEXPORT wxTextCtrl : public wxTextCtrlBase
 {
 public:
     // creation
     // --------
 

-    wxTextCtrl();
+    wxTextCtrl() { Init(); }

     wxTextCtrl(wxWindow *parent, wxWindowID id,
                const wxString& value = wxEmptyString,
                const wxPoint& pos = wxDefaultPosition,
     wxTextCtrl(wxWindow *parent, wxWindowID id,
                const wxString& value = wxEmptyString,
                const wxPoint& pos = wxDefaultPosition,


@@ -38,6 +31,8 @@ public:
                const wxValidator& validator = wxDefaultValidator,
                const wxString& name = wxTextCtrlNameStr)
     {
                const wxValidator& validator = wxDefaultValidator,
                const wxString& name = wxTextCtrlNameStr)
     {

+        Init();
+

         Create(parent, id, value, pos, size, style, validator, name);
     }
 
         Create(parent, id, value, pos, size, style, validator, name);
     }
 


@@ -55,6 +50,8 @@ public:
     virtual wxString GetValue() const;
     virtual void SetValue(const wxString& value);
 
     virtual wxString GetValue() const;
     virtual void SetValue(const wxString& value);
 

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

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


@@ -62,7 +59,6 @@ public:
     virtual bool IsModified() const;
     virtual bool IsEditable() const;
 
     virtual bool IsModified() const;
     virtual bool IsEditable() const;
 

-    // If the return values from and to are the same, there is no selection.

     virtual void GetSelection(long* from, long* to) const;
 
     // operations
     virtual void GetSelection(long* from, long* to) const;
 
     // operations


@@ -79,16 +75,29 @@ public:
     // clears the dirty flag
     virtual void DiscardEdits();
 
     // clears the dirty flag
     virtual void DiscardEdits();
 

+    virtual void SetMaxLength(unsigned long len);
+

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

+#ifdef __WIN32__
+    virtual bool EmulateKeyPress(const wxKeyEvent& event);
+#endif // __WIN32__
+
+#if wxUSE_RICHEDIT
+    // apply text attribute to the range of text (only works with richedit
+    // controls)
+    virtual bool SetStyle(long start, long end, const wxTextAttr& style);
+    virtual bool SetDefaultStyle(const wxTextAttr& style);
+#endif // wxUSE_RICHEDIT
+

     // translate between the position (which is just an index in the text ctrl
     // considering all its contents as a single strings) and (x, y) coordinates
     // which represent column and line.
     virtual long XYToPosition(long x, long y) const;
     // translate between the position (which is just an index in the text ctrl
     // considering all its contents as a single strings) and (x, y) coordinates
     // which represent column and line.
     virtual long XYToPosition(long x, long y) const;

-    virtual void PositionToXY(long pos, long *x, long *y) const;
+    virtual bool PositionToXY(long pos, long *x, long *y) const;

 
     virtual void ShowPosition(long pos);
 
 
     virtual void ShowPosition(long pos);
 


@@ -120,20 +129,32 @@ public:
     // Implementation from now on
     // --------------------------
 
     // Implementation from now on
     // --------------------------
 

+    virtual void SetWindowStyleFlag(long style);
+

     virtual void Command(wxCommandEvent& event);
     virtual bool MSWCommand(WXUINT param, WXWORD id);
     virtual void Command(wxCommandEvent& event);
     virtual bool MSWCommand(WXUINT param, WXWORD id);

+    virtual WXHBRUSH OnCtlColor(WXHDC pDC, WXHWND pWnd, WXUINT nCtlColor,
+            WXUINT message, WXWPARAM wParam, WXLPARAM lParam);
+
+    // In WIN16, need to override normal erasing because
+    // Ctl3D doesn't use the wxWindows background colour.
+#ifdef __WIN16__
+    void OnEraseBackground(wxEraseEvent& event);
+#endif

 
 #if wxUSE_RICHEDIT
 
 #if wxUSE_RICHEDIT

-    bool IsRich() const { return m_isRich; }
-    void SetRichEdit(bool isRich) { m_isRich = isRich; }
-#endif // wxUSE_RICHEDIT
+    virtual bool MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result);

 
 

-    virtual WXHBRUSH OnCtlColor(WXHDC pDC, WXHWND pWnd, WXUINT nCtlColor,
-                                WXUINT message, WXWPARAM wParam,
-                                WXLPARAM lParam);
+    int GetRichVersion() const { return m_verRichEdit; }
+    bool IsRich() const { return m_verRichEdit != 0; }
+
+    // rich edit controls are not compatible with normal ones and wem ust set
+    // the colours for them otherwise
+    virtual bool SetBackgroundColour(const wxColour& colour);
+    virtual bool SetForegroundColour(const wxColour& colour);
+#endif // wxUSE_RICHEDIT

 
     virtual void AdoptAttributesFromHWND();
 
     virtual void AdoptAttributesFromHWND();

-    virtual void SetupColours();

 
     virtual bool AcceptsFocus() const;
 
 
     virtual bool AcceptsFocus() const;
 


@@ -154,15 +175,57 @@ public:
     void OnUpdateRedo(wxUpdateUIEvent& event);
 
 protected:
     void OnUpdateRedo(wxUpdateUIEvent& event);
 
 protected:

-#if wxUSE_RICHEDIT
-    bool      m_isRich; // Are we using rich text edit to implement this?
-#endif
+    // common part of all ctors
+    void Init();
+
+    // intercept WM_GETDLGCODE
+    virtual long MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);

 
     // call this to increase the size limit (will do nothing if the current
     // limit is big enough)
 
     // call this to increase the size limit (will do nothing if the current
     // limit is big enough)

-    void AdjustSpaceLimit();
+    //
+    // returns true if we increased the limit to allow entering more text,
+    // false if we hit the limit set by SetMaxLength() and so didn't change it
+    bool AdjustSpaceLimit();
+
+#if wxUSE_RICHEDIT
+    // replace the selection or the entire control contents with the given text
+    // in the specified encoding
+    bool StreamIn(const wxString& value,
+                  wxFontEncoding encoding,
+                  bool selOnly);
+#endif // wxUSE_RICHEDIT
+
+    // replace the contents of the selection or of the entire control with the
+    // given text
+    void DoWriteText(const wxString& text, bool selectionOnly = TRUE);

 
 

-    virtual wxSize DoGetBestSize();
+    // set the selection possibly without scrolling the caret into view
+    void DoSetSelection(long from, long to, bool scrollCaret = TRUE);
+
+    // get the length of the line containing the character at the given
+    // position
+    long GetLengthOfLineContainingPos(long pos) const;
+
+    // send TEXT_UPDATED event, return TRUE if it was handled, FALSE otherwise
+    bool SendUpdateEvent();
+
+    // override some base class virtuals
+    virtual bool MSWShouldPreProcessMessage(WXMSG* pMsg);
+    virtual wxSize DoGetBestSize() const;
+
+    virtual WXDWORD MSWGetStyle(long style, WXDWORD *exstyle) const;
+
+#if wxUSE_RICHEDIT
+    // we're using RICHEDIT (and not simple EDIT) control if this field is not
+    // 0, it also gives the version of the RICHEDIT control being used (1, 2 or
+    // 3 so far)
+    int m_verRichEdit;
+
+    // if TRUE, SendUpdateEvent() will eat the next event (see comments in the
+    // code as to why this is needed)
+    bool m_suppressNextUpdate;
+#endif // wxUSE_RICHEDIT

 
 private:
     DECLARE_EVENT_TABLE()
 
 private:
     DECLARE_EVENT_TABLE()