Bring AddActionTrigger() doc string up to date with the interface

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

diff --git a/include/wx/msw/textctrl.h b/include/wx/msw/textctrl.h
index c12e9089bc572ea2ffd2d28a37229a29a20e8dd7..888ea4c76b8e0e461f334ba1060100f918857e62 100644 (file)
--- a/include/wx/msw/textctrl.h
+++ b/include/wx/msw/textctrl.h
@@ -12,7 +12,7 @@
 #ifndef _WX_TEXTCTRL_H_
 #define _WX_TEXTCTRL_H_
 
 #ifndef _WX_TEXTCTRL_H_
 #define _WX_TEXTCTRL_H_
 

-class WXDLLEXPORT wxTextCtrl : public wxTextCtrlBase
+class WXDLLIMPEXP_CORE wxTextCtrl : public wxTextCtrlBase

 {
 public:
     // creation
 {
 public:
     // creation


@@ -41,45 +41,40 @@ public:
                 const wxValidator& validator = wxDefaultValidator,
                 const wxString& name = wxTextCtrlNameStr);
 
                 const wxValidator& validator = wxDefaultValidator,
                 const wxString& name = wxTextCtrlNameStr);
 

-    // implement base class pure virtuals
-    // ----------------------------------
+    // overridden wxTextEntry methods
+    // ------------------------------

 
     virtual wxString GetValue() const;
 
     virtual wxString GetValue() const;

-    virtual void SetValue(const wxString& value);
-

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

+    virtual bool IsEmpty() const;
+
+    virtual void WriteText(const wxString& text);
+    virtual void AppendText(const wxString& text);
+    virtual void Clear();
+

     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;
 

-    virtual bool IsModified() const;
-    virtual bool IsEditable() const;
+    virtual void SetMaxLength(unsigned long len);

 
 

-    virtual void GetSelection(long* from, long* to) const;
+    virtual void GetSelection(long *from, long *to) const;

 
 

-    // operations
-    // ----------
+    virtual void Redo();
+    virtual bool CanRedo() const;

 
 

-    // editing
-    virtual void Clear();
-    virtual void Replace(long from, long to, const wxString& value);
-    virtual void Remove(long from, long to);
+    virtual void SetInsertionPointEnd();
+    virtual long GetInsertionPoint() const;
+    virtual wxTextPos GetLastPosition() const;

 
 

-    // load the controls contents from the file
-    virtual bool LoadFile(const wxString& file);
+    // implement base class pure virtuals
+    // ----------------------------------

 
 

-    // clears the dirty flag
+    virtual bool IsModified() const;

     virtual void MarkDirty();
     virtual void DiscardEdits();
 
     virtual void MarkDirty();
     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);
-

 #ifdef __WIN32__
     virtual bool EmulateKeyPress(const wxKeyEvent& event);
 #endif // __WIN32__
 #ifdef __WIN32__
     virtual bool EmulateKeyPress(const wxKeyEvent& event);
 #endif // __WIN32__


@@ -107,39 +102,17 @@ public:
         return wxTextCtrlBase::HitTest(pt, col, row);
     }
 
         return wxTextCtrlBase::HitTest(pt, col, row);
     }
 

-    // Clipboard operations
-    virtual void Copy();
-    virtual void Cut();
-    virtual void Paste();
-
-    virtual bool CanCopy() const;
-    virtual bool CanCut() const;
-    virtual bool CanPaste() const;
-
-    // Undo/redo
-    virtual void Undo();
-    virtual void Redo();
-
-    virtual bool CanUndo() const;
-    virtual bool CanRedo() const;
-
-    // Insertion point
-    virtual void SetInsertionPoint(long pos);
-    virtual void SetInsertionPointEnd();
-    virtual long GetInsertionPoint() const;
-    virtual wxTextPos GetLastPosition() const;
-
-    virtual void SetSelection(long from, long to);
-    virtual void SetEditable(bool editable);
-

     // Caret handling (Windows only)
     // Caret handling (Windows only)

-

     bool ShowNativeCaret(bool show = true);
     bool HideNativeCaret() { return ShowNativeCaret(false); }
 
     // Implementation from now on
     // --------------------------
 
     bool ShowNativeCaret(bool show = true);
     bool HideNativeCaret() { return ShowNativeCaret(false); }
 
     // Implementation from now on
     // --------------------------
 

+#if wxUSE_DRAG_AND_DROP && wxUSE_RICHEDIT
+    virtual void SetDropTarget(wxDropTarget *dropTarget);
+#endif // wxUSE_DRAG_AND_DROP && wxUSE_RICHEDIT
+

     virtual void SetWindowStyleFlag(long style);
 
     virtual void Command(wxCommandEvent& event);
     virtual void SetWindowStyleFlag(long style);
 
     virtual void Command(wxCommandEvent& event);


@@ -152,10 +125,13 @@ public:
     int GetRichVersion() const { return m_verRichEdit; }
     bool IsRich() const { return m_verRichEdit != 0; }
 
     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
