isa/mutter
1
0
Fork 0
mirror of https://github.com/brl/mutter.git synced 2025-01-23 09:59:03 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Inline test-drop.c into DropAction's description

Browse Source 
Also, mention that DropAction only works with DragAction.
This commit is contained in:
Emmanuele Bassi 2011-09-02 15:22:08 +01:00
parent 8775642e82
commit 0d6208f36e
1 changed files with 15 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
clutter/clutter-drop-action.c
View File

@ -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
*/