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/gtkcontainer.h>
23 #include <gtk/gtktreemodel.h>
24 #include <gtk/gtktreeviewcolumn.h>
25 #include <gtk/gtkdnd.h>
29 #endif /* __cplusplus */
33 /* drop before/after this row */
34 GTK_TREE_VIEW_DROP_BEFORE,
35 GTK_TREE_VIEW_DROP_AFTER,
36 /* drop as a child of this row (with fallback to before or after
37 * if into is not possible)
39 GTK_TREE_VIEW_DROP_INTO_OR_BEFORE,
40 GTK_TREE_VIEW_DROP_INTO_OR_AFTER
41 } GtkTreeViewDropPosition;
43 #define GTK_TYPE_TREE_VIEW (gtk_tree_view_get_type ())
44 #define GTK_TREE_VIEW(obj) (GTK_CHECK_CAST ((obj), GTK_TYPE_TREE_VIEW, GtkTreeView))
45 #define GTK_TREE_VIEW_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), GTK_TYPE_TREE_VIEW, GtkTreeViewClass))
46 #define GTK_IS_TREE_VIEW(obj) (GTK_CHECK_TYPE ((obj), GTK_TYPE_TREE_VIEW))
47 #define GTK_IS_TREE_VIEW_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((obj), GTK_TYPE_TREE_VIEW))
49 typedef struct _GtkTreeView GtkTreeView;
50 typedef struct _GtkTreeViewClass GtkTreeViewClass;
51 typedef struct _GtkTreeViewPrivate GtkTreeViewPrivate;
52 typedef struct _GtkTreeSelection GtkTreeSelection;
53 typedef struct _GtkTreeSelectionClass GtkTreeSelectionClass;
59 GtkTreeViewPrivate *priv;
62 struct _GtkTreeViewClass
64 GtkContainerClass parent_class;
66 void (* set_scroll_adjustments) (GtkTreeView *tree_view,
67 GtkAdjustment *hadjustment,
68 GtkAdjustment *vadjustment);
69 void (* row_activated) (GtkTreeView *tree_view,
71 GtkTreeViewColumn *column);
72 gboolean (* expand_row) (GtkTreeView *tree_view,
75 gboolean (* collapse_row) (GtkTreeView *tree_view,
78 void (* columns_changed) (GtkTreeView *tree_view);
82 typedef gboolean (* GtkTreeViewColumnDropFunc) (GtkTreeView *tree_view,
83 GtkTreeViewColumn *column,
84 GtkTreeViewColumn *prev_column,
85 GtkTreeViewColumn *next_column,
87 typedef gboolean (* GtkTreeViewDraggableFunc) (GtkTreeView *tree_view,
88 GdkDragContext *context,
91 typedef void (* GtkTreeViewMappingFunc) (GtkTreeView *tree_view,
94 typedef gboolean (* GtkTreeViewDroppableFunc) (GtkTreeView *tree_view,
95 GdkDragContext *context,
97 GtkTreeViewDropPosition *pos,
102 GtkType gtk_tree_view_get_type (void);
103 GtkWidget *gtk_tree_view_new (void);
104 GtkWidget *gtk_tree_view_new_with_model (GtkTreeModel *model);
107 GtkTreeModel *gtk_tree_view_get_model (GtkTreeView *tree_view);
108 void gtk_tree_view_set_model (GtkTreeView *tree_view,
109 GtkTreeModel *model);
110 GtkTreeSelection *gtk_tree_view_get_selection (GtkTreeView *tree_view);
111 GtkAdjustment *gtk_tree_view_get_hadjustment (GtkTreeView *tree_view);
112 void gtk_tree_view_set_hadjustment (GtkTreeView *tree_view,
113 GtkAdjustment *adjustment);
114 GtkAdjustment *gtk_tree_view_get_vadjustment (GtkTreeView *tree_view);
115 void gtk_tree_view_set_vadjustment (GtkTreeView *tree_view,
116 GtkAdjustment *adjustment);
117 gboolean gtk_tree_view_get_headers_visible (GtkTreeView *tree_view);
118 void gtk_tree_view_set_headers_visible (GtkTreeView *tree_view,
119 gboolean headers_visible);
120 void gtk_tree_view_columns_autosize (GtkTreeView *tree_view);
121 void gtk_tree_view_set_headers_clickable (GtkTreeView *tree_view,
123 void gtk_tree_view_set_rules_hint (GtkTreeView *tree_view,
125 gboolean gtk_tree_view_get_rules_hint (GtkTreeView *tree_view);
127 /* Column funtions */
128 gint gtk_tree_view_append_column (GtkTreeView *tree_view,
129 GtkTreeViewColumn *column);
130 gint gtk_tree_view_remove_column (GtkTreeView *tree_view,
131 GtkTreeViewColumn *column);
132 gint gtk_tree_view_insert_column (GtkTreeView *tree_view,
133 GtkTreeViewColumn *column,
135 gint gtk_tree_view_insert_column_with_attributes (GtkTreeView *tree_view,
138 GtkCellRenderer *cell,
140 GtkTreeViewColumn *gtk_tree_view_get_column (GtkTreeView *tree_view,
142 GList *gtk_tree_view_get_columns (GtkTreeView *tree_view);
143 void gtk_tree_view_move_column_after (GtkTreeView *tree_view,
144 GtkTreeViewColumn *column,
145 GtkTreeViewColumn *base_column);
146 void gtk_tree_view_set_expander_column (GtkTreeView *tree_view,
148 gint gtk_tree_view_get_expander_column (GtkTreeView *tree_view);
149 void gtk_tree_view_set_column_drag_function (GtkTreeView *tree_view,
150 GtkTreeViewColumnDropFunc func,
152 GtkDestroyNotify destroy);
155 void gtk_tree_view_scroll_to_point (GtkTreeView *tree_view,
158 void gtk_tree_view_scroll_to_cell (GtkTreeView *tree_view,
160 GtkTreeViewColumn *column,
163 void gtk_tree_view_row_activated (GtkTreeView *tree_view,
165 GtkTreeViewColumn *column);
166 void gtk_tree_view_expand_all (GtkTreeView *tree_view);
167 void gtk_tree_view_collapse_all (GtkTreeView *tree_view);
168 gboolean gtk_tree_view_expand_row (GtkTreeView *tree_view,
171 gboolean gtk_tree_view_collapse_row (GtkTreeView *tree_view,
173 void gtk_tree_view_map_expanded_rows (GtkTreeView *tree_view,
174 GtkTreeViewMappingFunc func,
176 void gtk_tree_view_set_reorderable (GtkTreeView *tree_view,
177 gboolean reorderable);
180 /* Layout information */
181 gboolean gtk_tree_view_get_path_at_pos (GtkTreeView *tree_view,
186 GtkTreeViewColumn **column,
189 void gtk_tree_view_get_cell_area (GtkTreeView *tree_view,
191 GtkTreeViewColumn *column,
193 void gtk_tree_view_get_background_area (GtkTreeView *tree_view,
195 GtkTreeViewColumn *column,
197 void gtk_tree_view_get_visible_rect (GtkTreeView *tree_view,
198 GdkRectangle *visible_rect);
199 void gtk_tree_view_widget_to_tree_coords (GtkTreeView *tree_view,
204 void gtk_tree_view_tree_to_widget_coords (GtkTreeView *tree_view,
210 /* Drag-and-Drop support */
211 void gtk_tree_view_set_rows_drag_source (GtkTreeView *tree_view,
212 GdkModifierType start_button_mask,
213 const GtkTargetEntry *targets,
215 GdkDragAction actions,
216 GtkTreeViewDraggableFunc row_draggable_func,
218 void gtk_tree_view_set_rows_drag_dest (GtkTreeView *tree_view,
219 const GtkTargetEntry *targets,
221 GdkDragAction actions,
222 GtkTreeViewDroppableFunc location_droppable_func,
224 void gtk_tree_view_unset_rows_drag_source (GtkTreeView *tree_view);
225 void gtk_tree_view_unset_rows_drag_dest (GtkTreeView *tree_view);
228 /* These are useful to implement your own custom stuff. */
229 void gtk_tree_view_set_drag_dest_row (GtkTreeView *tree_view,
231 GtkTreeViewDropPosition pos);
232 void gtk_tree_view_get_drag_dest_row (GtkTreeView *tree_view,
234 GtkTreeViewDropPosition *pos);
235 gboolean gtk_tree_view_get_dest_row_at_pos (GtkTreeView *tree_view,
239 GtkTreeViewDropPosition *pos);
240 GdkPixmap *gtk_tree_view_create_row_drag_icon (GtkTreeView *tree_view,
245 #endif /* __cplusplus */
248 #endif /* __GTK_TREE_VIEW_H__ */