aboutsummaryrefslogtreecommitdiffstats
path: root/pages/develop/api/efl/promise.txt
diff options
context:
space:
mode:
Diffstat (limited to 'pages/develop/api/efl/promise.txt')
-rw-r--r--pages/develop/api/efl/promise.txt132
1 files changed, 40 insertions, 92 deletions
diff --git a/pages/develop/api/efl/promise.txt b/pages/develop/api/efl/promise.txt
index 8e428d5d9..20e193128 100644
--- a/pages/develop/api/efl/promise.txt
+++ b/pages/develop/api/efl/promise.txt
@@ -41,125 +41,73 @@ digraph hierarchy {
++++
===== Members =====
-**[[:develop:api:efl:promise:method:connect|connect]]**
+**[[:develop:api:efl:promise:method:connect|connect]]**\\
+> %%Connects a future output to this promise.%%
<code c>
Eina_Bool efl_promise_connect(Eo *obj, Efl_Future *f);
</code>
-
-%%Connects a future output to this promise.%%\\
-\\
-**[[:develop:api:efl:promise:method:progress_set|progress_set]]**
+\\
+**[[:develop:api:efl:promise:method:constructor|constructor]]**// [Overridden from [[:develop:api:efl:object|Efl.Object]]]//\\
+> %%Call the object's constructor.%%
+<code c>
+Efl_Object *efl_constructor(Eo *obj);
+</code>
+\\
+**[[:develop:api:efl:promise:method:destructor|destructor]]**// [Overridden from [[:develop:api:efl:object|Efl.Object]]]//\\
+> %%Call the object's destructor.%%
+<code c>
+void efl_destructor(Eo *obj);
+</code>
+\\
+**[[:develop:api:efl:promise:method:progress_set|progress_set]]**\\
+> %%Updates the progress and send it immediately to all connected Efl_Future.%%
<code c>
void efl_promise_progress_set(Eo *obj, const void *p);
</code>
-
-%%Updates the progress and send it immediately to all connected Efl_Future.%%\\
-\\
-**[[:develop:api:efl:promise:property:failed|failed]]** //**(set)**//
+\\
+**[[:develop:api:efl:promise:property:failed|failed]]** //**(set)**//\\
+> %%Defines the failure state of this promise.%%
<code c>
void efl_promise_failed_set(Eo *obj, Eina_Error err);
</code>
-
-%%Defines the failure state of this promise.%%\\
-\\
-**[[:develop:api:efl:promise:property:future|future]]** //**(get)**//
+\\
+**[[:develop:api:efl:promise:property:future|future]]** //**(get)**//\\
+> %%Requests a new future linked to this promise.%%
<code c>
Efl_Future *efl_promise_future_get(const Eo *obj);
</code>
-
-%%Requests a new future linked to this promise.%%\\
-\\
-**[[:develop:api:efl:promise:property:value|value]]** //**(set)**//
+\\
+**[[:develop:api:efl:promise:property:value|value]]** //**(set)**//\\
+> %%The value expected by all connected future.%%
<code c>
void efl_promise_value_set(Eo *obj, void *v, Eina_Free_Cb free_cb);
</code>
-
-%%The value expected by all connected future.%%\\
-\\
+\\
==== Inherited ====
-[[:develop:api:efl:loop_user|Efl.Loop_User]].**[[:develop:api:efl:loop_user:property:loop|loop]]** //**(get)**//
-\\
-[[:develop:api:efl:object|Efl.Object]].**[[:develop:api:efl:loop_user:property:parent|parent]]** //**(get, set)**// //[Overridden in [[:develop:api:efl:loop_user|Efl.Loop_User]]]//
-\\
-[[:develop:api:efl:object|Efl.Object]].**[[:develop:api:efl:object:method:children_iterator_new|children_iterator_new]]**
-\\
-[[:develop:api:efl:object|Efl.Object]].**[[:develop:api:efl:object:method:composite_attach|composite_attach]]**
-\\
-[[:develop:api:efl:object|Efl.Object]].**[[:develop:api:efl:object:method:composite_detach|composite_detach]]**
-\\
-[[:develop:api:efl:object|Efl.Object]].**[[:develop:api:efl:object:method:composite_part_is|composite_part_is]]**
-\\
-[[:develop:api:efl:object|Efl.Object]].**[[:develop:api:efl:object:method:debug_name_override|debug_name_override]]**
-\\
-[[:develop:api:efl:object|Efl.Object]].**[[:develop:api:efl:object:method:del|del]]**
-\\
-[[:develop:api:efl:object|Efl.Object]].**[[:develop:api:efl:object:method:event_callback_forwarder_add|event_callback_forwarder_add]]**
-\\
-[[:develop:api:efl:object|Efl.Object]].**[[:develop:api:efl:object:method:event_callback_forwarder_del|event_callback_forwarder_del]]**
-\\
-[[:develop:api:efl:object|Efl.Object]].**[[:develop:api:efl:object:method:event_callback_stop|event_callback_stop]]**
-\\
-[[:develop:api:efl:object|Efl.Object]].**[[:develop:api:efl:object:method:event_freeze|event_freeze]]**
-\\
-[[:develop:api:efl:object|Efl.Object]].**[[:develop:api:efl:object:method:event_global_freeze|event_global_freeze]]**
-\\
-[[:develop:api:efl:object|Efl.Object]].**[[:develop:api:efl:object:method:event_global_thaw|event_global_thaw]]**
-\\
-[[:develop:api:efl:object|Efl.Object]].**[[:develop:api:efl:object:method:event_thaw|event_thaw]]**
-\\
-[[:develop:api:efl:object|Efl.Object]].**[[:develop:api:efl:object:method:finalize|finalize]]**
-\\
-[[:develop:api:efl:object|Efl.Object]].**[[:develop:api:efl:object:method:name_find|name_find]]**
-\\
-[[:develop:api:efl:object|Efl.Object]].**[[:develop:api:efl:object:method:provider_find|provider_find]]**
-\\
-[[:develop:api:efl:object|Efl.Object]].**[[:develop:api:efl:object:property:allow_parent_unref|allow_parent_unref]]** //**(get, set)**//
-\\
-[[:develop:api:efl:object|Efl.Object]].**[[:develop:api:efl:object:property:comment|comment]]** //**(get, set)**//
-\\
-[[:develop:api:efl:object|Efl.Object]].**[[:develop:api:efl:object:property:event_freeze_count|event_freeze_count]]** //**(get)**//
-\\
-[[:develop:api:efl:object|Efl.Object]].**[[:develop:api:efl:object:property:event_global_freeze_count|event_global_freeze_count]]** //**(get)**//
-\\
-[[:develop:api:efl:object|Efl.Object]].**[[:develop:api:efl:object:property:finalized|finalized]]** //**(get)**//
-\\
-[[:develop:api:efl:object|Efl.Object]].**[[:develop:api:efl:object:property:name|name]]** //**(get, set)**//
-\\
-[[:develop:api:efl:object|Efl.Object]].**[[:develop:api:efl:promise:method:constructor|constructor]]** //[Overridden here]//
-\\
-[[:develop:api:efl:object|Efl.Object]].**[[:develop:api:efl:promise:method:destructor|destructor]]** //[Overridden here]//
-\\
-
+[[:develop:api:efl:loop_user|Efl.Loop_User]]\\
+> **[[:develop:api:efl:loop_user:property:loop|loop]]** //**(get)**//, **[[:develop:api:efl:loop_user:property:parent|parent]]** //**(get, set)**//\\
+[[:develop:api:efl:object|Efl.Object]]\\
+> **[[:develop:api:efl:object:method:children_iterator_new|children_iterator_new]]**, **[[:develop:api:efl:object:method:composite_attach|composite_attach]]**, **[[:develop:api:efl:object:method:composite_detach|composite_detach]]**, **[[:develop:api:efl:object:method:composite_part_is|composite_part_is]]**, **[[:develop:api:efl:object:method:debug_name_override|debug_name_override]]**, **[[:develop:api:efl:object:method:del|del]]**, **[[:develop:api:efl:object:method:event_callback_forwarder_add|event_callback_forwarder_add]]**, **[[:develop:api:efl:object:method:event_callback_forwarder_del|event_callback_forwarder_del]]**, **[[:develop:api:efl:object:method:event_callback_stop|event_callback_stop]]**, **[[:develop:api:efl:object:method:event_freeze|event_freeze]]**, **[[:develop:api:efl:object:method:event_global_freeze|event_global_freeze]]**, **[[:develop:api:efl:object:method:event_global_thaw|event_global_thaw]]**, **[[:develop:api:efl:object:method:event_thaw|event_thaw]]**, **[[:develop:api:efl:object:method:finalize|finalize]]**, **[[:develop:api:efl:object:method:name_find|name_find]]**, **[[:develop:api:efl:object:method:provider_find|provider_find]]**, **[[:develop:api:efl:object:property:allow_parent_unref|allow_parent_unref]]** //**(get, set)**//, **[[:develop:api:efl:object:property:comment|comment]]** //**(get, set)**//, **[[:develop:api:efl:object:property:event_freeze_count|event_freeze_count]]** //**(get)**//, **[[:develop:api:efl:object:property:event_global_freeze_count|event_global_freeze_count]]** //**(get)**//, **[[:develop:api:efl:object:property:finalized|finalized]]** //**(get)**//, **[[:develop:api:efl:object:property:name|name]]** //**(get, set)**//
===== Events =====
-**[[:develop:api:efl:promise:event:future_none|future,none]]**
+**[[:develop:api:efl:promise:event:future_none|future,none]]**\\
+> %%This event is triggered whenever there is no more future connected to the promise.%%
<code c>
EFL_PROMISE_EVENT_FUTURE_NONE(void)
</code>
-
-%%This event is triggered whenever there is no more future connected to the promise.%%\\
-\\
-**[[:develop:api:efl:promise:event:future_progress_set|future,progress,set]]**
+\\ **[[:develop:api:efl:promise:event:future_progress_set|future,progress,set]]**\\
+> %%This event is triggered whenever a future has a progress callback registered and the user does not hold any more reference on it.%%
<code c>
EFL_PROMISE_EVENT_FUTURE_PROGRESS_SET(Efl_Future *)
</code>
-
-%%This event is triggered whenever a future has a progress callback registered and the user does not hold any more reference on it.%%\\
-\\
-**[[:develop:api:efl:promise:event:future_set|future,set]]**
+\\ **[[:develop:api:efl:promise:event:future_set|future,set]]**\\
+> %%This event is triggered whenever a future is fully set to receive all events and that the user of it do not hold any more reference on it.%%
<code c>
EFL_PROMISE_EVENT_FUTURE_SET(Efl_Future *)
</code>
+\\ ==== Inherited ====
-%%This event is triggered whenever a future is fully set to receive all events and that the user of it do not hold any more reference on it.%%\\
-\\
-==== Inherited ====
-
-[[:develop:api:efl:object|Efl.Object]].**[[:develop:api:efl:object:event:callback_add|callback,add]]**
-\\
-[[:develop:api:efl:object|Efl.Object]].**[[:develop:api:efl:object:event:callback_del|callback,del]]**
-\\
-[[:develop:api:efl:object|Efl.Object]].**[[:develop:api:efl:object:event:del|del]]**
-\\
+[[:develop:api:efl:object|Efl.Object]]\\
+> **[[:develop:api:efl:object:event:callback_add|callback,add]]**, **[[:develop:api:efl:object:event:callback_del|callback,del]]**, **[[:develop:api:efl:object:event:del|del]]** \ No newline at end of file