include/wx/msw/textctrl.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        textctrl.h
   3 // Purpose:     wxTextCtrl class
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     01/02/97
   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 #include "wx/setup.h"
  20 #include "wx/control.h"
  21
  22 #if wxUSE_IOSTREAMH
  23     #include <iostream.h>
  24 #else
  25     #include <iostream>
  26 #endif
  27
  28 #if defined(__WIN95__) && !defined(__TWIN32__) && !defined(__WXWINE__)
  29     #define wxUSE_RICHEDIT 1
  30 #else
  31     #define wxUSE_RICHEDIT 0
  32 #endif
  33
  34 WXDLLEXPORT_DATA(extern const wxChar*) wxTextCtrlNameStr;
  35 WXDLLEXPORT_DATA(extern const wxChar*) wxEmptyString;
  36
  37 // Single-line text item
  38 class WXDLLEXPORT wxTextCtrl : public wxControl
  39
  40 // 16-bit Borland 4.0 doesn't seem to allow multiple inheritance with wxWindow and streambuf:
  41 // it complains about deriving a huge class from the huge class streambuf. !!
  42 // Also, can't use streambuf if making or using a DLL :-(
  43
  44 #if (defined(__BORLANDC__)) || defined(__MWERKS__) || defined(_WINDLL) || defined(WXUSINGDLL) || defined(WXMAKINGDLL)
  45 #define NO_TEXT_WINDOW_STREAM
  46 #endif
  47
  48 #ifndef NO_TEXT_WINDOW_STREAM
  49 , public streambuf
  50 #endif
  51
  52 {
  53   DECLARE_DYNAMIC_CLASS(wxTextCtrl)
  54
  55 public:
  56     // creation
  57     // --------
  58     wxTextCtrl();
  59     wxTextCtrl(wxWindow *parent, wxWindowID id,
  60             const wxString& value = wxEmptyString,
  61             const wxPoint& pos = wxDefaultPosition,
  62             const wxSize& size = wxDefaultSize, long style = 0,
  63             const wxValidator& validator = wxDefaultValidator,
  64             const wxString& name = wxTextCtrlNameStr)
  65 #ifndef NO_TEXT_WINDOW_STREAM
  66         :streambuf()
  67 #endif
  68         {
  69             Create(parent, id, value, pos, size, style, validator, name);
  70         }
  71
  72     bool Create(wxWindow *parent, wxWindowID id,
  73             const wxString& value = wxEmptyString,
  74             const wxPoint& pos = wxDefaultPosition,
  75             const wxSize& size = wxDefaultSize, long style = wxTE_PROCESS_TAB,
  76             const wxValidator& validator = wxDefaultValidator,
  77             const wxString& name = wxTextCtrlNameStr);
  78
  79     // accessors
  80     // ---------
  81     virtual wxString GetValue() const ;
  82     virtual void SetValue(const wxString& value);
  83
  84     virtual int GetLineLength(long lineNo) const;
  85     virtual wxString GetLineText(long lineNo) const;
  86     virtual int GetNumberOfLines() const;
  87
  88     // operations
  89     // ----------
  90
  91     // Clipboard operations
  92     virtual void Copy();
  93     virtual void Cut();
  94     virtual void Paste();
  95
  96     virtual bool CanCopy() const;
  97     virtual bool CanCut() const;
  98     virtual bool CanPaste() const;
  99
 100     // Undo/redo
 101     virtual void Undo();
 102     virtual void Redo();
 103
 104     virtual bool CanUndo() const;
 105     virtual bool CanRedo() const;
 106
 107     virtual void SetInsertionPoint(long pos);
 108     virtual void SetInsertionPointEnd();
 109     virtual long GetInsertionPoint() const ;
 110     virtual long GetLastPosition() const ;
 111     virtual void Replace(long from, long to, const wxString& value);
 112     virtual void Remove(long from, long to);
 113     virtual void SetSelection(long from, long to);
 114     virtual void SetEditable(bool editable);
 115
 116     // If the return values from and to are the same, there is no
 117     // selection.
 118     virtual void GetSelection(long* from, long* to) const;
 119     virtual bool IsEditable() const ;
 120
 121     // streambuf implementation
 122 #ifndef NO_TEXT_WINDOW_STREAM
 123     int overflow(int i);
 124     int sync();
 125     int underflow();
 126 #endif
 127
 128     wxTextCtrl& operator<<(const wxString& s);
 129     wxTextCtrl& operator<<(int i);
 130     wxTextCtrl& operator<<(long i);
 131     wxTextCtrl& operator<<(float f);
 132     wxTextCtrl& operator<<(double d);
 133     wxTextCtrl& operator<<(const char c);
 134
 135     virtual bool LoadFile(const wxString& file);
 136     virtual bool SaveFile(const wxString& file);
 137     virtual void WriteText(const wxString& text);
 138     virtual void AppendText(const wxString& text);
 139     virtual void DiscardEdits();
 140     virtual bool IsModified() const;
 141
 142 #if WXWIN_COMPATIBILITY
 143     inline bool Modified() const { return IsModified(); }
 144 #endif
 145
 146     virtual long XYToPosition(long x, long y) const ;
 147     virtual void PositionToXY(long pos, long *x, long *y) const ;
 148     virtual void ShowPosition(long pos);
 149     virtual void Clear();
 150
 151     // callbacks
 152     // ---------
 153     void OnDropFiles(wxDropFilesEvent& event);
 154     void OnChar(wxKeyEvent& event); // Process 'enter' if required
 155
 156     void OnCut(wxCommandEvent& event);
 157     void OnCopy(wxCommandEvent& event);
 158     void OnPaste(wxCommandEvent& event);
 159     void OnUndo(wxCommandEvent& event);
 160     void OnRedo(wxCommandEvent& event);
 161
 162     void OnUpdateCut(wxUpdateUIEvent& event);
 163     void OnUpdateCopy(wxUpdateUIEvent& event);
 164     void OnUpdatePaste(wxUpdateUIEvent& event);
 165     void OnUpdateUndo(wxUpdateUIEvent& event);
 166     void OnUpdateRedo(wxUpdateUIEvent& event);
 167
 168     // Implementation
 169     // --------------
 170     virtual void Command(wxCommandEvent& event);
 171     virtual bool MSWCommand(WXUINT param, WXWORD id);
 172
 173 #if wxUSE_RICHEDIT
 174     bool IsRich() const { return m_isRich; }
 175     void SetRichEdit(bool isRich) { m_isRich = isRich; }
 176 #endif
 177
 178     virtual WXHBRUSH OnCtlColor(WXHDC pDC, WXHWND pWnd, WXUINT nCtlColor,
 179             WXUINT message, WXWPARAM wParam,
 180             WXLPARAM lParam);
 181
 182     virtual void AdoptAttributesFromHWND();
 183     virtual void SetupColours();
 184
 185 protected:
 186 #if wxUSE_RICHEDIT
 187     bool      m_isRich; // Are we using rich text edit to implement this?
 188 #endif
 189
 190     wxString  m_fileName;
 191
 192     // call this to increase the size limit (will do nothing if the current
 193     // limit is big enough)
 194     void AdjustSpaceLimit();
 195
 196     virtual void DoSetSize(int x, int y,
 197                            int width, int height,
 198                            int sizeFlags = wxSIZE_AUTO);
 199
 200 private:
 201     DECLARE_EVENT_TABLE()
 202 };
 203
 204 #endif
 205     // _WX_TEXTCTRL_H_