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 (* set_scroll_adjustments) (GtkTreeView *tree_view,
74 GtkAdjustment *hadjustment,
75 GtkAdjustment *vadjustment);
76 void (* row_activated) (GtkTreeView *tree_view,
78 GtkTreeViewColumn *column);
79 gboolean (* test_expand_row) (GtkTreeView *tree_view,
82 gboolean (* test_collapse_row) (GtkTreeView *tree_view,
85 void (* row_expanded) (GtkTreeView *tree_view,
88 void (* row_collapsed) (GtkTreeView *tree_view,
91 void (* columns_changed) (GtkTreeView *tree_view);
92 void (* cursor_changed) (GtkTreeView *tree_view);
94 /* Key Binding signals */
95 gboolean (* move_cursor) (GtkTreeView *tree_view,
98 gboolean (* select_all) (GtkTreeView *tree_view);
99 gboolean (* unselect_all) (GtkTreeView *tree_view);
100 gboolean (* select_cursor_row) (GtkTreeView *tree_view,
101 gboolean start_editing);
102 gboolean (* toggle_cursor_row) (GtkTreeView *tree_view);
103 gboolean (* expand_collapse_cursor_row) (GtkTreeView *tree_view,
107 gboolean (* select_cursor_parent) (GtkTreeView *tree_view);
108 gboolean (* start_interactive_search) (GtkTreeView *tree_view);
110 /* Padding for future expansion */
111 void (*_gtk_reserved1) (void);
112 void (*_gtk_reserved2) (void);
113 void (*_gtk_reserved3) (void);
114 void (*_gtk_reserved4) (void);
115 void (*_gtk_reserved5) (void);
116 void (*_gtk_reserved6) (void);
117 void (*_gtk_reserved7) (void);
118 void (*_gtk_reserved8) (void);
122 typedef gboolean (* GtkTreeViewColumnDropFunc) (GtkTreeView *tree_view,
123 GtkTreeViewColumn *column,
124 GtkTreeViewColumn *prev_column,
125 GtkTreeViewColumn *next_column,
127 typedef void (* GtkTreeViewMappingFunc) (GtkTreeView *tree_view,
130 typedef gboolean (*GtkTreeViewSearchEqualFunc) (GtkTreeModel *model,
134 gpointer search_data);
135 typedef gboolean (*GtkTreeViewRowSeparatorFunc) (GtkTreeModel *model,
138 typedef void (*GtkTreeViewSearchPositionFunc) (GtkTreeView *tree_view,
139 GtkWidget *search_dialog,
144 GType gtk_tree_view_get_type (void) G_GNUC_CONST;
145 GtkWidget *gtk_tree_view_new (void);
146 GtkWidget *gtk_tree_view_new_with_model (GtkTreeModel *model);
149 GtkTreeModel *gtk_tree_view_get_model (GtkTreeView *tree_view);
150 void gtk_tree_view_set_model (GtkTreeView *tree_view,
151 GtkTreeModel *model);
152 GtkTreeSelection *gtk_tree_view_get_selection (GtkTreeView *tree_view);
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);
159 gboolean gtk_tree_view_get_headers_visible (GtkTreeView *tree_view);
160 void gtk_tree_view_set_headers_visible (GtkTreeView *tree_view,
161 gboolean headers_visible);
162 void gtk_tree_view_columns_autosize (GtkTreeView *tree_view);
163 gboolean gtk_tree_view_get_headers_clickable (GtkTreeView *tree_view);
164 void gtk_tree_view_set_headers_clickable (GtkTreeView *tree_view,
166 void gtk_tree_view_set_rules_hint (GtkTreeView *tree_view,
168 gboolean gtk_tree_view_get_rules_hint (GtkTreeView *tree_view);
170 /* Column funtions */
171 gint gtk_tree_view_append_column (GtkTreeView *tree_view,
172 GtkTreeViewColumn *column);
173 gint gtk_tree_view_remove_column (GtkTreeView *tree_view,
174 GtkTreeViewColumn *column);
175 gint gtk_tree_view_insert_column (GtkTreeView *tree_view,
176 GtkTreeViewColumn *column,
178 gint gtk_tree_view_insert_column_with_attributes (GtkTreeView *tree_view,
181 GtkCellRenderer *cell,
182 ...) G_GNUC_NULL_TERMINATED;
183 gint gtk_tree_view_insert_column_with_data_func (GtkTreeView *tree_view,
186 GtkCellRenderer *cell,
187 GtkTreeCellDataFunc func,
189 GDestroyNotify dnotify);
190 GtkTreeViewColumn *gtk_tree_view_get_column (GtkTreeView *tree_view,
192 GList *gtk_tree_view_get_columns (GtkTreeView *tree_view);
193 void gtk_tree_view_move_column_after (GtkTreeView *tree_view,
194 GtkTreeViewColumn *column,
195 GtkTreeViewColumn *base_column);
196 void gtk_tree_view_set_expander_column (GtkTreeView *tree_view,
197 GtkTreeViewColumn *column);
198 GtkTreeViewColumn *gtk_tree_view_get_expander_column (GtkTreeView *tree_view);
199 void gtk_tree_view_set_column_drag_function (GtkTreeView *tree_view,
200 GtkTreeViewColumnDropFunc func,
202 GDestroyNotify destroy);
205 void gtk_tree_view_scroll_to_point (GtkTreeView *tree_view,
208 void gtk_tree_view_scroll_to_cell (GtkTreeView *tree_view,
210 GtkTreeViewColumn *column,
214 void gtk_tree_view_row_activated (GtkTreeView *tree_view,
216 GtkTreeViewColumn *column);
217 void gtk_tree_view_expand_all (GtkTreeView *tree_view);
218 void gtk_tree_view_collapse_all (GtkTreeView *tree_view);
219 void gtk_tree_view_expand_to_path (GtkTreeView *tree_view,
221 gboolean gtk_tree_view_expand_row (GtkTreeView *tree_view,
224 gboolean gtk_tree_view_collapse_row (GtkTreeView *tree_view,
226 void gtk_tree_view_map_expanded_rows (GtkTreeView *tree_view,
227 GtkTreeViewMappingFunc func,
229 gboolean gtk_tree_view_row_expanded (GtkTreeView *tree_view,
231 void gtk_tree_view_set_reorderable (GtkTreeView *tree_view,
232 gboolean reorderable);
233 gboolean gtk_tree_view_get_reorderable (GtkTreeView *tree_view);
234 void gtk_tree_view_set_cursor (GtkTreeView *tree_view,
236 GtkTreeViewColumn *focus_column,
237 gboolean start_editing);
238 void gtk_tree_view_set_cursor_on_cell (GtkTreeView *tree_view,
240 GtkTreeViewColumn *focus_column,
241 GtkCellRenderer *focus_cell,
242 gboolean start_editing);
243 void gtk_tree_view_get_cursor (GtkTreeView *tree_view,
245 GtkTreeViewColumn **focus_column);
248 /* Layout information */
249 GdkWindow *gtk_tree_view_get_bin_window (GtkTreeView *tree_view);
250 gboolean gtk_tree_view_get_path_at_pos (GtkTreeView *tree_view,
254 GtkTreeViewColumn **column,
257 void gtk_tree_view_get_cell_area (GtkTreeView *tree_view,
259 GtkTreeViewColumn *column,
261 void gtk_tree_view_get_background_area (GtkTreeView *tree_view,
263 GtkTreeViewColumn *column,
265 void gtk_tree_view_get_visible_rect (GtkTreeView *tree_view,
266 GdkRectangle *visible_rect);
267 gboolean gtk_tree_view_get_visible_range (GtkTreeView *tree_view,
268 GtkTreePath **start_path,
269 GtkTreePath **end_path);
271 /* Drag-and-Drop support */
272 void gtk_tree_view_enable_model_drag_source (GtkTreeView *tree_view,
273 GdkModifierType start_button_mask,
274 const GtkTargetEntry *targets,
276 GdkDragAction actions);
277 void gtk_tree_view_enable_model_drag_dest (GtkTreeView *tree_view,
278 const GtkTargetEntry *targets,
280 GdkDragAction actions);
281 void gtk_tree_view_unset_rows_drag_source (GtkTreeView *tree_view);
282 void gtk_tree_view_unset_rows_drag_dest (GtkTreeView *tree_view);
285 /* These are useful to implement your own custom stuff. */
286 void gtk_tree_view_set_drag_dest_row (GtkTreeView *tree_view,
288 GtkTreeViewDropPosition pos);
289 void gtk_tree_view_get_drag_dest_row (GtkTreeView *tree_view,
291 GtkTreeViewDropPosition *pos);
292 gboolean gtk_tree_view_get_dest_row_at_pos (GtkTreeView *tree_view,
296 GtkTreeViewDropPosition *pos);
297 cairo_surface_t *gtk_tree_view_create_row_drag_icon (GtkTreeView *tree_view,
300 /* Interactive search */
301 void gtk_tree_view_set_enable_search (GtkTreeView *tree_view,
302 gboolean enable_search);
303 gboolean gtk_tree_view_get_enable_search (GtkTreeView *tree_view);
304 gint gtk_tree_view_get_search_column (GtkTreeView *tree_view);
305 void gtk_tree_view_set_search_column (GtkTreeView *tree_view,
307 GtkTreeViewSearchEqualFunc gtk_tree_view_get_search_equal_func (GtkTreeView *tree_view);
308 void gtk_tree_view_set_search_equal_func (GtkTreeView *tree_view,
309 GtkTreeViewSearchEqualFunc search_equal_func,
310 gpointer search_user_data,
311 GDestroyNotify search_destroy);
313 GtkEntry *gtk_tree_view_get_search_entry (GtkTreeView *tree_view);
314 void gtk_tree_view_set_search_entry (GtkTreeView *tree_view,
316 GtkTreeViewSearchPositionFunc gtk_tree_view_get_search_position_func (GtkTreeView *tree_view);
317 void gtk_tree_view_set_search_position_func (GtkTreeView *tree_view,
318 GtkTreeViewSearchPositionFunc func,
320 GDestroyNotify destroy);
322 /* Convert between the different coordinate systems */
323 void gtk_tree_view_convert_widget_to_tree_coords (GtkTreeView *tree_view,
328 void gtk_tree_view_convert_tree_to_widget_coords (GtkTreeView *tree_view,
333 void gtk_tree_view_convert_widget_to_bin_window_coords (GtkTreeView *tree_view,
338 void gtk_tree_view_convert_bin_window_to_widget_coords (GtkTreeView *tree_view,
343 void gtk_tree_view_convert_tree_to_bin_window_coords (GtkTreeView *tree_view,
348 void gtk_tree_view_convert_bin_window_to_tree_coords (GtkTreeView *tree_view,
354 /* This function should really never be used. It is just for use by ATK.
356 typedef void (* GtkTreeDestroyCountFunc) (GtkTreeView *tree_view,
360 void gtk_tree_view_set_destroy_count_func (GtkTreeView *tree_view,
361 GtkTreeDestroyCountFunc func,
363 GDestroyNotify destroy);
365 void gtk_tree_view_set_fixed_height_mode (GtkTreeView *tree_view,
367 gboolean gtk_tree_view_get_fixed_height_mode (GtkTreeView *tree_view);
368 void gtk_tree_view_set_hover_selection (GtkTreeView *tree_view,
370 gboolean gtk_tree_view_get_hover_selection (GtkTreeView *tree_view);
371 void gtk_tree_view_set_hover_expand (GtkTreeView *tree_view,
373 gboolean gtk_tree_view_get_hover_expand (GtkTreeView *tree_view);
374 void gtk_tree_view_set_rubber_banding (GtkTreeView *tree_view,
376 gboolean gtk_tree_view_get_rubber_banding (GtkTreeView *tree_view);
378 gboolean gtk_tree_view_is_rubber_banding_active (GtkTreeView *tree_view);
380 GtkTreeViewRowSeparatorFunc gtk_tree_view_get_row_separator_func (GtkTreeView *tree_view);
381 void gtk_tree_view_set_row_separator_func (GtkTreeView *tree_view,
382 GtkTreeViewRowSeparatorFunc func,
384 GDestroyNotify destroy);
386 GtkTreeViewGridLines gtk_tree_view_get_grid_lines (GtkTreeView *tree_view);
387 void gtk_tree_view_set_grid_lines (GtkTreeView *tree_view,
388 GtkTreeViewGridLines grid_lines);
389 gboolean gtk_tree_view_get_enable_tree_lines (GtkTreeView *tree_view);
390 void gtk_tree_view_set_enable_tree_lines (GtkTreeView *tree_view,
392 void gtk_tree_view_set_show_expanders (GtkTreeView *tree_view,
394 gboolean gtk_tree_view_get_show_expanders (GtkTreeView *tree_view);
395 void gtk_tree_view_set_level_indentation (GtkTreeView *tree_view,
397 gint gtk_tree_view_get_level_indentation (GtkTreeView *tree_view);
399 /* Convenience functions for setting tooltips */
400 void gtk_tree_view_set_tooltip_row (GtkTreeView *tree_view,
403 void gtk_tree_view_set_tooltip_cell (GtkTreeView *tree_view,
406 GtkTreeViewColumn *column,
407 GtkCellRenderer *cell);
408 gboolean gtk_tree_view_get_tooltip_context(GtkTreeView *tree_view,
411 gboolean keyboard_tip,
412 GtkTreeModel **model,
415 void gtk_tree_view_set_tooltip_column (GtkTreeView *tree_view,
417 gint gtk_tree_view_get_tooltip_column (GtkTreeView *tree_view);
422 #endif /* __GTK_TREE_VIEW_H__ */