2 * Copyright (C) 2002, 2004 Anders Carlsson <andersca@gnome.org>
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.
20 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
21 #error "Only <gtk/gtk.h> can be included directly."
24 #ifndef __GTK_ICON_VIEW_H__
25 #define __GTK_ICON_VIEW_H__
27 #include <gtk/gtkcontainer.h>
28 #include <gtk/gtktreemodel.h>
29 #include <gtk/gtkcellrenderer.h>
30 #include <gtk/gtkselection.h>
31 #include <gtk/gtktooltip.h>
35 #define GTK_TYPE_ICON_VIEW (gtk_icon_view_get_type ())
36 #define GTK_ICON_VIEW(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_ICON_VIEW, GtkIconView))
37 #define GTK_ICON_VIEW_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_ICON_VIEW, GtkIconViewClass))
38 #define GTK_IS_ICON_VIEW(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_ICON_VIEW))
39 #define GTK_IS_ICON_VIEW_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_ICON_VIEW))
40 #define GTK_ICON_VIEW_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_ICON_VIEW, GtkIconViewClass))
42 typedef struct _GtkIconView GtkIconView;
43 typedef struct _GtkIconViewClass GtkIconViewClass;
44 typedef struct _GtkIconViewPrivate GtkIconViewPrivate;
46 typedef void (* GtkIconViewForeachFunc) (GtkIconView *icon_view,
52 GTK_ICON_VIEW_NO_DROP,
53 GTK_ICON_VIEW_DROP_INTO,
54 GTK_ICON_VIEW_DROP_LEFT,
55 GTK_ICON_VIEW_DROP_RIGHT,
56 GTK_ICON_VIEW_DROP_ABOVE,
57 GTK_ICON_VIEW_DROP_BELOW
58 } GtkIconViewDropPosition;
64 GtkIconViewPrivate *GSEAL (priv);
67 struct _GtkIconViewClass
69 GtkContainerClass parent_class;
71 void (* set_scroll_adjustments) (GtkIconView *icon_view,
72 GtkAdjustment *hadjustment,
73 GtkAdjustment *vadjustment);
75 void (* item_activated) (GtkIconView *icon_view,
77 void (* selection_changed) (GtkIconView *icon_view);
79 /* Key binding signals */
80 void (* select_all) (GtkIconView *icon_view);
81 void (* unselect_all) (GtkIconView *icon_view);
82 void (* select_cursor_item) (GtkIconView *icon_view);
83 void (* toggle_cursor_item) (GtkIconView *icon_view);
84 gboolean (* move_cursor) (GtkIconView *icon_view,
87 gboolean (* activate_cursor_item) (GtkIconView *icon_view);
90 GType gtk_icon_view_get_type (void) G_GNUC_CONST;
91 GtkWidget * gtk_icon_view_new (void);
92 GtkWidget * gtk_icon_view_new_with_model (GtkTreeModel *model);
94 void gtk_icon_view_set_model (GtkIconView *icon_view,
96 GtkTreeModel * gtk_icon_view_get_model (GtkIconView *icon_view);
97 void gtk_icon_view_set_text_column (GtkIconView *icon_view,
99 gint gtk_icon_view_get_text_column (GtkIconView *icon_view);
100 void gtk_icon_view_set_markup_column (GtkIconView *icon_view,
102 gint gtk_icon_view_get_markup_column (GtkIconView *icon_view);
103 void gtk_icon_view_set_pixbuf_column (GtkIconView *icon_view,
105 gint gtk_icon_view_get_pixbuf_column (GtkIconView *icon_view);
107 void gtk_icon_view_set_orientation (GtkIconView *icon_view,
108 GtkOrientation orientation);
109 GtkOrientation gtk_icon_view_get_orientation (GtkIconView *icon_view);
110 void gtk_icon_view_set_columns (GtkIconView *icon_view,
112 gint gtk_icon_view_get_columns (GtkIconView *icon_view);
113 void gtk_icon_view_set_item_width (GtkIconView *icon_view,
115 gint gtk_icon_view_get_item_width (GtkIconView *icon_view);
116 void gtk_icon_view_set_spacing (GtkIconView *icon_view,
118 gint gtk_icon_view_get_spacing (GtkIconView *icon_view);
119 void gtk_icon_view_set_row_spacing (GtkIconView *icon_view,
121 gint gtk_icon_view_get_row_spacing (GtkIconView *icon_view);
122 void gtk_icon_view_set_column_spacing (GtkIconView *icon_view,
123 gint column_spacing);
124 gint gtk_icon_view_get_column_spacing (GtkIconView *icon_view);
125 void gtk_icon_view_set_margin (GtkIconView *icon_view,
127 gint gtk_icon_view_get_margin (GtkIconView *icon_view);
128 void gtk_icon_view_set_item_padding (GtkIconView *icon_view,
130 gint gtk_icon_view_get_item_padding (GtkIconView *icon_view);
133 GtkTreePath * gtk_icon_view_get_path_at_pos (GtkIconView *icon_view,
136 gboolean gtk_icon_view_get_item_at_pos (GtkIconView *icon_view,
140 GtkCellRenderer **cell);
141 gboolean gtk_icon_view_get_visible_range (GtkIconView *icon_view,
142 GtkTreePath **start_path,
143 GtkTreePath **end_path);
145 void gtk_icon_view_selected_foreach (GtkIconView *icon_view,
146 GtkIconViewForeachFunc func,
148 void gtk_icon_view_set_selection_mode (GtkIconView *icon_view,
149 GtkSelectionMode mode);
150 GtkSelectionMode gtk_icon_view_get_selection_mode (GtkIconView *icon_view);
151 void gtk_icon_view_select_path (GtkIconView *icon_view,
153 void gtk_icon_view_unselect_path (GtkIconView *icon_view,
155 gboolean gtk_icon_view_path_is_selected (GtkIconView *icon_view,
157 gint gtk_icon_view_get_item_row (GtkIconView *icon_view,
159 gint gtk_icon_view_get_item_column (GtkIconView *icon_view,
161 GList *gtk_icon_view_get_selected_items (GtkIconView *icon_view);
162 void gtk_icon_view_select_all (GtkIconView *icon_view);
163 void gtk_icon_view_unselect_all (GtkIconView *icon_view);
164 void gtk_icon_view_item_activated (GtkIconView *icon_view,
166 void gtk_icon_view_set_cursor (GtkIconView *icon_view,
168 GtkCellRenderer *cell,
169 gboolean start_editing);
170 gboolean gtk_icon_view_get_cursor (GtkIconView *icon_view,
172 GtkCellRenderer **cell);
173 void gtk_icon_view_scroll_to_path (GtkIconView *icon_view,
179 /* Drag-and-Drop support */
180 void gtk_icon_view_enable_model_drag_source (GtkIconView *icon_view,
181 GdkModifierType start_button_mask,
182 const GtkTargetEntry *targets,
184 GdkDragAction actions);
185 void gtk_icon_view_enable_model_drag_dest (GtkIconView *icon_view,
186 const GtkTargetEntry *targets,
188 GdkDragAction actions);
189 void gtk_icon_view_unset_model_drag_source (GtkIconView *icon_view);
190 void gtk_icon_view_unset_model_drag_dest (GtkIconView *icon_view);
191 void gtk_icon_view_set_reorderable (GtkIconView *icon_view,
192 gboolean reorderable);
193 gboolean gtk_icon_view_get_reorderable (GtkIconView *icon_view);
196 /* These are useful to implement your own custom stuff. */
197 void gtk_icon_view_set_drag_dest_item (GtkIconView *icon_view,
199 GtkIconViewDropPosition pos);
200 void gtk_icon_view_get_drag_dest_item (GtkIconView *icon_view,
202 GtkIconViewDropPosition *pos);
203 gboolean gtk_icon_view_get_dest_item_at_pos (GtkIconView *icon_view,
207 GtkIconViewDropPosition *pos);
208 GdkPixmap *gtk_icon_view_create_drag_icon (GtkIconView *icon_view,
211 void gtk_icon_view_convert_widget_to_bin_window_coords (GtkIconView *icon_view,
218 void gtk_icon_view_set_tooltip_item (GtkIconView *icon_view,
221 void gtk_icon_view_set_tooltip_cell (GtkIconView *icon_view,
224 GtkCellRenderer *cell);
225 gboolean gtk_icon_view_get_tooltip_context (GtkIconView *icon_view,
228 gboolean keyboard_tip,
229 GtkTreeModel **model,
232 void gtk_icon_view_set_tooltip_column (GtkIconView *icon_view,
234 gint gtk_icon_view_get_tooltip_column (GtkIconView *icon_view);
239 #endif /* __GTK_ICON_VIEW_H__ */