summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMartin Norback <mback@src.gnome.org>1999-11-11 11:20:00 +0000
committerMartin Norback <mback@src.gnome.org>1999-11-11 11:20:00 +0000
commit25ae5a77a2fdb0ff52a80b85450eeae2fc9a975f (patch)
treee40e250ca27bb303dd394a90eff9bc23a6502d3a
parentcfb026651878dde2b0af21ff8de470527ed5f825 (diff)
downloadgtk+-25ae5a77a2fdb0ff52a80b85450eeae2fc9a975f.tar.gz
Added some information about sorting
-rw-r--r--docs/reference/ChangeLog4
-rw-r--r--docs/reference/gtk/tmpl/gtkclist.sgml26
2 files changed, 20 insertions, 10 deletions
diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index 49f23e7ef1..92821012c0 100644
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,3 +1,7 @@
+1999-09-22 Martin Norbäck <d95mback@dtek.chalmers.se>
+
+ * gtk/tmpl/gtkclist.sgml: Added information about the sorting functions
+
Tue Oct 26 16:50:15 1999 Owen Taylor <otaylor@redhat.com>
* gtk/tmpl/gtkrc.sgml: Added information about widget
diff --git a/docs/reference/gtk/tmpl/gtkclist.sgml b/docs/reference/gtk/tmpl/gtkclist.sgml
index 28138a5ccb..01d031d3d6 100644
--- a/docs/reference/gtk/tmpl/gtkclist.sgml
+++ b/docs/reference/gtk/tmpl/gtkclist.sgml
@@ -959,46 +959,52 @@ automatically to data in the row.
<!-- ##### FUNCTION gtk_clist_set_compare_func ##### -->
<para>
-
+Sets the compare function of the #GtkClist to cmp_func. If cmp_func is NULL,
+then the default compare function is used. The default compare function sorts
+ascending or with the type set by gtk_clist_set_sort_type() by the column set
+by gtk_clist_set_sort_column().
</para>
@clist: The #GtkCList to affect.
-@cmp_func:
+@cmp_func: The #GtkCompareFunction to use.
<!-- ##### FUNCTION gtk_clist_set_sort_column ##### -->
<para>
-
+Sets the sort column of the clist. The sort column is used by the
+default compare function to determine which column to sort by.
</para>
@clist: The #GtkCList to affect.
-@column:
+@column: The column to sort by
<!-- ##### FUNCTION gtk_clist_set_sort_type ##### -->
<para>
-
+Sets the sort type of the #GtkClist. This is either GTK_SORT_ASCENDING for
+ascening sort or GTK_SORT_DESCENDING for descending sort.
</para>
@clist: The #GtkCList to affect.
-@sort_type:
+@sort_type: the #GtkSortType to use
<!-- ##### FUNCTION gtk_clist_sort ##### -->
<para>
-
+Sorts the #GtkClist according to the current compare function, which
+can be set with the gtk_clist_set_compare_func() function.
</para>
-@clist: The #GtkCList to affect.
+@clist: The #GtkCList to sort.
<!-- ##### FUNCTION gtk_clist_set_auto_sort ##### -->
<para>
-
+Turns on or off auto sort of the #GtkCList. If auto sort is on, then the CList will be resorted when a row is inserted into the CList.
</para>
@clist: The #GtkCList to affect.
-@auto_sort:
+@auto_sort: whether auto sort should be on or off
<!-- ##### FUNCTION gtk_clist_columns_autosize ##### -->