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