gtktreednd.h 5.99 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14
/* 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
Javier Jardón's avatar
Javier Jardón committed
15
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
16 17
 */

18 19 20
#ifndef __GTK_TREE_DND_H__
#define __GTK_TREE_DND_H__

21
#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
22 23 24
#error "Only <gtk/gtk.h> can be included directly."
#endif

25 26 27
#include <gtk/gtktreemodel.h>
#include <gtk/gtkdnd.h>

Matthias Clasen's avatar
Matthias Clasen committed
28
G_BEGIN_DECLS
29 30 31 32

#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))
33
#define GTK_TREE_DRAG_SOURCE_GET_IFACE(obj)  (G_TYPE_INSTANCE_GET_INTERFACE ((obj), GTK_TYPE_TREE_DRAG_SOURCE, GtkTreeDragSourceIface))
34 35 36 37

typedef struct _GtkTreeDragSource      GtkTreeDragSource; /* Dummy typedef */
typedef struct _GtkTreeDragSourceIface GtkTreeDragSourceIface;

38 39 40 41 42 43 44 45 46
/**
 * 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.
 */
47 48
struct _GtkTreeDragSourceIface
{
49
  /*< private >*/
50 51
  GTypeInterface g_iface;

52 53
  /*< public >*/

54 55
  /* VTable - not signals */

56 57 58
  gboolean     (* row_draggable)        (GtkTreeDragSource   *drag_source,
                                         GtkTreePath         *path);

59
  gboolean     (* drag_data_get)        (GtkTreeDragSource   *drag_source,
60 61 62
                                         GtkTreePath         *path,
                                         GtkSelectionData    *selection_data);

63
  gboolean     (* drag_data_delete)     (GtkTreeDragSource *drag_source,
64 65 66
                                         GtkTreePath       *path);
};

67
GDK_AVAILABLE_IN_ALL
68 69
GType           gtk_tree_drag_source_get_type   (void) G_GNUC_CONST;

70
/* Returns whether the given row can be dragged */
71
GDK_AVAILABLE_IN_ALL
72 73 74
gboolean gtk_tree_drag_source_row_draggable    (GtkTreeDragSource *drag_source,
                                                GtkTreePath       *path);

75
/* Deletes the given row, or returns FALSE if it can't */
76
GDK_AVAILABLE_IN_ALL
77 78 79 80 81 82
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
 */
83
GDK_AVAILABLE_IN_ALL
84 85 86 87 88 89 90
gboolean gtk_tree_drag_source_drag_data_get    (GtkTreeDragSource *drag_source,
                                                GtkTreePath       *path,
                                                GtkSelectionData  *selection_data);

#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))
91
#define GTK_TREE_DRAG_DEST_GET_IFACE(obj)  (G_TYPE_INSTANCE_GET_INTERFACE ((obj), GTK_TYPE_TREE_DRAG_DEST, GtkTreeDragDestIface))
92 93 94 95

typedef struct _GtkTreeDragDest      GtkTreeDragDest; /* Dummy typedef */
typedef struct _GtkTreeDragDestIface GtkTreeDragDestIface;

96 97 98 99 100 101 102 103
/**
 * 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.
 */
104 105
struct _GtkTreeDragDestIface
{
106
  /*< private >*/
107 108
  GTypeInterface g_iface;

109 110
  /*< public >*/

111 112
  /* VTable - not signals */

113
  gboolean     (* drag_data_received) (GtkTreeDragDest   *drag_dest,
114 115 116
                                       GtkTreePath       *dest,
                                       GtkSelectionData  *selection_data);

117
  gboolean     (* row_drop_possible)  (GtkTreeDragDest   *drag_dest,
118 119
                                       GtkTreePath       *dest_path,
				       GtkSelectionData  *selection_data);
120 121
};

122
GDK_AVAILABLE_IN_ALL
123 124 125 126 127
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
 */
128
GDK_AVAILABLE_IN_ALL
129 130 131 132
gboolean gtk_tree_drag_dest_drag_data_received (GtkTreeDragDest   *drag_dest,
						GtkTreePath       *dest,
						GtkSelectionData  *selection_data);

133

134
/* Returns TRUE if we can drop before path; path may not exist. */
135
GDK_AVAILABLE_IN_ALL
136
gboolean gtk_tree_drag_dest_row_drop_possible  (GtkTreeDragDest   *drag_dest,
137 138
						GtkTreePath       *dest_path,
						GtkSelectionData  *selection_data);
139

140

141 142 143
/* The selection data would normally have target type GTK_TREE_MODEL_ROW in this
 * case. If the target is wrong these functions return FALSE.
 */
144
GDK_AVAILABLE_IN_ALL
145 146 147
gboolean gtk_tree_set_row_drag_data            (GtkSelectionData  *selection_data,
						GtkTreeModel      *tree_model,
						GtkTreePath       *path);
148
GDK_AVAILABLE_IN_ALL
149 150 151 152
gboolean gtk_tree_get_row_drag_data            (GtkSelectionData  *selection_data,
						GtkTreeModel     **tree_model,
						GtkTreePath      **path);

Matthias Clasen's avatar
Matthias Clasen committed
153
G_END_DECLS
154 155

#endif /* __GTK_TREE_DND_H__ */