include/wx/mac/carbon/textctrl.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/mac/carbon/textctrl.h
   3 // Purpose:     wxTextCtrl class
   4 // Author:      Stefan Csomor
   5 // Modified by:
   6 // Created:     1998-01-01
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Stefan Csomor
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_TEXTCTRL_H_
  13 #define _WX_TEXTCTRL_H_
  14
  15 #if wxUSE_SYSTEM_OPTIONS
  16     // set this to 'true' if you want to use the 'classic' MLTE-based implementation
  17     // instead of the HIView-based implementation in 10.3 and upwards, the former
  18     // has more features (backgrounds etc.), but may show redraw artefacts and other
  19     // problems depending on your usage; hence, the default is 'false'.
  20     #define wxMAC_TEXTCONTROL_USE_MLTE wxT("mac.textcontrol-use-mlte")
  21 #endif
  22
  23 #include "wx/control.h"
  24 #include "wx/textctrl.h"
  25
  26 class wxMacTextControl;
  27
  28
  29 class WXDLLEXPORT wxTextCtrl: public wxTextCtrlBase
  30 {
  31   DECLARE_DYNAMIC_CLASS(wxTextCtrl)
  32
  33 public:
  34     wxTextCtrl()
  35     { Init(); }
  36
  37     wxTextCtrl(wxWindow *parent,
  38         wxWindowID id,
  39         const wxString& value = wxEmptyString,
  40         const wxPoint& pos = wxDefaultPosition,
  41         const wxSize& size = wxDefaultSize,
  42         long style = 0,
  43         const wxValidator& validator = wxDefaultValidator,
  44         const wxString& name = wxTextCtrlNameStr)
  45     {
  46         Init();
  47         Create(parent, id, value, pos, size, style, validator, name);
  48     }
  49
  50     virtual ~wxTextCtrl();
  51
  52     bool Create(wxWindow *parent,
  53         wxWindowID id,
  54         const wxString& value = wxEmptyString,
  55         const wxPoint& pos = wxDefaultPosition,
  56         const wxSize& size = wxDefaultSize,
  57         long style = 0,
  58         const wxValidator& validator = wxDefaultValidator,
  59         const wxString& name = wxTextCtrlNameStr);
  60
  61     // accessors
  62     // ---------
  63     virtual wxString GetValue() const;
  64
  65     virtual int GetLineLength(long lineNo) const;
  66     virtual wxString GetLineText(long lineNo) const;
  67     virtual int GetNumberOfLines() const;
  68
  69     virtual bool IsModified() const;
  70     virtual bool IsEditable() const;
  71
  72     // If the return values from and to are the same, there is no selection.
  73     virtual void GetSelection(long* from, long* to) const;
  74
  75     // operations
  76     // ----------
  77
  78     // editing
  79     virtual void Clear();
  80     virtual void Replace(long from, long to, const wxString& value);
  81     virtual void Remove(long from, long to);
  82
  83     // sets/clears the dirty flag
  84     virtual void MarkDirty();
  85     virtual void DiscardEdits();
  86
  87     // set the max number of characters which may be entered
  88     // in a single line text control
  89     virtual void SetMaxLength(unsigned long len);
  90
  91     // text control under some platforms supports the text styles: these
  92     // methods apply the given text style to the given selection or to
  93     // set/get the style which will be used for all appended text
  94     virtual bool SetFont( const wxFont &font );
  95     virtual bool SetStyle(long start, long end, const wxTextAttr& style);
  96     virtual bool SetDefaultStyle(const wxTextAttr& style);
  97
  98     // writing text inserts it at the current position;
  99     // appending always inserts it at the end
 100     virtual void WriteText(const wxString& text);
 101     virtual void AppendText(const wxString& text);
 102
 103     // translate between the position (which is just an index into the textctrl
 104     // considering all its contents as a single strings) and (x, y) coordinates
 105     // which represent column and line.
 106     virtual long XYToPosition(long x, long y) const;
 107     virtual bool PositionToXY(long pos, long *x, long *y) const;
 108
 109     virtual void ShowPosition(long pos);
 110
 111     // Clipboard operations
 112     virtual void Copy();
 113     virtual void Cut();
 114     virtual void Paste();
 115
 116     virtual bool CanCopy() const;
 117     virtual bool CanCut() const;
 118     virtual bool CanPaste() const;
 119
 120     // Undo/redo
 121     virtual void Undo();
 122     virtual void Redo();
 123
 124     virtual bool CanUndo() const;
 125     virtual bool CanRedo() const;
 126
 127     // Insertion point
 128     virtual void SetInsertionPoint(long pos);
 129     virtual void SetInsertionPointEnd();
 130     virtual long GetInsertionPoint() const;
 131     virtual wxTextPos GetLastPosition() const;
 132
 133     virtual void SetSelection(long from, long to);
 134     virtual void SetEditable(bool editable);
 135
 136     // Implementation
 137     // --------------
 138     virtual void Command(wxCommandEvent& event);
 139
 140     virtual bool AcceptsFocus() const;
 141
 142     // callbacks
 143     void OnDropFiles(wxDropFilesEvent& event);
 144     void OnChar(wxKeyEvent& event); // Process 'enter' if required
 145
 146     void OnCut(wxCommandEvent& event);
 147     void OnCopy(wxCommandEvent& event);
 148     void OnPaste(wxCommandEvent& event);
 149     void OnUndo(wxCommandEvent& event);
 150     void OnRedo(wxCommandEvent& event);
 151     void OnDelete(wxCommandEvent& event);
 152     void OnSelectAll(wxCommandEvent& event);
 153
 154     void OnUpdateCut(wxUpdateUIEvent& event);
 155     void OnUpdateCopy(wxUpdateUIEvent& event);
 156     void OnUpdatePaste(wxUpdateUIEvent& event);
 157     void OnUpdateUndo(wxUpdateUIEvent& event);
 158     void OnUpdateRedo(wxUpdateUIEvent& event);
 159     void OnUpdateDelete(wxUpdateUIEvent& event);
 160     void OnUpdateSelectAll(wxUpdateUIEvent& event);
 161
 162     void OnEraseBackground(wxEraseEvent& event);
 163     void OnContextMenu(wxContextMenuEvent& event);
 164
 165     virtual bool MacCanFocus() const
 166     { return true; }
 167
 168     virtual bool MacSetupCursor( const wxPoint& pt );
 169
 170     virtual void MacVisibilityChanged();
 171     virtual void MacEnabledStateChanged();
 172     virtual void MacSuperChangedPosition();
 173
 174 #ifndef __WXMAC_OSX__
 175     virtual void MacControlUserPaneDrawProc(wxInt16 part);
 176     virtual wxInt16 MacControlUserPaneHitTestProc(wxInt16 x, wxInt16 y);
 177     virtual wxInt16 MacControlUserPaneTrackingProc(wxInt16 x, wxInt16 y, void* actionProc);
 178     virtual void MacControlUserPaneIdleProc();
 179     virtual wxInt16 MacControlUserPaneKeyDownProc(wxInt16 keyCode, wxInt16 charCode, wxInt16 modifiers);
 180     virtual void MacControlUserPaneActivateProc(bool activating);
 181     virtual wxInt16 MacControlUserPaneFocusProc(wxInt16 action);
 182     virtual void MacControlUserPaneBackgroundProc(void* info);
 183 #endif
 184
 185     wxMacTextControl * GetPeer() const
 186     { return (wxMacTextControl*) m_peer; }
 187
 188 protected:
 189     // common part of all ctors
 190     void Init();
 191
 192     virtual wxSize DoGetBestSize() const;
 193
 194     virtual void DoSetValue(const wxString& value, int flags = 0);
 195
 196     bool  m_editable;
 197
 198     // flag is set to true when the user edits the controls contents
 199     bool m_dirty;
 200
 201   // need to make this public because of the current implementation via callbacks
 202     unsigned long  m_maxLength;
 203
 204     bool GetTriggerOnSetValue() const
 205     {
 206         return m_triggerOnSetValue;
 207     }
 208
 209     void SetTriggerOnSetValue(bool trigger)
 210     {
 211         m_triggerOnSetValue = trigger;
 212     }
 213
 214     bool m_triggerOnSetValue ;
 215
 216 private :
 217   wxMenu  *m_privateContextMenu;
 218
 219   DECLARE_EVENT_TABLE()
 220 };
 221
 222 #endif // _WX_TEXTCTRL_H_