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))
48 #define GTK_TREE_VIEW_GET_CLASS(obj) (GTK_CHECK_GET_CLASS ((obj), GTK_TYPE_TREE_VIEW, GtkTreeViewClass))
50 typedef struct _GtkTreeView GtkTreeView;
51 typedef struct _GtkTreeViewClass GtkTreeViewClass;
52 typedef struct _GtkTreeViewPrivate GtkTreeViewPrivate;
53 typedef struct _GtkTreeSelection GtkTreeSelection;
54 typedef struct _GtkTreeSelectionClass GtkTreeSelectionClass;
60 GtkTreeViewPrivate *priv;
63 struct _GtkTreeViewClass
65 GtkContainerClass parent_class;
67 void (* set_scroll_adjustments) (GtkTreeView *tree_view,
68 GtkAdjustment *hadjustment,
69 GtkAdjustment *vadjustment);
70 void (* row_activated) (GtkTreeView *tree_view,
72 GtkTreeViewColumn *column);
73 gboolean (* expand_row) (GtkTreeView *tree_view,
76 gboolean (* collapse_row) (GtkTreeView *tree_view,
79 void (* columns_changed) (GtkTreeView *tree_view);
81 /* Key Binding signals */
82 void (* begin_extended_selection) (GtkTreeView *tree_view);
83 void (* end_extended_selection) (GtkTreeView *tree_view);
84 void (* begin_free_motion) (GtkTreeView *tree_view);
85 void (* end_free_motion) (GtkTreeView *tree_view);
86 void (* move_cursor) (GtkTreeView *tree_view,
89 void (* toggle_cursor_row) (GtkTreeView *tree_view);
90 void (* expand_collapse_cursor_row) (GtkTreeView *tree_view,
94 void (* select_cursor_parent) (GtkTreeView *tree_view);
98 typedef gboolean (* GtkTreeViewColumnDropFunc) (GtkTreeView *tree_view,
99 GtkTreeViewColumn *column,
100 GtkTreeViewColumn *prev_column,
101 GtkTreeViewColumn *next_column,
103 typedef gboolean (* GtkTreeViewDraggableFunc) (GtkTreeView *tree_view,
104 GdkDragContext *context,
107 typedef void (* GtkTreeViewMappingFunc) (GtkTreeView *tree_view,
110 typedef gboolean (* GtkTreeViewDroppableFunc) (GtkTreeView *tree_view,
111 GdkDragContext *context,
113 GtkTreeViewDropPosition *pos,
118 GtkType gtk_tree_view_get_type (void);
119 GtkWidget *gtk_tree_view_new (void);
120 GtkWidget *gtk_tree_view_new_with_model (GtkTreeModel *model);
123 GtkTreeModel *gtk_tree_view_get_model (GtkTreeView *tree_view);
124 void gtk_tree_view_set_model (GtkTreeView *tree_view,
125 GtkTreeModel *model);
126 GtkTreeSelection *gtk_tree_view_get_selection (GtkTreeView *tree_view);
127 GtkAdjustment *gtk_tree_view_get_hadjustment (GtkTreeView *tree_view);
128 void gtk_tree_view_set_hadjustment (GtkTreeView *tree_view,
129 GtkAdjustment *adjustment);
130 GtkAdjustment *gtk_tree_view_get_vadjustment (GtkTreeView *tree_view);
131 void gtk_tree_view_set_vadjustment (GtkTreeView *tree_view,
132 GtkAdjustment *adjustment);
133 gboolean gtk_tree_view_get_headers_visible (GtkTreeView *tree_view);
134 void gtk_tree_view_set_headers_visible (GtkTreeView *tree_view,
135 gboolean headers_visible);
136 void gtk_tree_view_columns_autosize (GtkTreeView *tree_view);
137 void gtk_tree_view_set_headers_clickable (GtkTreeView *tree_view,
139 void gtk_tree_view_set_rules_hint (GtkTreeView *tree_view,
141 gboolean gtk_tree_view_get_rules_hint (GtkTreeView *tree_view);
143 /* Column funtions */
144 gint gtk_tree_view_append_column (GtkTreeView *tree_view,
145 GtkTreeViewColumn *column);
146 gint gtk_tree_view_remove_column (GtkTreeView *tree_view,
147 GtkTreeViewColumn *column);
148 gint gtk_tree_view_insert_column (GtkTreeView *tree_view,
149 GtkTreeViewColumn *column,
151 gint gtk_tree_view_insert_column_with_attributes (GtkTreeView *tree_view,
154 GtkCellRenderer *cell,
156 gint gtk_tree_view_insert_column_with_data_func (GtkTreeView *tree_view,
159 GtkCellRenderer *cell,
160 GtkTreeCellDataFunc func,
162 GDestroyNotify dnotify);
163 GtkTreeViewColumn *gtk_tree_view_get_column (GtkTreeView *tree_view,
165 GList *gtk_tree_view_get_columns (GtkTreeView *tree_view);
166 void gtk_tree_view_move_column_after (GtkTreeView *tree_view,
167 GtkTreeViewColumn *column,
168 GtkTreeViewColumn *base_column);
169 void gtk_tree_view_set_expander_column (GtkTreeView *tree_view,
171 gint gtk_tree_view_get_expander_column (GtkTreeView *tree_view);
172 void gtk_tree_view_set_column_drag_function (GtkTreeView *tree_view,
173 GtkTreeViewColumnDropFunc func,
175 GtkDestroyNotify destroy);
178 void gtk_tree_view_scroll_to_point (GtkTreeView *tree_view,
181 void gtk_tree_view_scroll_to_cell (GtkTreeView *tree_view,
183 GtkTreeViewColumn *column,
186 void gtk_tree_view_row_activated (GtkTreeView *tree_view,
188 GtkTreeViewColumn *column);
189 void gtk_tree_view_expand_all (GtkTreeView *tree_view);
190 void gtk_tree_view_collapse_all (GtkTreeView *tree_view);
191 gboolean gtk_tree_view_expand_row (GtkTreeView *tree_view,
194 gboolean gtk_tree_view_collapse_row (GtkTreeView *tree_view,
196 void gtk_tree_view_map_expanded_rows (GtkTreeView *tree_view,
197 GtkTreeViewMappingFunc func,
199 void gtk_tree_view_set_reorderable (GtkTreeView *tree_view,
200 gboolean reorderable);
201 void gtk_tree_view_set_cursor (GtkTreeView *tree_view,
205 /* Layout information */
206 gboolean gtk_tree_view_get_path_at_pos (GtkTreeView *tree_view,
211 GtkTreeViewColumn **column,
214 void gtk_tree_view_get_cell_area (GtkTreeView *tree_view,
216 GtkTreeViewColumn *column,
218 void gtk_tree_view_get_background_area (GtkTreeView *tree_view,
220 GtkTreeViewColumn *column,
222 void gtk_tree_view_get_visible_rect (GtkTreeView *tree_view,
223 GdkRectangle *visible_rect);
224 void gtk_tree_view_widget_to_tree_coords (GtkTreeView *tree_view,
229 void gtk_tree_view_tree_to_widget_coords (GtkTreeView *tree_view,
235 /* Drag-and-Drop support */
236 void gtk_tree_view_set_rows_drag_source (GtkTreeView *tree_view,
237 GdkModifierType start_button_mask,
238 const GtkTargetEntry *targets,
240 GdkDragAction actions,
241 GtkTreeViewDraggableFunc row_draggable_func,
243 void gtk_tree_view_set_rows_drag_dest (GtkTreeView *tree_view,
244 const GtkTargetEntry *targets,
246 GdkDragAction actions,
247 GtkTreeViewDroppableFunc location_droppable_func,
249 void gtk_tree_view_unset_rows_drag_source (GtkTreeView *tree_view);
250 void gtk_tree_view_unset_rows_drag_dest (GtkTreeView *tree_view);
253 /* These are useful to implement your own custom stuff. */
254 void gtk_tree_view_set_drag_dest_row (GtkTreeView *tree_view,
256 GtkTreeViewDropPosition pos);
257 void gtk_tree_view_get_drag_dest_row (GtkTreeView *tree_view,
259 GtkTreeViewDropPosition *pos);
260 gboolean gtk_tree_view_get_dest_row_at_pos (GtkTreeView *tree_view,
264 GtkTreeViewDropPosition *pos);
265 GdkPixmap *gtk_tree_view_create_row_drag_icon (GtkTreeView *tree_view,
270 #endif /* __cplusplus */
273 #endif /* __GTK_TREE_VIEW_H__ */