Renamed internal GetClientWindow to GetClientAreaWindow so

[wxWidgets.git] / include / wx / msw / textctrl.h

diff --git a/include/wx/msw/textctrl.h b/include/wx/msw/textctrl.h
index 43b5ea9ac3a83667dcd67ef0b8afabab0e0a6fc5..b852df9a84b985e2907636e84284f11d67e4bc13 100644 (file)
--- a/include/wx/msw/textctrl.h
+++ b/include/wx/msw/textctrl.h
@@ -1,149 +1,229 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        textctrl.h
+// Name:        wx/msw/textctrl.h

 // Purpose:     wxTextCtrl class
 // Author:      Julian Smart
 // Modified by:
 // Created:     01/02/97
 // RCS-ID:      $Id$
 // Purpose:     wxTextCtrl class
 // Author:      Julian Smart
 // Modified by:
 // Created:     01/02/97
 // RCS-ID:      $Id$

-// Copyright:   (c) Julian Smart and Markus Holzem
-// Licence:    wxWindows license
+// Copyright:   (c) Julian Smart
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /////////////////////////////////////////////////////////////////////////////
 

-#ifndef __TEXTCTRLH__
-#define __TEXTCTRLH__
+#ifndef _WX_TEXTCTRL_H_
+#define _WX_TEXTCTRL_H_

 
 #ifdef __GNUG__
 
 #ifdef __GNUG__

-#pragma interface "textctrl.h"
+    #pragma interface "textctrl.h"

 #endif
 
 #endif
 

