Make all instances of HasEditorCtrl() const, not just a few

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

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

-// 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__
-#pragma interface "textctrl.h"
-#endif
+class WXDLLIMPEXP_CORE wxTextCtrl : public wxTextCtrlBase
+{
+public:
+    // creation
+    // --------

 
 

-#include "wx/control.h"
+    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);
+    }
+    virtual ~wxTextCtrl();

 
 

-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);

 
 

-// Single-line text item
-class WXDLLEXPORT wxTextCtrl: public wxControl
+    // overridden wxTextEntry methods
+    // ------------------------------

 
 

-// 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 wxString GetValue() const;
+    virtual wxString GetRange(long from, long to) const;

 
 

-#if (defined(__BORLANDC__) && !defined(__WIN32__)) || defined(__MWERKS__) || defined(_WINDLL) || defined(WXUSINGDLL) || defined(WXMAKINGDLL)
-#define NO_TEXT_WINDOW_STREAM
-#endif
+    virtual bool IsEmpty() const;

 
 

-#ifndef NO_TEXT_WINDOW_STREAM
-, public streambuf
-#endif
+    virtual void WriteText(const wxString& text);
+    virtual void AppendText(const wxString& text);
+    virtual void Clear();

 
 

-{
-  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);
-#endif
+    virtual int GetLineLength(long lineNo) const;
+    virtual wxString GetLineText(long lineNo) const;
+    virtual int GetNumberOfLines() const;
+
+    virtual void SetMaxLength(unsigned long len);
+
+    virtual void GetSelection(long *from, long *to) const;
+
+    virtual void Redo();
+    virtual bool CanRedo() const;
+
+    virtual void SetInsertionPointEnd();
+    virtual long GetInsertionPoint() const;
+    virtual wxTextPos GetLastPosition() const;
+
+    // implement base class pure virtuals
+    // ----------------------------------

 
 

-  void OnDropFiles(wxDropFilesEvent& event);
+    virtual bool IsModified() const;
+    virtual void MarkDirty();
+    virtual void DiscardEdits();

 
 

-  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);
+#ifdef __WIN32__
+    virtual bool EmulateKeyPress(const wxKeyEvent& event);
+#endif // __WIN32__

 
 

-  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;
+#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);
+    virtual bool GetStyle(long position, wxTextAttr& style);
+#endif // wxUSE_RICHEDIT

 
 

-#if WXWIN_COMPATIBILITY
-  inline bool Modified(void) const { return IsModified(); }
+    // 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);
+    virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt, long *pos) const;
+    virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt,
+                                            wxTextCoord *col,
+                                            wxTextCoord *row) const
+    {
+        return wxTextCtrlBase::HitTest(pt, col, row);
+    }
+
+    // Caret handling (Windows only)
+    bool ShowNativeCaret(bool show = true);
+    bool HideNativeCaret() { return ShowNativeCaret(false); }
+
+    // Implementation from now on
+    // --------------------------
+ 
+#if wxUSE_DRAG_AND_DROP && wxUSE_RICHEDIT
+    virtual void SetDropTarget(wxDropTarget *dropTarget);
+#endif // wxUSE_DRAG_AND_DROP && wxUSE_RICHEDIT
+
+    virtual void SetWindowStyleFlag(long style);
+
+    virtual void Command(wxCommandEvent& event);
+    virtual bool MSWCommand(WXUINT param, WXWORD id);
+    virtual WXHBRUSH MSWControlColor(WXHDC hDC, WXHWND hWnd);
+
+#if wxUSE_RICHEDIT
+    virtual bool MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result);
+
+    int GetRichVersion() const { return m_verRichEdit; }
+    bool IsRich() const { return m_verRichEdit != 0; }
+
+    // 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);
+#else
+    bool IsRich() const { return false; }
+#endif // wxUSE_RICHEDIT
+
+#if wxUSE_INKEDIT && wxUSE_RICHEDIT
+    bool IsInkEdit() const { return m_isInkEdit != 0; }
+#else
+    bool IsInkEdit() const { return false; }

 #endif
 
 #endif
 

