X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/b4782e576d1159ae3acd49f4cc62f4ddd1684c61..0a84f928e9a273248a4843f6282507a39212d2d1:/include/wx/textentry.h?ds=sidebyside diff --git a/include/wx/textentry.h b/include/wx/textentry.h index 0aa350ef9d..130446a4a3 100644 --- a/include/wx/textentry.h +++ b/include/wx/textentry.h @@ -16,6 +16,10 @@ typedef long wxTextPos; class WXDLLIMPEXP_FWD_BASE wxArrayString; +class WXDLLIMPEXP_FWD_CORE wxTextEntryHintData; +class WXDLLIMPEXP_FWD_CORE wxWindow; + +#include "wx/gdicmn.h" // for wxPoint // ---------------------------------------------------------------------------- // wxTextEntryBase @@ -24,8 +28,8 @@ class WXDLLIMPEXP_FWD_BASE wxArrayString; class WXDLLIMPEXP_CORE wxTextEntryBase { public: - wxTextEntryBase() { m_eventsBlock = 0; } - virtual ~wxTextEntryBase() { } + wxTextEntryBase() { m_eventsBlock = 0; m_hintData = NULL; } + virtual ~wxTextEntryBase(); // accessing the value @@ -43,9 +47,9 @@ public: virtual void WriteText(const wxString& text) = 0; virtual void AppendText(const wxString& text); - virtual wxString GetValue() const = 0; + virtual wxString GetValue() const; virtual wxString GetRange(long from, long to) const; - bool IsEmpty() const { return GetValue().empty(); } + bool IsEmpty() const { return GetLastPosition() <= 0; } // editing operations @@ -54,6 +58,7 @@ public: virtual void Replace(long from, long to, const wxString& value); virtual void Remove(long from, long to) = 0; virtual void Clear() { SetValue(wxString()); } + void RemoveSelection(); // clipboard operations @@ -91,12 +96,12 @@ public: // --------- virtual void SetSelection(long from, long to) = 0; - virtual void SelectAll() { SetSelection(0, GetLastPosition()); } + virtual void SelectAll() { SetSelection(-1, -1); } virtual void GetSelection(long *from, long *to) const = 0; bool HasSelection() const; virtual wxString GetStringSelection() const; - + // auto-completion // --------------- @@ -128,6 +133,31 @@ public: virtual void SetMaxLength(unsigned long WXUNUSED(len)) { } + // hints + // ----- + + // hint is the (usually greyed out) text shown in the control as long as + // it's empty and doesn't have focus, it is typically used in controls used + // for searching to let the user know what is supposed to be entered there + + virtual bool SetHint(const wxString& hint); + virtual wxString GetHint() const; + + + // margins + // ------- + + // margins are the empty space between borders of control and the text + // itself. When setting margin, use value -1 to indicate that specific + // margin should not be changed. + + bool SetMargins(const wxPoint& pt) + { return DoSetMargins(pt); } + bool SetMargins(wxCoord left, wxCoord top = -1) + { return DoSetMargins(wxPoint(left, top)); } + wxPoint GetMargins() const + { return DoGetMargins(); } + protected: // flags for DoSetValue(): common part of SetValue() and ChangeValue() and // also used to implement WriteText() in wxMSW @@ -139,6 +169,16 @@ protected: }; virtual void DoSetValue(const wxString& value, int flags); + virtual wxString DoGetValue() const = 0; + + // override this to return the associated window, it will be used for event + // generation and also by generic hints implementation + virtual wxWindow *GetEditableWindow() = 0; + + // margins functions + virtual bool DoSetMargins(const wxPoint& pt); + virtual wxPoint DoGetMargins() const; + // class which should be used to temporarily disable text change events // @@ -195,6 +235,9 @@ private: // if this counter is non-null, events are blocked unsigned m_eventsBlock; + + // hint-related stuff, only allocated if/when SetHint() is used + wxTextEntryHintData *m_hintData; }; #ifdef __WXUNIVERSAL__ @@ -207,6 +250,10 @@ private: #include "wx/gtk/textentry.h" #elif defined(__WXMSW__) #include "wx/msw/textentry.h" +#elif defined(__WXMOTIF__) + #include "wx/motif/textentry.h" +#elif defined(__WXPM__) + #include "wx/os2/textentry.h" #else // no platform-specific implementation of wxTextEntry yet class WXDLLIMPEXP_CORE wxTextEntry : public wxTextEntryBase