-#include "wx/control.h"
+class WXDLLEXPORT wxTextCtrl : public wxTextCtrlBase
+{
+public:
+    // creation
+    // --------
+
+    wxTextCtrl() { Init(); }
+    wxTextCtrl(wxWindow *parent, wxWindowID id,
+               const wxString& value = wxEmptyString,
+               const wxPoint& pos = wxDefaultPosition,
+               const wxSize& size = wxDefaultSize,
+               long style = 0,
+               const wxValidator& validator = wxDefaultValidator,
+               const wxString& name = wxTextCtrlNameStr)
+    {
+        Init();

 
 

-#if USE_IOSTREAMH
-#include <iostream.h>
-#else
-#include <iostream>
-#endif
+        Create(parent, id, value, pos, size, style, validator, name);
+    }

 
 

-WXDLLEXPORT_DATA(extern const char*) wxTextCtrlNameStr;
-WXDLLEXPORT_DATA(extern const char*) wxEmptyString;
+    bool Create(wxWindow *parent, wxWindowID id,
+                const wxString& value = wxEmptyString,
+                const wxPoint& pos = wxDefaultPosition,
+                const wxSize& size = wxDefaultSize,
+                long style = 0,
+                const wxValidator& validator = wxDefaultValidator,
+                const wxString& name = wxTextCtrlNameStr);
+
+    // implement base class pure virtuals
+    // ----------------------------------
+
+    virtual wxString GetValue() const;
+    virtual void SetValue(const wxString& value);
+
+    virtual wxString GetRange(long from, long to) const;
+
+    virtual int GetLineLength(long lineNo) const;
+    virtual wxString GetLineText(long lineNo) const;
+    virtual int GetNumberOfLines() const;
+
+    virtual bool IsModified() const;
+    virtual bool IsEditable() const;
+
+    virtual void GetSelection(long* from, long* to) const;
+
+    // operations
+    // ----------
+
+    // editing
+    virtual void Clear();
+    virtual void Replace(long from, long to, const wxString& value);
+    virtual void Remove(long from, long to);
+
+    // load the controls contents from the file
+    virtual bool LoadFile(const wxString& file);
+
+    // clears the dirty flag
+    virtual void DiscardEdits();
+
+    virtual void SetMaxLength(unsigned long len);
+
+    // writing text inserts it at the current position, appending always
+    // inserts it at the end
+    virtual void WriteText(const wxString& text);
+    virtual void AppendText(const wxString& text);
+
+#ifdef __WIN32__
+    virtual bool EmulateKeyPress(const wxKeyEvent& event);
+#endif // __WIN32__
+
+#if wxUSE_RICHEDIT
+    // apply text attribute to the range of text (only works with richedit
+    // controls)
+    virtual bool SetStyle(long start, long end, const wxTextAttr& style);
+    virtual bool SetDefaultStyle(const wxTextAttr& style);
+#endif // wxUSE_RICHEDIT
+
+    // translate between the position (which is just an index in the text ctrl
+    // considering all its contents as a single strings) and (x, y) coordinates
+    // which represent column and line.
+    virtual long XYToPosition(long x, long y) const;
+    virtual bool PositionToXY(long pos, long *x, long *y) const;
+
+    virtual void ShowPosition(long pos);
+
+    // Clipboard operations
+    virtual void Copy();
+    virtual void Cut();
+    virtual void Paste();
+
+    virtual bool CanCopy() const;
+    virtual bool CanCut() const;
+    virtual bool CanPaste() const;
+
+    // Undo/redo
+    virtual void Undo();
+    virtual void Redo();
+
+    virtual bool CanUndo() const;
+    virtual bool CanRedo() const;
+
+    // Insertion point
+    virtual void SetInsertionPoint(long pos);
+    virtual void SetInsertionPointEnd();
+    virtual long GetInsertionPoint() const;
+    virtual long GetLastPosition() const;
+
+    virtual void SetSelection(long from, long to);
+    virtual void SetEditable(bool editable);

 
 

-// Single-line text item
-class WXDLLEXPORT wxTextCtrl: public wxControl
+    // Implementation from now on
+    // --------------------------

 
 

-// 16-bit Borland 4.0 doesn't seem to allow multiple inheritance with wxWindow and streambuf:
-// it complains about deriving a huge class from the huge class streambuf. !!
-// Also, can't use streambuf if making or using a DLL :-(
+    virtual void SetWindowStyleFlag(long style);

 
 

-#if (defined(__BORLANDC__) && !defined(__WIN32__)) || defined(__MWERKS__) || defined(_WINDLL) || defined(WXUSINGDLL) || defined(WXMAKINGDLL)
-#define NO_TEXT_WINDOW_STREAM
-#endif
-
-#ifndef NO_TEXT_WINDOW_STREAM
-, public streambuf
-#endif
+    virtual void Command(wxCommandEvent& event);
+    virtual bool MSWCommand(WXUINT param, WXWORD id);
+    virtual WXHBRUSH OnCtlColor(WXHDC pDC, WXHWND pWnd, WXUINT nCtlColor,
+            WXUINT message, WXWPARAM wParam, WXLPARAM lParam);

 
 

-{
-  DECLARE_DYNAMIC_CLASS(wxTextCtrl)
-
- protected:
-  wxString fileName;
- public:
-  wxTextCtrl(void);
-  inline wxTextCtrl(wxWindow *parent, const wxWindowID id,
-           const wxString& value = wxEmptyString,
-           const wxPoint& pos = wxDefaultPosition,
-           const wxSize& size = wxDefaultSize, const long style = 0,
-           const wxValidator& validator = wxDefaultValidator,
-           const wxString& name = wxTextCtrlNameStr)
-#ifndef NO_TEXT_WINDOW_STREAM
- :streambuf()
-#endif
-  {
-      Create(parent, id, value, pos, size, style, validator, name);
-  }
-
-  bool Create(wxWindow *parent, const wxWindowID id,
-           const wxString& value = wxEmptyString,
-           const wxPoint& pos = wxDefaultPosition,
-           const wxSize& size = wxDefaultSize, const long style = 0,
-           const wxValidator& validator = wxDefaultValidator,
-           const wxString& name = wxTextCtrlNameStr);
-
-  virtual wxString GetValue(void) const ;
-  virtual void SetValue(const wxString& value);
-  virtual void SetSize(const int x, const int y, const int width, const int height, const int sizeFlags = wxSIZE_AUTO);
-
-  // Clipboard operations
-  virtual void Copy(void);
-  virtual void Cut(void);
-  virtual void Paste(void);
-
-  virtual void SetInsertionPoint(const long pos);
-  virtual void SetInsertionPointEnd(void);
-  virtual long GetInsertionPoint(void) const ;
-  virtual long GetLastPosition(void) const ;
-  virtual void Replace(const long from, const long to, const wxString& value);
-  virtual void Remove(const long from, const long to);
-  virtual void SetSelection(const long from, const long to);
-
-  virtual void Command(wxCommandEvent& event);
-
-  virtual void SetEditable(const bool editable);
-
-#ifndef NO_TEXT_WINDOW_STREAM
-  int overflow(int i);
-  int sync(void);
-  int underflow(void);
+    // In WIN16, need to override normal erasing because
+    // Ctl3D doesn't use the wxWindows background colour.
+#ifdef __WIN16__
+    void OnEraseBackground(wxEraseEvent& event);

 #endif
 
 #endif
 

-  void OnDropFiles(wxDropFilesEvent& event);
+#if wxUSE_RICHEDIT
+    virtual bool MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result);

 
 

-  wxTextCtrl& operator<<(const wxString& s);
-  wxTextCtrl& operator<<(const int i);
-  wxTextCtrl& operator<<(const long i);
-  wxTextCtrl& operator<<(const float f);
-  wxTextCtrl& operator<<(const double d);
-  wxTextCtrl& operator<<(const char c);
+    int GetRichVersion() const { return m_verRichEdit; }
+    bool IsRich() const { return m_verRichEdit != 0; }

 
 

-  virtual bool LoadFile(const wxString& file);
-  virtual bool SaveFile(const wxString& file);
-  virtual void WriteText(const wxString& text);
-  virtual void DiscardEdits(void);
-  virtual bool IsModified(void) const;
+    // rich edit controls are not compatible with normal ones and wem ust set
+    // the colours for them otherwise
+    virtual bool SetBackgroundColour(const wxColour& colour);
+    virtual bool SetForegroundColour(const wxColour& colour);
+#endif // wxUSE_RICHEDIT

 
 

-#if WXWIN_COMPATIBILITY
-  inline bool Modified(void) const { return IsModified(); }
-#endif
+    virtual void AdoptAttributesFromHWND();

 
 

-  virtual long XYToPosition(const long x, const long y) const ;
-  virtual void PositionToXY(const long pos, long *x, long *y) const ;
-  virtual void ShowPosition(const long pos);
-  virtual int GetLineLength(const long lineNo) const ;
-  virtual wxString GetLineText(const long lineNo) const ;
-  virtual int GetNumberOfLines(void) const ;
-  virtual void Clear(void);
+    virtual bool AcceptsFocus() const;

 
 

-  // Process special keys e.g. 'enter' and process as if it were a command, if required
-  void OnChar(wxKeyEvent& event);
+    // callbacks
+    void OnDropFiles(wxDropFilesEvent& event);
+    void OnChar(wxKeyEvent& event); // Process 'enter' if required

 
 

-  void OnEraseBackground(wxEraseEvent& event);
+    void OnCut(wxCommandEvent& event);
+    void OnCopy(wxCommandEvent& event);
+    void OnPaste(wxCommandEvent& event);
+    void OnUndo(wxCommandEvent& event);
+    void OnRedo(wxCommandEvent& event);

 
 

-  // Implementation
-  virtual bool MSWCommand(const WXUINT param, const WXWORD id);
-  inline bool IsRich(void) { return m_isRich; }
-  inline void SetRichEdit(const bool isRich) { m_isRich = isRich; }
-  virtual WXHBRUSH OnCtlColor(const WXHDC pDC, const WXHWND pWnd, const WXUINT nCtlColor,
-                       WXUINT message, WXWPARAM wParam, WXLPARAM lParam);
-
-  virtual long MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
-  virtual void AdoptAttributesFromHWND(void);
-  virtual void SetupColours(void);
+    void OnUpdateCut(wxUpdateUIEvent& event);
+    void OnUpdateCopy(wxUpdateUIEvent& event);
+    void OnUpdatePaste(wxUpdateUIEvent& event);
+    void OnUpdateUndo(wxUpdateUIEvent& event);
+    void OnUpdateRedo(wxUpdateUIEvent& event);

 
 protected:
 
 protected:

-   bool      m_isRich; // Are we using rich text edit to implement this?
-
-DECLARE_EVENT_TABLE()
+    // common part of all ctors
+    void Init();
+
+    // intercept WM_GETDLGCODE
+    virtual long MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
+
+    // call this to increase the size limit (will do nothing if the current
+    // limit is big enough)
+    //
+    // returns true if we increased the limit to allow entering more text,
+    // false if we hit the limit set by SetMaxLength() and so didn't change it
+    bool AdjustSpaceLimit();
+
+#if wxUSE_RICHEDIT
+    // replace the selection or the entire control contents with the given text
+    // in the specified encoding
+    bool StreamIn(const wxString& value,
+                  wxFontEncoding encoding,
+                  bool selOnly);
+#endif // wxUSE_RICHEDIT
+
+    // replace the contents of the selection or of the entire control with the
+    // given text
+    void DoWriteText(const wxString& text, bool selectionOnly = TRUE);
+
+    // set the selection possibly without scrolling the caret into view
+    void DoSetSelection(long from, long to, bool scrollCaret = TRUE);
+
+    // get the length of the line containing the character at the given
+    // position
+    long GetLengthOfLineContainingPos(long pos) const;
+
+    // override some base class virtuals
+    virtual bool MSWShouldPreProcessMessage(WXMSG* pMsg);
+    virtual wxSize DoGetBestSize() const;
+
+    virtual WXDWORD MSWGetStyle(long style, WXDWORD *exstyle) const;
+
+#if wxUSE_RICHEDIT
+    // we're using RICHEDIT (and not simple EDIT) control if this field is not
+    // 0, it also gives the version of the RICHEDIT control being used (1, 2 or
+    // 3 so far)
+    int m_verRichEdit;
+#endif // wxUSE_RICHEDIT
+
+private:
+    DECLARE_EVENT_TABLE()
+    DECLARE_DYNAMIC_CLASS(wxTextCtrl)

 };
 
 #endif
 };
 
 #endif

-    // __TEXTCTRLH__
+    // _WX_TEXTCTRL_H_