diff options
author | Javier Jardón <jjardon@gnome.org> | 2010-05-16 02:04:12 +0200 |
---|---|---|
committer | Javier Jardón <jjardon@gnome.org> | 2010-05-16 02:04:12 +0200 |
commit | b00a09de11e8dc1f16f137560f9aebf065584eb1 (patch) | |
tree | 55c92267a2babf2146e5f16dfeff85a66827118b | |
parent | 56d7417fcc4f389e9a1e637e7c7dfcdcd31eaea2 (diff) | |
download | gtk+-b00a09de11e8dc1f16f137560f9aebf065584eb1.tar.gz |
Move documentation to inline comments: GtkTreeView drag-and-drop
-rw-r--r-- | docs/reference/gtk/tmpl/.gitignore | 1 | ||||
-rw-r--r-- | docs/reference/gtk/tmpl/gtktreednd.sgml | 144 | ||||
-rw-r--r-- | gtk/gtktreednd.c | 24 |
3 files changed, 25 insertions, 144 deletions
diff --git a/docs/reference/gtk/tmpl/.gitignore b/docs/reference/gtk/tmpl/.gitignore index 96c7f8c969..123a23439c 100644 --- a/docs/reference/gtk/tmpl/.gitignore +++ b/docs/reference/gtk/tmpl/.gitignore @@ -17,3 +17,4 @@ gtktesting.sgml gtktextiter.sgml gtktoggleaction.sgml gtktoolitem.sgml +gtktreednd.sgml diff --git a/docs/reference/gtk/tmpl/gtktreednd.sgml b/docs/reference/gtk/tmpl/gtktreednd.sgml deleted file mode 100644 index a45f8219ed..0000000000 --- a/docs/reference/gtk/tmpl/gtktreednd.sgml +++ /dev/null @@ -1,144 +0,0 @@ -<!-- ##### SECTION Title ##### --> -GtkTreeView drag-and-drop - -<!-- ##### SECTION Short_Description ##### --> -Interfaces for drag-and-drop support in GtkTreeView - -<!-- ##### SECTION Long_Description ##### --> -<para> -GTK+ supports Drag-and-Drop in tree views with a high-level and a low-level -API. -</para> -<para> -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. -</para> -<para> -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. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### STRUCT GtkTreeDragSource ##### --> -<para> - -</para> - - -<!-- ##### STRUCT GtkTreeDragSourceIface ##### --> -<para> - -</para> - -@g_iface: -@row_draggable: -@drag_data_get: -@drag_data_delete: - -<!-- ##### FUNCTION gtk_tree_drag_source_drag_data_delete ##### --> -<para> - -</para> - -@drag_source: -@path: -@Returns: - - -<!-- ##### FUNCTION gtk_tree_drag_source_drag_data_get ##### --> -<para> - -</para> - -@drag_source: -@path: -@selection_data: -@Returns: - - -<!-- ##### FUNCTION gtk_tree_drag_source_row_draggable ##### --> -<para> - -</para> - -@drag_source: -@path: -@Returns: - - -<!-- ##### STRUCT GtkTreeDragDest ##### --> -<para> - -</para> - - -<!-- ##### STRUCT GtkTreeDragDestIface ##### --> -<para> - -</para> - -@g_iface: -@drag_data_received: -@row_drop_possible: - -<!-- ##### FUNCTION gtk_tree_drag_dest_drag_data_received ##### --> -<para> - -</para> - -@drag_dest: -@dest: -@selection_data: -@Returns: - - -<!-- ##### FUNCTION gtk_tree_drag_dest_row_drop_possible ##### --> -<para> - -</para> - -@drag_dest: -@dest_path: -@selection_data: -@Returns: - - -<!-- ##### FUNCTION gtk_tree_set_row_drag_data ##### --> -<para> - -</para> - -@selection_data: -@tree_model: -@path: -@Returns: - - -<!-- ##### FUNCTION gtk_tree_get_row_drag_data ##### --> -<para> - -</para> - -@selection_data: -@tree_model: -@path: -@Returns: - - diff --git a/gtk/gtktreednd.c b/gtk/gtktreednd.c index 7e079457e9..9a1c87fbea 100644 --- a/gtk/gtktreednd.c +++ b/gtk/gtktreednd.c @@ -23,6 +23,30 @@ #include "gtkintl.h" #include "gtkalias.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) { |