2 * Copyright (C) 2000 Red Hat, Inc., Jonathan Blandford <jrb@redhat.com>
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Library General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Library General Public License for more details.
14 * You should have received a copy of the GNU Library General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
20 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
21 #error "Only <gtk/gtk.h> can be included directly."
24 #ifndef __GTK_TREE_SELECTION_H__
25 #define __GTK_TREE_SELECTION_H__
27 #include <gtk/gtktreeview.h>
32 #define GTK_TYPE_TREE_SELECTION (gtk_tree_selection_get_type ())
33 #define GTK_TREE_SELECTION(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_TREE_SELECTION, GtkTreeSelection))
34 #define GTK_TREE_SELECTION_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_TREE_SELECTION, GtkTreeSelectionClass))
35 #define GTK_IS_TREE_SELECTION(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_TREE_SELECTION))
36 #define GTK_IS_TREE_SELECTION_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_TREE_SELECTION))
37 #define GTK_TREE_SELECTION_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_TREE_SELECTION, GtkTreeSelectionClass))
40 * GtkTreeSelectionFunc:
41 * @selection: A #GtkTreeSelection
42 * @model: A #GtkTreeModel being viewed
43 * @path: The #GtkTreePath of the row in question
44 * @path_currently_selected: %TRUE, if the path is currently selected
47 * A function used by gtk_tree_selection_set_select_function() to filter
48 * whether or not a row may be selected. It is called whenever a row's
49 * state might change. A return value of %TRUE indicates to @selection
50 * that it is okay to change the selection.
52 * Returns: %TRUE, if the selection state of the row can be toggled
54 typedef gboolean (* GtkTreeSelectionFunc) (GtkTreeSelection *selection,
57 gboolean path_currently_selected,
61 * GtkTreeSelectionForeachFunc:
62 * @model: The #GtkTreeModel being viewed
63 * @path: The #GtkTreePath of a selected row
64 * @iter: A #GtkTreeIter pointing to a selected row
67 * A function used by gtk_tree_selection_selected_foreach() to map all
68 * selected rows. It will be called on every selected row in the view.
70 typedef void (* GtkTreeSelectionForeachFunc) (GtkTreeModel *model,
75 struct _GtkTreeSelection
81 GtkTreeView *GSEAL (tree_view);
82 GtkSelectionMode GSEAL (type);
83 GtkTreeSelectionFunc GSEAL (user_func);
84 gpointer GSEAL (user_data);
85 GDestroyNotify GSEAL (destroy);
88 struct _GtkTreeSelectionClass
90 GObjectClass parent_class;
92 void (* changed) (GtkTreeSelection *selection);
94 /* Padding for future expansion */
95 void (*_gtk_reserved1) (void);
96 void (*_gtk_reserved2) (void);
97 void (*_gtk_reserved3) (void);
98 void (*_gtk_reserved4) (void);
102 GType gtk_tree_selection_get_type (void) G_GNUC_CONST;
104 void gtk_tree_selection_set_mode (GtkTreeSelection *selection,
105 GtkSelectionMode type);
106 GtkSelectionMode gtk_tree_selection_get_mode (GtkTreeSelection *selection);
107 void gtk_tree_selection_set_select_function (GtkTreeSelection *selection,
108 GtkTreeSelectionFunc func,
110 GDestroyNotify destroy);
111 gpointer gtk_tree_selection_get_user_data (GtkTreeSelection *selection);
112 GtkTreeView* gtk_tree_selection_get_tree_view (GtkTreeSelection *selection);
114 GtkTreeSelectionFunc gtk_tree_selection_get_select_function (GtkTreeSelection *selection);
116 /* Only meaningful if GTK_SELECTION_SINGLE or GTK_SELECTION_BROWSE is set */
117 /* Use selected_foreach or get_selected_rows for GTK_SELECTION_MULTIPLE */
118 gboolean gtk_tree_selection_get_selected (GtkTreeSelection *selection,
119 GtkTreeModel **model,
121 GList * gtk_tree_selection_get_selected_rows (GtkTreeSelection *selection,
122 GtkTreeModel **model);
123 gint gtk_tree_selection_count_selected_rows (GtkTreeSelection *selection);
124 void gtk_tree_selection_selected_foreach (GtkTreeSelection *selection,
125 GtkTreeSelectionForeachFunc func,
127 void gtk_tree_selection_select_path (GtkTreeSelection *selection,
129 void gtk_tree_selection_unselect_path (GtkTreeSelection *selection,
131 void gtk_tree_selection_select_iter (GtkTreeSelection *selection,
133 void gtk_tree_selection_unselect_iter (GtkTreeSelection *selection,
135 gboolean gtk_tree_selection_path_is_selected (GtkTreeSelection *selection,
137 gboolean gtk_tree_selection_iter_is_selected (GtkTreeSelection *selection,
139 void gtk_tree_selection_select_all (GtkTreeSelection *selection);
140 void gtk_tree_selection_unselect_all (GtkTreeSelection *selection);
141 void gtk_tree_selection_select_range (GtkTreeSelection *selection,
142 GtkTreePath *start_path,
143 GtkTreePath *end_path);
144 void gtk_tree_selection_unselect_range (GtkTreeSelection *selection,
145 GtkTreePath *start_path,
146 GtkTreePath *end_path);
151 #endif /* __GTK_TREE_SELECTION_H__ */