summaryrefslogtreecommitdiff
path: root/src/lib/ecore/efl_loop_message_handler.eo
blob: 7888fbcc93f1ca51f1e2980dbdfb9bd26eb71e53 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
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 {
         [[Creates a new message object of the correct type for this
           message type.]]
         return: Efl.Loop_Message; [[The new message payload object.]]
      }
      message_send {
         [[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; [[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.]]
         params {
            @in message: Efl.Loop_Message; [[ Generic message event type ]]
         }
      }
      message_clear {
         [[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; [[The message payload data]]
   }
   implements {
      Efl.Object.constructor;
      Efl.Object.destructor;
   }
}