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.
19 #ifndef __GTK_TREE_VIEW_H__
20 #define __GTK_TREE_VIEW_H__
22 #include <gtk/gtkwidget.h>
23 #include <gtk/gtkcontainer.h>
24 #include <gtk/gtktreemodel.h>
25 #include <gtk/gtktreeviewcolumn.h>
26 #include <gtk/gtkdnd.h>
30 #endif /* __cplusplus */
34 /* drop before/after this row */
35 GTK_TREE_VIEW_DROP_BEFORE,
36 GTK_TREE_VIEW_DROP_AFTER,
37 /* drop as a child of this row (with fallback to before or after
38 * if into is not possible)
40 GTK_TREE_VIEW_DROP_INTO_OR_BEFORE,
41 GTK_TREE_VIEW_DROP_INTO_OR_AFTER
42 } GtkTreeViewDropPosition;
44 #define GTK_TYPE_TREE_VIEW (gtk_tree_view_get_type ())
45 #define GTK_TREE_VIEW(obj) (GTK_CHECK_CAST ((obj), GTK_TYPE_TREE_VIEW, GtkTreeView))
46 #define GTK_TREE_VIEW_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), GTK_TYPE_TREE_VIEW, GtkTreeViewClass))
47 #define GTK_IS_TREE_VIEW(obj) (GTK_CHECK_TYPE ((obj), GTK_TYPE_TREE_VIEW))
48 #define GTK_IS_TREE_VIEW_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((obj), GTK_TYPE_TREE_VIEW))
49 #define GTK_TREE_VIEW_GET_CLASS(obj) (GTK_CHECK_GET_CLASS ((obj), GTK_TYPE_TREE_VIEW, GtkTreeViewClass))
51 typedef struct _GtkTreeView GtkTreeView;
52 typedef struct _GtkTreeViewClass GtkTreeViewClass;
53 typedef struct _GtkTreeViewPrivate GtkTreeViewPrivate;
54 typedef struct _GtkTreeSelection GtkTreeSelection;
55 typedef struct _GtkTreeSelectionClass GtkTreeSelectionClass;
61 GtkTreeViewPrivate *priv;
64 struct _GtkTreeViewClass
66 GtkContainerClass parent_class;
68 void (* set_scroll_adjustments) (GtkTreeView *tree_view,
69 GtkAdjustment *hadjustment,
70 GtkAdjustment *vadjustment);
71 void (* row_activated) (GtkTreeView *tree_view,
73 GtkTreeViewColumn *column);
74 gboolean (* test_expand_row) (GtkTreeView *tree_view,
77 gboolean (* test_collapse_row) (GtkTreeView *tree_view,
80 void (* row_expanded) (GtkTreeView *tree_view,
83 void (* row_collapsed) (GtkTreeView *tree_view,
86 void (* columns_changed) (GtkTreeView *tree_view);
88 /* Key Binding signals */
89 void (* move_cursor) (GtkTreeView *tree_view,
92 void (* select_all) (GtkTreeView *tree_view);
93 void (* select_cursor_row) (GtkTreeView *tree_view,
94 gboolean start_editing);
95 void (* toggle_cursor_row) (GtkTreeView *tree_view);
96 void (* expand_collapse_cursor_row) (GtkTreeView *tree_view,
100 void (* select_cursor_parent) (GtkTreeView *tree_view);
101 void (* start_interactive_search) (GtkTreeView *tree_view);
105 typedef gboolean (* GtkTreeViewColumnDropFunc) (GtkTreeView *tree_view,
106 GtkTreeViewColumn *column,
107 GtkTreeViewColumn *prev_column,
108 GtkTreeViewColumn *next_column,
110 typedef gboolean (* GtkTreeViewDraggableFunc) (GtkTreeView *tree_view,
111 GdkDragContext *context,
114 typedef void (* GtkTreeViewMappingFunc) (GtkTreeView *tree_view,
117 typedef gboolean (* GtkTreeViewDroppableFunc) (GtkTreeView *tree_view,
118 GdkDragContext *context,
120 GtkTreeViewDropPosition *pos,
122 typedef gboolean (*GtkTreeViewSearchEqualFunc) (GtkTreeModel *model,
126 gpointer search_data);
130 GtkType gtk_tree_view_get_type (void);
131 GtkWidget *gtk_tree_view_new (void);
132 GtkWidget *gtk_tree_view_new_with_model (GtkTreeModel *model);
135 GtkTreeModel *gtk_tree_view_get_model (GtkTreeView *tree_view);
136 void gtk_tree_view_set_model (GtkTreeView *tree_view,
137 GtkTreeModel *model);
138 GtkTreeSelection *gtk_tree_view_get_selection (GtkTreeView *tree_view);
139 GtkAdjustment *gtk_tree_view_get_hadjustment (GtkTreeView *tree_view);
140 void gtk_tree_view_set_hadjustment (GtkTreeView *tree_view,
141 GtkAdjustment *adjustment);
142 GtkAdjustment *gtk_tree_view_get_vadjustment (GtkTreeView *tree_view);
143 void gtk_tree_view_set_vadjustment (GtkTreeView *tree_view,
144 GtkAdjustment *adjustment);
145 gboolean gtk_tree_view_get_headers_visible (GtkTreeView *tree_view);
146 void gtk_tree_view_set_headers_visible (GtkTreeView *tree_view,
147 gboolean headers_visible);
148 void gtk_tree_view_columns_autosize (GtkTreeView *tree_view);
149 void gtk_tree_view_set_headers_clickable (GtkTreeView *tree_view,
151 void gtk_tree_view_set_rules_hint (GtkTreeView *tree_view,
153 gboolean gtk_tree_view_get_rules_hint (GtkTreeView *tree_view);
155 /* Column funtions */
156 gint gtk_tree_view_append_column (GtkTreeView *tree_view,
157 GtkTreeViewColumn *column);
158 gint gtk_tree_view_remove_column (GtkTreeView *tree_view,
159 GtkTreeViewColumn *column);
160 gint gtk_tree_view_insert_column (GtkTreeView *tree_view,
161 GtkTreeViewColumn *column,
163 gint gtk_tree_view_insert_column_with_attributes (GtkTreeView *tree_view,
166 GtkCellRenderer *cell,
168 gint gtk_tree_view_insert_column_with_data_func (GtkTreeView *tree_view,
171 GtkCellRenderer *cell,
172 GtkTreeCellDataFunc func,
174 GDestroyNotify dnotify);
175 GtkTreeViewColumn *gtk_tree_view_get_column (GtkTreeView *tree_view,
177 GList *gtk_tree_view_get_columns (GtkTreeView *tree_view);
178 void gtk_tree_view_move_column_after (GtkTreeView *tree_view,
179 GtkTreeViewColumn *column,
180 GtkTreeViewColumn *base_column);
181 void gtk_tree_view_set_expander_column (GtkTreeView *tree_view,
182 GtkTreeViewColumn *column);
183 GtkTreeViewColumn *gtk_tree_view_get_expander_column (GtkTreeView *tree_view);
184 void gtk_tree_view_set_column_drag_function (GtkTreeView *tree_view,
185 GtkTreeViewColumnDropFunc func,
187 GtkDestroyNotify destroy);
190 void gtk_tree_view_scroll_to_point (GtkTreeView *tree_view,
193 void gtk_tree_view_scroll_to_cell (GtkTreeView *tree_view,
195 GtkTreeViewColumn *column,
199 void gtk_tree_view_row_activated (GtkTreeView *tree_view,
201 GtkTreeViewColumn *column);
202 void gtk_tree_view_expand_all (GtkTreeView *tree_view);
203 void gtk_tree_view_collapse_all (GtkTreeView *tree_view);
204 gboolean gtk_tree_view_expand_row (GtkTreeView *tree_view,
207 gboolean gtk_tree_view_collapse_row (GtkTreeView *tree_view,
209 void gtk_tree_view_map_expanded_rows (GtkTreeView *tree_view,
210 GtkTreeViewMappingFunc func,
212 gboolean gtk_tree_view_row_expanded (GtkTreeView *tree_view,
214 void gtk_tree_view_set_reorderable (GtkTreeView *tree_view,
215 gboolean reorderable);
216 gboolean gtk_tree_view_get_reorderable (GtkTreeView *tree_view);
217 void gtk_tree_view_set_cursor (GtkTreeView *tree_view,
219 GtkTreeViewColumn *focus_column,
220 gboolean start_editing);
221 void gtk_tree_view_get_cursor (GtkTreeView *tree_view,
223 GtkTreeViewColumn **focus_column);
226 /* Layout information */
227 gboolean gtk_tree_view_get_path_at_pos (GtkTreeView *tree_view,
232 GtkTreeViewColumn **column,
235 void gtk_tree_view_get_cell_area (GtkTreeView *tree_view,
237 GtkTreeViewColumn *column,
239 void gtk_tree_view_get_background_area (GtkTreeView *tree_view,
241 GtkTreeViewColumn *column,
243 void gtk_tree_view_get_visible_rect (GtkTreeView *tree_view,
244 GdkRectangle *visible_rect);
245 void gtk_tree_view_widget_to_tree_coords (GtkTreeView *tree_view,
250 void gtk_tree_view_tree_to_widget_coords (GtkTreeView *tree_view,
256 /* Drag-and-Drop support */
257 void gtk_tree_view_set_rows_drag_source (GtkTreeView *tree_view,
258 GdkModifierType start_button_mask,
259 const GtkTargetEntry *targets,
261 GdkDragAction actions,
262 GtkTreeViewDraggableFunc row_draggable_func,
264 void gtk_tree_view_set_rows_drag_dest (GtkTreeView *tree_view,
265 const GtkTargetEntry *targets,
267 GdkDragAction actions,
268 GtkTreeViewDroppableFunc location_droppable_func,
270 void gtk_tree_view_unset_rows_drag_source (GtkTreeView *tree_view);
271 void gtk_tree_view_unset_rows_drag_dest (GtkTreeView *tree_view);
274 /* These are useful to implement your own custom stuff. */
275 void gtk_tree_view_set_drag_dest_row (GtkTreeView *tree_view,
277 GtkTreeViewDropPosition pos);
278 void gtk_tree_view_get_drag_dest_row (GtkTreeView *tree_view,
280 GtkTreeViewDropPosition *pos);
281 gboolean gtk_tree_view_get_dest_row_at_pos (GtkTreeView *tree_view,
285 GtkTreeViewDropPosition *pos);
286 GdkPixmap *gtk_tree_view_create_row_drag_icon (GtkTreeView *tree_view,
289 /* Interactive search */
290 void gtk_tree_view_set_enable_search (GtkTreeView *tree_view,
291 gboolean enable_search);
292 gboolean gtk_tree_view_get_enable_search (GtkTreeView *tree_view);
293 gint gtk_tree_view_get_search_column (GtkTreeView *tree_view);
294 void gtk_tree_view_set_search_column (GtkTreeView *tree_view,
296 GtkTreeViewSearchEqualFunc gtk_tree_view_get_search_equal_func (GtkTreeView *tree_view);
297 void gtk_tree_view_set_search_equal_func (GtkTreeView *tree_view,
298 GtkTreeViewSearchEqualFunc search_equal_func,
299 gpointer search_user_data,
300 GtkDestroyNotify search_destroy);
302 /* This function should really never be used. It is just for use by ATK.
304 typedef void (* GtkTreeDestroyCountFunc) (GtkTreeView *tree_view,
308 void gtk_tree_view_set_destroy_count_func (GtkTreeView *tree_view,
309 GtkTreeDestroyCountFunc func,
311 GtkDestroyNotify destroy);
318 #endif /* __cplusplus */
321 #endif /* __GTK_TREE_VIEW_H__ */