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, long *pos) const;
 107     virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt,
 108                                             wxTextCoord *col,
 109                                             wxTextCoord *row) const
 110     {
 111         return wxTextCtrlBase::HitTest(pt, col, row);
 112     }
 113
 114     // Clipboard operations
 115     virtual void Copy();
 116     virtual void Cut();
 117     virtual void Paste();
 118
 119     virtual bool CanCopy() const;
 120     virtual bool CanCut() const;
 121     virtual bool CanPaste() const;
 122
 123     // Undo/redo
 124     virtual void Undo();
 125     virtual void Redo();
 126
 127     virtual bool CanUndo() const;
 128     virtual bool CanRedo() const;
 129
 130     // Insertion point
 131     virtual void SetInsertionPoint(long pos);
 132     virtual void SetInsertionPointEnd();
 133     virtual long GetInsertionPoint() const;
 134     virtual long GetLastPosition() const;
 135
 136     virtual void SetSelection(long from, long to);
 137     virtual void SetEditable(bool editable);
 138
 139     // Caret handling (Windows only)
 140
 141     bool ShowNativeCaret(bool show = true);
 142     bool HideNativeCaret() { return ShowNativeCaret(false); }
 143
 144     // Implementation from now on
 145     // --------------------------
 146
 147     virtual void SetWindowStyleFlag(long style);
 148
 149     virtual void Command(wxCommandEvent& event);
 150     virtual bool MSWCommand(WXUINT param, WXWORD id);
 151     virtual WXHBRUSH MSWControlColor(WXHDC hDC);
 152
 153 #if wxUSE_RICHEDIT
 154     virtual bool MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result);
 155
 156     int GetRichVersion() const { return m_verRichEdit; }
 157     bool IsRich() const { return m_verRichEdit != 0; }
 158
 159     // rich edit controls are not compatible with normal ones and wem ust set
 160     // the colours for them otherwise
 161     virtual bool SetBackgroundColour(const wxColour& colour);
 162     virtual bool SetForegroundColour(const wxColour& colour);
 163 #endif // wxUSE_RICHEDIT
 164
 165     virtual void AdoptAttributesFromHWND();
 166
 167     virtual bool AcceptsFocus() const;
 168
 169     // callbacks
 170     void OnDropFiles(wxDropFilesEvent& event);
 171     void OnChar(wxKeyEvent& event); // Process 'enter' if required
 172
 173     void OnCut(wxCommandEvent& event);
 174     void OnCopy(wxCommandEvent& event);
 175     void OnPaste(wxCommandEvent& event);
 176     void OnUndo(wxCommandEvent& event);
 177     void OnRedo(wxCommandEvent& event);
 178     void OnDelete(wxCommandEvent& event);
 179     void OnSelectAll(wxCommandEvent& event);
 180
 181     void OnUpdateCut(wxUpdateUIEvent& event);
 182     void OnUpdateCopy(wxUpdateUIEvent& event);
 183     void OnUpdatePaste(wxUpdateUIEvent& event);
 184     void OnUpdateUndo(wxUpdateUIEvent& event);
 185     void OnUpdateRedo(wxUpdateUIEvent& event);
 186     void OnUpdateDelete(wxUpdateUIEvent& event);
 187     void OnUpdateSelectAll(wxUpdateUIEvent& event);
 188
 189     // Show a context menu for Rich Edit controls (the standard
 190     // EDIT control has one already)
 191     void OnRightClick(wxMouseEvent& event);
 192
 193     // be sure the caret remains invisible if the user
 194     // called HideNativeCaret() before
 195     void OnSetFocus(wxFocusEvent& event);
 196
 197 protected:
 198     // common part of all ctors
 199     void Init();
 200
 201     // intercept WM_GETDLGCODE
 202     virtual WXLRESULT MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
 203
 204     // call this to increase the size limit (will do nothing if the current
 205     // limit is big enough)
 206     //
 207     // returns true if we increased the limit to allow entering more text,
 208     // false if we hit the limit set by SetMaxLength() and so didn't change it
 209     bool AdjustSpaceLimit();
 210
 211 #if wxUSE_RICHEDIT && (!wxUSE_UNICODE || wxUSE_UNICODE_MSLU)
 212     // replace the selection or the entire control contents with the given text
 213     // in the specified encoding
 214     bool StreamIn(const wxString& value, wxFontEncoding encoding, bool selOnly);
 215
 216     // get the contents of the control out as text in the given encoding
 217     wxString StreamOut(wxFontEncoding encoding, bool selOnly = false) const;
 218 #endif // wxUSE_RICHEDIT
 219
 220     // replace the contents of the selection or of the entire control with the
 221     // given text
 222     void DoWriteText(const wxString& text, bool selectionOnly = true);
 223
 224     // set the selection possibly without scrolling the caret into view
 225     void DoSetSelection(long from, long to, bool scrollCaret = true);
 226
 227     // return true if there is a non empty selection in the control
 228     bool HasSelection() const;
 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     // override some base class virtuals
 238     virtual bool MSWShouldPreProcessMessage(WXMSG* pMsg);
 239     virtual wxSize DoGetBestSize() const;
 240
 241     virtual WXDWORD MSWGetStyle(long style, WXDWORD *exstyle) const;
 242
 243 #if wxUSE_RICHEDIT
 244     // we're using RICHEDIT (and not simple EDIT) control if this field is not
 245     // 0, it also gives the version of the RICHEDIT control being used (1, 2 or
 246     // 3 so far)
 247     int m_verRichEdit;
 248 #endif // wxUSE_RICHEDIT
 249
 250     // if true, SendUpdateEvent() will eat the next event (see comments in the
 251     // code as to why this is needed)
 252     bool m_suppressNextUpdate;
 253
 254     virtual wxVisualAttributes GetDefaultAttributes() const;
 255
 256 private:
 257     DECLARE_EVENT_TABLE()
 258     DECLARE_DYNAMIC_CLASS_NO_COPY(wxTextCtrl)
 259
 260     wxMenu* m_privateContextMenu;
 261
 262     bool m_isNativeCaretShown;
 263
 264     // this is an optimization: instead of checking all the time whether we
 265     // need to move the caret to the end of text (before appending to the
 266     // control), we remember whether it is already at the end of text in this
 267     // variable
 268     bool m_isCaretAtEnd;
 269 };
 270
 271 #endif
 272     // _WX_TEXTCTRL_H_