include/wx/msw/textctrl.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/msw/textctrl.h
   3 // Purpose:     wxTextCtrl class
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     01/02/97
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_TEXTCTRL_H_
  13 #define _WX_TEXTCTRL_H_
  14
  15 class WXDLLEXPORT wxTextCtrl : public wxTextCtrlBase
  16 {
  17 public:
  18     // creation
  19     // --------
  20
  21     wxTextCtrl() { Init(); }
  22     wxTextCtrl(wxWindow *parent, wxWindowID id,
  23                const wxString& value = wxEmptyString,
  24                const wxPoint& pos = wxDefaultPosition,
  25                const wxSize& size = wxDefaultSize,
  26                long style = 0,
  27                const wxValidator& validator = wxDefaultValidator,
  28                const wxString& name = wxTextCtrlNameStr)
  29     {
  30         Init();
  31
  32         Create(parent, id, value, pos, size, style, validator, name);
  33     }
  34     virtual ~wxTextCtrl();
  35
  36     bool Create(wxWindow *parent, wxWindowID id,
  37                 const wxString& value = wxEmptyString,
  38                 const wxPoint& pos = wxDefaultPosition,
  39                 const wxSize& size = wxDefaultSize,
  40                 long style = 0,
  41                 const wxValidator& validator = wxDefaultValidator,
  42                 const wxString& name = wxTextCtrlNameStr);
  43
  44     // overridden wxTextEntry methods
  45     // ------------------------------
  46
  47     virtual wxString GetValue() const;
  48     virtual wxString GetRange(long from, long to) const;
  49
  50     virtual bool IsEmpty() const;
  51
  52     virtual void WriteText(const wxString& text);
  53     virtual void AppendText(const wxString& text);
  54     virtual void Clear();
  55
  56     virtual int GetLineLength(long lineNo) const;
  57     virtual wxString GetLineText(long lineNo) const;
  58     virtual int GetNumberOfLines() const;
  59
  60     virtual void SetMaxLength(unsigned long len);
  61
  62     virtual void GetSelection(long *from, long *to) const;
  63
  64     virtual void Redo();
  65     virtual bool CanRedo() const;
  66
  67     virtual void SetInsertionPointEnd();
  68     virtual long GetInsertionPoint() const;
  69     virtual wxTextPos GetLastPosition() const;
  70
  71     // implement base class pure virtuals
  72     // ----------------------------------
  73
  74     virtual bool DoLoadFile(const wxString& file, int fileType);
  75
  76     virtual bool IsModified() const;
  77     virtual void MarkDirty();
  78     virtual void DiscardEdits();
  79
  80 #ifdef __WIN32__
  81     virtual bool EmulateKeyPress(const wxKeyEvent& event);
  82 #endif // __WIN32__
  83
  84 #if wxUSE_RICHEDIT
  85     // apply text attribute to the range of text (only works with richedit
  86     // controls)
  87     virtual bool SetStyle(long start, long end, const wxTextAttr& style);
  88     virtual bool SetDefaultStyle(const wxTextAttr& style);
  89     virtual bool GetStyle(long position, wxTextAttr& style);
  90 #endif // wxUSE_RICHEDIT
  91
  92     // translate between the position (which is just an index in the text ctrl
  93     // considering all its contents as a single strings) and (x, y) coordinates
  94     // which represent column and line.
  95     virtual long XYToPosition(long x, long y) const;
  96     virtual bool PositionToXY(long pos, long *x, long *y) const;
  97
  98     virtual void ShowPosition(long pos);
  99     virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt, long *pos) const;
 100     virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt,
 101                                             wxTextCoord *col,
 102                                             wxTextCoord *row) const
 103     {
 104         return wxTextCtrlBase::HitTest(pt, col, row);
 105     }
 106
 107     // Caret handling (Windows only)
 108     bool ShowNativeCaret(bool show = true);
 109     bool HideNativeCaret() { return ShowNativeCaret(false); }
 110
 111     // Implementation from now on
 112     // --------------------------
 113
 114 #if wxUSE_DRAG_AND_DROP && wxUSE_RICHEDIT
 115     virtual void SetDropTarget(wxDropTarget *dropTarget);
 116 #endif // wxUSE_DRAG_AND_DROP && wxUSE_RICHEDIT
 117
 118     virtual void SetWindowStyleFlag(long style);
 119
 120     virtual void Command(wxCommandEvent& event);
 121     virtual bool MSWCommand(WXUINT param, WXWORD id);
 122     virtual WXHBRUSH MSWControlColor(WXHDC hDC, WXHWND hWnd);
 123
 124 #if wxUSE_RICHEDIT
 125     virtual bool MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result);
 126
 127     int GetRichVersion() const { return m_verRichEdit; }
 128     bool IsRich() const { return m_verRichEdit != 0; }
 129
 130     // rich edit controls are not compatible with normal ones and wem ust set
 131     // the colours for them otherwise
 132     virtual bool SetBackgroundColour(const wxColour& colour);
 133     virtual bool SetForegroundColour(const wxColour& colour);
 134 #else
 135     bool IsRich() const { return false; }
 136 #endif // wxUSE_RICHEDIT
 137
 138 #if wxUSE_INKEDIT && wxUSE_RICHEDIT
 139     bool IsInkEdit() const { return m_isInkEdit != 0; }
 140 #else
 141     bool IsInkEdit() const { return false; }
 142 #endif
 143
 144     virtual void AdoptAttributesFromHWND();
 145
 146     virtual bool AcceptsFocusFromKeyboard() const;
 147
 148     // returns true if the platform should explicitly apply a theme border
 149     virtual bool CanApplyThemeBorder() const;
 150
 151     // callbacks
 152     void OnDropFiles(wxDropFilesEvent& event);
 153     void OnChar(wxKeyEvent& event); // Process 'enter' if required
 154
 155     void OnCut(wxCommandEvent& event);
 156     void OnCopy(wxCommandEvent& event);
 157     void OnPaste(wxCommandEvent& event);
 158     void OnUndo(wxCommandEvent& event);
 159     void OnRedo(wxCommandEvent& event);
 160     void OnDelete(wxCommandEvent& event);
 161     void OnSelectAll(wxCommandEvent& event);
 162
 163     void OnUpdateCut(wxUpdateUIEvent& event);
 164     void OnUpdateCopy(wxUpdateUIEvent& event);
 165     void OnUpdatePaste(wxUpdateUIEvent& event);
 166     void OnUpdateUndo(wxUpdateUIEvent& event);
 167     void OnUpdateRedo(wxUpdateUIEvent& event);
 168     void OnUpdateDelete(wxUpdateUIEvent& event);
 169     void OnUpdateSelectAll(wxUpdateUIEvent& event);
 170
 171     // Show a context menu for Rich Edit controls (the standard
 172     // EDIT control has one already)
 173     void OnContextMenu(wxContextMenuEvent& event);
 174
 175     // be sure the caret remains invisible if the user
 176     // called HideNativeCaret() before
 177     void OnSetFocus(wxFocusEvent& event);
 178
 179     // intercept WM_GETDLGCODE
 180     virtual WXLRESULT MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
 181
 182     virtual bool MSWShouldPreProcessMessage(WXMSG* pMsg);
 183     virtual WXDWORD MSWGetStyle(long style, WXDWORD *exstyle) const;
 184     virtual wxVisualAttributes GetDefaultAttributes() const;
 185
 186 protected:
 187     // common part of all ctors
 188     void Init();
 189
 190     // creates the control of appropriate class (plain or rich edit) with the
 191     // styles corresponding to m_windowStyle
 192     //
 193     // this is used by ctor/Create() and when we need to recreate the control
 194     // later
 195     bool MSWCreateText(const wxString& value,
 196                        const wxPoint& pos,
 197                        const wxSize& size);
 198
 199     virtual void DoSetValue(const wxString &value, int flags = 0);
 200
 201     // implement wxTextEntry pure virtual: it implements all the operations for
 202     // the simple EDIT controls
 203     virtual WXHWND GetEditHWND() const { return m_hWnd; }
 204
 205     // return true if this control has a user-set limit on amount of text (i.e.
 206     // the limit is due to a previous call to SetMaxLength() and not built in)
 207     bool HasSpaceLimit(unsigned int *len) const;
 208
 209     // call this to increase the size limit (will do nothing if the current
 210     // limit is big enough)
 211     //
 212     // returns true if we increased the limit to allow entering more text,
 213     // false if we hit the limit set by SetMaxLength() and so didn't change it
 214     bool AdjustSpaceLimit();
 215
 216 #if wxUSE_RICHEDIT && (!wxUSE_UNICODE || wxUSE_UNICODE_MSLU)
 217     // replace the selection or the entire control contents with the given text
 218     // in the specified encoding
 219     bool StreamIn(const wxString& value, wxFontEncoding encoding, bool selOnly);
 220
 221     // get the contents of the control out as text in the given encoding
 222     wxString StreamOut(wxFontEncoding encoding, bool selOnly = false) const;
 223 #endif // wxUSE_RICHEDIT
 224
 225     // replace the contents of the selection or of the entire control with the
 226     // given text
 227     void DoWriteText(const wxString& text,
 228                      int flags = SetValue_SendEvent | SetValue_SelectionOnly);
 229
 230     // set the selection (possibly without scrolling the caret into view)
 231     void DoSetSelection(long from, long to, int flags);
 232
 233     // get the length of the line containing the character at the given
 234     // position
 235     long GetLengthOfLineContainingPos(long pos) const;
 236
 237     // send TEXT_UPDATED event, return true if it was handled, false otherwise
 238     bool SendUpdateEvent();
 239
 240     virtual wxSize DoGetBestSize() const;
 241
 242 #if wxUSE_RICHEDIT
 243     // we're using RICHEDIT (and not simple EDIT) control if this field is not
 244     // 0, it also gives the version of the RICHEDIT control being used (1, 2 or
 245     // 3 so far)
 246     int m_verRichEdit;
 247 #endif // wxUSE_RICHEDIT
 248
 249     // number of EN_UPDATE events sent by Windows when we change the controls
 250     // text ourselves: we want this to be exactly 1
 251     int m_updatesCount;
 252
 253     virtual void EnableTextChangedEvents(bool enable)
 254     {
 255         m_updatesCount = enable ? -1 : -2;
 256     }
 257
 258 private:
 259     DECLARE_EVENT_TABLE()
 260     DECLARE_DYNAMIC_CLASS_NO_COPY(wxTextCtrl)
 261
 262     wxMenu* m_privateContextMenu;
 263
 264     bool m_isNativeCaretShown;
 265
 266 #if wxUSE_INKEDIT && wxUSE_RICHEDIT
 267     int  m_isInkEdit;
 268 #endif
 269
 270 };
 271
 272 #endif // _WX_TEXTCTRL_H_