summaryrefslogtreecommitdiff
path: root/src/lib
diff options
context:
space:
mode:
authorCarsten Haitzler (Rasterman) <raster@rasterman.com>2017-12-16 11:55:43 +0900
committerCarsten Haitzler (Rasterman) <raster@rasterman.com>2017-12-16 12:09:52 +0900
commitd9e149eb4d55cf4bd03845cfdd412713bdd080a5 (patch)
treec765fe62093360035fb53b069794c6c6460366c8 /src/lib
parent00fb5b228a0c7011381943eaa909b908336c8ff5 (diff)
efl loop message stuff - document the eo files.
Diffstat (limited to 'src/lib')
-rw-r--r--src/lib/ecore/efl_loop.eo23
-rw-r--r--src/lib/ecore/efl_loop_message.eo3
-rw-r--r--src/lib/ecore/efl_loop_message_handler.eo29
3 files changed, 35 insertions, 20 deletions
diff --git a/src/lib/ecore/efl_loop.eo b/src/lib/ecore/efl_loop.eo
index 2162039113..df39a642b1 100644
--- a/src/lib/ecore/efl_loop.eo
+++ b/src/lib/ecore/efl_loop.eo
@@ -129,20 +129,27 @@ class Efl.Loop (Efl.Object)
129 return: bool; [[$true if successfully unregistered, $false otherwise.]] 129 return: bool; [[$true if successfully unregistered, $false otherwise.]]
130 } 130 }
131 message_handler_get @class { 131 message_handler_get @class {
132 [[ ]] 132 [[Get a message handler object that is created by and owned by
133 the Efl.Loop object, so you can listen to this message type by
134 listening to message events on the handler as well as send
135 objects as events.]]
133 params { 136 params {
134 @in loop: Efl.Loop; [[ ]] 137 @in loop: Efl.Loop; [[The loop to get the object from.]]
135 @in klass: const(Efl.Class); [[ ]] 138 @in klass: const(Efl.Class); [[The class of the message object.]]
136 } 139 }
137 return: Efl.Loop.Message.Handler; [[ ]] 140 return: Efl.Loop.Message.Handler; [[The message handler to use.]]
138 } 141 }
139 message_process { 142 message_process {
140 [[ ]] 143 [[Process all messages in the queue that have been sent by
141 return: bool; [[ ]] 144 Efl.Loop.Message.Handler objects and thus call the event
145 callbacks for these messages in order in the queue. There
146 should never be a need to call this method as it is
147 automatically called as part of the loop execution.]]
148 return: bool; [[True if messages existed and were called.]]
142 } 149 }
143 message_exists { 150 message_exists {
144 [[ ]] 151 [[Checks if there are any messages on the queue to call.]]
145 return: bool; [[ ]] 152 return: bool; [[True if there are messages to call. ]]
146 } 153 }
147 } 154 }
148 events { 155 events {
diff --git a/src/lib/ecore/efl_loop_message.eo b/src/lib/ecore/efl_loop_message.eo
index 7368c28802..3ef851c55e 100644
--- a/src/lib/ecore/efl_loop_message.eo
+++ b/src/lib/ecore/efl_loop_message.eo
@@ -3,7 +3,8 @@ import eina_types;
3 3
4class Efl.Loop.Message (Efl.Object) 4class Efl.Loop.Message (Efl.Object)
5{ 5{
6 [[ ]] 6 [[Base message payload object class. Inherit this and extend for
7 specific message types.]]
7 methods { 8 methods {
8 } 9 }
9 implements { 10 implements {
diff --git a/src/lib/ecore/efl_loop_message_handler.eo b/src/lib/ecore/efl_loop_message_handler.eo
index b934364013..f0be9c4484 100644
--- a/src/lib/ecore/efl_loop_message_handler.eo
+++ b/src/lib/ecore/efl_loop_message_handler.eo
@@ -3,33 +3,40 @@ import eina_types;
3 3
4class Efl.Loop.Message.Handler (Efl.Object) 4class Efl.Loop.Message.Handler (Efl.Object)
5{ 5{
6 [[ ]] 6 [[Message handlers represent a single message type on the Efl.Loop
7 parent object. These message handlers can be used to listen for
8 that message type by listening to the message event for the generic
9 case or a class specific event type to get specific message object
10 typing correct.]]
7 methods { 11 methods {
8 message_add { 12 message_add {
9 [[ ]] 13 [[Creates a new message object of the correct type for this
10 return: Efl.Loop.Message; [[ ]] 14 message type.]]
15 return: Efl.Loop.Message; [[The new message payload object.]]
11 } 16 }
12 message_send { 17 message_send {
13 [[ Plase the message on the queue to be called later ]] 18 [[Place the message on the queue to be called later when
19 message_process() is called on the loop object.]]
14 params { 20 params {
15 @in message: Efl.Loop.Message; [[ ]] 21 @in message: Efl.Loop.Message; [[The message to place on the queue.]]
16 } 22 }
17 } 23 }
18 message_call { 24 message_call {
19 [[ Overide me (implement) then call super after calling the 25 [[Overide me (implement) then call super after calling the
20 right callback type if you specialize the message type 26 right callback type if you specialize the message type.]]
21 ]]
22 params { 27 params {
23 @in message: Efl.Loop.Message; [[ Generic message event type ]] 28 @in message: Efl.Loop.Message; [[ Generic message event type ]]
24 } 29 }
25 } 30 }
26 message_clear { 31 message_clear {
27 [[ ]] 32 [[Delete all queued messages belonging to this message handler
28 return: bool; [[ ]] 33 that are pending on the queue so they are not processed
34 later.]]
35 return: bool; [[True if any messages of this type were cleared.]]
29 } 36 }
30 } 37 }
31 events { 38 events {
32 message: Efl.Loop.Message; [[ ]] 39 message: Efl.Loop.Message; [[The message payload data]]
33 } 40 }
34 implements { 41 implements {
35 Efl.Object.constructor; 42 Efl.Object.constructor;