summaryrefslogtreecommitdiff
path: root/src/lib/eo
diff options
context:
space:
mode:
authorXavi Artigas <xavierartigas@yahoo.es>2019-03-27 15:10:57 +0000
committerMarcel Hollerbach <mail@marcel-hollerbach.de>2019-03-28 09:39:40 +0100
commit9f1cd60aeba0d0a55fb5546c39888bc4afbfbfcf (patch)
tree454904138aa22dd31374e98589e2cb8e094b8a59 /src/lib/eo
parent62b3759db553378d57e1d3acb2adba6b504301d7 (diff)
docs: Document event info calling convention
Both at the emitter (efl_event_callback_call) and the receiver (info field in the Efl.Event structure). The Events tutorial should repeat this. Fixes T7760 Reviewed-by: Marcel Hollerbach <mail@marcel-hollerbach.de> Differential Revision: https://phab.enlightenment.org/D8486
Diffstat (limited to 'src/lib/eo')
-rw-r--r--src/lib/eo/Eo.h5
-rw-r--r--src/lib/eo/efl_object.eo6
2 files changed, 9 insertions, 2 deletions
diff --git a/src/lib/eo/Eo.h b/src/lib/eo/Eo.h
index 613774da87..f5fb5eef09 100644
--- a/src/lib/eo/Eo.h
+++ b/src/lib/eo/Eo.h
@@ -311,7 +311,10 @@ EOAPI Eina_Bool efl_event_callback_array_del(Eo *obj, const Efl_Callback_Array_I
311 * @brief Call the callbacks for an event of an object. 311 * @brief Call the callbacks for an event of an object.
312 * 312 *
313 * @param[in] desc The description of the event to call. 313 * @param[in] desc The description of the event to call.
314 * @param[in] event_info Extra event info to pass to the callbacks. 314 * @param[in] event_info Extra event info to pass to the callbacks. Please provide objects of the same type as
315 * advertised in the EO file, as this is what listeners of this event will be expecting. Keep in mind that:
316 * 1) Objects must be passed as a normal Eo*. Event subscribers can call functions on these objects.
317 * 2) Structs, built-in types and containers must be passed as const pointers, with one level of indirection.
315 * 318 *
316 * @return @c false If one of the callbacks aborted the call, @c true otherwise 319 * @return @c false If one of the callbacks aborted the call, @c true otherwise
317 */ 320 */
diff --git a/src/lib/eo/efl_object.eo b/src/lib/eo/efl_object.eo
index 34d020160b..9e71ad8db0 100644
--- a/src/lib/eo/efl_object.eo
+++ b/src/lib/eo/efl_object.eo
@@ -424,5 +424,9 @@ struct Efl.Event {
424 ]] 424 ]]
425 object: Efl.Object; [[The object the callback was called on.]] 425 object: Efl.Object; [[The object the callback was called on.]]
426 desc: const(ptr(Efl.Event_Description)); [[The event description.]] 426 desc: const(ptr(Efl.Event_Description)); [[The event description.]]
427 info: void_ptr; [[Extra event information passed by the event caller]] 427 info: void_ptr; [[Extra event information passed by the event caller.
428 Must be cast to the event type declared in the EO file. Keep in mind that:
429 1) Objects are passed as a normal Eo*. Event subscribers can call functions on these objects.
430 2) Structs, built-in types and containers are passed as const pointers, with one level of indirection.
431 ]]
428} 432}