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>
27 #include <gtk/gtkentry.h>
35 /* drop before/after this row */
36 GTK_TREE_VIEW_DROP_BEFORE,
37 GTK_TREE_VIEW_DROP_AFTER,
38 /* drop as a child of this row (with fallback to before or after
39 * if into is not possible)
41 GTK_TREE_VIEW_DROP_INTO_OR_BEFORE,
42 GTK_TREE_VIEW_DROP_INTO_OR_AFTER
43 } GtkTreeViewDropPosition;
45 #define GTK_TYPE_TREE_VIEW (gtk_tree_view_get_type ())
46 #define GTK_TREE_VIEW(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_TREE_VIEW, GtkTreeView))
47 #define GTK_TREE_VIEW_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_TREE_VIEW, GtkTreeViewClass))
48 #define GTK_IS_TREE_VIEW(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_TREE_VIEW))
49 #define GTK_IS_TREE_VIEW_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_TREE_VIEW))
50 #define GTK_TREE_VIEW_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_TREE_VIEW, GtkTreeViewClass))
52 typedef struct _GtkTreeView GtkTreeView;
53 typedef struct _GtkTreeViewClass GtkTreeViewClass;
54 typedef struct _GtkTreeViewPrivate GtkTreeViewPrivate;
55 typedef struct _GtkTreeSelection GtkTreeSelection;
56 typedef struct _GtkTreeSelectionClass GtkTreeSelectionClass;
62 GtkTreeViewPrivate *priv;
65 struct _GtkTreeViewClass
67 GtkContainerClass parent_class;
69 void (* set_scroll_adjustments) (GtkTreeView *tree_view,
70 GtkAdjustment *hadjustment,
71 GtkAdjustment *vadjustment);
72 void (* row_activated) (GtkTreeView *tree_view,
74 GtkTreeViewColumn *column);
75 gboolean (* test_expand_row) (GtkTreeView *tree_view,
78 gboolean (* test_collapse_row) (GtkTreeView *tree_view,
81 void (* row_expanded) (GtkTreeView *tree_view,
84 void (* row_collapsed) (GtkTreeView *tree_view,
87 void (* columns_changed) (GtkTreeView *tree_view);
88 void (* cursor_changed) (GtkTreeView *tree_view);
90 /* Key Binding signals */
91 gboolean (* move_cursor) (GtkTreeView *tree_view,
94 gboolean (* select_all) (GtkTreeView *tree_view);
95 gboolean (* unselect_all) (GtkTreeView *tree_view);
96 gboolean (* select_cursor_row) (GtkTreeView *tree_view,
97 gboolean start_editing);
98 gboolean (* toggle_cursor_row) (GtkTreeView *tree_view);
99 gboolean (* expand_collapse_cursor_row) (GtkTreeView *tree_view,
103 gboolean (* select_cursor_parent) (GtkTreeView *tree_view);
104 gboolean (* start_interactive_search) (GtkTreeView *tree_view);
106 /* Padding for future expansion */
107 void (*_gtk_reserved0) (void);
108 void (*_gtk_reserved1) (void);
109 void (*_gtk_reserved2) (void);
110 void (*_gtk_reserved3) (void);
111 void (*_gtk_reserved4) (void);
115 typedef gboolean (* GtkTreeViewColumnDropFunc) (GtkTreeView *tree_view,
116 GtkTreeViewColumn *column,
117 GtkTreeViewColumn *prev_column,
118 GtkTreeViewColumn *next_column,
120 typedef void (* GtkTreeViewMappingFunc) (GtkTreeView *tree_view,
123 typedef gboolean (*GtkTreeViewSearchEqualFunc) (GtkTreeModel *model,
127 gpointer search_data);
128 typedef gboolean (*GtkTreeViewRowSeparatorFunc) (GtkTreeModel *model,
131 typedef void (*GtkTreeViewSearchPositionFunc) (GtkTreeView *tree_view,
132 GtkWidget *search_dialog,
137 GType gtk_tree_view_get_type (void) G_GNUC_CONST;
138 GtkWidget *gtk_tree_view_new (void);
139 GtkWidget *gtk_tree_view_new_with_model (GtkTreeModel *model);
142 GtkTreeModel *gtk_tree_view_get_model (GtkTreeView *tree_view);
143 void gtk_tree_view_set_model (GtkTreeView *tree_view,
144 GtkTreeModel *model);
145 GtkTreeSelection *gtk_tree_view_get_selection (GtkTreeView *tree_view);
146 GtkAdjustment *gtk_tree_view_get_hadjustment (GtkTreeView *tree_view);
147 void gtk_tree_view_set_hadjustment (GtkTreeView *tree_view,
148 GtkAdjustment *adjustment);
149 GtkAdjustment *gtk_tree_view_get_vadjustment (GtkTreeView *tree_view);
150 void gtk_tree_view_set_vadjustment (GtkTreeView *tree_view,
151 GtkAdjustment *adjustment);
152 gboolean gtk_tree_view_get_headers_visible (GtkTreeView *tree_view);
153 void gtk_tree_view_set_headers_visible (GtkTreeView *tree_view,
154 gboolean headers_visible);
155 void gtk_tree_view_columns_autosize (GtkTreeView *tree_view);
156 gboolean gtk_tree_view_get_headers_clickable (GtkTreeView *tree_view);
157 void gtk_tree_view_set_headers_clickable (GtkTreeView *tree_view,
159 void gtk_tree_view_set_rules_hint (GtkTreeView *tree_view,
161 gboolean gtk_tree_view_get_rules_hint (GtkTreeView *tree_view);
163 /* Column funtions */
164 gint gtk_tree_view_append_column (GtkTreeView *tree_view,
165 GtkTreeViewColumn *column);
166 gint gtk_tree_view_remove_column (GtkTreeView *tree_view,
167 GtkTreeViewColumn *column);
168 gint gtk_tree_view_insert_column (GtkTreeView *tree_view,
169 GtkTreeViewColumn *column,
171 gint gtk_tree_view_insert_column_with_attributes (GtkTreeView *tree_view,
174 GtkCellRenderer *cell,
175 ...) G_GNUC_NULL_TERMINATED;
176 gint gtk_tree_view_insert_column_with_data_func (GtkTreeView *tree_view,
179 GtkCellRenderer *cell,
180 GtkTreeCellDataFunc func,
182 GDestroyNotify dnotify);
183 GtkTreeViewColumn *gtk_tree_view_get_column (GtkTreeView *tree_view,
185 GList *gtk_tree_view_get_columns (GtkTreeView *tree_view);
186 void gtk_tree_view_move_column_after (GtkTreeView *tree_view,
187 GtkTreeViewColumn *column,
188 GtkTreeViewColumn *base_column);
189 void gtk_tree_view_set_expander_column (GtkTreeView *tree_view,
190 GtkTreeViewColumn *column);
191 GtkTreeViewColumn *gtk_tree_view_get_expander_column (GtkTreeView *tree_view);
192 void gtk_tree_view_set_column_drag_function (GtkTreeView *tree_view,
193 GtkTreeViewColumnDropFunc func,
195 GtkDestroyNotify destroy);
198 void gtk_tree_view_scroll_to_point (GtkTreeView *tree_view,
201 void gtk_tree_view_scroll_to_cell (GtkTreeView *tree_view,
203 GtkTreeViewColumn *column,
207 void gtk_tree_view_row_activated (GtkTreeView *tree_view,
209 GtkTreeViewColumn *column);
210 void gtk_tree_view_expand_all (GtkTreeView *tree_view);
211 void gtk_tree_view_collapse_all (GtkTreeView *tree_view);
212 void gtk_tree_view_expand_to_path (GtkTreeView *tree_view,
214 gboolean gtk_tree_view_expand_row (GtkTreeView *tree_view,
217 gboolean gtk_tree_view_collapse_row (GtkTreeView *tree_view,
219 void gtk_tree_view_map_expanded_rows (GtkTreeView *tree_view,
220 GtkTreeViewMappingFunc func,
222 gboolean gtk_tree_view_row_expanded (GtkTreeView *tree_view,
224 void gtk_tree_view_set_reorderable (GtkTreeView *tree_view,
225 gboolean reorderable);
226 gboolean gtk_tree_view_get_reorderable (GtkTreeView *tree_view);
227 void gtk_tree_view_set_cursor (GtkTreeView *tree_view,
229 GtkTreeViewColumn *focus_column,
230 gboolean start_editing);
231 void gtk_tree_view_set_cursor_on_cell (GtkTreeView *tree_view,
233 GtkTreeViewColumn *focus_column,
234 GtkCellRenderer *focus_cell,
235 gboolean start_editing);
236 void gtk_tree_view_get_cursor (GtkTreeView *tree_view,
238 GtkTreeViewColumn **focus_column);
241 /* Layout information */
242 GdkWindow *gtk_tree_view_get_bin_window (GtkTreeView *tree_view);
243 gboolean gtk_tree_view_get_path_at_pos (GtkTreeView *tree_view,
247 GtkTreeViewColumn **column,
250 void gtk_tree_view_get_cell_area (GtkTreeView *tree_view,
252 GtkTreeViewColumn *column,
254 void gtk_tree_view_get_background_area (GtkTreeView *tree_view,
256 GtkTreeViewColumn *column,
258 void gtk_tree_view_get_visible_rect (GtkTreeView *tree_view,
259 GdkRectangle *visible_rect);
260 void gtk_tree_view_widget_to_tree_coords (GtkTreeView *tree_view,
265 void gtk_tree_view_tree_to_widget_coords (GtkTreeView *tree_view,
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 GdkPixmap *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 GtkDestroyNotify 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 /* This function should really never be used. It is just for use by ATK.
327 typedef void (* GtkTreeDestroyCountFunc) (GtkTreeView *tree_view,
331 void gtk_tree_view_set_destroy_count_func (GtkTreeView *tree_view,
332 GtkTreeDestroyCountFunc func,
334 GtkDestroyNotify destroy);
336 void gtk_tree_view_set_fixed_height_mode (GtkTreeView *tree_view,
338 gboolean gtk_tree_view_get_fixed_height_mode (GtkTreeView *tree_view);
339 void gtk_tree_view_set_hover_selection (GtkTreeView *tree_view,
341 gboolean gtk_tree_view_get_hover_selection (GtkTreeView *tree_view);
342 void gtk_tree_view_set_hover_expand (GtkTreeView *tree_view,
344 gboolean gtk_tree_view_get_hover_expand (GtkTreeView *tree_view);
345 void gtk_tree_view_set_rubber_banding (GtkTreeView *tree_view,
347 gboolean gtk_tree_view_get_rubber_banding (GtkTreeView *tree_view);
349 GtkTreeViewRowSeparatorFunc gtk_tree_view_get_row_separator_func (GtkTreeView *tree_view);
350 void gtk_tree_view_set_row_separator_func (GtkTreeView *tree_view,
351 GtkTreeViewRowSeparatorFunc func,
353 GtkDestroyNotify destroy);
355 GtkTreeViewGridLines gtk_tree_view_get_grid_lines (GtkTreeView *tree_view);
356 void gtk_tree_view_set_grid_lines (GtkTreeView *tree_view,
357 GtkTreeViewGridLines grid_lines);
358 gboolean gtk_tree_view_get_enable_tree_lines (GtkTreeView *tree_view);
359 void gtk_tree_view_set_enable_tree_lines (GtkTreeView *tree_view,
361 void gtk_tree_view_set_show_expanders (GtkTreeView *tree_view,
363 gboolean gtk_tree_view_get_show_expanders (GtkTreeView *tree_view);
364 void gtk_tree_view_set_level_indentation (GtkTreeView *tree_view,
366 gint gtk_tree_view_get_level_indentation (GtkTreeView *tree_view);
371 #endif /* __GTK_TREE_VIEW_H__ */