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);
87 void (* cursor_changed) (GtkTreeView *tree_view);
89 /* Key Binding signals */
90 void (* move_cursor) (GtkTreeView *tree_view,
93 void (* select_all) (GtkTreeView *tree_view);
94 void (* select_cursor_row) (GtkTreeView *tree_view,
95 gboolean start_editing);
96 void (* toggle_cursor_row) (GtkTreeView *tree_view);
97 void (* expand_collapse_cursor_row) (GtkTreeView *tree_view,
101 void (* select_cursor_parent) (GtkTreeView *tree_view);
102 void (* start_interactive_search) (GtkTreeView *tree_view);
106 typedef gboolean (* GtkTreeViewColumnDropFunc) (GtkTreeView *tree_view,
107 GtkTreeViewColumn *column,
108 GtkTreeViewColumn *prev_column,
109 GtkTreeViewColumn *next_column,
111 typedef void (* GtkTreeViewMappingFunc) (GtkTreeView *tree_view,
114 typedef gboolean (*GtkTreeViewSearchEqualFunc) (GtkTreeModel *model,
118 gpointer search_data);
122 GtkType gtk_tree_view_get_type (void);
123 GtkWidget *gtk_tree_view_new (void);
124 GtkWidget *gtk_tree_view_new_with_model (GtkTreeModel *model);
127 GtkTreeModel *gtk_tree_view_get_model (GtkTreeView *tree_view);
128 void gtk_tree_view_set_model (GtkTreeView *tree_view,
129 GtkTreeModel *model);
130 GtkTreeSelection *gtk_tree_view_get_selection (GtkTreeView *tree_view);
131 GtkAdjustment *gtk_tree_view_get_hadjustment (GtkTreeView *tree_view);
132 void gtk_tree_view_set_hadjustment (GtkTreeView *tree_view,
133 GtkAdjustment *adjustment);
134 GtkAdjustment *gtk_tree_view_get_vadjustment (GtkTreeView *tree_view);
135 void gtk_tree_view_set_vadjustment (GtkTreeView *tree_view,
136 GtkAdjustment *adjustment);
137 gboolean gtk_tree_view_get_headers_visible (GtkTreeView *tree_view);
138 void gtk_tree_view_set_headers_visible (GtkTreeView *tree_view,
139 gboolean headers_visible);
140 void gtk_tree_view_columns_autosize (GtkTreeView *tree_view);
141 void gtk_tree_view_set_headers_clickable (GtkTreeView *tree_view,
143 void gtk_tree_view_set_rules_hint (GtkTreeView *tree_view,
145 gboolean gtk_tree_view_get_rules_hint (GtkTreeView *tree_view);
147 /* Column funtions */
148 gint gtk_tree_view_append_column (GtkTreeView *tree_view,
149 GtkTreeViewColumn *column);
150 gint gtk_tree_view_remove_column (GtkTreeView *tree_view,
151 GtkTreeViewColumn *column);
152 gint gtk_tree_view_insert_column (GtkTreeView *tree_view,
153 GtkTreeViewColumn *column,
155 gint gtk_tree_view_insert_column_with_attributes (GtkTreeView *tree_view,
158 GtkCellRenderer *cell,
160 gint gtk_tree_view_insert_column_with_data_func (GtkTreeView *tree_view,
163 GtkCellRenderer *cell,
164 GtkTreeCellDataFunc func,
166 GDestroyNotify dnotify);
167 GtkTreeViewColumn *gtk_tree_view_get_column (GtkTreeView *tree_view,
169 GList *gtk_tree_view_get_columns (GtkTreeView *tree_view);
170 void gtk_tree_view_move_column_after (GtkTreeView *tree_view,
171 GtkTreeViewColumn *column,
172 GtkTreeViewColumn *base_column);
173 void gtk_tree_view_set_expander_column (GtkTreeView *tree_view,
174 GtkTreeViewColumn *column);
175 GtkTreeViewColumn *gtk_tree_view_get_expander_column (GtkTreeView *tree_view);
176 void gtk_tree_view_set_column_drag_function (GtkTreeView *tree_view,
177 GtkTreeViewColumnDropFunc func,
179 GtkDestroyNotify destroy);
182 void gtk_tree_view_scroll_to_point (GtkTreeView *tree_view,
185 void gtk_tree_view_scroll_to_cell (GtkTreeView *tree_view,
187 GtkTreeViewColumn *column,
191 void gtk_tree_view_row_activated (GtkTreeView *tree_view,
193 GtkTreeViewColumn *column);
194 void gtk_tree_view_expand_all (GtkTreeView *tree_view);
195 void gtk_tree_view_collapse_all (GtkTreeView *tree_view);
196 gboolean gtk_tree_view_expand_row (GtkTreeView *tree_view,
199 gboolean gtk_tree_view_collapse_row (GtkTreeView *tree_view,
201 void gtk_tree_view_map_expanded_rows (GtkTreeView *tree_view,
202 GtkTreeViewMappingFunc func,
204 gboolean gtk_tree_view_row_expanded (GtkTreeView *tree_view,
206 void gtk_tree_view_set_reorderable (GtkTreeView *tree_view,
207 gboolean reorderable);
208 gboolean gtk_tree_view_get_reorderable (GtkTreeView *tree_view);
209 void gtk_tree_view_set_cursor (GtkTreeView *tree_view,
211 GtkTreeViewColumn *focus_column,
212 gboolean start_editing);
213 void gtk_tree_view_get_cursor (GtkTreeView *tree_view,
215 GtkTreeViewColumn **focus_column);
218 /* Layout information */
219 gboolean gtk_tree_view_get_path_at_pos (GtkTreeView *tree_view,
224 GtkTreeViewColumn **column,
227 void gtk_tree_view_get_cell_area (GtkTreeView *tree_view,
229 GtkTreeViewColumn *column,
231 void gtk_tree_view_get_background_area (GtkTreeView *tree_view,
233 GtkTreeViewColumn *column,
235 void gtk_tree_view_get_visible_rect (GtkTreeView *tree_view,
236 GdkRectangle *visible_rect);
237 void gtk_tree_view_widget_to_tree_coords (GtkTreeView *tree_view,
242 void gtk_tree_view_tree_to_widget_coords (GtkTreeView *tree_view,
248 /* Drag-and-Drop support */
249 void gtk_tree_view_enable_model_drag_source (GtkTreeView *tree_view,
250 GdkModifierType start_button_mask,
251 const GtkTargetEntry *targets,
253 GdkDragAction actions);
254 void gtk_tree_view_enable_model_drag_dest (GtkTreeView *tree_view,
255 const GtkTargetEntry *targets,
257 GdkDragAction actions);
258 void gtk_tree_view_unset_rows_drag_source (GtkTreeView *tree_view);
259 void gtk_tree_view_unset_rows_drag_dest (GtkTreeView *tree_view);
262 /* These are useful to implement your own custom stuff. */
263 void gtk_tree_view_set_drag_dest_row (GtkTreeView *tree_view,
265 GtkTreeViewDropPosition pos);
266 void gtk_tree_view_get_drag_dest_row (GtkTreeView *tree_view,
268 GtkTreeViewDropPosition *pos);
269 gboolean gtk_tree_view_get_dest_row_at_pos (GtkTreeView *tree_view,
273 GtkTreeViewDropPosition *pos);
274 GdkPixmap *gtk_tree_view_create_row_drag_icon (GtkTreeView *tree_view,
277 /* Interactive search */
278 void gtk_tree_view_set_enable_search (GtkTreeView *tree_view,
279 gboolean enable_search);
280 gboolean gtk_tree_view_get_enable_search (GtkTreeView *tree_view);
281 gint gtk_tree_view_get_search_column (GtkTreeView *tree_view);
282 void gtk_tree_view_set_search_column (GtkTreeView *tree_view,
284 GtkTreeViewSearchEqualFunc gtk_tree_view_get_search_equal_func (GtkTreeView *tree_view);
285 void gtk_tree_view_set_search_equal_func (GtkTreeView *tree_view,
286 GtkTreeViewSearchEqualFunc search_equal_func,
287 gpointer search_user_data,
288 GtkDestroyNotify search_destroy);
290 /* This function should really never be used. It is just for use by ATK.
292 typedef void (* GtkTreeDestroyCountFunc) (GtkTreeView *tree_view,
296 void gtk_tree_view_set_destroy_count_func (GtkTreeView *tree_view,
297 GtkTreeDestroyCountFunc func,
299 GtkDestroyNotify destroy);
304 #endif /* __cplusplus */
307 #endif /* __GTK_TREE_VIEW_H__ */