+    // rich edit controls are not compatible with normal ones and we must set
+    // the colours and font for them otherwise

     virtual bool SetBackgroundColour(const wxColour& colour);
     virtual bool SetForegroundColour(const wxColour& colour);
     virtual bool SetBackgroundColour(const wxColour& colour);
     virtual bool SetForegroundColour(const wxColour& colour);

+    virtual bool SetFont(const wxFont& font);
+#else
+    bool IsRich() const { return false; }

 #endif // wxUSE_RICHEDIT
 
 #if wxUSE_INKEDIT && wxUSE_RICHEDIT
 #endif // wxUSE_RICHEDIT
 
 #if wxUSE_INKEDIT && wxUSE_RICHEDIT


@@ -166,7 +142,10 @@ public:
 
     virtual void AdoptAttributesFromHWND();
 
 
     virtual void AdoptAttributesFromHWND();
 

-    virtual bool AcceptsFocus() const;
+    virtual bool AcceptsFocusFromKeyboard() const;
+
+    // returns true if the platform should explicitly apply a theme border
+    virtual bool CanApplyThemeBorder() const;

 
     // callbacks
     void OnDropFiles(wxDropFilesEvent& event);
 
     // callbacks
     void OnDropFiles(wxDropFilesEvent& event);


@@ -201,12 +180,24 @@ public:
 
     virtual bool MSWShouldPreProcessMessage(WXMSG* pMsg);
     virtual WXDWORD MSWGetStyle(long style, WXDWORD *exstyle) const;
 
     virtual bool MSWShouldPreProcessMessage(WXMSG* pMsg);
     virtual WXDWORD MSWGetStyle(long style, WXDWORD *exstyle) const;

-    virtual wxVisualAttributes GetDefaultAttributes() const;

 
 protected:
     // common part of all ctors
     void Init();
 
 
 protected:
     // common part of all ctors
     void Init();
 

+    virtual bool DoLoadFile(const wxString& file, int fileType);
+
+    // 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;
     // 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;


@@ -229,13 +220,11 @@ protected:
 
     // replace the contents of the selection or of the entire control with the
     // given text
 
     // replace the contents of the selection or of the entire control with the
     // given text

-    void DoWriteText(const wxString& text, bool selectionOnly = true);
+    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;
+    // set the selection (possibly without scrolling the caret into view)
+    void DoSetSelection(long from, long to, int flags);

 
     // get the length of the line containing the character at the given
     // position
 
     // get the length of the line containing the character at the given
     // position


@@ -247,9 +236,23 @@ protected:
     virtual wxSize DoGetBestSize() const;
 
 #if wxUSE_RICHEDIT
     virtual wxSize DoGetBestSize() const;
 
 #if wxUSE_RICHEDIT

+    // Apply the character-related parts of wxTextAttr to the given selection
+    // or the entire control if start == end == -1.
+    //
+    // This function is private and should only be called for rich edit
+    // controls and with (from, to) already in correct order, i.e. from <= to.
+    bool MSWSetCharFormat(const wxTextAttr& attr, long from = -1, long to = -1);
+
+    // Same as above for paragraph-related parts of wxTextAttr. Note that this
+    // can only be applied to the selection as RichEdit doesn't support setting
+    // the paragraph styles globally.
+    bool MSWSetParaFormat(const wxTextAttr& attr, long from, long to);
+
+

     // we're using RICHEDIT (and not simple EDIT) control if this field is not
     // 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)
+    // 0, it also gives the version of the RICHEDIT control being used
+    // (although not directly: 1 is for 1.0, 2 is for either 2.0 or 3.0 as we
+    // can't nor really need to distinguish between them and 4 is for 4.1)

     int m_verRichEdit;
 #endif // wxUSE_RICHEDIT
 
     int m_verRichEdit;
 #endif // wxUSE_RICHEDIT
 


@@ -258,6 +261,17 @@ protected:
     int m_updatesCount;
 
 private:
     int m_updatesCount;
 
 private:

+    virtual void EnableTextChangedEvents(bool enable)
+    {
+        m_updatesCount = enable ? -1 : -2;
+    }
+
+    // implement wxTextEntry pure virtual: it implements all the operations for
+    // the simple EDIT controls
+    virtual WXHWND GetEditHWND() const { return m_hWnd; }
+
+    void OnKeyDown(wxKeyEvent& event);
+

     DECLARE_EVENT_TABLE()
     DECLARE_DYNAMIC_CLASS_NO_COPY(wxTextCtrl)
 
     DECLARE_EVENT_TABLE()
     DECLARE_DYNAMIC_CLASS_NO_COPY(wxTextCtrl)
 


@@ -271,5 +285,4 @@ private:
 
 };
 
 
 };
 

-#endif
-    // _WX_TEXTCTRL_H_
+#endif // _WX_TEXTCTRL_H_