summaryrefslogtreecommitdiff
path: root/gtk/gtktreeview.h
blob: d15109eff2f50ec80ea876dcd3f77a05edff0657 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
/* gtktreeview.h
 * Copyright (C) 2000  Red Hat, Inc.,  Jonathan Blandford <jrb@redhat.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */
#ifndef __GTK_TREE_VIEW_H__
#define __GTK_TREE_VIEW_H__

#include <gtk/gtkcontainer.h>
#include <gtk/gtktreemodel.h>
#include <gtk/gtktreeviewcolumn.h>
#include <gtk/gtkdnd.h>

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

typedef enum
{
  /* drop before/after this row */
  GTK_TREE_VIEW_DROP_BEFORE,
  GTK_TREE_VIEW_DROP_AFTER,
  /* drop as a child of this row (with fallback to before or after
   * if into is not possible)
   */
  GTK_TREE_VIEW_DROP_INTO_OR_BEFORE,
  GTK_TREE_VIEW_DROP_INTO_OR_AFTER
} GtkTreeViewDropPosition;

#define GTK_TYPE_TREE_VIEW		(gtk_tree_view_get_type ())
#define GTK_TREE_VIEW(obj)		(GTK_CHECK_CAST ((obj), GTK_TYPE_TREE_VIEW, GtkTreeView))
#define GTK_TREE_VIEW_CLASS(klass)	(GTK_CHECK_CLASS_CAST ((klass), GTK_TYPE_TREE_VIEW, GtkTreeViewClass))
#define GTK_IS_TREE_VIEW(obj)		(GTK_CHECK_TYPE ((obj), GTK_TYPE_TREE_VIEW))
#define GTK_IS_TREE_VIEW_CLASS(klass)	(GTK_CHECK_CLASS_TYPE ((obj), GTK_TYPE_TREE_VIEW))

typedef struct _GtkTreeView        GtkTreeView;
typedef struct _GtkTreeViewClass   GtkTreeViewClass;
typedef struct _GtkTreeViewPrivate GtkTreeViewPrivate;

typedef struct _GtkTreeSelection      GtkTreeSelection;
typedef struct _GtkTreeSelectionClass GtkTreeSelectionClass;


struct _GtkTreeView
{
  GtkContainer parent;

  GtkTreeViewPrivate *priv;
};

struct _GtkTreeViewClass
{
  GtkContainerClass parent_class;

  void (*set_scroll_adjustments) (GtkTreeView   *tree_view,
				  GtkAdjustment *hadjustment,
				  GtkAdjustment *vadjustment);
  gint (*expand_row)             (GtkTreeView   *tree_view,
				  GtkTreeIter   *iter);
};

GtkType                gtk_tree_view_get_type            (void);
GtkWidget             *gtk_tree_view_new                 (void);
GtkWidget             *gtk_tree_view_new_with_model      (GtkTreeModel       *model);

GtkTreeModel          *gtk_tree_view_get_model           (GtkTreeView        *tree_view);
void                   gtk_tree_view_set_model           (GtkTreeView        *tree_view,
							  GtkTreeModel       *model);
GtkTreeSelection      *gtk_tree_view_get_selection       (GtkTreeView        *tree_view);
GtkAdjustment         *gtk_tree_view_get_hadjustment     (GtkTreeView        *tree_view);
void                   gtk_tree_view_set_hadjustment     (GtkTreeView        *tree_view,
							  GtkAdjustment      *adjustment);
GtkAdjustment         *gtk_tree_view_get_vadjustment     (GtkTreeView        *tree_view);
void                   gtk_tree_view_set_vadjustment     (GtkTreeView        *tree_view,
							  GtkAdjustment      *adjustment);
gboolean               gtk_tree_view_get_headers_visible (GtkTreeView        *tree_view);
void                   gtk_tree_view_set_headers_visible (GtkTreeView        *tree_view,
							  gboolean            headers_visible);
void                   gtk_tree_view_columns_autosize    (GtkTreeView        *tree_view);
void                   gtk_tree_view_set_headers_clickable (GtkTreeView        *tree_view,
                                                            gboolean            setting);
gint                   gtk_tree_view_append_column       (GtkTreeView        *tree_view,
							  GtkTreeViewColumn  *column);
gint                   gtk_tree_view_remove_column       (GtkTreeView        *tree_view,
							  GtkTreeViewColumn  *column);
gint                   gtk_tree_view_insert_column       (GtkTreeView        *tree_view,
							  GtkTreeViewColumn  *column,
							  gint                position);
GtkTreeViewColumn     *gtk_tree_view_get_column          (GtkTreeView        *tree_view,
							  gint                n);

void                   gtk_tree_view_set_expander_column (GtkTreeView        *tree_view,
                                                          gint                col);

