X-Git-Url: http://pileus.org/git/?a=blobdiff_plain;f=gtk%2Fgtktreesortable.h;h=1023a1710699fa9e74eb7b51ecba7009211f5ed2;hb=320613c439c6c7eeb5bc64685522195e0a6adc4e;hp=73df07b227a114f714c1e5a4bfa36949cdf440e2;hpb=8ccfa3edb95ed3fb5d0ba4f3c0a46e8c729a768e;p=~andy%2Fgtk
diff --git a/gtk/gtktreesortable.h b/gtk/gtktreesortable.h
index 73df07b22..1023a1710 100644
--- a/gtk/gtktreesortable.h
+++ b/gtk/gtktreesortable.h
@@ -12,16 +12,21 @@
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
- * License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * License along with this library. If not, see .
*/
#ifndef __GTK_TREE_SORTABLE_H__
#define __GTK_TREE_SORTABLE_H__
+
+#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
+#error "Only can be included directly."
+#endif
+
+#include
#include
+
G_BEGIN_DECLS
#define GTK_TYPE_TREE_SORTABLE (gtk_tree_sortable_get_type ())
@@ -31,12 +36,35 @@ G_BEGIN_DECLS
#define GTK_TREE_SORTABLE_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), GTK_TYPE_TREE_SORTABLE, GtkTreeSortableIface))
enum {
- GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID = -1
+ GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID = -1,
+ GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID = -2
};
typedef struct _GtkTreeSortable GtkTreeSortable; /* Dummy typedef */
typedef struct _GtkTreeSortableIface GtkTreeSortableIface;
+/**
+ * GtkTreeIterCompareFunc:
+ * @model: The #GtkTreeModel the comparison is within
+ * @a: A #GtkTreeIter in @model
+ * @b: Another #GtkTreeIter in @model
+ * @user_data: Data passed when the compare func is assigned e.g. by
+ * gtk_tree_sortable_set_sort_func()
+ *
+ * A GtkTreeIterCompareFunc should return a negative integer, zero, or a positive
+ * integer if @a sorts before @b, @a sorts with @b, or @a sorts after @b
+ * respectively. If two iters compare as equal, their order in the sorted model
+ * is undefined. In order to ensure that the #GtkTreeSortable behaves as
+ * expected, the GtkTreeIterCompareFunc must define a partial order on
+ * the model, i.e. it must be reflexive, antisymmetric and transitive.
+ *
+ * For example, if @model is a product catalogue, then a compare function
+ * for the "price" column could be one which returns
+ * price_of(@a) - price_of(@b).
+ *
+ * Returns: a negative integer, zero or a positive integer depending on whether
+ * @a sorts before, with or after @b
+ */
typedef gint (* GtkTreeIterCompareFunc) (GtkTreeModel *model,
GtkTreeIter *a,
GtkTreeIter *b,
@@ -59,13 +87,13 @@ struct _GtkTreeSortableIface
GtkSortType order);
void (* set_sort_func) (GtkTreeSortable *sortable,
gint sort_column_id,
- GtkTreeIterCompareFunc func,
- gpointer data,
- GtkDestroyNotify destroy);
+ GtkTreeIterCompareFunc sort_func,
+ gpointer user_data,
+ GDestroyNotify destroy);
void (* set_default_sort_func) (GtkTreeSortable *sortable,
- GtkTreeIterCompareFunc func,
- gpointer data,
- GtkDestroyNotify destroy);
+ GtkTreeIterCompareFunc sort_func,
+ gpointer user_data,
+ GDestroyNotify destroy);
gboolean (* has_default_sort_func) (GtkTreeSortable *sortable);
};
@@ -83,14 +111,13 @@ void gtk_tree_sortable_set_sort_func (GtkTreeSortable *sortab
gint sort_column_id,
GtkTreeIterCompareFunc sort_func,
gpointer user_data,
- GtkDestroyNotify destroy);
+ GDestroyNotify destroy);
void gtk_tree_sortable_set_default_sort_func (GtkTreeSortable *sortable,
GtkTreeIterCompareFunc sort_func,
gpointer user_data,
- GtkDestroyNotify destroy);
+ GDestroyNotify destroy);
gboolean gtk_tree_sortable_has_default_sort_func (GtkTreeSortable *sortable);
-
-
+
G_END_DECLS
#endif /* __GTK_TREE_SORTABLE_H__ */