forked from AuroraMiddleware/gtk
153c6424d3
GtkTreeView.get_tooltip_context() takes an inout X and Y coordinates,
but the "out" side is a side effect: the conversion from widget-relative
to bin window-relative coordinates is not documented, and can be done
using public API, if needed.
GtkIconView.get_tooltip_context() follows the same pattern, and takes
two inout arguments for the coordinates, but it does not change them any
more, after GtkIconView's bin window was dropped in commit 8dc5e13e.
There's really no point in having these `inout` arguments, and while
GtkTreeView and GtkIconView are certainly de-emphasised in GTK4, and we
nudge developers to move to the new list views, we should take advantage
of the API break to remove warts.
287 lines
15 KiB
C
287 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/gtktreemodel.h>
|
|
#include <gtk/gtkcellrenderer.h>
|
|
#include <gtk/gtkcellarea.h>
|
|
#include <gtk/gtktooltip.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_AVAILABLE_IN_ALL
|
|
GtkWidget * gtk_icon_view_new (void);
|
|
GDK_AVAILABLE_IN_ALL
|
|
GtkWidget * gtk_icon_view_new_with_area (GtkCellArea *area);
|
|
GDK_AVAILABLE_IN_ALL
|
|
GtkWidget * gtk_icon_view_new_with_model (GtkTreeModel *model);
|
|
|
|
GDK_AVAILABLE_IN_ALL
|
|
void gtk_icon_view_set_model (GtkIconView *icon_view,
|
|
GtkTreeModel *model);
|
|
GDK_AVAILABLE_IN_ALL
|
|
GtkTreeModel * gtk_icon_view_get_model (GtkIconView *icon_view);
|
|
GDK_AVAILABLE_IN_ALL
|
|
void gtk_icon_view_set_text_column (GtkIconView *icon_view,
|
|
int column);
|
|
GDK_AVAILABLE_IN_ALL
|
|
int gtk_icon_view_get_text_column (GtkIconView *icon_view);
|
|
GDK_AVAILABLE_IN_ALL
|
|
void gtk_icon_view_set_markup_column (GtkIconView *icon_view,
|
|
int column);
|
|
GDK_AVAILABLE_IN_ALL
|
|
int gtk_icon_view_get_markup_column (GtkIconView *icon_view);
|
|
GDK_AVAILABLE_IN_ALL
|
|
void gtk_icon_view_set_pixbuf_column (GtkIconView *icon_view,
|
|
int column);
|
|
GDK_AVAILABLE_IN_ALL
|
|
int gtk_icon_view_get_pixbuf_column (GtkIconView *icon_view);
|
|
|
|
GDK_AVAILABLE_IN_ALL
|
|
void gtk_icon_view_set_item_orientation (GtkIconView *icon_view,
|
|
GtkOrientation orientation);
|
|
GDK_AVAILABLE_IN_ALL
|
|
GtkOrientation gtk_icon_view_get_item_orientation (GtkIconView *icon_view);
|
|
GDK_AVAILABLE_IN_ALL
|
|
void gtk_icon_view_set_columns (GtkIconView *icon_view,
|
|
int columns);
|
|
GDK_AVAILABLE_IN_ALL
|
|
int gtk_icon_view_get_columns (GtkIconView *icon_view);
|
|
GDK_AVAILABLE_IN_ALL
|
|
void gtk_icon_view_set_item_width (GtkIconView *icon_view,
|
|
int item_width);
|
|
GDK_AVAILABLE_IN_ALL
|
|
int gtk_icon_view_get_item_width (GtkIconView *icon_view);
|
|
GDK_AVAILABLE_IN_ALL
|
|
void gtk_icon_view_set_spacing (GtkIconView *icon_view,
|
|
int spacing);
|
|
GDK_AVAILABLE_IN_ALL
|
|
int gtk_icon_view_get_spacing (GtkIconView *icon_view);
|
|
GDK_AVAILABLE_IN_ALL
|
|
void gtk_icon_view_set_row_spacing (GtkIconView *icon_view,
|
|
int row_spacing);
|
|
GDK_AVAILABLE_IN_ALL
|
|
int gtk_icon_view_get_row_spacing (GtkIconView *icon_view);
|
|
GDK_AVAILABLE_IN_ALL
|
|
void gtk_icon_view_set_column_spacing (GtkIconView *icon_view,
|
|
int column_spacing);
|
|
GDK_AVAILABLE_IN_ALL
|
|
int gtk_icon_view_get_column_spacing (GtkIconView *icon_view);
|
|
GDK_AVAILABLE_IN_ALL
|
|
void gtk_icon_view_set_margin (GtkIconView *icon_view,
|
|
int margin);
|
|
GDK_AVAILABLE_IN_ALL
|
|
int gtk_icon_view_get_margin (GtkIconView *icon_view);
|
|
GDK_AVAILABLE_IN_ALL
|
|
void gtk_icon_view_set_item_padding (GtkIconView *icon_view,
|
|
int item_padding);
|
|
GDK_AVAILABLE_IN_ALL
|
|
int gtk_icon_view_get_item_padding (GtkIconView *icon_view);
|
|
|
|
GDK_AVAILABLE_IN_ALL
|
|
GtkTreePath * gtk_icon_view_get_path_at_pos (GtkIconView *icon_view,
|
|
int x,
|
|
int y);
|
|
GDK_AVAILABLE_IN_ALL
|
|
gboolean gtk_icon_view_get_item_at_pos (GtkIconView *icon_view,
|
|
int x,
|
|
int y,
|
|
GtkTreePath **path,
|
|
GtkCellRenderer **cell);
|
|
GDK_AVAILABLE_IN_ALL
|
|
gboolean gtk_icon_view_get_visible_range (GtkIconView *icon_view,
|
|
GtkTreePath **start_path,
|
|
GtkTreePath **end_path);
|
|
GDK_AVAILABLE_IN_ALL
|
|
void gtk_icon_view_set_activate_on_single_click (GtkIconView *icon_view,
|
|
gboolean single);
|
|
GDK_AVAILABLE_IN_ALL
|
|
gboolean gtk_icon_view_get_activate_on_single_click (GtkIconView *icon_view);
|
|
|
|
GDK_AVAILABLE_IN_ALL
|
|
void gtk_icon_view_selected_foreach (GtkIconView *icon_view,
|
|
GtkIconViewForeachFunc func,
|
|
gpointer data);
|
|
GDK_AVAILABLE_IN_ALL
|
|
void gtk_icon_view_set_selection_mode (GtkIconView *icon_view,
|
|
GtkSelectionMode mode);
|
|
GDK_AVAILABLE_IN_ALL
|
|
GtkSelectionMode gtk_icon_view_get_selection_mode (GtkIconView *icon_view);
|
|
GDK_AVAILABLE_IN_ALL
|
|
void gtk_icon_view_select_path (GtkIconView *icon_view,
|
|
GtkTreePath *path);
|
|
GDK_AVAILABLE_IN_ALL
|
|
void gtk_icon_view_unselect_path (GtkIconView *icon_view,
|
|
GtkTreePath *path);
|
|
GDK_AVAILABLE_IN_ALL
|
|
gboolean gtk_icon_view_path_is_selected (GtkIconView *icon_view,
|
|
GtkTreePath *path);
|
|
GDK_AVAILABLE_IN_ALL
|
|
int gtk_icon_view_get_item_row (GtkIconView *icon_view,
|
|
GtkTreePath *path);
|
|
GDK_AVAILABLE_IN_ALL
|
|
int gtk_icon_view_get_item_column (GtkIconView *icon_view,
|
|
GtkTreePath *path);
|
|
GDK_AVAILABLE_IN_ALL
|
|
GList *gtk_icon_view_get_selected_items (GtkIconView *icon_view);
|
|
GDK_AVAILABLE_IN_ALL
|
|
void gtk_icon_view_select_all (GtkIconView *icon_view);
|
|
GDK_AVAILABLE_IN_ALL
|
|
void gtk_icon_view_unselect_all (GtkIconView *icon_view);
|
|
GDK_AVAILABLE_IN_ALL
|
|
void gtk_icon_view_item_activated (GtkIconView *icon_view,
|
|
GtkTreePath *path);
|
|
GDK_AVAILABLE_IN_ALL
|
|
void gtk_icon_view_set_cursor (GtkIconView *icon_view,
|
|
GtkTreePath *path,
|
|
GtkCellRenderer *cell,
|
|
gboolean start_editing);
|
|
GDK_AVAILABLE_IN_ALL
|
|
gboolean gtk_icon_view_get_cursor (GtkIconView *icon_view,
|
|
GtkTreePath **path,
|
|
GtkCellRenderer **cell);
|
|
GDK_AVAILABLE_IN_ALL
|
|
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_AVAILABLE_IN_ALL
|
|
void gtk_icon_view_enable_model_drag_source (GtkIconView *icon_view,
|
|
GdkModifierType start_button_mask,
|
|
GdkContentFormats *formats,
|
|
GdkDragAction actions);
|
|
GDK_AVAILABLE_IN_ALL
|
|
void gtk_icon_view_enable_model_drag_dest (GtkIconView *icon_view,
|
|
GdkContentFormats *formats,
|
|
GdkDragAction actions);
|
|
GDK_AVAILABLE_IN_ALL
|
|
void gtk_icon_view_unset_model_drag_source (GtkIconView *icon_view);
|
|
GDK_AVAILABLE_IN_ALL
|
|
void gtk_icon_view_unset_model_drag_dest (GtkIconView *icon_view);
|
|
GDK_AVAILABLE_IN_ALL
|
|
void gtk_icon_view_set_reorderable (GtkIconView *icon_view,
|
|
gboolean reorderable);
|
|
GDK_AVAILABLE_IN_ALL
|
|
gboolean gtk_icon_view_get_reorderable (GtkIconView *icon_view);
|
|
|
|
|
|
/* These are useful to implement your own custom stuff. */
|
|
GDK_AVAILABLE_IN_ALL
|
|
void gtk_icon_view_set_drag_dest_item (GtkIconView *icon_view,
|
|
GtkTreePath *path,
|
|
GtkIconViewDropPosition pos);
|
|
GDK_AVAILABLE_IN_ALL
|
|
void gtk_icon_view_get_drag_dest_item (GtkIconView *icon_view,
|
|
GtkTreePath **path,
|
|
GtkIconViewDropPosition *pos);
|
|
GDK_AVAILABLE_IN_ALL
|
|
gboolean gtk_icon_view_get_dest_item_at_pos (GtkIconView *icon_view,
|
|
int drag_x,
|
|
int drag_y,
|
|
GtkTreePath **path,
|
|
GtkIconViewDropPosition *pos);
|
|
GDK_AVAILABLE_IN_ALL
|
|
GdkPaintable *gtk_icon_view_create_drag_icon (GtkIconView *icon_view,
|
|
GtkTreePath *path);
|
|
|
|
GDK_AVAILABLE_IN_ALL
|
|
gboolean gtk_icon_view_get_cell_rect (GtkIconView *icon_view,
|
|
GtkTreePath *path,
|
|
GtkCellRenderer *cell,
|
|
GdkRectangle *rect);
|
|
|
|
|
|
GDK_AVAILABLE_IN_ALL
|
|
void gtk_icon_view_set_tooltip_item (GtkIconView *icon_view,
|
|
GtkTooltip *tooltip,
|
|
GtkTreePath *path);
|
|
GDK_AVAILABLE_IN_ALL
|
|
void gtk_icon_view_set_tooltip_cell (GtkIconView *icon_view,
|
|
GtkTooltip *tooltip,
|
|
GtkTreePath *path,
|
|
GtkCellRenderer *cell);
|
|
GDK_AVAILABLE_IN_ALL
|
|
gboolean gtk_icon_view_get_tooltip_context (GtkIconView *icon_view,
|
|
int x,
|
|
int y,
|
|
gboolean keyboard_tip,
|
|
GtkTreeModel **model,
|
|
GtkTreePath **path,
|
|
GtkTreeIter *iter);
|
|
GDK_AVAILABLE_IN_ALL
|
|
void gtk_icon_view_set_tooltip_column (GtkIconView *icon_view,
|
|
int column);
|
|
GDK_AVAILABLE_IN_ALL
|
|
int gtk_icon_view_get_tooltip_column (GtkIconView *icon_view);
|
|
|
|
|
|
G_END_DECLS
|
|
|
|
#endif /* __GTK_ICON_VIEW_H__ */
|