summaryrefslogtreecommitdiff
path: root/gtk/gtktreesortable.c
diff options
context:
space:
mode:
authorMatthias Clasen <mclasen@redhat.com>2004-11-30 21:45:26 +0000
committerMatthias Clasen <matthiasc@src.gnome.org>2004-11-30 21:45:26 +0000
commit35a3099ec676f0e4b62173154c377084c9f80640 (patch)
treecac2ba2c0f13122b9dad08e7642c4440686e2383 /gtk/gtktreesortable.c
parent126efafc406d5945663b5bd86c7833796e12e349 (diff)
downloadgtk+-35a3099ec676f0e4b62173154c377084c9f80640.tar.gz
Update the documentation to specify a more useful behaviour, which can be
2004-11-30 Matthias Clasen <mclasen@redhat.com> * gtk/gtktreesortable.c (gtk_tree_sortable_get_sort_column_id): Update the documentation to specify a more useful behaviour, which can be implemented with the multiple special values we have now. (#159984, Nicholas Rahn) * gtk/gtktreemodelsort.c (gtk_tree_model_sort_get_sort_column_id): * gtk/gtktreestore.c (gtk_tree_store_get_sort_column_id): * gtk/gtkliststore.c (gtk_list_store_get_sort_column_id): Update the implementations.
Diffstat (limited to 'gtk/gtktreesortable.c')
-rw-r--r--gtk/gtktreesortable.c10
1 files changed, 6 insertions, 4 deletions
diff --git a/gtk/gtktreesortable.c b/gtk/gtktreesortable.c
index 79a7d09287..8b0f5d6ac6 100644
--- a/gtk/gtktreesortable.c
+++ b/gtk/gtktreesortable.c
@@ -94,10 +94,12 @@ gtk_tree_sortable_sort_column_changed (GtkTreeSortable *sortable)
* @order: The #GtkSortType to be filled in
*
* Fills in @sort_column_id and @order with the current sort column and the
- * order, if applicable. If the sort column is not set, then FALSE is returned,
- * and the values in @sort_column_id and @order are unchanged.
- *
- * Return value: %TRUE, if the sort column has been set
+ * order. It returns %TRUE unless the @sort_column_id is
+ * %GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID or
+ * %GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID.
+ *
+ * Return value: %TRUE if the sort column is not one of the special sort
+ * column ids.
**/
gboolean
gtk_tree_sortable_get_sort_column_id (GtkTreeSortable *sortable,