X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/bf3e0fbd1ff071caa5d929f01ad6ef9a64ee6494..b6e5eaa59701315ca06996ff845872ca4122695f:/include/wx/textctrl.h?ds=sidebyside diff --git a/include/wx/textctrl.h b/include/wx/textctrl.h index 5e7d35a11f..94a65ac2c3 100644 --- a/include/wx/textctrl.h +++ b/include/wx/textctrl.h @@ -15,11 +15,15 @@ // ---------------------------------------------------------------------------- // headers // ---------------------------------------------------------------------------- + #ifdef __GNUG__ #pragma interface "textctrlbase.h" -#endif +#endif #include "wx/defs.h" + +#if wxUSE_TEXTCTRL + #include "wx/control.h" // the base class // 16-bit Borland 4.0 doesn't seem to allow multiple inheritance with wxWindow @@ -30,6 +34,13 @@ #define NO_TEXT_WINDOW_STREAM #endif +// the streambuf which is used in the declaration of wxTextCtrlBase below is not compatible +// with the standard-conforming implementation found in newer egcs versions +// (that is, the libstdc++ v3 that is shipped with it) +#if defined(__GNUC__)&&( (__GNUC__>2) ||( (__GNUC__==2)&&(__GNUC_MINOR__>97) ) ) + #define NO_TEXT_WINDOW_STREAM +#endif + #ifndef NO_TEXT_WINDOW_STREAM #if wxUSE_STD_IOSTREAM #include "wx/ioswrap.h" // for iostream classes if we need them @@ -48,6 +59,72 @@ class WXDLLEXPORT wxTextCtrl; WXDLLEXPORT_DATA(extern const wxChar*) wxTextCtrlNameStr; WXDLLEXPORT_DATA(extern const wxChar*) wxEmptyString; +// ---------------------------------------------------------------------------- +// wxTextCtrl style flags +// ---------------------------------------------------------------------------- + +// the flag bits 0x0001, 2, 4 and 8 are free but should be used only for the +// things which don't make sense for a text control used by wxTextEntryDialog +// because they would otherwise conflict with wxOK, wxCANCEL, wxCENTRE +#define wxTE_READONLY 0x0010 +#define wxTE_MULTILINE 0x0020 +#define wxTE_PROCESS_TAB 0x0040 + +// this style means to use RICHEDIT control and does something only under wxMSW +// and Win32 and is silently ignored under all other platforms +#define wxTE_RICH 0x0080 +#define wxTE_NO_VSCROLL 0x0100 +#define wxTE_AUTO_SCROLL 0x0200 +#define wxTE_PROCESS_ENTER 0x0400 +#define wxTE_PASSWORD 0x0800 + +// automatically detect the URLs and generate the events when mouse is +// moved/clicked over an URL +// +// this is for Win32 richedit controls only so far +#define wxTE_AUTO_URL 0x1000 + +// ---------------------------------------------------------------------------- +// wxTextAttr: a structure containing the visual attributes of a text +// ---------------------------------------------------------------------------- + +class WXDLLEXPORT wxTextAttr +{ +public: + // ctors + wxTextAttr() { } + wxTextAttr(const wxColour& colText, + const wxColour& colBack = wxNullColour, + const wxFont& font = wxNullFont) + : m_colText(colText), m_colBack(colBack), m_font(font) { } + + // setters + void SetTextColour(const wxColour& colText) { m_colText = colText; } + void SetBackgroundColour(const wxColour& colBack) { m_colBack = colBack; } + void SetFont(const wxFont& font) { m_font = font; } + + // accessors + bool HasTextColour() const { return m_colText.Ok(); } + bool HasBackgroundColour() const { return m_colBack.Ok(); } + bool HasFont() const { return m_font.Ok(); } + + // setters + const wxColour& GetTextColour() const { return m_colText; } + const wxColour& GetBackgroundColour() const { return m_colBack; } + const wxFont& GetFont() const { return m_font; } + + // returns false if we have any attributes set, true otherwise + bool IsDefault() const + { + return !HasTextColour() && !HasBackgroundColour() && !HasFont(); + } + +private: + wxColour m_colText, + m_colBack; + wxFont m_font; +}; + // ---------------------------------------------------------------------------- // wxTextCtrl: a single or multiple line text zone where user can enter and // edit text @@ -64,6 +141,7 @@ public: // -------- wxTextCtrlBase(); + ~wxTextCtrlBase(); // accessors // --------- @@ -96,11 +174,22 @@ public: // clears the dirty flag virtual void DiscardEdits() = 0; + // set the max number of characters which may be entered in a single line + // text control + virtual void SetMaxLength(unsigned long WXUNUSED(len)) { } + // writing text inserts it at the current position, appending always // inserts it at the end virtual void WriteText(const wxString& text) = 0; virtual void AppendText(const wxString& text) = 0; + // text control under some platforms supports the text styles: these + // methods allow to apply the given text style to the given selection or to + // set/get the style which will be used for all appended text + virtual bool SetStyle(long start, long end, const wxTextAttr& style); + virtual bool SetDefaultStyle(const wxTextAttr& style); + virtual const wxTextAttr& GetDefaultStyle() const; + // 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. @@ -114,9 +203,9 @@ public: virtual void Cut() = 0; virtual void Paste() = 0; - virtual bool CanCopy() const = 0; - virtual bool CanCut() const = 0; - virtual bool CanPaste() const = 0; + virtual bool CanCopy() const; + virtual bool CanCut() const; + virtual bool CanPaste() const; // Undo/redo virtual void Undo() = 0; @@ -132,6 +221,7 @@ public: virtual long GetLastPosition() const = 0; virtual void SetSelection(long from, long to) = 0; + virtual void SelectAll(); virtual void SetEditable(bool editable) = 0; // streambuf methods @@ -155,17 +245,29 @@ public: bool Modified() const { return IsModified(); } #endif -private: +protected: // the name of the last file loaded with LoadFile() which will be used by // SaveFile() by default wxString m_filename; + + // the text style which will be used for any new text added to the control + wxTextAttr m_defaultStyle; + +private: +#ifndef NO_TEXT_WINDOW_STREAM +#if !wxUSE_IOSTREAMH + char *m_streambuf; +#endif +#endif }; // ---------------------------------------------------------------------------- // include the platform-dependent class definition // ---------------------------------------------------------------------------- -#if defined(__WXMSW__) +#if defined(__WXUNIVERSAL__) + #include "wx/univ/textctrl.h" +#elif defined(__WXMSW__) #include "wx/msw/textctrl.h" #elif defined(__WXMOTIF__) #include "wx/motif/textctrl.h" @@ -181,5 +283,63 @@ private: #include "wx/stubs/textctrl.h" #endif +// ---------------------------------------------------------------------------- +// wxTextCtrl events +// ---------------------------------------------------------------------------- + +#if !WXWIN_COMPATIBILITY_EVENT_TYPES + +BEGIN_DECLARE_EVENT_TYPES() + DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_UPDATED, 7) + DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_ENTER, 8) + DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_URL, 13) + DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_MAXLEN, 14) +END_DECLARE_EVENT_TYPES() + +#endif // !WXWIN_COMPATIBILITY_EVENT_TYPES + +class WXDLLEXPORT wxTextUrlEvent : public wxCommandEvent +{ +public: + wxTextUrlEvent(int id, const wxMouseEvent& evtMouse, + long start, long end) + : wxCommandEvent(wxEVT_COMMAND_TEXT_URL, id), + m_evtMouse(evtMouse) + { m_start = start; m_end = end; } + + // get the mouse event which happend over the URL + const wxMouseEvent& GetMouseEvent() const { return m_evtMouse; } + + // get the start of the URL + long GetURLStart() const { return m_start; } + + // get the end of the URL + long GetURLEnd() const { return m_end; } + +protected: + // the corresponding mouse event + wxMouseEvent m_evtMouse; + + // the start and end indices of the URL in the text control + long m_start, + m_end; + +private: + DECLARE_DYNAMIC_CLASS(wxTextUrlEvent) + +public: + // for wxWin RTTI only, don't use + wxTextUrlEvent() { } +}; + +typedef void (wxEvtHandler::*wxTextUrlEventFunction)(wxTextUrlEvent&); + +#define EVT_TEXT(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TEXT_UPDATED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ), +#define EVT_TEXT_ENTER(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TEXT_ENTER, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ), +#define EVT_TEXT_URL(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TEXT_URL, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) (wxTextUrlEventFunction) & fn, (wxObject *) NULL ), +#define EVT_TEXT_MAXLEN(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TEXT_MAXLEN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL ), + +#endif // wxUSE_TEXTCTRL + #endif // _WX_TEXTCTRL_H_BASE_