X-Git-Url: http://pileus.org/git/?a=blobdiff_plain;f=gtk%2Fgtktreesortable.h;h=1023a1710699fa9e74eb7b51ecba7009211f5ed2;hb=aaedf5a35219b034a244730564b8fdf2b7d32540;hp=52dea7199db34e4d853adaa0316f91a31890583f;hpb=5e29973773d4e2177f234675cc2a2b2016aa9fbc;p=~andy%2Fgtk

diff --git a/gtk/gtktreesortable.h b/gtk/gtktreesortable.h
index 52dea7199..1023a1710 100644
--- a/gtk/gtktreesortable.h
+++ b/gtk/gtktreesortable.h
@@ -12,21 +12,19 @@
  * 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 <http://www.gnu.org/licenses/>.
  */
 
-#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
-#error "Only <gtk/gtk.h> can be included directly."
-#endif
-
 #ifndef __GTK_TREE_SORTABLE_H__
 #define __GTK_TREE_SORTABLE_H__
 
 
+#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
+#error "Only <gtk/gtk.h> can be included directly."
+#endif
+
+#include <gtk/gtkenums.h>
 #include <gtk/gtktreemodel.h>
-#include <gtk/gtktypeutils.h>
 
 
 G_BEGIN_DECLS
@@ -45,6 +43,28 @@ enum {
 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
+ * <literal>price_of(@a) - price_of(@b)</literal>.
+ *
+ * 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,
@@ -67,12 +87,12 @@ struct _GtkTreeSortableIface
 				      GtkSortType             order);
   void     (* set_sort_func)         (GtkTreeSortable        *sortable,
 				      gint                    sort_column_id,
-				      GtkTreeIterCompareFunc  func,
-				      gpointer                data,
+				      GtkTreeIterCompareFunc  sort_func,
+				      gpointer                user_data,
 				      GDestroyNotify          destroy);
   void     (* set_default_sort_func) (GtkTreeSortable        *sortable,
-				      GtkTreeIterCompareFunc  func,
-				      gpointer                data,
+				      GtkTreeIterCompareFunc  sort_func,
+				      gpointer                user_data,
 				      GDestroyNotify          destroy);
   gboolean (* has_default_sort_func) (GtkTreeSortable        *sortable);
 };