]> Pileus Git - ~andy/gtk/blobdiff - gtk/gtktreednd.c
GtkBubbleWindow: use OSD style class
[~andy/gtk] / gtk / gtktreednd.c
index 8fbeabb2d7ae02127d77aa16a854d9b8258092c7..d65cdc09737beb6c33162c1d6b54593aada74b79 100644 (file)
  * 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/>.
  */
 
+#include "config.h"
 #include <string.h>
 #include "gtktreednd.h"
+#include "gtkintl.h"
+
+
+/**
+ * SECTION:gtktreednd
+ * @Short_description: Interfaces for drag-and-drop support in GtkTreeView
+ * @Title: GtkTreeView drag-and-drop
+ *
+ * GTK+ supports Drag-and-Drop in tree views with a high-level and a low-level
+ * API.
+ *
+ * The low-level API consists of the GTK+ DND API, augmented by some treeview
+ * utility functions: gtk_tree_view_set_drag_dest_row(),
+ * gtk_tree_view_get_drag_dest_row(), gtk_tree_view_get_dest_row_at_pos(),
+ * gtk_tree_view_create_row_drag_icon(), gtk_tree_set_row_drag_data() and
+ * gtk_tree_get_row_drag_data(). This API leaves a lot of flexibility, but
+ * nothing is done automatically, and implementing advanced features like
+ * hover-to-open-rows or autoscrolling on top of this API is a lot of work.
+ *
+ * On the other hand, if you write to the high-level API, then all the
+ * bookkeeping of rows is done for you, as well as things like hover-to-open
+ * and auto-scroll, but your models have to implement the
+ * #GtkTreeDragSource and #GtkTreeDragDest interfaces.
+ */
+
 
 GType
 gtk_tree_drag_source_get_type (void)
@@ -27,7 +51,7 @@ gtk_tree_drag_source_get_type (void)
 
   if (!our_type)
     {
-      static const GTypeInfo our_info =
+      const GTypeInfo our_info =
       {
         sizeof (GtkTreeDragSourceIface), /* class_size */
        NULL,           /* base_init */
@@ -40,7 +64,9 @@ gtk_tree_drag_source_get_type (void)
        NULL
       };
 
-      our_type = g_type_register_static (G_TYPE_INTERFACE, "GtkTreeDragSource", &our_info, 0);
+      our_type = g_type_register_static (G_TYPE_INTERFACE, 
+                                        I_("GtkTreeDragSource"),
+                                        &our_info, 0);
     }
   
   return our_type;
@@ -54,7 +80,7 @@ gtk_tree_drag_dest_get_type (void)
 
   if (!our_type)
     {
-      static const GTypeInfo our_info =
+      const GTypeInfo our_info =
       {
         sizeof (GtkTreeDragDestIface), /* class_size */
        NULL,           /* base_init */
@@ -67,7 +93,7 @@ gtk_tree_drag_dest_get_type (void)
        NULL
       };
 
-      our_type = g_type_register_static (G_TYPE_INTERFACE, "GtkTreeDragDest", &our_info, 0);
+      our_type = g_type_register_static (G_TYPE_INTERFACE, I_("GtkTreeDragDest"), &our_info, 0);
     }
   
   return our_type;
@@ -96,6 +122,9 @@ gtk_tree_drag_source_row_draggable (GtkTreeDragSource *drag_source,
     return (* iface->row_draggable) (drag_source, path);
   else
     return TRUE;
+    /* Returning TRUE if row_draggable is not implemented is a fallback.
+       Interface implementations such as GtkTreeStore and GtkListStore really should
+       implement row_draggable. */
 }
 
 
@@ -128,7 +157,8 @@ gtk_tree_drag_source_drag_data_delete (GtkTreeDragSource *drag_source,
  * gtk_tree_drag_source_drag_data_get:
  * @drag_source: a #GtkTreeDragSource
  * @path: row that was dragged
- * @selection_data: a #GtkSelectionData to fill with data from the dragged row
+ * @selection_data: a #GtkSelectionData to fill with data
+ *                  from the dragged row
  * 
  * Asks the #GtkTreeDragSource to fill in @selection_data with a
  * representation of the row at @path. @selection_data->target gives
@@ -182,7 +212,7 @@ gtk_tree_drag_dest_drag_data_received (GtkTreeDragDest  *drag_dest,
 
 
 /**
- * gtk_tree_drag_dest_drop_possible:
+ * gtk_tree_drag_dest_row_drop_possible:
  * @drag_dest: a #GtkTreeDragDest
  * @dest_path: destination row
  * @selection_data: the data being dragged
@@ -242,7 +272,7 @@ gtk_tree_set_row_drag_data (GtkSelectionData *selection_data,
   g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), FALSE);
   g_return_val_if_fail (path != NULL, FALSE);
 
-  if (selection_data->target != gdk_atom_intern ("GTK_TREE_MODEL_ROW", FALSE))
+  if (gtk_selection_data_get_target (selection_data) != gdk_atom_intern_static_string ("GTK_TREE_MODEL_ROW"))
     return FALSE;
   
   path_str = gtk_tree_path_to_string (path);
@@ -262,7 +292,7 @@ gtk_tree_set_row_drag_data (GtkSelectionData *selection_data,
   trd->model = tree_model;
   
   gtk_selection_data_set (selection_data,
-                          gdk_atom_intern ("GTK_TREE_MODEL_ROW", FALSE),
+                          gdk_atom_intern_static_string ("GTK_TREE_MODEL_ROW"),
                           8, /* bytes */
                           (void*)trd,
                           struct_size);
@@ -275,8 +305,8 @@ gtk_tree_set_row_drag_data (GtkSelectionData *selection_data,
 /**
  * gtk_tree_get_row_drag_data:
  * @selection_data: a #GtkSelectionData
- * @tree_model: a #GtkTreeModel
- * @path: row in @tree_model
+ * @tree_model: (out): a #GtkTreeModel
+ * @path: (out): row in @tree_model
  * 
  * Obtains a @tree_model and @path from selection data of target type
  * %GTK_TREE_MODEL_ROW. Normally called from a drag_data_received handler.
@@ -305,11 +335,14 @@ gtk_tree_get_row_drag_data (GtkSelectionData  *selection_data,
 
   if (path)
     *path = NULL;
-  
-  if (selection_data->target != gdk_atom_intern ("GTK_TREE_MODEL_ROW", FALSE))
+
+  if (gtk_selection_data_get_target (selection_data) != gdk_atom_intern_static_string ("GTK_TREE_MODEL_ROW"))
+    return FALSE;
+
+  if (gtk_selection_data_get_length (selection_data) < 0)
     return FALSE;
 
-  trd = (void*) selection_data->data;
+  trd = (void*) gtk_selection_data_get_data (selection_data);
 
   if (tree_model)
     *tree_model = trd->model;