include/wx/palmos/textctrl.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/palmos/textctrl.h
   3 // Purpose:     wxTextCtrl class
   4 // Author:      William Osborne - minimal working wxPalmOS port
   5 // Modified by:
   6 // Created:     10/13/04
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) William Osborne
   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 #if wxUSE_RICHEDIT
  88     // apply text attribute to the range of text (only works with richedit
  89     // controls)
  90     virtual bool SetStyle(long start, long end, const wxTextAttr& style);
  91     virtual bool SetDefaultStyle(const wxTextAttr& style);
  92     virtual bool GetStyle(long position, 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     virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt,
 103                                             wxTextCoord *col,
 104                                             wxTextCoord *row) const;
 105
 106     // Clipboard operations
 107     virtual void Copy();
 108     virtual void Cut();
 109     virtual void Paste();
 110
 111     virtual bool CanCopy() const;
 112     virtual bool CanCut() const;
 113     virtual bool CanPaste() const;
 114
 115     // Undo/redo
 116     virtual void Undo();
 117     virtual void Redo();
 118
 119     virtual bool CanUndo() const;
 120     virtual bool CanRedo() const;
 121
 122     // Insertion point
 123     virtual void SetInsertionPoint(long pos);
 124     virtual void SetInsertionPointEnd();
 125     virtual long GetInsertionPoint() const;
 126     virtual wxTextPos GetLastPosition() const;
 127
 128     virtual void SetSelection(long from, long to);
 129     virtual void SetEditable(bool editable);
 130
 131     // Caret handling (Windows only)
 132
 133     bool ShowNativeCaret(bool show = true);
 134     bool HideNativeCaret() { return ShowNativeCaret(false); }
 135
 136     // Implementation from now on
 137     // --------------------------
 138
 139     virtual void Command(wxCommandEvent& event);
 140     virtual bool MSWCommand(WXUINT param, WXWORD id);
 141
 142 #if wxUSE_RICHEDIT
 143     virtual bool MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result);
 144
 145     int GetRichVersion() const { return m_verRichEdit; }
 146     bool IsRich() const { return m_verRichEdit != 0; }
 147
 148     // rich edit controls are not compatible with normal ones and wem ust set
 149     // the colours for them otherwise
 150     virtual bool SetBackgroundColour(const wxColour& colour);
 151     virtual bool SetForegroundColour(const wxColour& colour);
 152 #endif // wxUSE_RICHEDIT
 153
 154     virtual bool AcceptsFocus() const;
 155
 156     // callbacks
 157     void OnDropFiles(wxDropFilesEvent& event);
 158     void OnChar(wxKeyEvent& event); // Process 'enter' if required
 159
 160     void OnCut(wxCommandEvent& event);
 161     void OnCopy(wxCommandEvent& event);
 162     void OnPaste(wxCommandEvent& event);
 163     void OnUndo(wxCommandEvent& event);
 164     void OnRedo(wxCommandEvent& event);
 165     void OnDelete(wxCommandEvent& event);
 166     void OnSelectAll(wxCommandEvent& event);
 167
 168     void OnUpdateCut(wxUpdateUIEvent& event);
 169     void OnUpdateCopy(wxUpdateUIEvent& event);
 170     void OnUpdatePaste(wxUpdateUIEvent& event);
 171     void OnUpdateUndo(wxUpdateUIEvent& event);
 172     void OnUpdateRedo(wxUpdateUIEvent& event);
 173     void OnUpdateDelete(wxUpdateUIEvent& event);
 174     void OnUpdateSelectAll(wxUpdateUIEvent& event);
 175
 176     // Show a context menu for Rich Edit controls (the standard
 177     // EDIT control has one already)
 178     void OnRightClick(wxMouseEvent& event);
 179
 180     // be sure the caret remains invisible if the user
 181     // called HideNativeCaret() before
 182     void OnSetFocus(wxFocusEvent& event);
 183
 184 protected:
 185     // common part of all ctors
 186     void Init();
 187
 188     // intercept WM_GETDLGCODE
 189     virtual WXLRESULT MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
 190
 191     // call this to increase the size limit (will do nothing if the current
 192     // limit is big enough)
 193     //
 194     // returns true if we increased the limit to allow entering more text,
 195     // false if we hit the limit set by SetMaxLength() and so didn't change it
 196     bool AdjustSpaceLimit();
 197
 198 #if wxUSE_RICHEDIT && (!wxUSE_UNICODE || wxUSE_UNICODE_MSLU)
 199     // replace the selection or the entire control contents with the given text
 200     // in the specified encoding
 201     bool StreamIn(const wxString& value, wxFontEncoding encoding, bool selOnly);
 202
 203     // get the contents of the control out as text in the given encoding
 204     wxString StreamOut(wxFontEncoding encoding, bool selOnly = false) const;
 205 #endif // wxUSE_RICHEDIT
 206
 207     // replace the contents of the selection or of the entire control with the
 208     // given text
 209     void DoWriteText(const wxString& text, bool selectionOnly = true);
 210
 211     // set the selection possibly without scrolling the caret into view
 212     void DoSetSelection(long from, long to, bool scrollCaret = true);
 213
 214     // return true if there is a non empty selection in the control
 215     bool HasSelection() const;
 216
 217     // get the length of the line containing the character at the given
 218     // position
 219     long GetLengthOfLineContainingPos(long pos) const;
 220
 221     // send TEXT_UPDATED event, return true if it was handled, false otherwise
 222     bool SendUpdateEvent();
 223
 224     // override some base class virtuals
 225     virtual bool MSWShouldPreProcessMessage(WXMSG* pMsg);
 226     virtual wxSize DoGetBestSize() const;
 227
 228     virtual WXDWORD MSWGetStyle(long style, WXDWORD *exstyle) const;
 229
 230 #if wxUSE_RICHEDIT
 231     // we're using RICHEDIT (and not simple EDIT) control if this field is not
 232     // 0, it also gives the version of the RICHEDIT control being used (1, 2 or
 233     // 3 so far)
 234     int m_verRichEdit;
 235 #endif // wxUSE_RICHEDIT
 236
 237     // if true, SendUpdateEvent() will eat the next event (see comments in the
 238     // code as to why this is needed)
 239     bool m_suppressNextUpdate;
 240
 241 private:
 242     DECLARE_EVENT_TABLE()
 243     DECLARE_DYNAMIC_CLASS_NO_COPY(wxTextCtrl)
 244
 245     wxMenu* m_privateContextMenu;
 246
 247     bool m_isNativeCaretShown;
 248 };
 249
 250 #endif
 251     // _WX_TEXTCTRL_H_