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();
  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         Create(parent, id, value, pos, size, style, validator, name);
  35     }
  36
  37     bool Create(wxWindow *parent, wxWindowID id,
  38                 const wxString& value = wxEmptyString,
  39                 const wxPoint& pos = wxDefaultPosition,
  40                 const wxSize& size = wxDefaultSize,
  41                 long style = 0,
  42                 const wxValidator& validator = wxDefaultValidator,
  43                 const wxString& name = wxTextCtrlNameStr);
  44
  45     // implement base class pure virtuals
  46     // ----------------------------------
  47
  48     virtual wxString GetValue() const;
  49     virtual void SetValue(const wxString& value);
  50
  51     virtual int GetLineLength(long lineNo) const;
  52     virtual wxString GetLineText(long lineNo) const;
  53     virtual int GetNumberOfLines() const;
  54
  55     virtual bool IsModified() const;
  56     virtual bool IsEditable() const;
  57
  58     // If the return values from and to are the same, there is no selection.
  59     virtual void GetSelection(long* from, long* to) const;
  60
  61     // operations
  62     // ----------
  63
  64     // editing
  65     virtual void Clear();
  66     virtual void Replace(long from, long to, const wxString& value);
  67     virtual void Remove(long from, long to);
  68
  69     // load the controls contents from the file
  70     virtual bool LoadFile(const wxString& file);
  71
  72     // clears the dirty flag
  73     virtual void DiscardEdits();
  74
  75     virtual void SetMaxLength(unsigned long len);
  76
  77     // writing text inserts it at the current position, appending always
  78     // inserts it at the end
  79     virtual void WriteText(const wxString& text);
  80     virtual void AppendText(const wxString& text);
  81
  82 #if wxUSE_RICHEDIT
  83     // apply text attribute to the range of text (only works with richedit
  84     // controls)
  85     virtual bool SetStyle(long start, long end, const wxTextAttr& style);
  86 #endif // wxUSE_RICHEDIT
  87
  88     // translate between the position (which is just an index in the text ctrl
  89     // considering all its contents as a single strings) and (x, y) coordinates
  90     // which represent column and line.
  91     virtual long XYToPosition(long x, long y) const;
  92     virtual bool PositionToXY(long pos, long *x, long *y) const;
  93
  94     virtual void ShowPosition(long pos);
  95
  96     // Clipboard operations
  97     virtual void Copy();
  98     virtual void Cut();
  99     virtual void Paste();
 100
 101     virtual bool CanCopy() const;
 102     virtual bool CanCut() const;
 103     virtual bool CanPaste() const;
 104
 105     // Undo/redo
 106     virtual void Undo();
 107     virtual void Redo();
 108
 109     virtual bool CanUndo() const;
 110     virtual bool CanRedo() const;
 111
 112     // Insertion point
 113     virtual void SetInsertionPoint(long pos);
 114     virtual void SetInsertionPointEnd();
 115     virtual long GetInsertionPoint() const;
 116     virtual long GetLastPosition() const;
 117
 118     virtual void SetSelection(long from, long to);
 119     virtual void SetEditable(bool editable);
 120
 121     // Implementation from now on
 122     // --------------------------
 123
 124     virtual void Command(wxCommandEvent& event);
 125     virtual bool MSWCommand(WXUINT param, WXWORD id);
 126     virtual WXHBRUSH OnCtlColor(WXHDC pDC, WXHWND pWnd, WXUINT nCtlColor,
 127             WXUINT message, WXWPARAM wParam, WXLPARAM lParam);
 128
 129     // In WIN16, need to override normal erasing because
 130     // Ctl3D doesn't use the wxWindows background colour.
 131 #ifdef __WIN16__
 132     void OnEraseBackground(wxEraseEvent& event);
 133 #endif
 134
 135 #if wxUSE_RICHEDIT
 136     virtual bool MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result);
 137
 138     bool IsRich() const { return m_isRich; }
 139     void SetRichEdit(bool isRich) { m_isRich = isRich; }
 140
 141     // rich edit controls are not compatible with normal ones and wem ust set
 142     // the colours for them otherwise
 143     virtual bool SetBackgroundColour(const wxColour& colour);
 144     virtual bool SetForegroundColour(const wxColour& colour);
 145 #endif // wxUSE_RICHEDIT
 146
 147     virtual void AdoptAttributesFromHWND();
 148
 149     virtual bool AcceptsFocus() const;
 150
 151     // callbacks
 152     void OnDropFiles(wxDropFilesEvent& event);
 153     void OnChar(wxKeyEvent& event); // Process 'enter' if required
 154
 155     void OnCut(wxCommandEvent& event);
 156     void OnCopy(wxCommandEvent& event);
 157     void OnPaste(wxCommandEvent& event);
 158     void OnUndo(wxCommandEvent& event);
 159     void OnRedo(wxCommandEvent& event);
 160
 161     void OnUpdateCut(wxUpdateUIEvent& event);
 162     void OnUpdateCopy(wxUpdateUIEvent& event);
 163     void OnUpdatePaste(wxUpdateUIEvent& event);
 164     void OnUpdateUndo(wxUpdateUIEvent& event);
 165     void OnUpdateRedo(wxUpdateUIEvent& event);
 166
 167 protected:
 168     // call this to increase the size limit (will do nothing if the current
 169     // limit is big enough)
 170     //
 171     // returns true if we increased the limit to allow entering more text,
 172     // false if we hit the limit set by SetMaxLength() and so didn't change it
 173     bool AdjustSpaceLimit();
 174
 175     // override some base class virtuals
 176     virtual bool MSWShouldPreProcessMessage(WXMSG* pMsg);
 177     virtual wxSize DoGetBestSize() const;
 178
 179 #if wxUSE_RICHEDIT
 180     bool m_isRich; // Are we using rich text edit to implement this?
 181 #endif
 182
 183 private:
 184     DECLARE_EVENT_TABLE()
 185     DECLARE_DYNAMIC_CLASS(wxTextCtrl)
 186 };
 187
 188 #endif
 189     // _WX_TEXTCTRL_H_