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 #ifdef __GNUG__
  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
  39     bool Create(wxWindow *parent, wxWindowID id,
  40                 const wxString& value = wxEmptyString,
  41                 const wxPoint& pos = wxDefaultPosition,
  42                 const wxSize& size = wxDefaultSize,
  43                 long style = 0,
  44                 const wxValidator& validator = wxDefaultValidator,
  45                 const wxString& name = wxTextCtrlNameStr);
  46
  47     // implement base class pure virtuals
  48     // ----------------------------------
  49
  50     virtual wxString GetValue() const;
  51     virtual void SetValue(const wxString& value);
  52
  53     virtual wxString GetRange(long from, long to) const;
  54
  55     virtual int GetLineLength(long lineNo) const;
  56     virtual wxString GetLineText(long lineNo) const;
  57     virtual int GetNumberOfLines() const;
  58
  59     virtual bool IsModified() const;
  60     virtual bool IsEditable() const;
  61
  62     virtual void GetSelection(long* from, long* to) const;
  63
  64     // operations
  65     // ----------
  66
  67     // editing
  68     virtual void Clear();
  69     virtual void Replace(long from, long to, const wxString& value);
  70     virtual void Remove(long from, long to);
  71
  72     // load the controls contents from the file
  73     virtual bool LoadFile(const wxString& file);
  74
  75     // clears the dirty flag
  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 #endif // wxUSE_RICHEDIT
  94
  95     // translate between the position (which is just an index in the text ctrl
  96     // considering all its contents as a single strings) and (x, y) coordinates
  97     // which represent column and line.
  98     virtual long XYToPosition(long x, long y) const;
  99     virtual bool PositionToXY(long pos, long *x, long *y) const;
 100
 101     virtual void ShowPosition(long pos);
 102
 103     // Clipboard operations
 104     virtual void Copy();
 105     virtual void Cut();
 106     virtual void Paste();
 107
 108     virtual bool CanCopy() const;
 109     virtual bool CanCut() const;
 110     virtual bool CanPaste() const;
 111
 112     // Undo/redo
 113     virtual void Undo();
 114     virtual void Redo();
 115
 116     virtual bool CanUndo() const;
 117     virtual bool CanRedo() const;
 118
 119     // Insertion point
 120     virtual void SetInsertionPoint(long pos);
 121     virtual void SetInsertionPointEnd();
 122     virtual long GetInsertionPoint() const;
 123     virtual long GetLastPosition() const;
 124
 125     virtual void SetSelection(long from, long to);
 126     virtual void SetEditable(bool editable);
 127
 128     // Implementation from now on
 129     // --------------------------
 130
 131     virtual void SetWindowStyleFlag(long style);
 132
 133     virtual void Command(wxCommandEvent& event);
 134     virtual bool MSWCommand(WXUINT param, WXWORD id);
 135     virtual WXHBRUSH OnCtlColor(WXHDC pDC, WXHWND pWnd, WXUINT nCtlColor,
 136             WXUINT message, WXWPARAM wParam, WXLPARAM lParam);
 137
 138     // In WIN16, need to override normal erasing because
 139     // Ctl3D doesn't use the wxWindows background colour.
 140 #ifdef __WIN16__
 141     void OnEraseBackground(wxEraseEvent& event);
 142 #endif
 143
 144 #if wxUSE_RICHEDIT
 145     virtual bool MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result);
 146
 147     int GetRichVersion() const { return m_verRichEdit; }
 148     bool IsRich() const { return m_verRichEdit != 0; }
 149
 150     // rich edit controls are not compatible with normal ones and wem ust set
 151     // the colours for them otherwise
 152     virtual bool SetBackgroundColour(const wxColour& colour);
 153     virtual bool SetForegroundColour(const wxColour& colour);
 154 #endif // wxUSE_RICHEDIT
 155
 156     virtual void AdoptAttributesFromHWND();
 157
 158     virtual bool AcceptsFocus() const;
 159
 160     // callbacks
 161     void OnDropFiles(wxDropFilesEvent& event);
 162     void OnChar(wxKeyEvent& event); // Process 'enter' if required
 163
 164     void OnCut(wxCommandEvent& event);
 165     void OnCopy(wxCommandEvent& event);
 166     void OnPaste(wxCommandEvent& event);
 167     void OnUndo(wxCommandEvent& event);
 168     void OnRedo(wxCommandEvent& event);
 169
 170     void OnUpdateCut(wxUpdateUIEvent& event);
 171     void OnUpdateCopy(wxUpdateUIEvent& event);
 172     void OnUpdatePaste(wxUpdateUIEvent& event);
 173     void OnUpdateUndo(wxUpdateUIEvent& event);
 174     void OnUpdateRedo(wxUpdateUIEvent& event);
 175
 176 protected:
 177     // common part of all ctors
 178     void Init();
 179
 180     // intercept WM_GETDLGCODE
 181     virtual long MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
 182
 183     // call this to increase the size limit (will do nothing if the current
 184     // limit is big enough)
 185     //
 186     // returns true if we increased the limit to allow entering more text,
 187     // false if we hit the limit set by SetMaxLength() and so didn't change it
 188     bool AdjustSpaceLimit();
 189
 190 #if wxUSE_RICHEDIT
 191     // replace the selection or the entire control contents with the given text
 192     // in the specified encoding
 193     bool StreamIn(const wxString& value,
 194                   wxFontEncoding encoding,
 195                   bool selOnly);
 196 #endif // wxUSE_RICHEDIT
 197
 198     // replace the contents of the selection or of the entire control with the
 199     // given text
 200     void DoWriteText(const wxString& text, bool selectionOnly = TRUE);
 201
 202     // set the selection possibly without scrolling the caret into view
 203     void DoSetSelection(long from, long to, bool scrollCaret = TRUE);
 204
 205     // get the length of the line containing the character at the given
 206     // position
 207     long GetLengthOfLineContainingPos(long pos) const;
 208
 209     // override some base class virtuals
 210     virtual bool MSWShouldPreProcessMessage(WXMSG* pMsg);
 211     virtual wxSize DoGetBestSize() const;
 212
 213     virtual WXDWORD MSWGetStyle(long style, WXDWORD *exstyle) const;
 214
 215 #if wxUSE_RICHEDIT
 216     // we're using RICHEDIT (and not simple EDIT) control if this field is not
 217     // 0, it also gives the version of the RICHEDIT control being used (1, 2 or
 218     // 3 so far)
 219     int m_verRichEdit;
 220 #endif // wxUSE_RICHEDIT
 221
 222 private:
 223     DECLARE_EVENT_TABLE()
 224     DECLARE_DYNAMIC_CLASS(wxTextCtrl)
 225 };
 226
 227 #endif
 228     // _WX_TEXTCTRL_H_