[clutter] docs: Include test-drag as the DragAction example



commit 8775642e82f999d7fa49bcec8aa967d240c89c2d
Author: Emmanuele Bassi <ebassi linux intel com>
Date:   Fri Sep 2 14:50:07 2011 +0100

    docs: Include test-drag as the DragAction example

 clutter/clutter-drag-action.c |   14 ++++++++++++++
 1 files changed, 14 insertions(+), 0 deletions(-)
---
diff --git a/clutter/clutter-drag-action.c b/clutter/clutter-drag-action.c
index cf37600..c7b21dd 100644
--- a/clutter/clutter-drag-action.c
+++ b/clutter/clutter-drag-action.c
@@ -54,6 +54,20 @@
  * parented and exist between the emission of #ClutterDragAction::drag-begin
  * and #ClutterDragAction::drag-end.
  *
+ * <example id="drag-action-example">
+ *   <title>A simple draggable actor</title>
+ *   <programlisting>
+ * <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"; parse="text" href="../../../../tests/interactive/test-drag.c">
+ *   <xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback>
+ * </xi:include>
+ *   </programlisting>
+ *   <para>The example program above allows dragging the rectangle around
+ *   the stage using a #ClutterDragAction. When pressing the
+ *   <keycap>Shift</keycap> key the actor that is going to be dragged is a
+ *   separate rectangle, and when the drag ends, the original rectangle will
+ *   be animated to the final coordinates.</para>
+ * </example>
+ *
  * #ClutterDragAction is available since Clutter 1.4
  */
 



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]