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