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>
38 /* drop before/after this row */
39 GTK_TREE_VIEW_DROP_BEFORE,
40 GTK_TREE_VIEW_DROP_AFTER,
41 /* drop as a child of this row (with fallback to before or after
42 * if into is not possible)
44 GTK_TREE_VIEW_DROP_INTO_OR_BEFORE,
45 GTK_TREE_VIEW_DROP_INTO_OR_AFTER
46 } GtkTreeViewDropPosition;
48 #define GTK_TYPE_TREE_VIEW (gtk_tree_view_get_type ())
49 #define GTK_TREE_VIEW(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_TREE_VIEW, GtkTreeView))
50 #define GTK_TREE_VIEW_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_TREE_VIEW, GtkTreeViewClass))
51 #define GTK_IS_TREE_VIEW(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_TREE_VIEW))
52 #define GTK_IS_TREE_VIEW_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_TREE_VIEW))
53 #define GTK_TREE_VIEW_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_TREE_VIEW, GtkTreeViewClass))
55 typedef struct _GtkTreeView GtkTreeView;
56 typedef struct _GtkTreeViewClass GtkTreeViewClass;
57 typedef struct _GtkTreeViewPrivate GtkTreeViewPrivate;
58 typedef struct _GtkTreeSelection GtkTreeSelection;
59 typedef struct _GtkTreeSelectionClass GtkTreeSelectionClass;
66 GtkTreeViewPrivate *priv;
69 struct _GtkTreeViewClass
71 GtkContainerClass parent_class;
73 void (* row_activated) (GtkTreeView *tree_view,
75 GtkTreeViewColumn *column);
76 gboolean (* test_expand_row) (GtkTreeView *tree_view,
79 gboolean (* test_collapse_row) (GtkTreeView *tree_view,
82 void (* row_expanded) (GtkTreeView *tree_view,
85 void (* row_collapsed) (GtkTreeView *tree_view,
88 void (* columns_changed) (GtkTreeView *tree_view);
89 void (* cursor_changed) (GtkTreeView *tree_view);
91 /* Key Binding signals */
92 gboolean (* move_cursor) (GtkTreeView *tree_view,
95 gboolean (* select_all) (GtkTreeView *tree_view);
96 gboolean (* unselect_all) (GtkTreeView *tree_view);
97 gboolean (* select_cursor_row) (GtkTreeView *tree_view,
98 gboolean start_editing);
99 gboolean (* toggle_cursor_row) (GtkTreeView *tree_view);
100 gboolean (* expand_collapse_cursor_row) (GtkTreeView *tree_view,
104 gboolean (* select_cursor_parent) (GtkTreeView *tree_view);
105 gboolean (* start_interactive_search) (GtkTreeView *tree_view);
107 /* Padding for future expansion */
108 void (*_gtk_reserved1) (void);
109 void (*_gtk_reserved2) (void);
110 void (*_gtk_reserved3) (void);
111 void (*_gtk_reserved4) (void);
112 void (*_gtk_reserved5) (void);
113 void (*_gtk_reserved6) (void);
114 void (*_gtk_reserved7) (void);
115 void (*_gtk_reserved8) (void);
119 typedef gboolean (* GtkTreeViewColumnDropFunc) (GtkTreeView *tree_view,
120 GtkTreeViewColumn *column,
121 GtkTreeViewColumn *prev_column,
122 GtkTreeViewColumn *next_column,
124 typedef void (* GtkTreeViewMappingFunc) (GtkTreeView *tree_view,
127 typedef gboolean (*GtkTreeViewSearchEqualFunc) (GtkTreeModel *model,
131 gpointer search_data);
132 typedef gboolean (*GtkTreeViewRowSeparatorFunc) (GtkTreeModel *model,
135 typedef void (*GtkTreeViewSearchPositionFunc) (GtkTreeView *tree_view,
136 GtkWidget *search_dialog,
141 GType gtk_tree_view_get_type (void) G_GNUC_CONST;
142 GtkWidget *gtk_tree_view_new (void);
143 GtkWidget *gtk_tree_view_new_with_model (GtkTreeModel *model);
146 GtkTreeModel *gtk_tree_view_get_model (GtkTreeView *tree_view);
147 void gtk_tree_view_set_model (GtkTreeView *tree_view,
148 GtkTreeModel *model);
149 GtkTreeSelection *gtk_tree_view_get_selection (GtkTreeView *tree_view);
151 #ifndef GTK_DISABLE_DEPRECATED
153 GtkAdjustment *gtk_tree_view_get_hadjustment (GtkTreeView *tree_view);
154 void gtk_tree_view_set_hadjustment (GtkTreeView *tree_view,
155 GtkAdjustment *adjustment);
156 GtkAdjustment *gtk_tree_view_get_vadjustment (GtkTreeView *tree_view);
157 void gtk_tree_view_set_vadjustment (GtkTreeView *tree_view,
158 GtkAdjustment *adjustment);
162 gboolean gtk_tree_view_get_headers_visible (GtkTreeView *tree_view);
163 void gtk_tree_view_set_headers_visible (GtkTreeView *tree_view,
164 gboolean headers_visible);
165 void gtk_tree_view_columns_autosize (GtkTreeView *tree_view);
166 gboolean gtk_tree_view_get_headers_clickable (GtkTreeView *tree_view);
167 void gtk_tree_view_set_headers_clickable (GtkTreeView *tree_view,
169 void gtk_tree_view_set_rules_hint (GtkTreeView *tree_view,
171 gboolean gtk_tree_view_get_rules_hint (GtkTreeView *tree_view);
173 /* Column funtions */
174 gint gtk_tree_view_append_column (GtkTreeView *tree_view,
175 GtkTreeViewColumn *column);
176 gint gtk_tree_view_remove_column (GtkTreeView *tree_view,
177 GtkTreeViewColumn *column);
178 gint gtk_tree_view_insert_column (GtkTreeView *tree_view,
179 GtkTreeViewColumn *column,
181 gint gtk_tree_view_insert_column_with_attributes (GtkTreeView *tree_view,
184 GtkCellRenderer *cell,
185 ...) G_GNUC_NULL_TERMINATED;
186 gint gtk_tree_view_insert_column_with_data_func (GtkTreeView *tree_view,
189 GtkCellRenderer *cell,
190 GtkTreeCellDataFunc func,
192 GDestroyNotify dnotify);
193 GtkTreeViewColumn *gtk_tree_view_get_column (GtkTreeView *tree_view,
195 GList *gtk_tree_view_get_columns (GtkTreeView *tree_view);
196 void gtk_tree_view_move_column_after (GtkTreeView *tree_view,
197 GtkTreeViewColumn *column,
198 GtkTreeViewColumn *base_column);
199 void gtk_tree_view_set_expander_column (GtkTreeView *tree_view,
200 GtkTreeViewColumn *column);
201 GtkTreeViewColumn *gtk_tree_view_get_expander_column (GtkTreeView *tree_view);
202 void gtk_tree_view_set_column_drag_function (GtkTreeView *tree_view,
203 GtkTreeViewColumnDropFunc func,
205 GDestroyNotify destroy);
208 void gtk_tree_view_scroll_to_point (GtkTreeView *tree_view,
211 void gtk_tree_view_scroll_to_cell (GtkTreeView *tree_view,
213 GtkTreeViewColumn *column,
217 void gtk_tree_view_row_activated (GtkTreeView *tree_view,
219 GtkTreeViewColumn *column);
220 void gtk_tree_view_expand_all (GtkTreeView *tree_view);
221 void gtk_tree_view_collapse_all (GtkTreeView *tree_view);
222 void gtk_tree_view_expand_to_path (GtkTreeView *tree_view,
224 gboolean gtk_tree_view_expand_row (GtkTreeView *tree_view,
227 gboolean gtk_tree_view_collapse_row (GtkTreeView *tree_view,
229 void gtk_tree_view_map_expanded_rows (GtkTreeView *tree_view,
230 GtkTreeViewMappingFunc func,
232 gboolean gtk_tree_view_row_expanded (GtkTreeView *tree_view,
234 void gtk_tree_view_set_reorderable (GtkTreeView *tree_view,
235 gboolean reorderable);
236 gboolean gtk_tree_view_get_reorderable (GtkTreeView *tree_view);
237 void gtk_tree_view_set_cursor (GtkTreeView *tree_view,
239 GtkTreeViewColumn *focus_column,
240 gboolean start_editing);
241 void gtk_tree_view_set_cursor_on_cell (GtkTreeView *tree_view,
243 GtkTreeViewColumn *focus_column,
244 GtkCellRenderer *focus_cell,
245 gboolean start_editing);
246 void gtk_tree_view_get_cursor (GtkTreeView *tree_view,
248 GtkTreeViewColumn **focus_column);
251 /* Layout information */
252 GdkWindow *gtk_tree_view_get_bin_window (GtkTreeView *tree_view);
253 gboolean gtk_tree_view_get_path_at_pos (GtkTreeView *tree_view,
257 GtkTreeViewColumn **column,
260 void gtk_tree_view_get_cell_area (GtkTreeView *tree_view,
262 GtkTreeViewColumn *column,
264 void gtk_tree_view_get_background_area (GtkTreeView *tree_view,
266 GtkTreeViewColumn *column,
268 void gtk_tree_view_get_visible_rect (GtkTreeView *tree_view,
269 GdkRectangle *visible_rect);
270 gboolean gtk_tree_view_get_visible_range (GtkTreeView *tree_view,
271 GtkTreePath **start_path,
272 GtkTreePath **end_path);
274 /* Drag-and-Drop support */
275 void gtk_tree_view_enable_model_drag_source (GtkTreeView *tree_view,
276 GdkModifierType start_button_mask,
277 const GtkTargetEntry *targets,
279 GdkDragAction actions);
280 void gtk_tree_view_enable_model_drag_dest (GtkTreeView *tree_view,
281 const GtkTargetEntry *targets,
283 GdkDragAction actions);
284 void gtk_tree_view_unset_rows_drag_source (GtkTreeView *tree_view);
285 void gtk_tree_view_unset_rows_drag_dest (GtkTreeView *tree_view);
288 /* These are useful to implement your own custom stuff. */
289 void gtk_tree_view_set_drag_dest_row (GtkTreeView *tree_view,
291 GtkTreeViewDropPosition pos);
292 void gtk_tree_view_get_drag_dest_row (GtkTreeView *tree_view,
294 GtkTreeViewDropPosition *pos);
295 gboolean gtk_tree_view_get_dest_row_at_pos (GtkTreeView *tree_view,
299 GtkTreeViewDropPosition *pos);
300 cairo_surface_t *gtk_tree_view_create_row_drag_icon (GtkTreeView *tree_view,
303 /* Interactive search */
304 void gtk_tree_view_set_enable_search (GtkTreeView *tree_view,
305 gboolean enable_search);
306 gboolean gtk_tree_view_get_enable_search (GtkTreeView *tree_view);
307 gint gtk_tree_view_get_search_column (GtkTreeView *tree_view);
308 void gtk_tree_view_set_search_column (GtkTreeView *tree_view,
310 GtkTreeViewSearchEqualFunc gtk_tree_view_get_search_equal_func (GtkTreeView *tree_view);
311 void gtk_tree_view_set_search_equal_func (GtkTreeView *tree_view,
312 GtkTreeViewSearchEqualFunc search_equal_func,
313 gpointer search_user_data,
314 GDestroyNotify search_destroy);
316 GtkEntry *gtk_tree_view_get_search_entry (GtkTreeView *tree_view);
317 void gtk_tree_view_set_search_entry (GtkTreeView *tree_view,
319 GtkTreeViewSearchPositionFunc gtk_tree_view_get_search_position_func (GtkTreeView *tree_view);
320 void gtk_tree_view_set_search_position_func (GtkTreeView *tree_view,
321 GtkTreeViewSearchPositionFunc func,
323 GDestroyNotify destroy);
325 /* Convert between the different coordinate systems */
326 void gtk_tree_view_convert_widget_to_tree_coords (GtkTreeView *tree_view,
331 void gtk_tree_view_convert_tree_to_widget_coords (GtkTreeView *tree_view,
336 void gtk_tree_view_convert_widget_to_bin_window_coords (GtkTreeView *tree_view,
341 void gtk_tree_view_convert_bin_window_to_widget_coords (GtkTreeView *tree_view,
346 void gtk_tree_view_convert_tree_to_bin_window_coords (GtkTreeView *tree_view,
351 void gtk_tree_view_convert_bin_window_to_tree_coords (GtkTreeView *tree_view,
357 /* This function should really never be used. It is just for use by ATK.
359 typedef void (* GtkTreeDestroyCountFunc) (GtkTreeView *tree_view,
363 void gtk_tree_view_set_destroy_count_func (GtkTreeView *tree_view,
364 GtkTreeDestroyCountFunc func,
366 GDestroyNotify destroy);
368 void gtk_tree_view_set_fixed_height_mode (GtkTreeView *tree_view,
370 gboolean gtk_tree_view_get_fixed_height_mode (GtkTreeView *tree_view);
371 void gtk_tree_view_set_hover_selection (GtkTreeView *tree_view,
373 gboolean gtk_tree_view_get_hover_selection (GtkTreeView *tree_view);
374 void gtk_tree_view_set_hover_expand (GtkTreeView *tree_view,
376 gboolean gtk_tree_view_get_hover_expand (GtkTreeView *tree_view);
377 void gtk_tree_view_set_rubber_banding (GtkTreeView *tree_view,
379 gboolean gtk_tree_view_get_rubber_banding (GtkTreeView *tree_view);
381 gboolean gtk_tree_view_is_rubber_banding_active (GtkTreeView *tree_view);
383 GtkTreeViewRowSeparatorFunc gtk_tree_view_get_row_separator_func (GtkTreeView *tree_view);
384 void gtk_tree_view_set_row_separator_func (GtkTreeView *tree_view,
385 GtkTreeViewRowSeparatorFunc func,
387 GDestroyNotify destroy);
389 GtkTreeViewGridLines gtk_tree_view_get_grid_lines (GtkTreeView *tree_view);
390 void gtk_tree_view_set_grid_lines (GtkTreeView *tree_view,
391 GtkTreeViewGridLines grid_lines);
392 gboolean gtk_tree_view_get_enable_tree_lines (GtkTreeView *tree_view);
393 void gtk_tree_view_set_enable_tree_lines (GtkTreeView *tree_view,
395 void gtk_tree_view_set_show_expanders (GtkTreeView *tree_view,
397 gboolean gtk_tree_view_get_show_expanders (GtkTreeView *tree_view);
398 void gtk_tree_view_set_level_indentation (GtkTreeView *tree_view,
400 gint gtk_tree_view_get_level_indentation (GtkTreeView *tree_view);
402 /* Convenience functions for setting tooltips */
403 void gtk_tree_view_set_tooltip_row (GtkTreeView *tree_view,
406 void gtk_tree_view_set_tooltip_cell (GtkTreeView *tree_view,
409 GtkTreeViewColumn *column,
410 GtkCellRenderer *cell);
411 gboolean gtk_tree_view_get_tooltip_context(GtkTreeView *tree_view,
414 gboolean keyboard_tip,
415 GtkTreeModel **model,
418 void gtk_tree_view_set_tooltip_column (GtkTreeView *tree_view,
420 gint gtk_tree_view_get_tooltip_column (GtkTreeView *tree_view);
425 #endif /* __GTK_TREE_VIEW_H__ */