include/wx/cocoa/textctrl.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/cocoa/textctrl.h
   3 // Purpose:     wxTextCtrl class
   4 // Author:      David Elliott
   5 // Modified by:
   6 // Created:     2003/03/16
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 2003 David Elliott
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef __WX_COCOA_TEXTCTRL_H__
  13 #define __WX_COCOA_TEXTCTRL_H__
  14
  15 #include "wx/cocoa/NSTextField.h"
  16
  17 // ========================================================================
  18 // wxTextCtrl
  19 // ========================================================================
  20 class WXDLLEXPORT wxTextCtrl : public wxTextCtrlBase, protected wxCocoaNSTextField
  21 {
  22     DECLARE_DYNAMIC_CLASS(wxTextCtrl)
  23     DECLARE_EVENT_TABLE()
  24     WX_DECLARE_COCOA_OWNER(NSTextField,NSControl,NSView)
  25 // ------------------------------------------------------------------------
  26 // initialization
  27 // ------------------------------------------------------------------------
  28 public:
  29     wxTextCtrl() {}
  30     wxTextCtrl(wxWindow *parent, wxWindowID winid,
  31             const wxString& value = wxEmptyString,
  32             const wxPoint& pos = wxDefaultPosition,
  33             const wxSize& size = wxDefaultSize, long style = 0,
  34             const wxValidator& validator = wxDefaultValidator,
  35             const wxString& name = wxTextCtrlNameStr)
  36     {
  37         Create(parent, winid, value, pos, size, style, validator, name);
  38     }
  39
  40     bool Create(wxWindow *parent, wxWindowID winid,
  41             const wxString& value = wxEmptyString,
  42             const wxPoint& pos = wxDefaultPosition,
  43             const wxSize& size = wxDefaultSize, long style = 0,
  44             const wxValidator& validator = wxDefaultValidator,
  45             const wxString& name = wxTextCtrlNameStr);
  46     virtual ~wxTextCtrl();
  47
  48 // ------------------------------------------------------------------------
  49 // Cocoa specifics
  50 // ------------------------------------------------------------------------
  51 protected:
  52     virtual void Cocoa_didChangeText(void);
  53 // ------------------------------------------------------------------------
  54 // Implementation
  55 // ------------------------------------------------------------------------
  56 public:
  57     virtual wxString GetValue() const;
  58
  59     virtual int GetLineLength(long lineNo) const;
  60     virtual wxString GetLineText(long lineNo) const;
  61     virtual int GetNumberOfLines() const;
  62
  63     virtual bool IsModified() const;
  64     virtual bool IsEditable() const;
  65
  66     // If the return values from and to are the same, there is no selection.
  67     virtual void GetSelection(long* from, long* to) const;
  68
  69     // operations
  70     // ----------
  71
  72     // editing
  73     virtual void Clear();
  74     virtual void Replace(long from, long to, const wxString& value);
  75     virtual void Remove(long from, long to);
  76
  77     // clears the dirty flag
  78     virtual void MarkDirty();
  79     virtual void DiscardEdits();
  80
  81     // writing text inserts it at the current position, appending always
  82     // inserts it at the end
  83     virtual void WriteText(const wxString& text);
  84     virtual void AppendText(const wxString& text);
  85
  86     // translate between the position (which is just an index in the text ctrl
  87     // considering all its contents as a single strings) and (x, y) coordinates
  88     // which represent column and line.
  89     virtual long XYToPosition(long x, long y) const;
  90     virtual bool PositionToXY(long pos, long *x, long *y) const;
  91
  92     virtual void ShowPosition(long pos);
  93
  94     // Clipboard operations
  95     virtual void Copy();
  96     virtual void Cut();
  97     virtual void Paste();
  98
  99     // Undo/redo
 100     virtual void Undo();
 101     virtual void Redo();
 102
 103     virtual bool CanUndo() const;
 104     virtual bool CanRedo() const;
 105
 106     // Insertion point
 107     virtual void SetInsertionPoint(long pos);
 108     virtual void SetInsertionPointEnd();
 109     virtual long GetInsertionPoint() const;
 110     virtual wxTextPos GetLastPosition() const;
 111
 112     virtual void SetSelection(long from, long to);
 113 //    virtual void SelectAll();
 114     virtual void SetEditable(bool editable);
 115
 116 protected:
 117     virtual wxSize DoGetBestSize() const;
 118
 119     virtual void DoSetValue(const wxString& value, int flags = 0);
 120 };
 121
 122 #endif // __WX_COCOA_TEXTCTRL_H__