[clutter] docs: Inline test-drop.c into DropAction's description
- From: Emmanuele Bassi <ebassi src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [clutter] docs: Inline test-drop.c into DropAction's description
- Date: Fri, 2 Sep 2011 15:17:06 +0000 (UTC)
commit 0d6208f36e0c66e89635e2d586568bfa40102f8e
Author: Emmanuele Bassi <ebassi linux intel com>
Date: Fri Sep 2 15:22:08 2011 +0100
docs: Inline test-drop.c into DropAction's description
Also, mention that DropAction only works with DragAction.
clutter/clutter-drop-action.c | 18 +++++++++++++++---
1 files changed, 15 insertions(+), 3 deletions(-)
---
diff --git a/clutter/clutter-drop-action.c b/clutter/clutter-drop-action.c
index b52dc0d..d2d772e 100644
--- a/clutter/clutter-drop-action.c
+++ b/clutter/clutter-drop-action.c
@@ -28,9 +28,9 @@
* @short_description: An action for drop targets
*
* #ClutterDropAction is a #ClutterAction that allows a #ClutterActor
- * implementation to control what happens when a dragged actor crosses
- * the target area or when a dragged actor is released (or "dropped")
- * on the target area.
+ * implementation to control what happens when an actor dragged using
+ * a #ClutterDragAction crosses the target area or when a dragged actor
+ * is released (or "dropped") on the target area.
*
* A trivial use of #ClutterDropAction consists in connecting to the
* #ClutterDropAction::drop signal and handling the drop from there,
@@ -49,6 +49,18 @@
* cause the #ClutterDropAction::drop signal to be skipped when the input
* device button is released.
*
+ * <example id="drop-action-example">
+ * <title>Drop targets</title>
+ * <programlisting>
+ * <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../tests/interactive/test-drop.c">
+ * <xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback>
+ * </xi:include>
+ * </programlisting>
+ * </example>
+ *
+ * It's important to note that #ClutterDropAction will only work with
+ * actors dragged using #ClutterDragAction.
+ *
* #ClutterDropAction is available since Clutter 1.8
*/
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]