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 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  16     #pragma interface "textctrl.h"
  17 #endif
  18
  19 class WXDLLEXPORT wxTextCtrl : public wxTextCtrlBase
  20 {
  21 public:
  22     // creation
  23     // --------
  24
  25     wxTextCtrl() { Init(); }
  26     wxTextCtrl(wxWindow *parent, wxWindowID id,
  27                const wxString& value = wxEmptyString,
  28                const wxPoint& pos = wxDefaultPosition,
  29                const wxSize& size = wxDefaultSize,
  30                long style = 0,
  31                const wxValidator& validator = wxDefaultValidator,
  32                const wxString& name = wxTextCtrlNameStr)
  33     {
  34         Init();
  35
  36         Create(parent, id, value, pos, size, style, validator, name);
  37     }
  38     ~wxTextCtrl();
  39
  40     bool Create(wxWindow *parent, wxWindowID id,
  41                 const wxString& value = wxEmptyString,
  42                 const wxPoint& pos = wxDefaultPosition,
  43                 const wxSize& size = wxDefaultSize,
  44                 long style = 0,
  45                 const wxValidator& validator = wxDefaultValidator,
  46                 const wxString& name = wxTextCtrlNameStr);
  47
  48     // implement base class pure virtuals
  49     // ----------------------------------
  50
  51     virtual wxString GetValue() const;
  52     virtual void SetValue(const wxString& value);
  53
  54     virtual wxString GetRange(long from, long to) const;
  55
  56     virtual int GetLineLength(long lineNo) const;
  57     virtual wxString GetLineText(long lineNo) const;
  58     virtual int GetNumberOfLines() const;
  59
  60     virtual bool IsModified() const;
  61     virtual bool IsEditable() const;
  62
  63     virtual void GetSelection(long* from, long* to) const;
  64
  65     // operations
  66     // ----------
  67
  68     // editing
  69     virtual void Clear();
  70     virtual void Replace(long from, long to, const wxString& value);
  71     virtual void Remove(long from, long to);
  72
  73     // load the controls contents from the file
  74     virtual bool LoadFile(const wxString& file);
  75
  76     // clears the dirty flag
  77     virtual void MarkDirty();
  78     virtual void DiscardEdits();
  79
  80     virtual void SetMaxLength(unsigned long len);
  81
  82     // writing text inserts it at the current position, appending always
  83     // inserts it at the end
  84     virtual void WriteText(const wxString& text);
  85     virtual void AppendText(const wxString& text);
  86
  87 #ifdef __WIN32__
  88     virtual bool EmulateKeyPress(const wxKeyEvent& event);
  89 #endif // __WIN32__
  90
  91 #if wxUSE_RICHEDIT
  92     // apply text attribute to the range of text (only works with richedit
  93     // controls)
  94     virtual bool SetStyle(long start, long end, const wxTextAttr& style);
  95     virtual bool SetDefaultStyle(const wxTextAttr& style);
  96     virtual bool GetStyle(long position, wxTextAttr& style);
  97 #endif // wxUSE_RICHEDIT
  98
  99     // translate between the position (which is just an index in the text ctrl
 100     // considering all its contents as a single strings) and (x, y) coordinates
 101     // which represent column and line.
 102     virtual long XYToPosition(long x, long y) const;
 103     virtual bool PositionToXY(long pos, long *x, long *y) const;
 104
 105     virtual void ShowPosition(long pos);
 106     virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt,
 107                                             wxTextCoord *col,
 108                                             wxTextCoord *row) const;
 109
 110     // Clipboard operations
 111     virtual void Copy();
 112     virtual void Cut();
 113     virtual void Paste();
 114
 115     virtual bool CanCopy() const;
 116     virtual bool CanCut() const;
 117     virtual bool CanPaste() const;
 118
 119     // Undo/redo
 120     virtual void Undo();
 121     virtual void Redo();
 122
 123     virtual bool CanUndo() const;
 124     virtual bool CanRedo() const;
 125
 126     // Insertion point
 127     virtual void SetInsertionPoint(long pos);
 128     virtual void SetInsertionPointEnd();
 129     virtual long GetInsertionPoint() const;
 130     virtual long GetLastPosition() const;
 131
 132     virtual void SetSelection(long from, long to);
 133     virtual void SetEditable(bool editable);
 134
 135     // Caret handling (Windows only)
 136
 137     bool ShowNativeCaret(bool show = true);
 138     bool HideNativeCaret() { return ShowNativeCaret(false); }
 139
 140     // Implementation from now on
 141     // --------------------------
 142
 143     virtual void SetWindowStyleFlag(long style);
 144
 145     virtual void Command(wxCommandEvent& event);
 146     virtual bool MSWCommand(WXUINT param, WXWORD id);
 147     virtual WXHBRUSH OnCtlColor(WXHDC pDC, WXHWND pWnd, WXUINT nCtlColor,
 148             WXUINT message, WXWPARAM wParam, WXLPARAM lParam);
 149
 150     // In WIN16, need to override normal erasing because
 151     // Ctl3D doesn't use the wxWindows background colour.
 152 #ifdef __WIN16__
 153     void OnEraseBackground(wxEraseEvent& event);
 154 #endif
 155
 156 #if wxUSE_RICHEDIT
 157     virtual bool MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result);
 158
 159     int GetRichVersion() const { return m_verRichEdit; }
 160     bool IsRich() const { return m_verRichEdit != 0; }
 161
 162     // rich edit controls are not compatible with normal ones and wem ust set
 163     // the colours for them otherwise
 164     virtual bool SetBackgroundColour(const wxColour& colour);
 165     virtual bool SetForegroundColour(const wxColour& colour);
 166 #endif // wxUSE_RICHEDIT
 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 OnRightClick(wxMouseEvent& event);
 195
 196     // be sure the caret remains invisible if the user
 197     // called HideNativeCaret() before
 198     void OnSetFocus(wxFocusEvent& event);
 199
 200 protected:
 201     // common part of all ctors
 202     void Init();
 203
 204     // intercept WM_GETDLGCODE
 205     virtual long MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
 206
 207     // call this to increase the size limit (will do nothing if the current
 208     // limit is big enough)
 209     //
 210     // returns true if we increased the limit to allow entering more text,
 211     // false if we hit the limit set by SetMaxLength() and so didn't change it
 212     bool AdjustSpaceLimit();
 213
 214 #if wxUSE_RICHEDIT && (!wxUSE_UNICODE || wxUSE_UNICODE_MSLU)
 215     // replace the selection or the entire control contents with the given text
 216     // in the specified encoding
 217     bool StreamIn(const wxString& value, wxFontEncoding encoding, bool selOnly);
 218
 219     // get the contents of the control out as text in the given encoding
 220     wxString StreamOut(wxFontEncoding encoding, bool selOnly = false) const;
 221 #endif // wxUSE_RICHEDIT
 222
 223     // replace the contents of the selection or of the entire control with the
 224     // given text
 225     void DoWriteText(const wxString& text, bool selectionOnly = TRUE);
 226
 227     // set the selection possibly without scrolling the caret into view
 228     void DoSetSelection(long from, long to, bool scrollCaret = TRUE);
 229
 230     // return true if there is a non empty selection in the control
 231     bool HasSelection() const;
 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     // override some base class virtuals
 241     virtual bool MSWShouldPreProcessMessage(WXMSG* pMsg);
 242     virtual wxSize DoGetBestSize() const;
 243
 244     virtual WXDWORD MSWGetStyle(long style, WXDWORD *exstyle) const;
 245
 246 #if wxUSE_RICHEDIT
 247     // we're using RICHEDIT (and not simple EDIT) control if this field is not
 248     // 0, it also gives the version of the RICHEDIT control being used (1, 2 or
 249     // 3 so far)
 250     int m_verRichEdit;
 251 #endif // wxUSE_RICHEDIT
 252
 253     // if TRUE, SendUpdateEvent() will eat the next event (see comments in the
 254     // code as to why this is needed)
 255     bool m_suppressNextUpdate;
 256
 257 private:
 258     DECLARE_EVENT_TABLE()
 259     DECLARE_DYNAMIC_CLASS_NO_COPY(wxTextCtrl)
 260
 261     wxMenu* m_privateContextMenu;
 262
 263     bool m_isNativeCaretShown;
 264 };
 265
 266 #endif
 267     // _WX_TEXTCTRL_H_