added wxTextEntry::SetHint() (a.k.a. cue banner or placeholder string)

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@59263 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin
2009-03-02 12:25:01 +00:00
parent 231728361c
commit 63f7d5022e
21 changed files with 311 additions and 18 deletions

View File

@@ -351,6 +351,36 @@ public:
*/
virtual void SelectAll();
/**
Sets a hint shown in an empty unfocused text control.
The hints are usually used to indicate to the user what is supposed to
be entered into the given entry field, e.g. a common use of them is to
show an explanation of what can be entered in a wxSearchCtrl.
The hint is shown (usually greyed out) for an empty control until it
gets focus and is shown again if the control loses it and remains
empty. It won't be shown once the control has a non-empty value,
although it will be shown again if the control contents is cleared.
Because of this, it generally only makes sense to use hints with the
controls which are initially empty.
Notice that hints are known as <em>cue banners</em> under MSW or
<em>placeholder strings</em> under OS X.
@since 2.9.0
*/
virtual void SetHint(const wxString& hint);
/**
Returns the current hint string.
See SetHint() for more information about hints.
@since 2.9.0
*/
virtual wxString GetHint() const;
/**
Sets the new text control value.