AuroraMiddleware/gtk
1
0
Fork 1
mirror of https://gitlab.gnome.org/GNOME/gtk.git synced 2024-12-28 22:41:43 +00:00
Code Issues Projects Releases Wiki Activity

searchentry: Update the docs slightly

Browse Source 
Update the docs to get closer to describing reality.
This commit is contained in:
Matthias Clasen 2020-06-25 14:14:33 -04:00
parent d0e56106fe
commit 1f410faccb
1 changed files with 3 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
gtk/gtksearchentry.c
View File

@ -49,17 +49,14 @@
* @Short_description: An entry which shows a search icon * @Short_description: An entry which shows a search icon
* @Title: GtkSearchEntry * @Title: GtkSearchEntry
* *
* #GtkSearchEntry is a subclass of #GtkEntry that has been * #GtkSearchEntry is an entry widget that has been tailored for use
* tailored for use as a search entry. * as a search entry. The main aPI for interacting with a GtkSearchEntry
* as entry is the #GtkEditable interface.
* *
* It will show an inactive symbolic “find” icon when the search * It will show an inactive symbolic “find” icon when the search
* entry is empty, and a symbolic “clear” icon when there is text. * entry is empty, and a symbolic “clear” icon when there is text.
* Clicking on the “clear” icon will empty the search entry. * Clicking on the “clear” icon will empty the search entry.
* *
* Note that the search/clear icon is shown using a secondary
* icon, and thus does not work if you are using the secondary
* icon position for some other purpose.
*
* To make filtering appear more reactive, it is a good idea to * To make filtering appear more reactive, it is a good idea to
* not react to every change in the entry text immediately, but * not react to every change in the entry text immediately, but
* only after a short delay. To support this, #GtkSearchEntry * only after a short delay. To support this, #GtkSearchEntry