summaryrefslogtreecommitdiff
path: root/src/lib/ecore/efl_loop_message_handler.eo
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/ecore/efl_loop_message_handler.eo')
-rw-r--r--src/lib/ecore/efl_loop_message_handler.eo29
1 files changed, 18 insertions, 11 deletions
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;
class Efl.Loop.Message.Handler (Efl.Object)
{
- [[ ]]
+ [[Message handlers represent a single message type on the Efl.Loop
+ parent object. These message handlers can be used to listen for
+ that message type by listening to the message event for the generic
+ case or a class specific event type to get specific message object
+ typing correct.]]
methods {
message_add {
- [[ ]]
- return: Efl.Loop.Message; [[ ]]
+ [[Creates a new message object of the correct type for this
+ message type.]]
+ return: Efl.Loop.Message; [[The new message payload object.]]
}
message_send {
- [[ Plase the message on the queue to be called later ]]
+ [[Place the message on the queue to be called later when
+ message_process() is called on the loop object.]]
params {
- @in message: Efl.Loop.Message; [[ ]]
+ @in message: Efl.Loop.Message; [[The message to place on the queue.]]
}
}
message_call {
- [[ Overide me (implement) then call super after calling the
- right callback type if you specialize the message type
- ]]
+ [[Overide me (implement) then call super after calling the
+ right callback type if you specialize the message type.]]
params {
@in message: Efl.Loop.Message; [[ Generic message event type ]]
}
}
message_clear {
- [[ ]]
- return: bool; [[ ]]
+ [[Delete all queued messages belonging to this message handler
+ that are pending on the queue so they are not processed
+ later.]]
+ return: bool; [[True if any messages of this type were cleared.]]
}
}
events {
- message: Efl.Loop.Message; [[ ]]
+ message: Efl.Loop.Message; [[The message payload data]]
}
implements {
Efl.Object.constructor;