X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/2bda0e173844e8e0f8acf4e8ad8b5c26e5c6fe5d..e951b8e4e6c07fe5d5200b8cbf6148e7317aa0e5:/include/wx/msw/textctrl.h diff --git a/include/wx/msw/textctrl.h b/include/wx/msw/textctrl.h index 43b5ea9ac3..1fb28361f6 100644 --- a/include/wx/msw/textctrl.h +++ b/include/wx/msw/textctrl.h @@ -1,149 +1,272 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: textctrl.h +// Name: wx/msw/textctrl.h // 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" +#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) + #pragma interface "textctrl.h" #endif -#include "wx/control.h" +class WXDLLEXPORT wxTextCtrl : public wxTextCtrlBase +{ +public: + // creation + // -------- -#if USE_IOSTREAMH -#include -#else -#include -#endif + 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(); -WXDLLEXPORT_DATA(extern const char*) wxTextCtrlNameStr; -WXDLLEXPORT_DATA(extern const char*) wxEmptyString; + Create(parent, id, value, pos, size, style, validator, name); + } + ~wxTextCtrl(); -// Single-line text item -class WXDLLEXPORT wxTextCtrl: public wxControl + 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); -// 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 :-( + // implement base class pure virtuals + // ---------------------------------- -#if (defined(__BORLANDC__) && !defined(__WIN32__)) || defined(__MWERKS__) || defined(_WINDLL) || defined(WXUSINGDLL) || defined(WXMAKINGDLL) -#define NO_TEXT_WINDOW_STREAM -#endif + virtual wxString GetValue() const; + virtual void SetValue(const wxString& value); -#ifndef NO_TEXT_WINDOW_STREAM -, public streambuf -#endif + virtual wxString GetRange(long from, long to) const; -{ - 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; - void OnDropFiles(wxDropFilesEvent& event); + virtual bool IsModified() const; + virtual bool IsEditable() const; - 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); + virtual void GetSelection(long* from, long* to) const; - 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; + // operations + // ---------- -#if WXWIN_COMPATIBILITY - inline bool Modified(void) const { return IsModified(); } -#endif + // 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 MarkDirty(); + 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); + virtual bool GetStyle(long position, 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); + 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); + } + + // 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); + + // Caret handling (Windows only) + + bool ShowNativeCaret(bool show = true); + bool HideNativeCaret() { return ShowNativeCaret(false); } + + // Implementation from now on + // -------------------------- - 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 SetWindowStyleFlag(long style); - // Process special keys e.g. 'enter' and process as if it were a command, if required - void OnChar(wxKeyEvent& event); + virtual void Command(wxCommandEvent& event); + virtual bool MSWCommand(WXUINT param, WXWORD id); + virtual WXHBRUSH MSWControlColor(WXHDC hDC); - void OnEraseBackground(wxEraseEvent& event); +#if wxUSE_RICHEDIT + virtual bool MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result); - // 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); + int GetRichVersion() const { return m_verRichEdit; } + bool IsRich() const { return m_verRichEdit != 0; } - virtual long MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam); - virtual void AdoptAttributesFromHWND(void); - virtual void SetupColours(void); + // 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 + + virtual void AdoptAttributesFromHWND(); + + virtual bool AcceptsFocus() const; + + // callbacks + void OnDropFiles(wxDropFilesEvent& event); + void OnChar(wxKeyEvent& event); // Process 'enter' if required + + 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); + + 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); + + // Show a context menu for Rich Edit controls (the standard + // EDIT control has one already) + void OnRightClick(wxMouseEvent& event); + + // be sure the caret remains invisible if the user + // called HideNativeCaret() before + void OnSetFocus(wxFocusEvent& event); protected: - bool m_isRich; // Are we using rich text edit to implement this? + // common part of all ctors + void Init(); + + // intercept WM_GETDLGCODE + virtual WXLRESULT 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 && (!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, bool selectionOnly = true); + + // set the selection possibly without scrolling the caret into view + void DoSetSelection(long from, long to, bool scrollCaret = true); + + // return true if there is a non empty selection in the control + bool HasSelection() const; + + // 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(); + + // 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 + + // 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; + + virtual wxVisualAttributes GetDefaultAttributes() const; + +private: + DECLARE_EVENT_TABLE() + DECLARE_DYNAMIC_CLASS_NO_COPY(wxTextCtrl) + + wxMenu* m_privateContextMenu; + + bool m_isNativeCaretShown; -DECLARE_EVENT_TABLE() + // this is an optimization: instead of checking all the time whether we + // need to move the caret to the end of text (before appending to the + // control), we remember whether it is already at the end of text in this + // variable + bool m_isCaretAtEnd; }; #endif - // __TEXTCTRLH__ + // _WX_TEXTCTRL_H_