gint                   gtk_tree_view_get_expander_column (GtkTreeView        *tree_view);

/* Actions */
void                   gtk_tree_view_scroll_to_point     (GtkTreeView       *tree_view,
                                                          gint               tree_x,
                                                          gint               tree_y);

void                   gtk_tree_view_scroll_to_cell      (GtkTreeView        *tree_view,
							  GtkTreePath        *path,
							  GtkTreeViewColumn  *column,
							  gfloat              row_align,
							  gfloat              col_align);
gboolean               gtk_tree_view_get_path_at_pos     (GtkTreeView        *tree_view,
							  GdkWindow          *window,
							  gint                x,
							  gint                y,
							  GtkTreePath       **path,
							  GtkTreeViewColumn **column,
                                                          gint               *cell_x,
                                                          gint               *cell_y);
void                   gtk_tree_view_get_cell_rect       (GtkTreeView        *tree_view,
                                                          GtkTreePath        *path,
                                                          GtkTreeViewColumn  *column,
                                                          GdkRectangle       *rect);

void                   gtk_tree_view_expand_all          (GtkTreeView        *tree_view);
void                   gtk_tree_view_collapse_all        (GtkTreeView        *tree_view);
gboolean               gtk_tree_view_expand_row          (GtkTreeView        *tree_view,
							  GtkTreePath        *path,
							  gboolean            open_all);
gboolean               gtk_tree_view_collapse_row        (GtkTreeView        *tree_view,
							  GtkTreePath        *path);

void gtk_tree_view_get_visible_rect      (GtkTreeView  *tree_view,
                                          GdkRectangle *visible_rect);
void gtk_tree_view_widget_to_tree_coords (GtkTreeView  *tree_view,
                                          gint          wx,
                                          gint          wy,
                                          gint         *tx,
                                          gint         *ty);
void gtk_tree_view_tree_to_widget_coords (GtkTreeView  *tree_view,
                                          gint          tx,
                                          gint          ty,
                                          gint         *wx,
                                          gint         *wy);



/* Drag-and-Drop support */

typedef gboolean (* GtkTreeViewDraggableFunc) (GtkTreeView    *tree_view,
                                               GdkDragContext *context,
                                               GtkTreePath    *path,
                                               gpointer        user_data);

/* this func can change "pos" if it likes, in addition to returning
 * true/false for whether a drop is possible
 */
typedef gboolean (* GtkTreeViewDroppableFunc) (GtkTreeView             *tree_view,
                                               GdkDragContext          *context,
                                               GtkTreePath             *path,
                                               GtkTreeViewDropPosition *pos,
                                               gpointer                 user_data);

void     gtk_tree_view_set_rows_drag_source   (GtkTreeView              *tree_view,
                                               GdkModifierType           start_button_mask,
                                               const GtkTargetEntry     *targets,
                                               gint                      n_targets,
                                               GdkDragAction             actions,
                                               GtkTreeViewDraggableFunc  row_draggable_func,
                                               gpointer                  user_data);
void     gtk_tree_view_set_rows_drag_dest     (GtkTreeView              *tree_view,
                                               const GtkTargetEntry     *targets,
                                               gint                      n_targets,
                                               GdkDragAction             actions,
                                               GtkTreeViewDroppableFunc  location_droppable_func,
                                               gpointer                  user_data);

void     gtk_tree_view_unset_rows_drag_source (GtkTreeView *tree_view);
void     gtk_tree_view_unset_rows_drag_dest   (GtkTreeView *tree_view);

/* These are useful to implement your own custom stuff. */
void       gtk_tree_view_set_drag_dest_row    (GtkTreeView              *tree_view,
                                               GtkTreePath              *path,
                                               GtkTreeViewDropPosition   pos);
gboolean   gtk_tree_view_get_dest_row_at_pos  (GtkTreeView              *tree_view,
                                               gint                      drag_x,
                                               gint                      drag_y,
                                               GtkTreePath             **path,
                                               GtkTreeViewDropPosition  *pos);
GdkPixmap* gtk_tree_view_create_row_drag_icon (GtkTreeView              *tree_view,
                                               GtkTreePath              *path);

/* The selection data would normally have target type GTK_TREE_VIEW_ROW in this
 * case. If the target is wrong these functions return FALSE.
 */
gboolean gtk_selection_data_set_tree_row     (GtkSelectionData         *selection_data,
                                              GtkTreeView              *tree_view,
                                              GtkTreePath              *path);
gboolean gtk_selection_data_get_tree_row     (GtkSelectionData         *selection_data,
                                              GtkTreeView             **tree_view,
                                              GtkTreePath             **path);



#ifdef __cplusplus
}
#endif /* __cplusplus */


#endif /* __GTK_TREE_VIEW_H__ */