From: gastal <gastal>
Date: Fri, 1 Jul 2011 13:46:25 +0000 (+0000)
Subject: Emotion: signals documentation.
X-Git-Tag: submit/2.0alpha-wayland/20121127.222018~236
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=e8077a2560d30ffc4a66cfb45cc1f73102f9af06;p=profile%2Fivi%2Femotion.git

Emotion: signals documentation.



git-svn-id: http://svn.enlightenment.org/svn/e/trunk/emotion@60917 7cbeb6ba-43b4-40fd-8cce-4c39aea84d33
---

diff --git a/src/lib/Emotion.h b/src/lib/Emotion.h
index 83c68a4..1616541 100644
--- a/src/lib/Emotion.h
+++ b/src/lib/Emotion.h
@@ -140,7 +140,16 @@ extern "C" {
  *
  * @li Add the description of modules here.
  * @li Basic emotion example
- * @li Signals available
+ * @section signals Available signals
+ * The Evas_Object returned by emotion_object_add() has a number of signals that
+ * can be listened to using evas' smart callbacks mechanism. All signals have
+ * NULL as event info. The following is a list of interesting signals:
+ * @li "playback_started" - Emitted when the playback starts
+ * @li "playback_finished" - Emitted when the playback finishes
+ * @li "frame_decode" - Emitted every time a frame is decoded
+ * @li "open_done" - Emitted when the media file is opened
+ * @li "position_update" - Emitted when emotion_object_position_set is called
+ * @li "decode_stop" - Emitted after the last frame is decoded
  */
 
 /**