]> Pileus Git - ~andy/gtk/blobdiff - gtk/gtktreeselection.h
Fixed merge conflicts from cherry-pick of construct-only GtkTreeViewColumn:cell-area...
[~andy/gtk] / gtk / gtktreeselection.h
index 6036dfc9d2cc088b4b1b6ba6732cb18c5f43c670..38a1f702e33770bbc1b59090c1d8d885f7de760e 100644 (file)
  * Boston, MA 02111-1307, USA.
  */
 
-#if defined(GTK_DISABLE_SINGLE_INCLUDES) && !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
+#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
 #error "Only <gtk/gtk.h> can be included directly."
 #endif
 
 #ifndef __GTK_TREE_SELECTION_H__
 #define __GTK_TREE_SELECTION_H__
 
-#include <glib-object.h>
 #include <gtk/gtktreeview.h>
 
-
 G_BEGIN_DECLS
 
 
@@ -38,11 +36,37 @@ G_BEGIN_DECLS
 #define GTK_IS_TREE_SELECTION_CLASS(klass)     (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_TREE_SELECTION))
 #define GTK_TREE_SELECTION_GET_CLASS(obj)      (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_TREE_SELECTION, GtkTreeSelectionClass))
 
+/**
+ * GtkTreeSelectionFunc:
+ * @selection: A #GtkTreeSelection
+ * @model: A #GtkTreeModel being viewed
+ * @path: The #GtkTreePath of the row in question
+ * @path_currently_selected: %TRUE, if the path is currently selected
+ * @data: user data
+ *
+ * A function used by gtk_tree_selection_set_select_function() to filter
+ * whether or not a row may be selected.  It is called whenever a row's
+ * state might change.  A return value of %TRUE indicates to @selection
+ * that it is okay to change the selection.
+ *
+ * Returns: %TRUE, if the selection state of the row can be toggled
+ */
 typedef gboolean (* GtkTreeSelectionFunc)    (GtkTreeSelection  *selection,
                                              GtkTreeModel      *model,
                                              GtkTreePath       *path,
                                               gboolean           path_currently_selected,
                                              gpointer           data);
+
+/**
+ * GtkTreeSelectionForeachFunc:
+ * @model: The #GtkTreeModel being viewed
+ * @path: The #GtkTreePath of a selected row
+ * @iter: A #GtkTreeIter pointing to a selected row
+ * @data: user data
+ *
+ * A function used by gtk_tree_selection_selected_foreach() to map all
+ * selected rows.  It will be called on every selected row in the view.
+ */
 typedef void (* GtkTreeSelectionForeachFunc) (GtkTreeModel      *model,
                                              GtkTreePath       *path,
                                              GtkTreeIter       *iter,
@@ -54,11 +78,11 @@ struct _GtkTreeSelection
 
   /*< private >*/
 
-  GtkTreeView *tree_view;
-  GtkSelectionMode type;
-  GtkTreeSelectionFunc user_func;
-  gpointer user_data;
-  GDestroyNotify destroy;
+  GtkTreeView *GSEAL (tree_view);
+  GtkSelectionMode GSEAL (type);
+  GtkTreeSelectionFunc GSEAL (user_func);
+  gpointer GSEAL (user_data);
+  GDestroyNotify GSEAL (destroy);
 };
 
 struct _GtkTreeSelectionClass
@@ -87,6 +111,8 @@ void             gtk_tree_selection_set_select_function (GtkTreeSelection
 gpointer         gtk_tree_selection_get_user_data       (GtkTreeSelection            *selection);
 GtkTreeView*     gtk_tree_selection_get_tree_view       (GtkTreeSelection            *selection);
 
+GtkTreeSelectionFunc gtk_tree_selection_get_select_function (GtkTreeSelection        *selection);
+
 /* Only meaningful if GTK_SELECTION_SINGLE or GTK_SELECTION_BROWSE is set */
 /* Use selected_foreach or get_selected_rows for GTK_SELECTION_MULTIPLE */
 gboolean         gtk_tree_selection_get_selected        (GtkTreeSelection            *selection,
@@ -122,5 +148,4 @@ void             gtk_tree_selection_unselect_range      (GtkTreeSelection
 
 G_END_DECLS
 
-
 #endif /* __GTK_TREE_SELECTION_H__ */