-  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 void AdoptAttributesFromHWND();
+
+    virtual bool AcceptsFocusFromKeyboard() const;
+
+    // returns true if the platform should explicitly apply a theme border
+    virtual bool CanApplyThemeBorder() 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);
+    void OnDelete(wxCommandEvent& event);
+    void OnSelectAll(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);
+    void OnUpdateCut(wxUpdateUIEvent& event);
+    void OnUpdateCopy(wxUpdateUIEvent& event);
+    void OnUpdatePaste(wxUpdateUIEvent& event);
+    void OnUpdateUndo(wxUpdateUIEvent& event);
+    void OnUpdateRedo(wxUpdateUIEvent& event);
+    void OnUpdateDelete(wxUpdateUIEvent& event);
+    void OnUpdateSelectAll(wxUpdateUIEvent& event);

 
 

-  virtual long MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
-  virtual void AdoptAttributesFromHWND(void);
-  virtual void SetupColours(void);
+    // Show a context menu for Rich Edit controls (the standard
+    // EDIT control has one already)
+    void OnContextMenu(wxContextMenuEvent& event);
+
+    // be sure the caret remains invisible if the user
+    // called HideNativeCaret() before
+    void OnSetFocus(wxFocusEvent& event);
+
+    // intercept WM_GETDLGCODE
+    virtual WXLRESULT MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
+
+    virtual bool MSWShouldPreProcessMessage(WXMSG* pMsg);
+    virtual WXDWORD MSWGetStyle(long style, WXDWORD *exstyle) const;
+    virtual wxVisualAttributes GetDefaultAttributes() const;

 
 protected:
 
 protected:

-   bool      m_isRich; // Are we using rich text edit to implement this?
+    // common part of all ctors
+    void Init();

 
 

-DECLARE_EVENT_TABLE()
-};
+    virtual bool DoLoadFile(const wxString& file, int fileType);
+
+    // creates the control of appropriate class (plain or rich edit) with the
+    // styles corresponding to m_windowStyle
+    //
+    // this is used by ctor/Create() and when we need to recreate the control
+    // later
+    bool MSWCreateText(const wxString& value,
+                       const wxPoint& pos,
+                       const wxSize& size);
+
+    virtual void DoSetValue(const wxString &value, int flags = 0);
+
+    // return true if this control has a user-set limit on amount of text (i.e.
+    // the limit is due to a previous call to SetMaxLength() and not built in)
+    bool HasSpaceLimit(unsigned int *len) const;
+
+    // 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 && (!wxUSE_UNICODE || wxUSE_UNICODE_MSLU)
+    // 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);
+
+    // get the contents of the control out as text in the given encoding
+    wxString StreamOut(wxFontEncoding encoding, bool selOnly = false) const;
+#endif // wxUSE_RICHEDIT
+
+    // replace the contents of the selection or of the entire control with the
+    // given text
+    void DoWriteText(const wxString& text,
+                     int flags = SetValue_SendEvent | SetValue_SelectionOnly);
+
+    // set the selection (possibly without scrolling the caret into view)
+    void DoSetSelection(long from, long to, int flags);
+
+    // get the length of the line containing the character at the given
+    // position
+    long GetLengthOfLineContainingPos(long pos) const;

 
 

+    // send TEXT_UPDATED event, return true if it was handled, false otherwise
+    bool SendUpdateEvent();
+
+    virtual wxSize DoGetBestSize() 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
+
+    // number of EN_UPDATE events sent by Windows when we change the controls
+    // text ourselves: we want this to be exactly 1
+    int m_updatesCount;
+
+private:
+    virtual void EnableTextChangedEvents(bool enable)
+    {
+        m_updatesCount = enable ? -1 : -2;
+    }
+
+    // implement wxTextEntry pure virtual: it implements all the operations for
+    // the simple EDIT controls
+    virtual WXHWND GetEditHWND() const { return m_hWnd; }
+
+    void OnKeyDown(wxKeyEvent& event);
+
+    DECLARE_EVENT_TABLE()
+    DECLARE_DYNAMIC_CLASS_NO_COPY(wxTextCtrl)
+
+    wxMenu* m_privateContextMenu;
+
+    bool m_isNativeCaretShown;
+
+#if wxUSE_INKEDIT && wxUSE_RICHEDIT
+    int  m_isInkEdit;

 #endif
 #endif

-    // __TEXTCTRLH__
+
+};
+
+#endif // _WX_TEXTCTRL_H_