// and should probably be replaced with int anyhow)
typedef long wxTextPos;
+class WXDLLIMPEXP_FWD_BASE wxArrayString;
+class WXDLLIMPEXP_FWD_CORE wxTextEntryHintData;
+class WXDLLIMPEXP_FWD_CORE wxWindow;
+
// ----------------------------------------------------------------------------
// 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 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
// ---------
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
+ // ---------------
+
+ // these functions allow to auto-complete the text already entered into the
+ // control using either the given fixed list of strings, the paths from the
+ // file system or, in the future, an arbitrary user-defined completer
+ //
+ // they all return true if completion was enabled or false on error (most
+ // commonly meaning that this functionality is not available under the
+ // current platform)
+
+ virtual bool AutoComplete(const wxArrayString& WXUNUSED(choices))
+ {
+ return false;
+ }
+
+ virtual bool AutoCompleteFileNames() { return false; }
+
+
// status
// ------
+
virtual bool IsEditable() const = 0;
virtual void SetEditable(bool editable) = 0;
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;
+
+
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;
+
// class which should be used to temporarily disable text change events
//
{
public:
EventsSuppressor(wxTextEntryBase *text, bool suppress = true)
+ : m_text(text),
+ m_suppress(suppress)
{
- m_suppress = suppress;
if ( m_suppress )
- {
- m_text = text;
m_text->SuppressTextChangedEvents();
- }
}
~EventsSuppressor()
wxTextEntryBase *m_text;
bool m_suppress;
};
+
friend class EventsSuppressor;
// return true if the events are currently not suppressed
// 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__
#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