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     // implement base class pure virtuals
  45     // ----------------------------------
  46
  47     virtual wxString GetValue() const;
  48     virtual bool IsEmpty() const;
  49     virtual void SetValue(const wxString& value) { DoSetValue(value, SetValue_SendEvent); }
  50     virtual void ChangeValue(const wxString& value) { DoSetValue(value); }
  51
  52     virtual wxString GetRange(long from, long to) const;
  53
  54     virtual int GetLineLength(long lineNo) const;
  55     virtual wxString GetLineText(long lineNo) const;
  56     virtual int GetNumberOfLines() const;
  57
  58     virtual bool IsModified() const;
  59     virtual bool IsEditable() const;
  60
  61     virtual void GetSelection(long* from, long* to) const;
  62
  63     // operations
  64     // ----------
  65
  66     // editing
  67     virtual void Clear();
  68     virtual void Replace(long from, long to, const wxString& value);
  69     virtual void Remove(long from, long to);
  70
  71     // load the control's contents from the file
  72     virtual bool DoLoadFile(const wxString& file, int fileType);
  73
  74     // clears the dirty flag
  75     virtual void MarkDirty();
  76     virtual void DiscardEdits();
  77
  78     virtual void SetMaxLength(unsigned long len);
  79
  80     // writing text inserts it at the current position, appending always
  81     // inserts it at the end
  82     virtual void WriteText(const wxString& text);
  83     virtual void AppendText(const wxString& text);
  84
  85 #ifdef __WIN32__
  86     virtual bool EmulateKeyPress(const wxKeyEvent& event);
  87 #endif // __WIN32__
  88
  89 #if wxUSE_RICHEDIT
  90     // apply text attribute to the range of text (only works with richedit
  91     // controls)
  92     virtual bool SetStyle(long start, long end, const wxTextAttr& style);
  93     virtual bool SetDefaultStyle(const wxTextAttr& style);
  94     virtual bool GetStyle(long position, wxTextAttr& style);
  95 #endif // wxUSE_RICHEDIT
  96
  97     // translate between the position (which is just an index in the text ctrl
  98     // considering all its contents as a single strings) and (x, y) coordinates
  99     // which represent column and line.
 100     virtual long XYToPosition(long x, long y) const;
 101     virtual bool PositionToXY(long pos, long *x, long *y) const;
 102
 103     virtual void ShowPosition(long pos);
 104     virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt, long *pos) const;
 105     virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt,
 106                                             wxTextCoord *col,
 107                                             wxTextCoord *row) const
 108     {
 109         return wxTextCtrlBase::HitTest(pt, col, row);
 110     }
 111
 112     // Clipboard operations
 113     virtual void Copy();
 114     virtual void Cut();
 115     virtual void Paste();
 116
 117     virtual bool CanCopy() const;
 118     virtual bool CanCut() const;
 119     virtual bool CanPaste() const;
 120
 121     // Undo/redo
 122     virtual void Undo();
 123     virtual void Redo();
 124
 125     virtual bool CanUndo() const;
 126     virtual bool CanRedo() const;
 127
 128     // Insertion point
 129     virtual void SetInsertionPoint(long pos);
 130     virtual void SetInsertionPointEnd();
 131     virtual long GetInsertionPoint() const;
 132     virtual wxTextPos GetLastPosition() const;
 133
 134     virtual void SetSelection(long from, long to);
 135     virtual void SetEditable(bool editable);
 136
 137     // Caret handling (Windows only)
 138
 139     bool ShowNativeCaret(bool show = true);
 140     bool HideNativeCaret() { return ShowNativeCaret(false); }
 141
 142     // Implementation from now on
 143     // --------------------------
 144
 145     virtual void SetWindowStyleFlag(long style);
 146
 147     virtual void Command(wxCommandEvent& event);
 148     virtual bool MSWCommand(WXUINT param, WXWORD id);
 149     virtual WXHBRUSH MSWControlColor(WXHDC hDC, WXHWND hWnd);
 150
 151 #if wxUSE_RICHEDIT
 152     virtual bool MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result);
 153
 154     int GetRichVersion() const { return m_verRichEdit; }
 155     bool IsRich() const { return m_verRichEdit != 0; }
 156
 157     // rich edit controls are not compatible with normal ones and wem ust set
 158     // the colours for them otherwise
 159     virtual bool SetBackgroundColour(const wxColour& colour);
 160     virtual bool SetForegroundColour(const wxColour& colour);
 161 #endif // wxUSE_RICHEDIT
 162
 163 #if wxUSE_INKEDIT && wxUSE_RICHEDIT
 164     bool IsInkEdit() const { return m_isInkEdit != 0; }
 165 #else
 166     bool IsInkEdit() const { return false; }
 167 #endif
 168
 169     virtual void AdoptAttributesFromHWND();
 170
 171     virtual bool AcceptsFocus() const;
 172
 173     // callbacks
 174     void OnDropFiles(wxDropFilesEvent& event);
 175     void OnChar(wxKeyEvent& event); // Process 'enter' if required
 176
 177     void OnCut(wxCommandEvent& event);
 178     void OnCopy(wxCommandEvent& event);
 179     void OnPaste(wxCommandEvent& event);
 180     void OnUndo(wxCommandEvent& event);
 181     void OnRedo(wxCommandEvent& event);
 182     void OnDelete(wxCommandEvent& event);
 183     void OnSelectAll(wxCommandEvent& event);
 184
 185     void OnUpdateCut(wxUpdateUIEvent& event);
 186     void OnUpdateCopy(wxUpdateUIEvent& event);
 187     void OnUpdatePaste(wxUpdateUIEvent& event);
 188     void OnUpdateUndo(wxUpdateUIEvent& event);
 189     void OnUpdateRedo(wxUpdateUIEvent& event);
 190     void OnUpdateDelete(wxUpdateUIEvent& event);
 191     void OnUpdateSelectAll(wxUpdateUIEvent& event);
 192
 193     // Show a context menu for Rich Edit controls (the standard
 194     // EDIT control has one already)
 195     void OnContextMenu(wxContextMenuEvent& event);
 196
 197     // be sure the caret remains invisible if the user
 198     // called HideNativeCaret() before
 199     void OnSetFocus(wxFocusEvent& event);
 200
 201     // intercept WM_GETDLGCODE
 202     virtual WXLRESULT MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
 203
 204     virtual bool MSWShouldPreProcessMessage(WXMSG* pMsg);
 205     virtual WXDWORD MSWGetStyle(long style, WXDWORD *exstyle) const;
 206     virtual wxVisualAttributes GetDefaultAttributes() const;
 207
 208 protected:
 209     // common part of all ctors
 210     void Init();
 211
 212     void DoSetValue(const wxString &value, int flags = 0);
 213
 214     // return true if this control has a user-set limit on amount of text (i.e.
 215     // the limit is due to a previous call to SetMaxLength() and not built in)
 216     bool HasSpaceLimit(unsigned int *len) const;
 217
 218     // call this to increase the size limit (will do nothing if the current
 219     // limit is big enough)
 220     //
 221     // returns true if we increased the limit to allow entering more text,
 222     // false if we hit the limit set by SetMaxLength() and so didn't change it
 223     bool AdjustSpaceLimit();
 224
 225 #if wxUSE_RICHEDIT && (!wxUSE_UNICODE || wxUSE_UNICODE_MSLU)
 226     // replace the selection or the entire control contents with the given text
 227     // in the specified encoding
 228     bool StreamIn(const wxString& value, wxFontEncoding encoding, bool selOnly);
 229
 230     // get the contents of the control out as text in the given encoding
 231     wxString StreamOut(wxFontEncoding encoding, bool selOnly = false) const;
 232 #endif // wxUSE_RICHEDIT
 233
 234     // replace the contents of the selection or of the entire control with the
 235     // given text
 236     void DoWriteText(const wxString& text, int flags = SetValue_SelectionOnly);
 237
 238     // set the selection possibly without scrolling the caret into view
 239     void DoSetSelection(long from, long to, bool scrollCaret = true);
 240
 241     // return true if there is a non empty selection in the control
 242     bool HasSelection() const;
 243
 244     // get the length of the line containing the character at the given
 245     // position
 246     long GetLengthOfLineContainingPos(long pos) const;
 247
 248     // send TEXT_UPDATED event, return true if it was handled, false otherwise
 249     bool SendUpdateEvent();
 250
 251     virtual wxSize DoGetBestSize() const;
 252
 253 #if wxUSE_RICHEDIT
 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 (1, 2 or
 256     // 3 so far)
 257     int m_verRichEdit;
 258 #endif // wxUSE_RICHEDIT
 259
 260     // number of EN_UPDATE events sent by Windows when we change the controls
 261     // text ourselves: we want this to be exactly 1
 262     int m_updatesCount;
 263
 264 private:
 265     DECLARE_EVENT_TABLE()
 266     DECLARE_DYNAMIC_CLASS_NO_COPY(wxTextCtrl)
 267
 268     wxMenu* m_privateContextMenu;
 269
 270     bool m_isNativeCaretShown;
 271
 272 #if wxUSE_INKEDIT && wxUSE_RICHEDIT
 273     int  m_isInkEdit;
 274 #endif
 275
 276 };
 277
 278 #endif
 279     // _WX_TEXTCTRL_H_