X-Git-Url: http://pileus.org/git/?a=blobdiff_plain;f=gtk%2Fgtktreesortable.h;h=1023a1710699fa9e74eb7b51ecba7009211f5ed2;hb=bb3c56abe2e7916126bd4f8234dee080b5381941;hp=a84a664f817b872d2bf5c9fe4930c68e0090dcd7;hpb=55704fc7c1b5429bf8cc7e8100893b01898a9fe8;p=~andy%2Fgtk

diff --git a/gtk/gtktreesortable.h b/gtk/gtktreesortable.h
index a84a664f8..1023a1710 100644
--- a/gtk/gtktreesortable.h
+++ b/gtk/gtktreesortable.h
@@ -12,17 +12,20 @@
  * 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/>.
  */
 
 #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
 
@@ -33,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
+ * <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,
@@ -61,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);
 };
 
@@ -85,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__ */