include/wx/motif/textctrl.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        textctrl.h
   3 // Purpose:     wxTextCtrl class
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     17/09/98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_TEXTCTRL_H_
  13 #define _WX_TEXTCTRL_H_
  14
  15 #ifdef __GNUG__
  16     #pragma interface "textctrl.h"
  17 #endif
  18
  19 WXDLLEXPORT_DATA(extern const char*) wxTextCtrlNameStr;
  20 WXDLLEXPORT_DATA(extern const char*) wxEmptyString;
  21
  22 // Single-line text item
  23 class WXDLLEXPORT wxTextCtrl : public wxControl
  24 {
  25     DECLARE_DYNAMIC_CLASS(wxTextCtrl)
  26
  27 public:
  28     // creation
  29     // --------
  30     wxTextCtrl();
  31     wxTextCtrl(wxWindow *parent,
  32                wxWindowID id,
  33                const wxString& value = wxEmptyString,
  34                const wxPoint& pos = wxDefaultPosition,
  35                const wxSize& size = wxDefaultSize,
  36                long style = 0,
  37                const wxValidator& validator = wxDefaultValidator,
  38                const wxString& name = wxTextCtrlNameStr)
  39         {
  40             Create(parent, id, value, pos, size, style, validator, name);
  41         }
  42
  43     bool Create(wxWindow *parent, wxWindowID id,
  44                 const wxString& value = wxEmptyString,
  45                 const wxPoint& pos = wxDefaultPosition,
  46                 const wxSize& size = wxDefaultSize, long style = 0,
  47                 const wxValidator& validator = wxDefaultValidator,
  48                 const wxString& name = wxTextCtrlNameStr);
  49
  50     // accessors
  51     // ---------
  52     virtual wxString GetValue() const;
  53     virtual void SetValue(const wxString& value);
  54
  55     virtual int GetLineLength(long lineNo) const;
  56     virtual wxString GetLineText(long lineNo) const;
  57     virtual int GetNumberOfLines() const;
  58
  59     // operations
  60     // ----------
  61
  62     // Clipboard operations
  63     virtual void Copy();
  64     virtual void Cut();
  65     virtual void Paste();
  66     virtual bool CanCopy() const;
  67     virtual bool CanCut() const;
  68     virtual bool CanPaste() const;
  69
  70     // Undo/redo
  71     virtual void Undo();
  72     virtual void Redo();
  73
  74     virtual bool CanUndo() const;
  75     virtual bool CanRedo() const;
  76
  77     virtual void SetInsertionPoint(long pos);
  78     virtual void SetInsertionPointEnd();
  79     virtual long GetInsertionPoint() const;
  80     virtual long GetLastPosition() const;
  81     virtual void Replace(long from, long to, const wxString& value);
  82     virtual void Remove(long from, long to);
  83     virtual void SetSelection(long from, long to);
  84     virtual void SetEditable(bool editable);
  85     // If the return values from and to are the same, there is no
  86     // selection.
  87     virtual void GetSelection(long* from, long* to) const;
  88     virtual bool IsEditable() const ;
  89
  90     virtual bool LoadFile(const wxString& file);
  91     virtual bool SaveFile(const wxString& file);
  92     virtual void WriteText(const wxString& text);
  93     virtual void AppendText(const wxString& text);
  94     virtual void DiscardEdits();
  95     virtual bool IsModified() const;
  96
  97     virtual long XYToPosition(long x, long y) const;
  98     virtual void PositionToXY(long pos, long *x, long *y) const;
  99     virtual void ShowPosition(long pos);
 100     virtual void Clear();
 101
 102     // callbacks
 103     // ---------
 104     void OnDropFiles(wxDropFilesEvent& event);
 105     void OnChar(wxKeyEvent& event);
 106     //  void OnEraseBackground(wxEraseEvent& event);
 107
 108     void OnCut(wxCommandEvent& event);
 109     void OnCopy(wxCommandEvent& event);
 110     void OnPaste(wxCommandEvent& event);
 111     void OnUndo(wxCommandEvent& event);
 112     void OnRedo(wxCommandEvent& event);
 113
 114     void OnUpdateCut(wxUpdateUIEvent& event);
 115     void OnUpdateCopy(wxUpdateUIEvent& event);
 116     void OnUpdatePaste(wxUpdateUIEvent& event);
 117     void OnUpdateUndo(wxUpdateUIEvent& event);
 118     void OnUpdateRedo(wxUpdateUIEvent& event);
 119
 120     virtual void Command(wxCommandEvent& event);
 121
 122     // implementation from here to the end
 123     // -----------------------------------
 124     virtual void ChangeFont(bool keepOriginalSize = TRUE);
 125     virtual void ChangeBackgroundColour();
 126     virtual void ChangeForegroundColour();
 127     void SetModified(bool mod) { m_modified = mod; }
 128     virtual WXWidget GetTopWidget() const;
 129
 130     // send the CHAR and TEXT_UPDATED events
 131     void DoSendEvents(void /* XmTextVerifyCallbackStruct */ *cbs,
 132                       long keycode);
 133
 134 protected:
 135     wxString  m_fileName;
 136
 137 public:
 138     // Motif-specific
 139     void*     m_tempCallbackStruct;
 140     bool      m_modified;
 141     wxString  m_value;            // Required for password text controls
 142
 143     // Did we call wxTextCtrl::OnChar? If so, generate a command event.
 144     bool      m_processedDefault;
 145
 146 private:
 147     DECLARE_EVENT_TABLE()
 148 };
 149
 150 #endif
 151     // _WX_TEXTCTRL_H_