include/wx/osx/textentry.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/osx/textentry.h
   3 // Purpose:     wxTextEntry class
   4 // Author:      Stefan Csomor
   5 // Modified by: Kevin Ollivier
   6 // Created:     1998-01-01
   7 // RCS-ID:      $Id: textctrl.h 62531 2009-11-01 00:58:04Z KO $
   8 // Copyright:   (c) Stefan Csomor
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_OSX_TEXTENTRY_H_
  13 #define _WX_OSX_TEXTENTRY_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     // set this to 'true' if you want editable text controls to have spell checking turned
  22     // on by default, you can change this setting individually on a control using MacCheckSpelling
  23     #define wxMAC_TEXTCONTROL_USE_SPELL_CHECKER wxT("mac.textcontrol-use-spell-checker")
  24 #endif
  25
  26 #include "wx/control.h"
  27
  28 // forward decl for wxListWidgetImpl implementation type.
  29 class WXDLLIMPEXP_FWD_CORE wxTextWidgetImpl;
  30
  31 class WXDLLIMPEXP_CORE wxTextEntry: public wxTextEntryBase
  32 {
  33
  34 public:
  35     wxTextEntry()
  36         : m_editable(true),
  37           m_maxLength(0)
  38     { }
  39
  40     virtual ~wxTextEntry() {};
  41
  42     virtual bool IsEditable() const;
  43
  44     // If the return values from and to are the same, there is no selection.
  45     virtual void GetSelection(long* from, long* to) const;
  46
  47     // operations
  48     // ----------
  49
  50     // editing
  51     virtual void Clear();
  52     virtual void Remove(long from, long to);
  53
  54     // set the max number of characters which may be entered
  55     // in a single line text control
  56     virtual void SetMaxLength(unsigned long len);
  57
  58     // writing text inserts it at the current position;
  59     // appending always inserts it at the end
  60     virtual void WriteText(const wxString& text);
  61
  62     // Clipboard operations
  63     virtual void Copy();
  64     virtual void Cut();
  65     virtual void Paste();
  66
  67     virtual bool CanCopy() const;
  68     virtual bool CanCut() const;
  69     virtual bool CanPaste() const;
  70
  71     // Undo/redo
  72     virtual void Undo();
  73     virtual void Redo();
  74
  75     virtual bool CanUndo() const;
  76     virtual bool CanRedo() const;
  77
  78     // Insertion point
  79     virtual void SetInsertionPoint(long pos);
  80     virtual void SetInsertionPointEnd();
  81     virtual long GetInsertionPoint() const;
  82     virtual wxTextPos GetLastPosition() const;
  83
  84     virtual void SetSelection(long from, long to);
  85     virtual void SetEditable(bool editable);
  86
  87     // Implementation
  88     // --------------
  89
  90     virtual wxTextWidgetImpl * GetTextPeer() const;
  91 protected:
  92
  93     virtual wxString DoGetValue() const;
  94
  95     bool  m_editable;
  96
  97   // need to make this public because of the current implementation via callbacks
  98     unsigned long  m_maxLength;
  99
 100 };
 101
 102 #endif // _WX_OSX_TEXTENTRY_H_