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_VIEW_H__
25 #define __GTK_TREE_VIEW_H__
27 #include <gtk/gtkcontainer.h>
28 #include <gtk/gtktreemodel.h>
29 #include <gtk/gtktreeviewcolumn.h>
30 #include <gtk/gtkdnd.h>
31 #include <gtk/gtkentry.h>
36 * GtkTreeViewDropPosition:
37 * @GTK_TREE_VIEW_DROP_BEFORE: dropped row is inserted before
38 * @GTK_TREE_VIEW_DROP_AFTER: dropped row is inserted after
39 * @GTK_TREE_VIEW_DROP_INTO_OR_BEFORE: dropped row becomes a child or is inserted before
40 * @GTK_TREE_VIEW_DROP_INTO_OR_AFTER: dropped row becomes a child or is inserted after
42 * An enum for determining where a dropped row goes.
46 /* drop before/after this row */
47 GTK_TREE_VIEW_DROP_BEFORE,
48 GTK_TREE_VIEW_DROP_AFTER,
49 /* drop as a child of this row (with fallback to before or after
50 * if into is not possible)
52 GTK_TREE_VIEW_DROP_INTO_OR_BEFORE,
53 GTK_TREE_VIEW_DROP_INTO_OR_AFTER
54 } GtkTreeViewDropPosition;
56 #define GTK_TYPE_TREE_VIEW (gtk_tree_view_get_type ())
57 #define GTK_TREE_VIEW(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_TREE_VIEW, GtkTreeView))
58 #define GTK_TREE_VIEW_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_TREE_VIEW, GtkTreeViewClass))
59 #define GTK_IS_TREE_VIEW(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_TREE_VIEW))
60 #define GTK_IS_TREE_VIEW_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_TREE_VIEW))
61 #define GTK_TREE_VIEW_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_TREE_VIEW, GtkTreeViewClass))
63 typedef struct _GtkTreeView GtkTreeView;
64 typedef struct _GtkTreeViewClass GtkTreeViewClass;
65 typedef struct _GtkTreeViewPrivate GtkTreeViewPrivate;
66 typedef struct _GtkTreeSelection GtkTreeSelection;
67 typedef struct _GtkTreeSelectionClass GtkTreeSelectionClass;
74 GtkTreeViewPrivate *priv;
77 struct _GtkTreeViewClass
79 GtkContainerClass parent_class;
81 void (* row_activated) (GtkTreeView *tree_view,
83 GtkTreeViewColumn *column);
84 gboolean (* test_expand_row) (GtkTreeView *tree_view,
87 gboolean (* test_collapse_row) (GtkTreeView *tree_view,
90 void (* row_expanded) (GtkTreeView *tree_view,
93 void (* row_collapsed) (GtkTreeView *tree_view,
96 void (* columns_changed) (GtkTreeView *tree_view);
97 void (* cursor_changed) (GtkTreeView *tree_view);
99 /* Key Binding signals */
100 gboolean (* move_cursor) (GtkTreeView *tree_view,
101 GtkMovementStep step,
103 gboolean (* select_all) (GtkTreeView *tree_view);
104 gboolean (* unselect_all) (GtkTreeView *tree_view);
105 gboolean (* select_cursor_row) (GtkTreeView *tree_view,
106 gboolean start_editing);
107 gboolean (* toggle_cursor_row) (GtkTreeView *tree_view);
108 gboolean (* expand_collapse_cursor_row) (GtkTreeView *tree_view,
112 gboolean (* select_cursor_parent) (GtkTreeView *tree_view);
113 gboolean (* start_interactive_search) (GtkTreeView *tree_view);
115 /* Padding for future expansion */
116 void (*_gtk_reserved1) (void);
117 void (*_gtk_reserved2) (void);
118 void (*_gtk_reserved3) (void);
119 void (*_gtk_reserved4) (void);
120 void (*_gtk_reserved5) (void);
121 void (*_gtk_reserved6) (void);
122 void (*_gtk_reserved7) (void);
123 void (*_gtk_reserved8) (void);
127 * GtkTreeViewColumnDropFunc:
128 * @tree_view: A #GtkTreeView
129 * @column: The #GtkTreeViewColumn being dragged
130 * @prev_column: A #GtkTreeViewColumn on one side of @column
131 * @next_column: A #GtkTreeViewColumn on the other side of @column
132 * @data: (closure): user data
134 * Function type for determining whether @column can be dropped in a
135 * particular spot (as determined by @prev_column and @next_column). In
136 * left to right locales, @prev_column is on the left of the potential drop
137 * spot, and @next_column is on the right. In right to left mode, this is
138 * reversed. This function should return %TRUE if the spot is a valid drop
139 * spot. Please note that returning %TRUE does not actually indicate that
140 * the column drop was made, but is meant only to indicate a possible drop
143 * Returns: %TRUE, if @column can be dropped in this spot
145 typedef gboolean (* GtkTreeViewColumnDropFunc) (GtkTreeView *tree_view,
146 GtkTreeViewColumn *column,
147 GtkTreeViewColumn *prev_column,
148 GtkTreeViewColumn *next_column,
152 * GtkTreeViewMappingFunc:
153 * @tree_view: A #GtkTreeView
154 * @path: The path that's expanded
155 * @user_data: user data
157 * Function used for gtk_tree_view_map_expanded_rows().
159 typedef void (* GtkTreeViewMappingFunc) (GtkTreeView *tree_view,
164 * GtkTreeViewSearchEqualFunc:
165 * @model: the #GtkTreeModel being searched
166 * @column: the search column set by gtk_tree_view_set_search_column()
167 * @key: the key string to compare with
168 * @iter: a #GtkTreeIter pointing the row of @model that should be compared
170 * @search_data: (closure): user data from gtk_tree_view_set_search_equal_func()
172 * A function used for checking whether a row in @model matches
173 * a search key string entered by the user. Note the return value
174 * is reversed from what you would normally expect, though it
175 * has some similarity to strcmp() returning 0 for equal strings.
177 * Returns: %FALSE if the row matches, %TRUE otherwise.
179 typedef gboolean (*GtkTreeViewSearchEqualFunc) (GtkTreeModel *model,
183 gpointer search_data);
186 * GtkTreeViewRowSeparatorFunc:
187 * @model: the #GtkTreeModel
188 * @iter: a #GtkTreeIter pointing at a row in @model
189 * @data: (closure): user data
191 * Function type for determining whether the row pointed to by @iter should
192 * be rendered as a separator. A common way to implement this is to have a
193 * boolean column in the model, whose values the #GtkTreeViewRowSeparatorFunc
196 * Returns: %TRUE if the row is a separator
198 typedef gboolean (*GtkTreeViewRowSeparatorFunc) (GtkTreeModel *model,
201 typedef void (*GtkTreeViewSearchPositionFunc) (GtkTreeView *tree_view,
202 GtkWidget *search_dialog,
207 GType gtk_tree_view_get_type (void) G_GNUC_CONST;
208 GtkWidget *gtk_tree_view_new (void);
209 GtkWidget *gtk_tree_view_new_with_model (GtkTreeModel *model);
212 GtkTreeModel *gtk_tree_view_get_model (GtkTreeView *tree_view);
213 void gtk_tree_view_set_model (GtkTreeView *tree_view,
214 GtkTreeModel *model);
215 GtkTreeSelection *gtk_tree_view_get_selection (GtkTreeView *tree_view);
217 GDK_DEPRECATED_FOR(gtk_scrollable_get_hadjustment)
218 GtkAdjustment *gtk_tree_view_get_hadjustment (GtkTreeView *tree_view);
219 GDK_DEPRECATED_FOR(gtk_scrollable_set_hadjustment)
220 void gtk_tree_view_set_hadjustment (GtkTreeView *tree_view,
221 GtkAdjustment *adjustment);
222 GDK_DEPRECATED_FOR(gtk_scrollable_get_vadjustment)
223 GtkAdjustment *gtk_tree_view_get_vadjustment (GtkTreeView *tree_view);
224 GDK_DEPRECATED_FOR(gtk_scrollable_set_vadjustment)
225 void gtk_tree_view_set_vadjustment (GtkTreeView *tree_view,
226 GtkAdjustment *adjustment);
229 gboolean gtk_tree_view_get_headers_visible (GtkTreeView *tree_view);
230 void gtk_tree_view_set_headers_visible (GtkTreeView *tree_view,
231 gboolean headers_visible);
232 void gtk_tree_view_columns_autosize (GtkTreeView *tree_view);
233 gboolean gtk_tree_view_get_headers_clickable (GtkTreeView *tree_view);
234 void gtk_tree_view_set_headers_clickable (GtkTreeView *tree_view,
236 void gtk_tree_view_set_rules_hint (GtkTreeView *tree_view,
238 gboolean gtk_tree_view_get_rules_hint (GtkTreeView *tree_view);
240 /* Column funtions */
241 gint gtk_tree_view_append_column (GtkTreeView *tree_view,
242 GtkTreeViewColumn *column);
243 gint gtk_tree_view_remove_column (GtkTreeView *tree_view,
244 GtkTreeViewColumn *column);
245 gint gtk_tree_view_insert_column (GtkTreeView *tree_view,
246 GtkTreeViewColumn *column,
248 gint gtk_tree_view_insert_column_with_attributes (GtkTreeView *tree_view,
251 GtkCellRenderer *cell,
252 ...) G_GNUC_NULL_TERMINATED;
253 gint gtk_tree_view_insert_column_with_data_func (GtkTreeView *tree_view,
256 GtkCellRenderer *cell,
257 GtkTreeCellDataFunc func,
259 GDestroyNotify dnotify);
260 guint gtk_tree_view_get_n_columns (GtkTreeView *tree_view);
261 GtkTreeViewColumn *gtk_tree_view_get_column (GtkTreeView *tree_view,
263 GList *gtk_tree_view_get_columns (GtkTreeView *tree_view);
264 void gtk_tree_view_move_column_after (GtkTreeView *tree_view,
265 GtkTreeViewColumn *column,
266 GtkTreeViewColumn *base_column);
267 void gtk_tree_view_set_expander_column (GtkTreeView *tree_view,
268 GtkTreeViewColumn *column);
269 GtkTreeViewColumn *gtk_tree_view_get_expander_column (GtkTreeView *tree_view);
270 void gtk_tree_view_set_column_drag_function (GtkTreeView *tree_view,
271 GtkTreeViewColumnDropFunc func,
273 GDestroyNotify destroy);
276 void gtk_tree_view_scroll_to_point (GtkTreeView *tree_view,
279 void gtk_tree_view_scroll_to_cell (GtkTreeView *tree_view,
281 GtkTreeViewColumn *column,
285 void gtk_tree_view_row_activated (GtkTreeView *tree_view,
287 GtkTreeViewColumn *column);
288 void gtk_tree_view_expand_all (GtkTreeView *tree_view);
289 void gtk_tree_view_collapse_all (GtkTreeView *tree_view);
290 void gtk_tree_view_expand_to_path (GtkTreeView *tree_view,
292 gboolean gtk_tree_view_expand_row (GtkTreeView *tree_view,
295 gboolean gtk_tree_view_collapse_row (GtkTreeView *tree_view,
297 void gtk_tree_view_map_expanded_rows (GtkTreeView *tree_view,
298 GtkTreeViewMappingFunc func,
300 gboolean gtk_tree_view_row_expanded (GtkTreeView *tree_view,
302 void gtk_tree_view_set_reorderable (GtkTreeView *tree_view,
303 gboolean reorderable);
304 gboolean gtk_tree_view_get_reorderable (GtkTreeView *tree_view);
305 void gtk_tree_view_set_cursor (GtkTreeView *tree_view,
307 GtkTreeViewColumn *focus_column,
308 gboolean start_editing);
309 void gtk_tree_view_set_cursor_on_cell (GtkTreeView *tree_view,
311 GtkTreeViewColumn *focus_column,
312 GtkCellRenderer *focus_cell,
313 gboolean start_editing);
314 void gtk_tree_view_get_cursor (GtkTreeView *tree_view,
316 GtkTreeViewColumn **focus_column);
319 /* Layout information */
320 GdkWindow *gtk_tree_view_get_bin_window (GtkTreeView *tree_view);
321 gboolean gtk_tree_view_get_path_at_pos (GtkTreeView *tree_view,
325 GtkTreeViewColumn **column,
328 void gtk_tree_view_get_cell_area (GtkTreeView *tree_view,
330 GtkTreeViewColumn *column,
332 void gtk_tree_view_get_background_area (GtkTreeView *tree_view,
334 GtkTreeViewColumn *column,
336 void gtk_tree_view_get_visible_rect (GtkTreeView *tree_view,
337 GdkRectangle *visible_rect);
338 gboolean gtk_tree_view_get_visible_range (GtkTreeView *tree_view,
339 GtkTreePath **start_path,
340 GtkTreePath **end_path);
341 gboolean gtk_tree_view_is_blank_at_pos (GtkTreeView *tree_view,
345 GtkTreeViewColumn **column,
349 /* Drag-and-Drop support */
350 void gtk_tree_view_enable_model_drag_source (GtkTreeView *tree_view,
351 GdkModifierType start_button_mask,
352 const GtkTargetEntry *targets,
354 GdkDragAction actions);
355 void gtk_tree_view_enable_model_drag_dest (GtkTreeView *tree_view,
356 const GtkTargetEntry *targets,
358 GdkDragAction actions);
359 void gtk_tree_view_unset_rows_drag_source (GtkTreeView *tree_view);
360 void gtk_tree_view_unset_rows_drag_dest (GtkTreeView *tree_view);
363 /* These are useful to implement your own custom stuff. */
364 void gtk_tree_view_set_drag_dest_row (GtkTreeView *tree_view,
366 GtkTreeViewDropPosition pos);
367 void gtk_tree_view_get_drag_dest_row (GtkTreeView *tree_view,
369 GtkTreeViewDropPosition *pos);
370 gboolean gtk_tree_view_get_dest_row_at_pos (GtkTreeView *tree_view,
374 GtkTreeViewDropPosition *pos);
375 cairo_surface_t *gtk_tree_view_create_row_drag_icon (GtkTreeView *tree_view,
378 /* Interactive search */
379 void gtk_tree_view_set_enable_search (GtkTreeView *tree_view,
380 gboolean enable_search);
381 gboolean gtk_tree_view_get_enable_search (GtkTreeView *tree_view);
382 gint gtk_tree_view_get_search_column (GtkTreeView *tree_view);
383 void gtk_tree_view_set_search_column (GtkTreeView *tree_view,
385 GtkTreeViewSearchEqualFunc gtk_tree_view_get_search_equal_func (GtkTreeView *tree_view);
386 void gtk_tree_view_set_search_equal_func (GtkTreeView *tree_view,
387 GtkTreeViewSearchEqualFunc search_equal_func,
388 gpointer search_user_data,
389 GDestroyNotify search_destroy);
391 GtkEntry *gtk_tree_view_get_search_entry (GtkTreeView *tree_view);
392 void gtk_tree_view_set_search_entry (GtkTreeView *tree_view,
394 GtkTreeViewSearchPositionFunc gtk_tree_view_get_search_position_func (GtkTreeView *tree_view);
395 void gtk_tree_view_set_search_position_func (GtkTreeView *tree_view,
396 GtkTreeViewSearchPositionFunc func,
398 GDestroyNotify destroy);
400 /* Convert between the different coordinate systems */
401 void gtk_tree_view_convert_widget_to_tree_coords (GtkTreeView *tree_view,
406 void gtk_tree_view_convert_tree_to_widget_coords (GtkTreeView *tree_view,
411 void gtk_tree_view_convert_widget_to_bin_window_coords (GtkTreeView *tree_view,
416 void gtk_tree_view_convert_bin_window_to_widget_coords (GtkTreeView *tree_view,
421 void gtk_tree_view_convert_tree_to_bin_window_coords (GtkTreeView *tree_view,
426 void gtk_tree_view_convert_bin_window_to_tree_coords (GtkTreeView *tree_view,
432 /* This function should really never be used. It is just for use by ATK.
434 typedef void (* GtkTreeDestroyCountFunc) (GtkTreeView *tree_view,
438 void gtk_tree_view_set_destroy_count_func (GtkTreeView *tree_view,
439 GtkTreeDestroyCountFunc func,
441 GDestroyNotify destroy);
443 void gtk_tree_view_set_fixed_height_mode (GtkTreeView *tree_view,
445 gboolean gtk_tree_view_get_fixed_height_mode (GtkTreeView *tree_view);
446 void gtk_tree_view_set_hover_selection (GtkTreeView *tree_view,
448 gboolean gtk_tree_view_get_hover_selection (GtkTreeView *tree_view);
449 void gtk_tree_view_set_hover_expand (GtkTreeView *tree_view,
451 gboolean gtk_tree_view_get_hover_expand (GtkTreeView *tree_view);
452 void gtk_tree_view_set_rubber_banding (GtkTreeView *tree_view,
454 gboolean gtk_tree_view_get_rubber_banding (GtkTreeView *tree_view);
456 gboolean gtk_tree_view_is_rubber_banding_active (GtkTreeView *tree_view);
458 GtkTreeViewRowSeparatorFunc gtk_tree_view_get_row_separator_func (GtkTreeView *tree_view);
459 void gtk_tree_view_set_row_separator_func (GtkTreeView *tree_view,
460 GtkTreeViewRowSeparatorFunc func,
462 GDestroyNotify destroy);
464 GtkTreeViewGridLines gtk_tree_view_get_grid_lines (GtkTreeView *tree_view);
465 void gtk_tree_view_set_grid_lines (GtkTreeView *tree_view,
466 GtkTreeViewGridLines grid_lines);
467 gboolean gtk_tree_view_get_enable_tree_lines (GtkTreeView *tree_view);
468 void gtk_tree_view_set_enable_tree_lines (GtkTreeView *tree_view,
470 void gtk_tree_view_set_show_expanders (GtkTreeView *tree_view,
472 gboolean gtk_tree_view_get_show_expanders (GtkTreeView *tree_view);
473 void gtk_tree_view_set_level_indentation (GtkTreeView *tree_view,
475 gint gtk_tree_view_get_level_indentation (GtkTreeView *tree_view);
477 /* Convenience functions for setting tooltips */
478 void gtk_tree_view_set_tooltip_row (GtkTreeView *tree_view,
481 void gtk_tree_view_set_tooltip_cell (GtkTreeView *tree_view,
484 GtkTreeViewColumn *column,
485 GtkCellRenderer *cell);
486 gboolean gtk_tree_view_get_tooltip_context(GtkTreeView *tree_view,
489 gboolean keyboard_tip,
490 GtkTreeModel **model,
493 void gtk_tree_view_set_tooltip_column (GtkTreeView *tree_view,
495 gint gtk_tree_view_get_tooltip_column (GtkTreeView *tree_view);
500 #endif /* __GTK_TREE_VIEW_H__ */