* 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.
+ * License along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
+
#ifndef __GTK_ICON_VIEW_H__
#define __GTK_ICON_VIEW_H__
+#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
+#error "Only <gtk/gtk.h> can be included directly."
+#endif
+
#include <gtk/gtkcontainer.h>
#include <gtk/gtktreemodel.h>
+#include <gtk/gtkcellrenderer.h>
+#include <gtk/gtkcellarea.h>
+#include <gtk/gtkselection.h>
+#include <gtk/gtktooltip.h>
G_BEGIN_DECLS
-#define GTK_TYPE_ICON_VIEW (gtk_icon_view_get_type ())
-#define GTK_ICON_VIEW(obj) (GTK_CHECK_CAST ((obj), GTK_TYPE_ICON_VIEW, GtkIconView))
-#define GTK_ICON_VIEW_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), GTK_TYPE_ICON_VIEW, GtkIconViewClass))
-#define GTK_IS_ICON_VIEW(obj) (GTK_CHECK_TYPE ((obj), GTK_TYPE_ICON_VIEW))
-#define GTK_IS_ICON_VIEW_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), GTK_TYPE_ICON_VIEW))
-#define GTK_ICON_VIEW_GET_CLASS(obj) (GTK_CHECK_GET_CLASS ((obj), GTK_TYPE_ICON_VIEW, GtkIconViewClass))
+#define GTK_TYPE_ICON_VIEW (gtk_icon_view_get_type ())
+#define GTK_ICON_VIEW(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_ICON_VIEW, GtkIconView))
+#define GTK_ICON_VIEW_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_ICON_VIEW, GtkIconViewClass))
+#define GTK_IS_ICON_VIEW(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_ICON_VIEW))
+#define GTK_IS_ICON_VIEW_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_ICON_VIEW))
+#define GTK_ICON_VIEW_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_ICON_VIEW, GtkIconViewClass))
typedef struct _GtkIconView GtkIconView;
typedef struct _GtkIconViewClass GtkIconViewClass;
typedef struct _GtkIconViewPrivate GtkIconViewPrivate;
+/**
+ * GtkIconViewForeachFunc:
+ * @icon_view: a #GtkIconView
+ * @path: The #GtkTreePath of a selected row
+ * @data: user data
+ *
+ * A function used by gtk_icon_view_selected_foreach() to map all
+ * selected rows. It will be called on every selected row in the view.
+ */
typedef void (* GtkIconViewForeachFunc) (GtkIconView *icon_view,
GtkTreePath *path,
gpointer data);
+/**
+ * GtkIconViewDropPosition:
+ * @GTK_ICON_VIEW_NO_DROP: no drop possible
+ * @GTK_ICON_VIEW_DROP_INTO: dropped item replaces the item
+ * @GTK_ICON_VIEW_DROP_LEFT: droppped item is inserted to the left
+ * @GTK_ICON_VIEW_DROP_RIGHT: dropped item is inserted to the right
+ * @GTK_ICON_VIEW_DROP_ABOVE: dropped item is inserted above
+ * @GTK_ICON_VIEW_DROP_BELOW: dropped item is inserted below
+ *
+ * An enum for determining where a dropped item goes.
+ */
+typedef enum
+{
+ GTK_ICON_VIEW_NO_DROP,
+ GTK_ICON_VIEW_DROP_INTO,
+ GTK_ICON_VIEW_DROP_LEFT,
+ GTK_ICON_VIEW_DROP_RIGHT,
+ GTK_ICON_VIEW_DROP_ABOVE,
+ GTK_ICON_VIEW_DROP_BELOW
+} GtkIconViewDropPosition;
+
struct _GtkIconView
{
GtkContainer parent;
+ /*< private >*/
GtkIconViewPrivate *priv;
};
{
GtkContainerClass parent_class;
- void (* set_scroll_adjustments) (GtkIconView *icon_view,
- GtkAdjustment *hadjustment,
- GtkAdjustment *vadjustment);
-
void (* item_activated) (GtkIconView *icon_view,
GtkTreePath *path);
void (* selection_changed) (GtkIconView *icon_view);
GtkMovementStep step,
gint count);
gboolean (* activate_cursor_item) (GtkIconView *icon_view);
+
+ /* Padding for future expansion */
+ void (*_gtk_reserved1) (void);
+ void (*_gtk_reserved2) (void);
+ void (*_gtk_reserved3) (void);
+ void (*_gtk_reserved4) (void);
};
-GType gtk_icon_view_get_type (void);
-GtkWidget *gtk_icon_view_new (void);
-GtkWidget *gtk_icon_view_new_with_model (GtkTreeModel *model);
-
-void gtk_icon_view_set_model (GtkIconView *icon_view,
- GtkTreeModel *model);
-GtkTreeModel *gtk_icon_view_get_model (GtkIconView *icon_view);
-void gtk_icon_view_set_text_column (GtkIconView *icon_view,
- gint column);
-gint gtk_icon_view_get_text_column (GtkIconView *icon_view);
-void gtk_icon_view_set_markup_column (GtkIconView *icon_view,
- gint column);
-gint gtk_icon_view_get_markup_column (GtkIconView *icon_view);
-void gtk_icon_view_set_pixbuf_column (GtkIconView *icon_view,
- gint column);
-gint gtk_icon_view_get_pixbuf_column (GtkIconView *icon_view);
-
-
-GtkTreePath * gtk_icon_view_get_path_at_pos (GtkIconView *icon_view,
- gint x,
- gint y);
-void gtk_icon_view_selected_foreach (GtkIconView *icon_view,
- GtkIconViewForeachFunc func,
- gpointer data);
-void gtk_icon_view_set_selection_mode (GtkIconView *icon_view,
- GtkSelectionMode mode);
+GType gtk_icon_view_get_type (void) G_GNUC_CONST;
+GtkWidget * gtk_icon_view_new (void);
+GtkWidget * gtk_icon_view_new_with_area (GtkCellArea *area);
+GtkWidget * gtk_icon_view_new_with_model (GtkTreeModel *model);
+
+void gtk_icon_view_set_model (GtkIconView *icon_view,
+ GtkTreeModel *model);
+GtkTreeModel * gtk_icon_view_get_model (GtkIconView *icon_view);
+void gtk_icon_view_set_text_column (GtkIconView *icon_view,
+ gint column);
+gint gtk_icon_view_get_text_column (GtkIconView *icon_view);
+void gtk_icon_view_set_markup_column (GtkIconView *icon_view,
+ gint column);
+gint gtk_icon_view_get_markup_column (GtkIconView *icon_view);
+void gtk_icon_view_set_pixbuf_column (GtkIconView *icon_view,
+ gint column);
+gint gtk_icon_view_get_pixbuf_column (GtkIconView *icon_view);
+
+void gtk_icon_view_set_item_orientation (GtkIconView *icon_view,
+ GtkOrientation orientation);
+GtkOrientation gtk_icon_view_get_item_orientation (GtkIconView *icon_view);
+void gtk_icon_view_set_columns (GtkIconView *icon_view,
+ gint columns);
+gint gtk_icon_view_get_columns (GtkIconView *icon_view);
+void gtk_icon_view_set_item_width (GtkIconView *icon_view,
+ gint item_width);
+gint gtk_icon_view_get_item_width (GtkIconView *icon_view);
+void gtk_icon_view_set_spacing (GtkIconView *icon_view,
+ gint spacing);
+gint gtk_icon_view_get_spacing (GtkIconView *icon_view);
+void gtk_icon_view_set_row_spacing (GtkIconView *icon_view,
+ gint row_spacing);
+gint gtk_icon_view_get_row_spacing (GtkIconView *icon_view);
+void gtk_icon_view_set_column_spacing (GtkIconView *icon_view,
+ gint column_spacing);
+gint gtk_icon_view_get_column_spacing (GtkIconView *icon_view);
+void gtk_icon_view_set_margin (GtkIconView *icon_view,
+ gint margin);
+gint gtk_icon_view_get_margin (GtkIconView *icon_view);
+void gtk_icon_view_set_item_padding (GtkIconView *icon_view,
+ gint item_padding);
+gint gtk_icon_view_get_item_padding (GtkIconView *icon_view);
+
+GtkTreePath * gtk_icon_view_get_path_at_pos (GtkIconView *icon_view,
+ gint x,
+ gint y);
+gboolean gtk_icon_view_get_item_at_pos (GtkIconView *icon_view,
+ gint x,
+ gint y,
+ GtkTreePath **path,
+ GtkCellRenderer **cell);
+gboolean gtk_icon_view_get_visible_range (GtkIconView *icon_view,
+ GtkTreePath **start_path,
+ GtkTreePath **end_path);
+GDK_AVAILABLE_IN_3_8
+void gtk_icon_view_set_activate_on_single_click (GtkIconView *icon_view,
+ gboolean single);
+GDK_AVAILABLE_IN_3_8
+gboolean gtk_icon_view_get_activate_on_single_click (GtkIconView *icon_view);
+
+void gtk_icon_view_selected_foreach (GtkIconView *icon_view,
+ GtkIconViewForeachFunc func,
+ gpointer data);
+void gtk_icon_view_set_selection_mode (GtkIconView *icon_view,
+ GtkSelectionMode mode);
GtkSelectionMode gtk_icon_view_get_selection_mode (GtkIconView *icon_view);
void gtk_icon_view_select_path (GtkIconView *icon_view,
GtkTreePath *path);
GtkTreePath *path);
gboolean gtk_icon_view_path_is_selected (GtkIconView *icon_view,
GtkTreePath *path);
+gint gtk_icon_view_get_item_row (GtkIconView *icon_view,
+ GtkTreePath *path);
+gint gtk_icon_view_get_item_column (GtkIconView *icon_view,
+ GtkTreePath *path);
GList *gtk_icon_view_get_selected_items (GtkIconView *icon_view);
void gtk_icon_view_select_all (GtkIconView *icon_view);
void gtk_icon_view_unselect_all (GtkIconView *icon_view);
void gtk_icon_view_item_activated (GtkIconView *icon_view,
GtkTreePath *path);
+void gtk_icon_view_set_cursor (GtkIconView *icon_view,
+ GtkTreePath *path,
+ GtkCellRenderer *cell,
+ gboolean start_editing);
+gboolean gtk_icon_view_get_cursor (GtkIconView *icon_view,
+ GtkTreePath **path,
+ GtkCellRenderer **cell);
+void gtk_icon_view_scroll_to_path (GtkIconView *icon_view,
+ GtkTreePath *path,
+ gboolean use_align,
+ gfloat row_align,
+ gfloat col_align);
+
+/* Drag-and-Drop support */
+void gtk_icon_view_enable_model_drag_source (GtkIconView *icon_view,
+ GdkModifierType start_button_mask,
+ const GtkTargetEntry *targets,
+ gint n_targets,
+ GdkDragAction actions);
+void gtk_icon_view_enable_model_drag_dest (GtkIconView *icon_view,
+ const GtkTargetEntry *targets,
+ gint n_targets,
+ GdkDragAction actions);
+void gtk_icon_view_unset_model_drag_source (GtkIconView *icon_view);
+void gtk_icon_view_unset_model_drag_dest (GtkIconView *icon_view);
+void gtk_icon_view_set_reorderable (GtkIconView *icon_view,
+ gboolean reorderable);
+gboolean gtk_icon_view_get_reorderable (GtkIconView *icon_view);
+
+
+/* These are useful to implement your own custom stuff. */
+void gtk_icon_view_set_drag_dest_item (GtkIconView *icon_view,
+ GtkTreePath *path,
+ GtkIconViewDropPosition pos);
+void gtk_icon_view_get_drag_dest_item (GtkIconView *icon_view,
+ GtkTreePath **path,
+ GtkIconViewDropPosition *pos);
+gboolean gtk_icon_view_get_dest_item_at_pos (GtkIconView *icon_view,
+ gint drag_x,
+ gint drag_y,
+ GtkTreePath **path,
+ GtkIconViewDropPosition *pos);
+cairo_surface_t *gtk_icon_view_create_drag_icon (GtkIconView *icon_view,
+ GtkTreePath *path);
+
+void gtk_icon_view_convert_widget_to_bin_window_coords (GtkIconView *icon_view,
+ gint wx,
+ gint wy,
+ gint *bx,
+ gint *by);
+GDK_AVAILABLE_IN_3_6
+gboolean gtk_icon_view_get_cell_rect (GtkIconView *icon_view,
+ GtkTreePath *path,
+ GtkCellRenderer *cell,
+ GdkRectangle *rect);
+
+
+void gtk_icon_view_set_tooltip_item (GtkIconView *icon_view,
+ GtkTooltip *tooltip,
+ GtkTreePath *path);
+void gtk_icon_view_set_tooltip_cell (GtkIconView *icon_view,
+ GtkTooltip *tooltip,
+ GtkTreePath *path,
+ GtkCellRenderer *cell);
+gboolean gtk_icon_view_get_tooltip_context (GtkIconView *icon_view,
+ gint *x,
+ gint *y,
+ gboolean keyboard_tip,
+ GtkTreeModel **model,
+ GtkTreePath **path,
+ GtkTreeIter *iter);
+void gtk_icon_view_set_tooltip_column (GtkIconView *icon_view,
+ gint column);
+gint gtk_icon_view_get_tooltip_column (GtkIconView *icon_view);
+
+
G_END_DECLS
#endif /* __GTK_ICON_VIEW_H__ */