added support for broadcasting to UDP sockets (patch 1740266)

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

diff --git a/include/wx/msw/textctrl.h b/include/wx/msw/textctrl.h
index 184655a8d5ea6a8f224c26f6fbbf86d04c8e9e64..8b3c71f4859732767575a6f5a3f9a30b53bbd9ea 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:


@@ -12,24 +12,13 @@
 #ifndef _WX_TEXTCTRL_H_
 #define _WX_TEXTCTRL_H_
 
 #ifndef _WX_TEXTCTRL_H_
 #define _WX_TEXTCTRL_H_
 

-#ifdef __GNUG__
-    #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,8 +27,11 @@ 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);
     }

+    virtual ~wxTextCtrl();

 
     bool Create(wxWindow *parent, wxWindowID id,
                 const wxString& value = wxEmptyString,
 
     bool Create(wxWindow *parent, wxWindowID id,
                 const wxString& value = wxEmptyString,


@@ -53,7 +45,9 @@ public:
     // ----------------------------------
 
     virtual wxString GetValue() const;
     // ----------------------------------
 
     virtual wxString GetValue() const;

-    virtual void SetValue(const wxString& value);
+    virtual bool IsEmpty() const;
+
+    virtual wxString GetRange(long from, long to) const;

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


@@ -62,7 +56,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


@@ -73,17 +66,32 @@ public:
     virtual void Replace(long from, long to, const wxString& value);
     virtual void Remove(long from, long to);
 
     virtual void Replace(long from, long to, const wxString& value);
     virtual void Remove(long from, long to);
 

-    // load the controls contents from the file
-    virtual bool LoadFile(const wxString& file);
+    // load the control's contents from the file
+    virtual bool DoLoadFile(const wxString& file, int fileType);

 
     // clears the dirty flag
 
     // clears the dirty flag

+    virtual void MarkDirty();

     virtual void DiscardEdits();
 
     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);
+    virtual bool GetStyle(long position, 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.
     // 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.


@@ -91,6 +99,13 @@ public:
     virtual bool PositionToXY(long pos, long *x, long *y) const;
 
     virtual void ShowPosition(long pos);
     virtual bool PositionToXY(long pos, long *x, long *y) const;
 
     virtual void ShowPosition(long pos);

+    virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt, long *pos) const;
+    virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt,
+                                            wxTextCoord *col,
+                                            wxTextCoord *row) const
+    {
+        return wxTextCtrlBase::HitTest(pt, col, row);
+    }

 
     // Clipboard operations
     virtual void Copy();
 
     // Clipboard operations
     virtual void Copy();


@@ -112,24 +127,46 @@ public:
     virtual void SetInsertionPoint(long pos);
     virtual void SetInsertionPointEnd();
     virtual long GetInsertionPoint() const;
     virtual void SetInsertionPoint(long pos);
     virtual void SetInsertionPointEnd();
     virtual long GetInsertionPoint() const;

-    virtual long GetLastPosition() const;
+    virtual wxTextPos GetLastPosition() const;

 
     virtual void SetSelection(long from, long to);
     virtual void SetEditable(bool editable);
 
 
     virtual void SetSelection(long from, long to);
     virtual void SetEditable(bool editable);
 

+    // Caret handling (Windows only)
+
+    bool ShowNativeCaret(bool show = true);
+    bool HideNativeCaret() { return ShowNativeCaret(false); }
+

     // 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 MSWControlColor(WXHDC hDC, WXHWND hWnd);

 
 #if wxUSE_RICHEDIT
 
 #if wxUSE_RICHEDIT

-    bool IsRich() const { return m_isRich; }
-    void SetRichEdit(bool isRich) { m_isRich = isRich; }
+    virtual bool MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result);
+
+    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);
+#else
+    bool IsRich() const { return false; }

 #endif // wxUSE_RICHEDIT
 
 #endif // wxUSE_RICHEDIT
 

+#if wxUSE_INKEDIT && wxUSE_RICHEDIT
+    bool IsInkEdit() const { return m_isInkEdit != 0; }
+#else
+    bool IsInkEdit() const { return false; }
+#endif
+

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

-    virtual void SetupColours();

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


