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);
88 /* Key Binding signals */
89 void (* move_cursor) (GtkTreeView *tree_view,
92 void (* select_cursor_row) (GtkTreeView *tree_view);
93 void (* toggle_cursor_row) (GtkTreeView *tree_view);
94 void (* expand_collapse_cursor_row) (GtkTreeView *tree_view,
98 void (* select_cursor_parent) (GtkTreeView *tree_view);
99 void (* start_interactive_search) (GtkTreeView *tree_view);
103 typedef gboolean (* GtkTreeViewColumnDropFunc) (GtkTreeView *tree_view,
104 GtkTreeViewColumn *column,
105 GtkTreeViewColumn *prev_column,
106 GtkTreeViewColumn *next_column,
108 typedef gboolean (* GtkTreeViewDraggableFunc) (GtkTreeView *tree_view,
109 GdkDragContext *context,
112 typedef void (* GtkTreeViewMappingFunc) (GtkTreeView *tree_view,
115 typedef gboolean (* GtkTreeViewDroppableFunc) (GtkTreeView *tree_view,
116 GdkDragContext *context,
118 GtkTreeViewDropPosition *pos,
120 typedef gboolean (*GtkTreeViewSearchEqualFunc) (GtkTreeModel *model,
124 gpointer search_data);
128 GtkType gtk_tree_view_get_type (void);
129 GtkWidget *gtk_tree_view_new (void);
130 GtkWidget *gtk_tree_view_new_with_model (GtkTreeModel *model);
133 GtkTreeModel *gtk_tree_view_get_model (GtkTreeView *tree_view);
134 void gtk_tree_view_set_model (GtkTreeView *tree_view,
135 GtkTreeModel *model);
136 GtkTreeSelection *gtk_tree_view_get_selection (GtkTreeView *tree_view);
137 GtkAdjustment *gtk_tree_view_get_hadjustment (GtkTreeView *tree_view);
138 void gtk_tree_view_set_hadjustment (GtkTreeView *tree_view,
139 GtkAdjustment *adjustment);
140 GtkAdjustment *gtk_tree_view_get_vadjustment (GtkTreeView *tree_view);
141 void gtk_tree_view_set_vadjustment (GtkTreeView *tree_view,
142 GtkAdjustment *adjustment);
143 gboolean gtk_tree_view_get_headers_visible (GtkTreeView *tree_view);
144 void gtk_tree_view_set_headers_visible (GtkTreeView *tree_view,
145 gboolean headers_visible);
146 void gtk_tree_view_columns_autosize (GtkTreeView *tree_view);
147 void gtk_tree_view_set_headers_clickable (GtkTreeView *tree_view,
149 void gtk_tree_view_set_rules_hint (GtkTreeView *tree_view,
151 gboolean gtk_tree_view_get_rules_hint (GtkTreeView *tree_view);
153 /* Column funtions */
154 gint gtk_tree_view_append_column (GtkTreeView *tree_view,
155 GtkTreeViewColumn *column);
156 gint gtk_tree_view_remove_column (GtkTreeView *tree_view,
157 GtkTreeViewColumn *column);
158 gint gtk_tree_view_insert_column (GtkTreeView *tree_view,
159 GtkTreeViewColumn *column,
161 gint gtk_tree_view_insert_column_with_attributes (GtkTreeView *tree_view,
164 GtkCellRenderer *cell,
166 gint gtk_tree_view_insert_column_with_data_func (GtkTreeView *tree_view,
169 GtkCellRenderer *cell,
170 GtkTreeCellDataFunc func,
172 GDestroyNotify dnotify);
173 GtkTreeViewColumn *gtk_tree_view_get_column (GtkTreeView *tree_view,
175 GList *gtk_tree_view_get_columns (GtkTreeView *tree_view);
176 void gtk_tree_view_move_column_after (GtkTreeView *tree_view,
177 GtkTreeViewColumn *column,
178 GtkTreeViewColumn *base_column);
179 void gtk_tree_view_set_expander_column (GtkTreeView *tree_view,
180 GtkTreeViewColumn *column);
181 GtkTreeViewColumn *gtk_tree_view_get_expander_column (GtkTreeView *tree_view);
182 void gtk_tree_view_set_column_drag_function (GtkTreeView *tree_view,
183 GtkTreeViewColumnDropFunc func,
185 GtkDestroyNotify destroy);
188 void gtk_tree_view_scroll_to_point (GtkTreeView *tree_view,
191 void gtk_tree_view_scroll_to_cell (GtkTreeView *tree_view,
193 GtkTreeViewColumn *column,
197 void gtk_tree_view_row_activated (GtkTreeView *tree_view,
199 GtkTreeViewColumn *column);
200 void gtk_tree_view_expand_all (GtkTreeView *tree_view);
201 void gtk_tree_view_collapse_all (GtkTreeView *tree_view);
202 gboolean gtk_tree_view_expand_row (GtkTreeView *tree_view,
205 gboolean gtk_tree_view_collapse_row (GtkTreeView *tree_view,
207 void gtk_tree_view_map_expanded_rows (GtkTreeView *tree_view,
208 GtkTreeViewMappingFunc func,
210 gboolean gtk_tree_view_row_expanded (GtkTreeView *tree_view,
212 void gtk_tree_view_set_reorderable (GtkTreeView *tree_view,
213 gboolean reorderable);
214 gboolean gtk_tree_view_get_reorderable (GtkTreeView *tree_view);
215 void gtk_tree_view_set_cursor (GtkTreeView *tree_view,
217 GtkTreeViewColumn *focus_column,
218 gboolean start_editing);
221 /* Layout information */
222 gboolean gtk_tree_view_get_path_at_pos (GtkTreeView *tree_view,
227 GtkTreeViewColumn **column,
230 void gtk_tree_view_get_cell_area (GtkTreeView *tree_view,
232 GtkTreeViewColumn *column,
234 void gtk_tree_view_get_background_area (GtkTreeView *tree_view,
236 GtkTreeViewColumn *column,
238 void gtk_tree_view_get_visible_rect (GtkTreeView *tree_view,
239 GdkRectangle *visible_rect);
240 void gtk_tree_view_widget_to_tree_coords (GtkTreeView *tree_view,
245 void gtk_tree_view_tree_to_widget_coords (GtkTreeView *tree_view,
251 /* Drag-and-Drop support */
252 void gtk_tree_view_set_rows_drag_source (GtkTreeView *tree_view,
253 GdkModifierType start_button_mask,
254 const GtkTargetEntry *targets,
256 GdkDragAction actions,
257 GtkTreeViewDraggableFunc row_draggable_func,
259 void gtk_tree_view_set_rows_drag_dest (GtkTreeView *tree_view,
260 const GtkTargetEntry *targets,
262 GdkDragAction actions,
263 GtkTreeViewDroppableFunc location_droppable_func,
265 void gtk_tree_view_unset_rows_drag_source (GtkTreeView *tree_view);
266 void gtk_tree_view_unset_rows_drag_dest (GtkTreeView *tree_view);
269 /* These are useful to implement your own custom stuff. */
270 void gtk_tree_view_set_drag_dest_row (GtkTreeView *tree_view,
272 GtkTreeViewDropPosition pos);
273 void gtk_tree_view_get_drag_dest_row (GtkTreeView *tree_view,
275 GtkTreeViewDropPosition *pos);
276 gboolean gtk_tree_view_get_dest_row_at_pos (GtkTreeView *tree_view,
280 GtkTreeViewDropPosition *pos);
281 GdkPixmap *gtk_tree_view_create_row_drag_icon (GtkTreeView *tree_view,
284 /* Interactive search */
285 void gtk_tree_view_set_enable_search (GtkTreeView *tree_view,
286 gboolean use_search);
287 gboolean gtk_tree_view_get_enable_search (GtkTreeView *tree_view);
288 gint gtk_tree_view_get_search_column (GtkTreeView *tree_view);
289 void gtk_tree_view_set_search_column (GtkTreeView *tree_view,
291 GtkTreeViewSearchEqualFunc gtk_tree_view_get_search_equal_func (GtkTreeView *tree_view);
292 void gtk_tree_view_set_search_equal_func (GtkTreeView *tree_view,
293 GtkTreeViewSearchEqualFunc search_compare_func,
294 gpointer search_data,
295 GtkDestroyNotify search_destroy);
297 /* This function should really never be used. It is just for use by ATK.
299 typedef void (* GtkTreeDestroyCountFunc) (GtkTreeView *tree_view,
303 void gtk_tree_view_set_destroy_count_func (GtkTreeView *tree_view,
304 GtkTreeDestroyCountFunc func,
306 GtkDestroyNotify destroy);
313 #endif /* __cplusplus */
316 #endif /* __GTK_TREE_VIEW_H__ */