include/wx/msw/wince/textctrlce.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/msw/wince/textctrlce.h
   3 // Purpose:     wxTextCtrl class - Smartphone implementation
   4 // Author:      Wlodzimierz ABX Skiba
   5 // Modified by:
   6 // Created:     30.08.2004
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Wlodzimierz Skiba
   9 // License:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_TEXTCTRLCE_H_
  13 #define _WX_TEXTCTRLCE_H_
  14
  15 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  16     #pragma interface "textctrlce.h"
  17 #endif
  18
  19 #include "wx/dynarray.h"
  20
  21 class WXDLLEXPORT wxTextCtrl;
  22 WX_DEFINE_EXPORTED_ARRAY_PTR(wxTextCtrl *, wxArrayTextSpins);
  23
  24 class WXDLLEXPORT wxTextCtrl : public wxTextCtrlBase
  25 {
  26 public:
  27     // creation
  28     // --------
  29
  30     wxTextCtrl() { Init(); }
  31     wxTextCtrl(wxWindow *parent, wxWindowID id,
  32                const wxString& value = wxEmptyString,
  33                const wxPoint& pos = wxDefaultPosition,
  34                const wxSize& size = wxDefaultSize,
  35                long style = 0,
  36                const wxValidator& validator = wxDefaultValidator,
  37                const wxString& name = wxTextCtrlNameStr)
  38     {
  39         Init();
  40
  41         Create(parent, id, value, pos, size, style, validator, name);
  42     }
  43     ~wxTextCtrl();
  44
  45     bool Create(wxWindow *parent, wxWindowID id,
  46                 const wxString& value = wxEmptyString,
  47                 const wxPoint& pos = wxDefaultPosition,
  48                 const wxSize& size = wxDefaultSize,
  49                 long style = 0,
  50                 const wxValidator& validator = wxDefaultValidator,
  51                 const wxString& name = wxTextCtrlNameStr);
  52
  53     // implement base class pure virtuals
  54     // ----------------------------------
  55
  56     virtual wxString GetValue() const;
  57     virtual void SetValue(const wxString& value);
  58
  59     virtual wxString GetRange(long from, long to) const;
  60
  61     virtual int GetLineLength(long lineNo) const;
  62     virtual wxString GetLineText(long lineNo) const;
  63     virtual int GetNumberOfLines() const;
  64
  65     virtual bool IsModified() const;
  66     virtual bool IsEditable() const;
  67
  68     virtual void GetSelection(long* from, long* to) const;
  69
  70     // operations
  71     // ----------
  72
  73     // editing
  74     virtual void Clear();
  75     virtual void Replace(long from, long to, const wxString& value);
  76     virtual void Remove(long from, long to);
  77
  78     // load the controls contents from the file
  79     virtual bool LoadFile(const wxString& file);
  80
  81     // clears the dirty flag
  82     virtual void MarkDirty();
  83     virtual void DiscardEdits();
  84
  85     virtual void SetMaxLength(unsigned long len);
  86
  87     // writing text inserts it at the current position, appending always
  88     // inserts it at the end
  89     virtual void WriteText(const wxString& text);
  90     virtual void AppendText(const wxString& text);
  91
  92     // translate between the position (which is just an index in the text ctrl
  93     // considering all its contents as a single strings) and (x, y) coordinates
  94     // which represent column and line.
  95     virtual long XYToPosition(long x, long y) const;
  96     virtual bool PositionToXY(long pos, long *x, long *y) const;
  97
  98     virtual void ShowPosition(long pos);
  99     virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt, long *pos) const;
 100     virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt,
 101                                             wxTextCoord *col,
 102                                             wxTextCoord *row) const
 103     {
 104         return wxTextCtrlBase::HitTest(pt, col, row);
 105     }
 106
 107     // Clipboard operations
 108     virtual void Copy();
 109     virtual void Cut();
 110     virtual void Paste();
 111
 112     virtual bool CanCopy() const;
 113     virtual bool CanCut() const;
 114     virtual bool CanPaste() const;
 115
 116     // Undo/redo
 117     virtual void Undo();
 118     virtual void Redo();
 119
 120     virtual bool CanUndo() const;
 121     virtual bool CanRedo() const;
 122
 123     // Insertion point
 124     virtual void SetInsertionPoint(long pos);
 125     virtual void SetInsertionPointEnd();
 126     virtual long GetInsertionPoint() const;
 127     virtual long GetLastPosition() const;
 128
 129     virtual void SetSelection(long from, long to);
 130     virtual void SetEditable(bool editable);
 131
 132     // Caret handling (Windows only)
 133
 134     bool ShowNativeCaret(bool show = true);
 135     bool HideNativeCaret() { return ShowNativeCaret(false); }
 136
 137     // Implementation from now on
 138     // --------------------------
 139
 140     virtual void Command(wxCommandEvent& event);
 141     virtual bool MSWCommand(WXUINT param, WXWORD id);
 142     virtual WXHBRUSH OnCtlColor(WXHDC pDC, WXHWND pWnd, WXUINT nCtlColor,
 143             WXUINT message, WXWPARAM wParam, WXLPARAM lParam);
 144
 145     virtual void AdoptAttributesFromHWND();
 146
 147     virtual bool AcceptsFocus() const;
 148
 149     // callbacks
 150     void OnDropFiles(wxDropFilesEvent& event);
 151     void OnChar(wxKeyEvent& event); // Process 'enter' if required
 152
 153     void OnCut(wxCommandEvent& event);
 154     void OnCopy(wxCommandEvent& event);
 155     void OnPaste(wxCommandEvent& event);
 156     void OnUndo(wxCommandEvent& event);
 157     void OnRedo(wxCommandEvent& event);
 158     void OnDelete(wxCommandEvent& event);
 159     void OnSelectAll(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     void OnUpdateDelete(wxUpdateUIEvent& event);
 167     void OnUpdateSelectAll(wxUpdateUIEvent& event);
 168
 169     // Show a context menu for Rich Edit controls (the standard
 170     // EDIT control has one already)
 171     void OnRightClick(wxMouseEvent& event);
 172
 173     // be sure the caret remains invisible if the user
 174     // called HideNativeCaret() before
 175     void OnSetFocus(wxFocusEvent& event);
 176
 177     // get the subclassed window proc of the buddy
 178     WXFARPROC GetBuddyWndProc() const { return m_wndProcBuddy; }
 179
 180     // intercept WM_GETDLGCODE
 181     virtual WXLRESULT MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
 182
 183 protected:
 184     // common part of all ctors
 185     void Init();
 186
 187     // call this to increase the size limit (will do nothing if the current
 188     // limit is big enough)
 189     //
 190     // returns true if we increased the limit to allow entering more text,
 191     // false if we hit the limit set by SetMaxLength() and so didn't change it
 192     bool AdjustSpaceLimit();
 193
 194     // replace the contents of the selection or of the entire control with the
 195     // given text
 196     void DoWriteText(const wxString& text, bool selectionOnly = true);
 197
 198     // set the selection possibly without scrolling the caret into view
 199     void DoSetSelection(long from, long to, bool scrollCaret = true);
 200
 201     // return true if there is a non empty selection in the control
 202     bool HasSelection() const;
 203
 204     // get the length of the line containing the character at the given
 205     // position
 206     long GetLengthOfLineContainingPos(long pos) const;
 207
 208     // send TEXT_UPDATED event, return true if it was handled, false otherwise
 209     bool SendUpdateEvent();
 210
 211     // override some base class virtuals
 212     virtual void DoMoveWindow(int x, int y, int width, int height);
 213     virtual wxSize DoGetBestSize() const;
 214
 215     virtual WXDWORD MSWGetStyle(long style, WXDWORD *exstyle) const;
 216
 217     // if true, SendUpdateEvent() will eat the next event (see comments in the
 218     // code as to why this is needed)
 219     bool m_suppressNextUpdate;
 220
 221     // all existing wxTextCtrl - this allows to find the one corresponding to
 222     // the given buddy window in GetSpinTextCtrl()
 223     static wxArrayTextSpins ms_allTextSpins;
 224
 225 protected:
 226
 227     // the data for the "buddy" list
 228     WXHWND     m_hwndBuddy;
 229     WXFARPROC  m_wndProcBuddy;
 230
 231 private:
 232     DECLARE_EVENT_TABLE()
 233     DECLARE_DYNAMIC_CLASS_NO_COPY(wxTextCtrl)
 234
 235     bool m_isNativeCaretShown;
 236 };
 237
 238 #endif // _WX_TEXTCTRLCE_H_