AuroraMiddleware/gtk2
1
0
Fork 0
forked from AuroraMiddleware/gtk
Code Issues Pull Requests Projects Releases Wiki Activity

docs: Revise sorter docs a bit

Browse Source
This commit is contained in:
Matthias Clasen 2020-07-16 21:45:11 -04:00
parent 5e97df5058
commit 72d66dfcdd
3 changed files with 12 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/reference/gtk/gtk4-docs.xml
View File

@ -65,9 +65,9 @@
<section> <section>
<xi:include href="xml/gtksorter.xml" /> <xi:include href="xml/gtksorter.xml" />
<xi:include href="xml/gtkcustomsorter.xml" /> <xi:include href="xml/gtkcustomsorter.xml" />
<xi:include href="xml/gtkmultisorter.xml" />
<xi:include href="xml/gtkstringsorter.xml" /> <xi:include href="xml/gtkstringsorter.xml" />
<xi:include href="xml/gtknumericsorter.xml" /> <xi:include href="xml/gtknumericsorter.xml" />
<xi:include href="xml/gtkmultisorter.xml" />
</section> </section>
<xi:include href="xml/gtkselectionmodel.xml" /> <xi:include href="xml/gtkselectionmodel.xml" />
<section> <section>

10
gtk/gtkcustomsorter.c
View File

@ -27,7 +27,7 @@
/** /**
* SECTION:gtkcustomsorter * SECTION:gtkcustomsorter
* @Title: GtkCustomSorter * @Title: GtkCustomSorter
* @Short_description: Sorting with a callback * @Short_description: Sorting with a callbacks
* *
* GtkCustomSorter is a #GtkSorter implementation that sorts * GtkCustomSorter is a #GtkSorter implementation that sorts
* via a traditional #GCompareDataFunc callback. * via a traditional #GCompareDataFunc callback.
@ -108,7 +108,9 @@ gtk_custom_sorter_init (GtkCustomSorter *self)
* Creates a new #GtkSorter that works by calling * Creates a new #GtkSorter that works by calling
* @sort_func to compare items. * @sort_func to compare items.
* *
* Returns: a new #GTkSorter * If @sort_func is %NULL, all items are considered equal.
*
* Returns: a new #GtkSorter
*/ */
GtkSorter * GtkSorter *
gtk_custom_sorter_new (GCompareDataFunc sort_func, gtk_custom_sorter_new (GCompareDataFunc sort_func,
@ -129,10 +131,12 @@ gtk_custom_sorter_new (GCompareDataFunc sort_func,
* @self: a #GtkCustomSorter * @self: a #GtkCustomSorter
* @sort_func: (nullable): function to sort items * @sort_func: (nullable): function to sort items
* @user_data: (nullable): user data to pass to @match_func * @user_data: (nullable): user data to pass to @match_func
* @user_destroy: destory notify * @user_destroy: destroy notify for @user_data
* *
* Sets (or unsets) the function used for sorting items. * Sets (or unsets) the function used for sorting items.
* *
* If @sort_func is %NULL, all items are considered equal.
*
* If the sort func changes its sorting behavior, * If the sort func changes its sorting behavior,
* gtk_sorter_changed() needs to be called. * gtk_sorter_changed() needs to be called.
* *

5
gtk/gtksorter.c
View File

@ -37,9 +37,8 @@
* by calling gtk_sorter_compare() for pairs of items. * by calling gtk_sorter_compare() for pairs of items.
* *
* Sorters may change their sorting behavior through their lifetime. In that case, * Sorters may change their sorting behavior through their lifetime. In that case,
* they call gtk_sorter_changed(), which will emit the #GtkSorter::changed signal to * they will emit the #GtkSorter::changed signal to notify that the sort order is
* notify that the sort order is no longer valid and should be updated by calling * no longer valid and should be updated by calling gtk_sorter_compare() again.
* gtk_sorter_compare() again.
* *
* GTK provides various pre-made sorter implementations for common sorting operations. * GTK provides various pre-made sorter implementations for common sorting operations.
* #GtkColumnView has built-in support for sorting lists via the #GtkColumnViewColumn:sorter * #GtkColumnView has built-in support for sorting lists via the #GtkColumnViewColumn:sorter