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,
81 typedef gboolean (* GtkTreeViewColumnDropFunc) (GtkTreeView *tree_view,
82 GtkTreeViewColumn *column,
83 GtkTreeViewColumn *prev_column,
84 GtkTreeViewColumn *next_column,
86 typedef gboolean (* GtkTreeViewDraggableFunc) (GtkTreeView *tree_view,
87 GdkDragContext *context,
90 typedef void (* GtkTreeViewMappingFunc) (GtkTreeView *tree_view,
93 typedef gboolean (* GtkTreeViewDroppableFunc) (GtkTreeView *tree_view,
94 GdkDragContext *context,
96 GtkTreeViewDropPosition *pos,
101 GtkType gtk_tree_view_get_type (void);
102 GtkWidget *gtk_tree_view_new (void);
103 GtkWidget *gtk_tree_view_new_with_model (GtkTreeModel *model);
106 GtkTreeModel *gtk_tree_view_get_model (GtkTreeView *tree_view);
107 void gtk_tree_view_set_model (GtkTreeView *tree_view,
108 GtkTreeModel *model);
109 GtkTreeSelection *gtk_tree_view_get_selection (GtkTreeView *tree_view);
110 GtkAdjustment *gtk_tree_view_get_hadjustment (GtkTreeView *tree_view);
111 void gtk_tree_view_set_hadjustment (GtkTreeView *tree_view,
112 GtkAdjustment *adjustment);
113 GtkAdjustment *gtk_tree_view_get_vadjustment (GtkTreeView *tree_view);
114 void gtk_tree_view_set_vadjustment (GtkTreeView *tree_view,
115 GtkAdjustment *adjustment);
116 gboolean gtk_tree_view_get_headers_visible (GtkTreeView *tree_view);
117 void gtk_tree_view_set_headers_visible (GtkTreeView *tree_view,
118 gboolean headers_visible);
119 void gtk_tree_view_columns_autosize (GtkTreeView *tree_view);
120 void gtk_tree_view_set_headers_clickable (GtkTreeView *tree_view,
122 void gtk_tree_view_set_rules_hint (GtkTreeView *tree_view,
124 gboolean gtk_tree_view_get_rules_hint (GtkTreeView *tree_view);
126 /* Column funtions */
127 gint gtk_tree_view_append_column (GtkTreeView *tree_view,
128 GtkTreeViewColumn *column);
129 gint gtk_tree_view_remove_column (GtkTreeView *tree_view,
130 GtkTreeViewColumn *column);
131 gint gtk_tree_view_insert_column (GtkTreeView *tree_view,
132 GtkTreeViewColumn *column,
134 gint gtk_tree_view_insert_column_with_attributes (GtkTreeView *tree_view,
137 GtkCellRenderer *cell,
139 GtkTreeViewColumn *gtk_tree_view_get_column (GtkTreeView *tree_view,
141 GList *gtk_tree_view_get_columns (GtkTreeView *tree_view);
142 void gtk_tree_view_move_column_after (GtkTreeView *tree_view,
143 GtkTreeViewColumn *column,
144 GtkTreeViewColumn *base_column);
145 void gtk_tree_view_set_expander_column (GtkTreeView *tree_view,
147 gint gtk_tree_view_get_expander_column (GtkTreeView *tree_view);
150 void gtk_tree_view_scroll_to_point (GtkTreeView *tree_view,
153 void gtk_tree_view_scroll_to_cell (GtkTreeView *tree_view,
155 GtkTreeViewColumn *column,
158 void gtk_tree_view_row_activated (GtkTreeView *tree_view,
160 GtkTreeViewColumn *column);
161 void gtk_tree_view_expand_all (GtkTreeView *tree_view);
162 void gtk_tree_view_collapse_all (GtkTreeView *tree_view);
163 gboolean gtk_tree_view_expand_row (GtkTreeView *tree_view,
166 gboolean gtk_tree_view_collapse_row (GtkTreeView *tree_view,
168 void gtk_tree_view_map_expanded_rows (GtkTreeView *tree_view,
169 GtkTreeViewMappingFunc func,
172 /* Layout information */
173 gboolean gtk_tree_view_get_path_at_pos (GtkTreeView *tree_view,
178 GtkTreeViewColumn **column,
181 void gtk_tree_view_get_cell_area (GtkTreeView *tree_view,
183 GtkTreeViewColumn *column,
185 void gtk_tree_view_get_background_area (GtkTreeView *tree_view,
187 GtkTreeViewColumn *column,
189 void gtk_tree_view_get_visible_rect (GtkTreeView *tree_view,
190 GdkRectangle *visible_rect);
191 void gtk_tree_view_widget_to_tree_coords (GtkTreeView *tree_view,
196 void gtk_tree_view_tree_to_widget_coords (GtkTreeView *tree_view,
202 /* Drag-and-Drop support */
203 void gtk_tree_view_set_rows_drag_source (GtkTreeView *tree_view,
204 GdkModifierType start_button_mask,
205 const GtkTargetEntry *targets,
207 GdkDragAction actions,
208 GtkTreeViewDraggableFunc row_draggable_func,
210 void gtk_tree_view_set_rows_drag_dest (GtkTreeView *tree_view,
211 const GtkTargetEntry *targets,
213 GdkDragAction actions,
214 GtkTreeViewDroppableFunc location_droppable_func,
216 void gtk_tree_view_unset_rows_drag_source (GtkTreeView *tree_view);
217 void gtk_tree_view_unset_rows_drag_dest (GtkTreeView *tree_view);
219 /* These are useful to implement your own custom stuff. */
220 void gtk_tree_view_set_drag_dest_row (GtkTreeView *tree_view,
222 GtkTreeViewDropPosition pos);
223 void gtk_tree_view_get_drag_dest_row (GtkTreeView *tree_view,
225 GtkTreeViewDropPosition *pos);
226 gboolean gtk_tree_view_get_dest_row_at_pos (GtkTreeView *tree_view,
230 GtkTreeViewDropPosition *pos);
231 GdkPixmap *gtk_tree_view_create_row_drag_icon (GtkTreeView *tree_view,
236 #endif /* __cplusplus */
239 #endif /* __GTK_TREE_VIEW_H__ */