@@ -142,27 +179,110 @@ public:
     void OnPaste(wxCommandEvent& event);
     void OnUndo(wxCommandEvent& event);
     void OnRedo(wxCommandEvent& event);
     void OnPaste(wxCommandEvent& event);
     void OnUndo(wxCommandEvent& event);
     void OnRedo(wxCommandEvent& event);

+    void OnDelete(wxCommandEvent& event);
+    void OnSelectAll(wxCommandEvent& event);

 
     void OnUpdateCut(wxUpdateUIEvent& event);
     void OnUpdateCopy(wxUpdateUIEvent& event);
     void OnUpdatePaste(wxUpdateUIEvent& event);
     void OnUpdateUndo(wxUpdateUIEvent& event);
     void OnUpdateRedo(wxUpdateUIEvent& event);
 
     void OnUpdateCut(wxUpdateUIEvent& event);
     void OnUpdateCopy(wxUpdateUIEvent& event);
     void OnUpdatePaste(wxUpdateUIEvent& event);
     void OnUpdateUndo(wxUpdateUIEvent& event);
     void OnUpdateRedo(wxUpdateUIEvent& event);

+    void OnUpdateDelete(wxUpdateUIEvent& event);
+    void OnUpdateSelectAll(wxUpdateUIEvent& event);
+
+    // Show a context menu for Rich Edit controls (the standard
+    // EDIT control has one already)
+    void OnContextMenu(wxContextMenuEvent& event);
+
+    // be sure the caret remains invisible if the user
+    // called HideNativeCaret() before
+    void OnSetFocus(wxFocusEvent& event);
+
+    // intercept WM_GETDLGCODE
+    virtual WXLRESULT MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
+
+    virtual bool MSWShouldPreProcessMessage(WXMSG* pMsg);
+    virtual WXDWORD MSWGetStyle(long style, WXDWORD *exstyle) const;
+    virtual wxVisualAttributes GetDefaultAttributes() const;

 
 protected:
 
 protected:

-#if wxUSE_RICHEDIT
-    bool      m_isRich; // Are we using rich text edit to implement this?
-#endif
+    // common part of all ctors
+    void Init();
+
+    // creates the control of appropriate class (plain or rich edit) with the
+    // styles corresponding to m_windowStyle
+    //
+    // this is used by ctor/Create() and when we need to recreate the control
+    // later
+    bool MSWCreateText(const wxString& value,
+                       const wxPoint& pos,
+                       const wxSize& size);
+
+    virtual void DoSetValue(const wxString &value, int flags = 0);
+
+    // return true if this control has a user-set limit on amount of text (i.e.
+    // the limit is due to a previous call to SetMaxLength() and not built in)
+    bool HasSpaceLimit(unsigned int *len) const;

 
     // 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 && (!wxUSE_UNICODE || wxUSE_UNICODE_MSLU)
+    // 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);
+
+    // get the contents of the control out as text in the given encoding
+    wxString StreamOut(wxFontEncoding encoding, bool selOnly = false) const;
+#endif // wxUSE_RICHEDIT
+
+    // replace the contents of the selection or of the entire control with the
+    // given text
+    void DoWriteText(const wxString& text,
+                     int flags = SetValue_SendEvent | SetValue_SelectionOnly);
+
+    // set the selection possibly without scrolling the caret into view
+    void DoSetSelection(long from, long to, bool scrollCaret = true);
+
+    // return true if there is a non empty selection in the control
+    bool HasSelection() const;
+
+    // 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();

 
     virtual wxSize DoGetBestSize() const;
 
 
     virtual wxSize DoGetBestSize() 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;
+#endif // wxUSE_RICHEDIT
+
+    // number of EN_UPDATE events sent by Windows when we change the controls
+    // text ourselves: we want this to be exactly 1
+    int m_updatesCount;
+

 private:
     DECLARE_EVENT_TABLE()
 private:
     DECLARE_EVENT_TABLE()

-    DECLARE_DYNAMIC_CLASS(wxTextCtrl)
+    DECLARE_DYNAMIC_CLASS_NO_COPY(wxTextCtrl)
+
+    wxMenu* m_privateContextMenu;
+
+    bool m_isNativeCaretShown;
+
+#if wxUSE_INKEDIT && wxUSE_RICHEDIT
+    int  m_isInkEdit;
+#endif
+

 };
 
 #endif
 };
 
 #endif