gtk2/gtk/deprecated/gtkiconview.h
Matthias Clasen 5e256590db Deprecate treeviews and cell renderers
This includes

GtkCellArea
GtkCellAreaBox
GtkCellAreaContext
GtkCellEditable
GtkCellRenderer
GtkCellRendererAccel
GtkCellRendererCombo
GtkCellRendererPixbuf
GtkCellRendererProgress
GtkCellRendererSpin
GtkCellRendererSpinner
GtkCellRendererText
GtkCellRendererToggle
GtkCellView
GtkComboBox
GtkComboBoxText
GtkIconView
GtkListStore
GtkTreeModel
GtkTreeModelFilter
GtkTreeModelSort
GtkTreeStore
GtkTreeView
GtkTreeViewColumn
GtkTreeSelection
2022-10-11 17:18:21 -04:00

290 lines
15 KiB
C

/* gtkiconview.h
* Copyright (C) 2002, 2004 Anders Carlsson <andersca@gnome.org>
*
* 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, 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/gtkwidget.h>
#include <gtk/gtktooltip.h>
#include <gtk/deprecated/gtktreemodel.h>
#include <gtk/deprecated/gtkcellrenderer.h>
#include <gtk/deprecated/gtkcellarea.h>
G_BEGIN_DECLS
#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_IS_ICON_VIEW(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_ICON_VIEW))
typedef struct _GtkIconView GtkIconView;
/**
* GtkIconViewForeachFunc:
* @icon_view: a `GtkIconView`
* @path: The `GtkTreePath` of a selected row
* @data: (closure): 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: dropped 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;
GDK_AVAILABLE_IN_ALL
GType gtk_icon_view_get_type (void) G_GNUC_CONST;
GDK_DEPRECATED_IN_4_10
GtkWidget * gtk_icon_view_new (void);
GDK_DEPRECATED_IN_4_10
GtkWidget * gtk_icon_view_new_with_area (GtkCellArea *area);
GDK_DEPRECATED_IN_4_10
GtkWidget * gtk_icon_view_new_with_model (GtkTreeModel *model);
GDK_DEPRECATED_IN_4_10
void gtk_icon_view_set_model (GtkIconView *icon_view,
GtkTreeModel *model);
GDK_DEPRECATED_IN_4_10
GtkTreeModel * gtk_icon_view_get_model (GtkIconView *icon_view);
GDK_DEPRECATED_IN_4_10
void gtk_icon_view_set_text_column (GtkIconView *icon_view,
int column);
GDK_DEPRECATED_IN_4_10
int gtk_icon_view_get_text_column (GtkIconView *icon_view);
GDK_DEPRECATED_IN_4_10
void gtk_icon_view_set_markup_column (GtkIconView *icon_view,
int column);
GDK_DEPRECATED_IN_4_10
int gtk_icon_view_get_markup_column (GtkIconView *icon_view);
GDK_DEPRECATED_IN_4_10
void gtk_icon_view_set_pixbuf_column (GtkIconView *icon_view,
int column);
GDK_DEPRECATED_IN_4_10
int gtk_icon_view_get_pixbuf_column (GtkIconView *icon_view);
GDK_DEPRECATED_IN_4_10
void gtk_icon_view_set_item_orientation (GtkIconView *icon_view,
GtkOrientation orientation);
GDK_DEPRECATED_IN_4_10
GtkOrientation gtk_icon_view_get_item_orientation (GtkIconView *icon_view);
GDK_DEPRECATED_IN_4_10
void gtk_icon_view_set_columns (GtkIconView *icon_view,
int columns);
GDK_DEPRECATED_IN_4_10
int gtk_icon_view_get_columns (GtkIconView *icon_view);
GDK_DEPRECATED_IN_4_10
void gtk_icon_view_set_item_width (GtkIconView *icon_view,
int item_width);
GDK_DEPRECATED_IN_4_10
int gtk_icon_view_get_item_width (GtkIconView *icon_view);
GDK_DEPRECATED_IN_4_10
void gtk_icon_view_set_spacing (GtkIconView *icon_view,
int spacing);
GDK_DEPRECATED_IN_4_10
int gtk_icon_view_get_spacing (GtkIconView *icon_view);
GDK_DEPRECATED_IN_4_10
void gtk_icon_view_set_row_spacing (GtkIconView *icon_view,
int row_spacing);
GDK_DEPRECATED_IN_4_10
int gtk_icon_view_get_row_spacing (GtkIconView *icon_view);
GDK_DEPRECATED_IN_4_10
void gtk_icon_view_set_column_spacing (GtkIconView *icon_view,
int column_spacing);
GDK_DEPRECATED_IN_4_10
int gtk_icon_view_get_column_spacing (GtkIconView *icon_view);
GDK_DEPRECATED_IN_4_10
void gtk_icon_view_set_margin (GtkIconView *icon_view,
int margin);
GDK_DEPRECATED_IN_4_10
int gtk_icon_view_get_margin (GtkIconView *icon_view);
GDK_DEPRECATED_IN_4_10
void gtk_icon_view_set_item_padding (GtkIconView *icon_view,
int item_padding);
GDK_DEPRECATED_IN_4_10
int gtk_icon_view_get_item_padding (GtkIconView *icon_view);
GDK_DEPRECATED_IN_4_10
GtkTreePath * gtk_icon_view_get_path_at_pos (GtkIconView *icon_view,
int x,
int y);
GDK_DEPRECATED_IN_4_10
gboolean gtk_icon_view_get_item_at_pos (GtkIconView *icon_view,
int x,
int y,
GtkTreePath **path,
GtkCellRenderer **cell);
GDK_DEPRECATED_IN_4_10
gboolean gtk_icon_view_get_visible_range (GtkIconView *icon_view,
GtkTreePath **start_path,
GtkTreePath **end_path);
GDK_DEPRECATED_IN_4_10
void gtk_icon_view_set_activate_on_single_click (GtkIconView *icon_view,
gboolean single);
GDK_DEPRECATED_IN_4_10
gboolean gtk_icon_view_get_activate_on_single_click (GtkIconView *icon_view);
GDK_DEPRECATED_IN_4_10
void gtk_icon_view_selected_foreach (GtkIconView *icon_view,
GtkIconViewForeachFunc func,
gpointer data);
GDK_DEPRECATED_IN_4_10
void gtk_icon_view_set_selection_mode (GtkIconView *icon_view,
GtkSelectionMode mode);
GDK_DEPRECATED_IN_4_10
GtkSelectionMode gtk_icon_view_get_selection_mode (GtkIconView *icon_view);
GDK_DEPRECATED_IN_4_10
void gtk_icon_view_select_path (GtkIconView *icon_view,
GtkTreePath *path);
GDK_DEPRECATED_IN_4_10
void gtk_icon_view_unselect_path (GtkIconView *icon_view,
GtkTreePath *path);
GDK_DEPRECATED_IN_4_10
gboolean gtk_icon_view_path_is_selected (GtkIconView *icon_view,
GtkTreePath *path);
GDK_DEPRECATED_IN_4_10
int gtk_icon_view_get_item_row (GtkIconView *icon_view,
GtkTreePath *path);
GDK_DEPRECATED_IN_4_10
int gtk_icon_view_get_item_column (GtkIconView *icon_view,
GtkTreePath *path);
GDK_DEPRECATED_IN_4_10
GList *gtk_icon_view_get_selected_items (GtkIconView *icon_view);
GDK_DEPRECATED_IN_4_10
void gtk_icon_view_select_all (GtkIconView *icon_view);
GDK_DEPRECATED_IN_4_10
void gtk_icon_view_unselect_all (GtkIconView *icon_view);
GDK_DEPRECATED_IN_4_10
void gtk_icon_view_item_activated (GtkIconView *icon_view,
GtkTreePath *path);
GDK_DEPRECATED_IN_4_10
void gtk_icon_view_set_cursor (GtkIconView *icon_view,
GtkTreePath *path,
GtkCellRenderer *cell,
gboolean start_editing);
GDK_DEPRECATED_IN_4_10
gboolean gtk_icon_view_get_cursor (GtkIconView *icon_view,
GtkTreePath **path,
GtkCellRenderer **cell);
GDK_DEPRECATED_IN_4_10
void gtk_icon_view_scroll_to_path (GtkIconView *icon_view,
GtkTreePath *path,
gboolean use_align,
float row_align,
float col_align);
/* Drag-and-Drop support */
GDK_DEPRECATED_IN_4_10
void gtk_icon_view_enable_model_drag_source (GtkIconView *icon_view,
GdkModifierType start_button_mask,
GdkContentFormats *formats,
GdkDragAction actions);
GDK_DEPRECATED_IN_4_10
void gtk_icon_view_enable_model_drag_dest (GtkIconView *icon_view,
GdkContentFormats *formats,
GdkDragAction actions);
GDK_DEPRECATED_IN_4_10
void gtk_icon_view_unset_model_drag_source (GtkIconView *icon_view);
GDK_DEPRECATED_IN_4_10
void gtk_icon_view_unset_model_drag_dest (GtkIconView *icon_view);
GDK_DEPRECATED_IN_4_10
void gtk_icon_view_set_reorderable (GtkIconView *icon_view,
gboolean reorderable);
GDK_DEPRECATED_IN_4_10
gboolean gtk_icon_view_get_reorderable (GtkIconView *icon_view);
/* These are useful to implement your own custom stuff. */
GDK_DEPRECATED_IN_4_10
void gtk_icon_view_set_drag_dest_item (GtkIconView *icon_view,
GtkTreePath *path,
GtkIconViewDropPosition pos);
GDK_DEPRECATED_IN_4_10
void gtk_icon_view_get_drag_dest_item (GtkIconView *icon_view,
GtkTreePath **path,
GtkIconViewDropPosition *pos);
GDK_DEPRECATED_IN_4_10
gboolean gtk_icon_view_get_dest_item_at_pos (GtkIconView *icon_view,
int drag_x,
int drag_y,
GtkTreePath **path,
GtkIconViewDropPosition *pos);
GDK_DEPRECATED_IN_4_10
GdkPaintable *gtk_icon_view_create_drag_icon (GtkIconView *icon_view,
GtkTreePath *path);
GDK_DEPRECATED_IN_4_10
gboolean gtk_icon_view_get_cell_rect (GtkIconView *icon_view,
GtkTreePath *path,
GtkCellRenderer *cell,
GdkRectangle *rect);
GDK_DEPRECATED_IN_4_10
void gtk_icon_view_set_tooltip_item (GtkIconView *icon_view,
GtkTooltip *tooltip,
GtkTreePath *path);
GDK_DEPRECATED_IN_4_10
void gtk_icon_view_set_tooltip_cell (GtkIconView *icon_view,
GtkTooltip *tooltip,
GtkTreePath *path,
GtkCellRenderer *cell);
GDK_DEPRECATED_IN_4_10
gboolean gtk_icon_view_get_tooltip_context (GtkIconView *icon_view,
int x,
int y,
gboolean keyboard_tip,
GtkTreeModel **model,
GtkTreePath **path,
GtkTreeIter *iter);
GDK_DEPRECATED_IN_4_10
void gtk_icon_view_set_tooltip_column (GtkIconView *icon_view,
int column);
GDK_DEPRECATED_IN_4_10
int gtk_icon_view_get_tooltip_column (GtkIconView *icon_view);
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GtkIconView, g_object_unref)
G_END_DECLS
#endif /* __GTK_ICON_VIEW_H__ */