diff options
-rw-r--r-- | src/lib/ecore/efl_loop.eo | 23 | ||||
-rw-r--r-- | src/lib/ecore/efl_loop_message.eo | 3 | ||||
-rw-r--r-- | src/lib/ecore/efl_loop_message_handler.eo | 29 |
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) return: bool; [[$true if successfully unregistered, $false otherwise.]] } message_handler_get @class { - [[ ]] + [[Get a message handler object that is created by and owned by + the Efl.Loop object, so you can listen to this message type by + listening to message events on the handler as well as send + objects as events.]] params { - @in loop: Efl.Loop; [[ ]] - @in klass: const(Efl.Class); [[ ]] + @in loop: Efl.Loop; [[The loop to get the object from.]] + @in klass: const(Efl.Class); [[The class of the message object.]] } - return: Efl.Loop.Message.Handler; [[ ]] + return: Efl.Loop.Message.Handler; [[The message handler to use.]] } message_process { - [[ ]] - return: bool; [[ ]] + [[Process all messages in the queue that have been sent by + Efl.Loop.Message.Handler objects and thus call the event + callbacks for these messages in order in the queue. There + should never be a need to call this method as it is + automatically called as part of the loop execution.]] + return: bool; [[True if messages existed and were called.]] } message_exists { - [[ ]] - return: bool; [[ ]] + [[Checks if there are any messages on the queue to call.]] + return: bool; [[True if there are messages to call. ]] } } 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; class Efl.Loop.Message (Efl.Object) { - [[ ]] + [[Base message payload object class. Inherit this and extend for + specific message types.]] methods { } 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; 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; |