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
class WXDLLIMPEXP_CORE wxTextEntryBase
{
public:
- wxTextEntryBase() { m_eventsBlock = 0; }
- virtual ~wxTextEntryBase() { }
+ wxTextEntryBase() { m_eventsBlock = 0; m_hintData = NULL; }
+ virtual ~wxTextEntryBase();
// accessing the value
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
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
};
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
//
// 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__