gtktreeselection.h 7.14 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14
/* gtktreeselection.h
 * Copyright (C) 2000  Red Hat, Inc.,  Jonathan Blandford <jrb@redhat.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
Javier Jardón's avatar
Javier Jardón committed
15
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
16 17
 */

18 19 20
#ifndef __GTK_TREE_SELECTION_H__
#define __GTK_TREE_SELECTION_H__

21
#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
22 23 24
#error "Only <gtk/gtk.h> can be included directly."
#endif

25 26
#include <gtk/gtktreeview.h>

27 28
G_BEGIN_DECLS

29 30

#define GTK_TYPE_TREE_SELECTION			(gtk_tree_selection_get_type ())
Manish Singh's avatar
Manish Singh committed
31 32 33 34 35
#define GTK_TREE_SELECTION(obj)			(G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_TREE_SELECTION, GtkTreeSelection))
#define GTK_TREE_SELECTION_CLASS(klass)		(G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_TREE_SELECTION, GtkTreeSelectionClass))
#define GTK_IS_TREE_SELECTION(obj)		(G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_TREE_SELECTION))
#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))
36

37 38
typedef struct _GtkTreeSelectionPrivate      GtkTreeSelectionPrivate;

39 40 41 42 43 44
/**
 * 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
45
 * @data: (closure): user data
46 47 48 49 50 51 52 53
 *
 * 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
 */
54 55 56
typedef gboolean (* GtkTreeSelectionFunc)    (GtkTreeSelection  *selection,
					      GtkTreeModel      *model,
					      GtkTreePath       *path,
Havoc Pennington's avatar
Havoc Pennington committed
57
                                              gboolean           path_currently_selected,
58
					      gpointer           data);
59 60 61 62 63 64

/**
 * GtkTreeSelectionForeachFunc:
 * @model: The #GtkTreeModel being viewed
 * @path: The #GtkTreePath of a selected row
 * @iter: A #GtkTreeIter pointing to a selected row
65
 * @data: (closure): user data
66 67 68 69
 *
 * 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.
 */
70
typedef void (* GtkTreeSelectionForeachFunc) (GtkTreeModel      *model,
71
					      GtkTreePath       *path,
72
					      GtkTreeIter       *iter,
73 74 75 76
					      gpointer           data);

struct _GtkTreeSelection
{
77
  /*< private >*/
78
  GObject parent;
79

80
  GtkTreeSelectionPrivate *priv;
81 82
};

83 84 85 86 87
/**
 * GtkTreeSelectionClass:
 * @parent_class: The parent class.
 * @changed: Signal emitted whenever the selection has (possibly) changed.
 */
88 89
struct _GtkTreeSelectionClass
{
90
  GObjectClass parent_class;
91

92 93
  /*< public >*/

94
  void (* changed) (GtkTreeSelection *selection);
95

96 97
  /*< private >*/

98 99 100 101 102
  /* Padding for future expansion */
  void (*_gtk_reserved1) (void);
  void (*_gtk_reserved2) (void);
  void (*_gtk_reserved3) (void);
  void (*_gtk_reserved4) (void);
103 104 105
};


106
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
107
GType            gtk_tree_selection_get_type            (void) G_GNUC_CONST;
108

109
GDK_AVAILABLE_IN_ALL
Havoc Pennington's avatar
Havoc Pennington committed
110
void             gtk_tree_selection_set_mode            (GtkTreeSelection            *selection,
111
							 GtkSelectionMode             type);
112
GDK_AVAILABLE_IN_ALL
113
GtkSelectionMode gtk_tree_selection_get_mode        (GtkTreeSelection            *selection);
114
GDK_AVAILABLE_IN_ALL
115 116
void             gtk_tree_selection_set_select_function (GtkTreeSelection            *selection,
							 GtkTreeSelectionFunc         func,
117
							 gpointer                     data,
118
							 GDestroyNotify               destroy);
119
GDK_AVAILABLE_IN_ALL
120
gpointer         gtk_tree_selection_get_user_data       (GtkTreeSelection            *selection);
121
GDK_AVAILABLE_IN_ALL
Havoc Pennington's avatar
Havoc Pennington committed
122
GtkTreeView*     gtk_tree_selection_get_tree_view       (GtkTreeSelection            *selection);
123

124
GDK_AVAILABLE_IN_ALL
125 126
GtkTreeSelectionFunc gtk_tree_selection_get_select_function (GtkTreeSelection        *selection);

127 128
/* Only meaningful if GTK_SELECTION_SINGLE or GTK_SELECTION_BROWSE is set */
/* Use selected_foreach or get_selected_rows for GTK_SELECTION_MULTIPLE */
129
GDK_AVAILABLE_IN_ALL
130
gboolean         gtk_tree_selection_get_selected        (GtkTreeSelection            *selection,
131
							 GtkTreeModel               **model,
132
							 GtkTreeIter                 *iter);
133
GDK_AVAILABLE_IN_ALL
134 135
GList *          gtk_tree_selection_get_selected_rows   (GtkTreeSelection            *selection,
                                                         GtkTreeModel               **model);
136
GDK_AVAILABLE_IN_ALL
137
gint             gtk_tree_selection_count_selected_rows (GtkTreeSelection            *selection);
138
GDK_AVAILABLE_IN_ALL
139 140 141
void             gtk_tree_selection_selected_foreach    (GtkTreeSelection            *selection,
							 GtkTreeSelectionForeachFunc  func,
							 gpointer                     data);
142
GDK_AVAILABLE_IN_ALL
143 144
void             gtk_tree_selection_select_path         (GtkTreeSelection            *selection,
							 GtkTreePath                 *path);
145
GDK_AVAILABLE_IN_ALL
146 147
void             gtk_tree_selection_unselect_path       (GtkTreeSelection            *selection,
							 GtkTreePath                 *path);
148
GDK_AVAILABLE_IN_ALL
149 150
void             gtk_tree_selection_select_iter         (GtkTreeSelection            *selection,
							 GtkTreeIter                 *iter);
151
GDK_AVAILABLE_IN_ALL
152 153
void             gtk_tree_selection_unselect_iter       (GtkTreeSelection            *selection,
							 GtkTreeIter                 *iter);
154
GDK_AVAILABLE_IN_ALL
155 156
gboolean         gtk_tree_selection_path_is_selected    (GtkTreeSelection            *selection,
							 GtkTreePath                 *path);
157
GDK_AVAILABLE_IN_ALL
158 159
gboolean         gtk_tree_selection_iter_is_selected    (GtkTreeSelection            *selection,
							 GtkTreeIter                 *iter);
160
GDK_AVAILABLE_IN_ALL
161
void             gtk_tree_selection_select_all          (GtkTreeSelection            *selection);
162
GDK_AVAILABLE_IN_ALL
163
void             gtk_tree_selection_unselect_all        (GtkTreeSelection            *selection);
164
GDK_AVAILABLE_IN_ALL
165 166 167
void             gtk_tree_selection_select_range        (GtkTreeSelection            *selection,
							 GtkTreePath                 *start_path,
							 GtkTreePath                 *end_path);
168
GDK_AVAILABLE_IN_ALL
169 170 171
void             gtk_tree_selection_unselect_range      (GtkTreeSelection            *selection,
                                                         GtkTreePath                 *start_path,
							 GtkTreePath                 *end_path);
172 173


174
G_END_DECLS
175 176

#endif /* __GTK_TREE_SELECTION_H__ */