forked from AuroraMiddleware/gtk
169 lines
6.3 KiB
C
169 lines
6.3 KiB
C
/* gtktreednd.h
|
|
* Copyright (C) 2001 Red Hat, Inc.
|
|
*
|
|
* 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_TREE_DND_H__
|
|
#define __GTK_TREE_DND_H__
|
|
|
|
#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
|
|
#error "Only <gtk/gtk.h> can be included directly."
|
|
#endif
|
|
|
|
#include <gtk/gtktreemodel.h>
|
|
|
|
G_BEGIN_DECLS
|
|
|
|
/**
|
|
* GTK_TYPE_TREE_ROW_DATA:
|
|
* Magic `GType` to use when dragging rows in a `GtkTreeModel`.
|
|
*
|
|
* Data in this format will be provided by gtk_tree_create_row_drag_content()
|
|
* and can be consumed via gtk_tree_get_row_drag_data().
|
|
*/
|
|
#define GTK_TYPE_TREE_ROW_DATA (gtk_tree_row_data_get_type ())
|
|
GDK_AVAILABLE_IN_ALL
|
|
GType gtk_tree_row_data_get_type (void) G_GNUC_CONST;
|
|
|
|
|
|
#define GTK_TYPE_TREE_DRAG_SOURCE (gtk_tree_drag_source_get_type ())
|
|
#define GTK_TREE_DRAG_SOURCE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_TREE_DRAG_SOURCE, GtkTreeDragSource))
|
|
#define GTK_IS_TREE_DRAG_SOURCE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_TREE_DRAG_SOURCE))
|
|
#define GTK_TREE_DRAG_SOURCE_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), GTK_TYPE_TREE_DRAG_SOURCE, GtkTreeDragSourceIface))
|
|
|
|
typedef struct _GtkTreeDragSource GtkTreeDragSource; /* Dummy typedef */
|
|
typedef struct _GtkTreeDragSourceIface GtkTreeDragSourceIface;
|
|
|
|
/**
|
|
* GtkTreeDragSourceIface:
|
|
* @row_draggable: Asks the `GtkTreeDragSource` whether a particular
|
|
* row can be used as the source of a DND operation.
|
|
* @drag_data_get: Asks the `GtkTreeDragSource` to fill in
|
|
* selection_data with a representation of the row at path.
|
|
* @drag_data_delete: Asks the `GtkTreeDragSource` to delete the row at
|
|
* path, because it was moved somewhere else via drag-and-drop.
|
|
*/
|
|
struct _GtkTreeDragSourceIface
|
|
{
|
|
/*< private >*/
|
|
GTypeInterface g_iface;
|
|
|
|
/*< public >*/
|
|
|
|
/* VTable - not signals */
|
|
|
|
gboolean (* row_draggable) (GtkTreeDragSource *drag_source,
|
|
GtkTreePath *path);
|
|
|
|
GdkContentProvider * (* drag_data_get)(GtkTreeDragSource *drag_source,
|
|
GtkTreePath *path);
|
|
|
|
gboolean (* drag_data_delete) (GtkTreeDragSource *drag_source,
|
|
GtkTreePath *path);
|
|
};
|
|
|
|
GDK_AVAILABLE_IN_ALL
|
|
GType gtk_tree_drag_source_get_type (void) G_GNUC_CONST;
|
|
|
|
/* Returns whether the given row can be dragged */
|
|
GDK_AVAILABLE_IN_ALL
|
|
gboolean gtk_tree_drag_source_row_draggable (GtkTreeDragSource *drag_source,
|
|
GtkTreePath *path);
|
|
|
|
/* Deletes the given row, or returns FALSE if it can't */
|
|
GDK_AVAILABLE_IN_ALL
|
|
gboolean gtk_tree_drag_source_drag_data_delete (GtkTreeDragSource *drag_source,
|
|
GtkTreePath *path);
|
|
|
|
/* Fills in selection_data with type selection_data->target based on
|
|
* the row denoted by path, returns TRUE if it does anything
|
|
*/
|
|
GDK_AVAILABLE_IN_ALL
|
|
GdkContentProvider *
|
|
gtk_tree_drag_source_drag_data_get (GtkTreeDragSource *drag_source,
|
|
GtkTreePath *path);
|
|
|
|
#define GTK_TYPE_TREE_DRAG_DEST (gtk_tree_drag_dest_get_type ())
|
|
#define GTK_TREE_DRAG_DEST(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_TREE_DRAG_DEST, GtkTreeDragDest))
|
|
#define GTK_IS_TREE_DRAG_DEST(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_TREE_DRAG_DEST))
|
|
#define GTK_TREE_DRAG_DEST_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), GTK_TYPE_TREE_DRAG_DEST, GtkTreeDragDestIface))
|
|
|
|
typedef struct _GtkTreeDragDest GtkTreeDragDest; /* Dummy typedef */
|
|
typedef struct _GtkTreeDragDestIface GtkTreeDragDestIface;
|
|
|
|
/**
|
|
* GtkTreeDragDestIface:
|
|
* @drag_data_received: Asks the `GtkTreeDragDest` to insert a row
|
|
* before the path dest, deriving the contents of the row from
|
|
* selection_data.
|
|
* @row_drop_possible: Determines whether a drop is possible before
|
|
* the given dest_path, at the same depth as dest_path.
|
|
*/
|
|
struct _GtkTreeDragDestIface
|
|
{
|
|
/*< private >*/
|
|
GTypeInterface g_iface;
|
|
|
|
/*< public >*/
|
|
|
|
/* VTable - not signals */
|
|
|
|
gboolean (* drag_data_received) (GtkTreeDragDest *drag_dest,
|
|
GtkTreePath *dest,
|
|
const GValue *value);
|
|
|
|
gboolean (* row_drop_possible) (GtkTreeDragDest *drag_dest,
|
|
GtkTreePath *dest_path,
|
|
const GValue *value);
|
|
};
|
|
|
|
GDK_AVAILABLE_IN_ALL
|
|
GType gtk_tree_drag_dest_get_type (void) G_GNUC_CONST;
|
|
|
|
/* Inserts a row before dest which contains data in selection_data,
|
|
* or returns FALSE if it can't
|
|
*/
|
|
GDK_AVAILABLE_IN_ALL
|
|
gboolean gtk_tree_drag_dest_drag_data_received (GtkTreeDragDest *drag_dest,
|
|
GtkTreePath *dest,
|
|
const GValue *value);
|
|
|
|
|
|
/* Returns TRUE if we can drop before path; path may not exist. */
|
|
GDK_AVAILABLE_IN_ALL
|
|
gboolean gtk_tree_drag_dest_row_drop_possible (GtkTreeDragDest *drag_dest,
|
|
GtkTreePath *dest_path,
|
|
const GValue *value);
|
|
|
|
|
|
/* The selection data would normally have target type GTK_TREE_MODEL_ROW in this
|
|
* case. If the target is wrong these functions return FALSE.
|
|
*/
|
|
GDK_AVAILABLE_IN_ALL
|
|
GdkContentProvider *
|
|
gtk_tree_create_row_drag_content (GtkTreeModel *tree_model,
|
|
GtkTreePath *path);
|
|
GDK_AVAILABLE_IN_ALL
|
|
gboolean gtk_tree_get_row_drag_data (const GValue *value,
|
|
GtkTreeModel **tree_model,
|
|
GtkTreePath **path);
|
|
|
|
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GtkTreeDragDest, g_object_unref)
|
|
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GtkTreeDragSource, g_object_unref)
|
|
|
|
G_END_DECLS
|
|
|
|
#endif /* __GTK_TREE_DND_H__ */
|