Data Structures

struct  _Eo_Event_Description
 This struct holds the description of a specific event. More...
 

Macros

#define EO_EVENT_DESCRIPTION(name, doc)   { name, doc }
 An helper macro to help populating Eo_Event_Description.
 
#define EO_CALLBACK_PRIORITY_BEFORE   -100
 Slightly more prioritized than default.
 
#define EO_CALLBACK_PRIORITY_DEFAULT   0
 Default callback priority level.
 
#define EO_CALLBACK_PRIORITY_AFTER   100
 Slightly less prioritized than default.
 
#define EO_CALLBACK_STOP   EINA_FALSE
 Stop calling callbacks for the even of which the callback was called for.
 
#define EO_CALLBACK_CONTINUE   EINA_TRUE
 Continue calling callbacks for the even of which the callback was called for.
 
#define eo_event_callback_forwarder_add(desc, new_obj)   EO_BASE_ID(EO_BASE_SUB_ID_EVENT_CALLBACK_FORWARDER_ADD), EO_TYPECHECK(const Eo_Event_Description *, desc), EO_TYPECHECK(Eo *, new_obj)
 Add an event callback forwarder for an event and an object.
 
#define eo_event_callback_forwarder_del(desc, new_obj)   EO_BASE_ID(EO_BASE_SUB_ID_EVENT_CALLBACK_FORWARDER_DEL), EO_TYPECHECK(const Eo_Event_Description *, desc), EO_TYPECHECK(Eo *, new_obj)
 Remove an event callback forwarder for an event and an object.
 
#define eo_event_freeze()   EO_BASE_ID(EO_BASE_SUB_ID_EVENT_FREEZE)
 freeze events of object.
 
#define eo_event_thaw()   EO_BASE_ID(EO_BASE_SUB_ID_EVENT_THAW)
 thaw events of object.
 
#define eo_event_freeze_get(fcount)   EO_BASE_ID(EO_BASE_SUB_ID_EVENT_FREEZE_GET), EO_TYPECHECK(int *, fcount)
 return freeze events of object.
 
#define eo_event_global_freeze()   EO_BASE_ID(EO_BASE_SUB_ID_EVENT_GLOBAL_FREEZE)
 freeze events of object.
 
#define eo_event_global_thaw()   EO_BASE_ID(EO_BASE_SUB_ID_EVENT_GLOBAL_THAW)
 thaw events of object.
 
#define eo_event_global_freeze_get(fcount)   EO_BASE_ID(EO_BASE_SUB_ID_EVENT_GLOBAL_FREEZE_GET), EO_TYPECHECK(int *, fcount)
 return freeze events of object.
 
#define eo_event_callback_add(desc, cb, data)
 Add a callback for an event.
 
#define eo_event_callback_priority_add(desc, priority, cb, data)   EO_BASE_ID(EO_BASE_SUB_ID_EVENT_CALLBACK_PRIORITY_ADD), EO_TYPECHECK(const Eo_Event_Description *, desc), EO_TYPECHECK(Eo_Callback_Priority, priority), EO_TYPECHECK(Eo_Event_Cb, cb), EO_TYPECHECK(const void *, data)
 Add a callback for an event with a specific priority.
 
#define eo_event_callback_del(desc, func, user_data)   EO_BASE_ID(EO_BASE_SUB_ID_EVENT_CALLBACK_DEL), EO_TYPECHECK(const Eo_Event_Description *, desc), EO_TYPECHECK(Eo_Event_Cb, func), EO_TYPECHECK(const void *, user_data)
 Del a callback with a specific data associated to it for an event.
 
#define eo_event_callback_call(desc, event_info, aborted)   EO_BASE_ID(EO_BASE_SUB_ID_EVENT_CALLBACK_CALL), EO_TYPECHECK(const Eo_Event_Description *, desc), EO_TYPECHECK(const void *, event_info), EO_TYPECHECK(Eina_Bool *, aborted)
 Call the callbacks for an event of an object.
 

Typedefs

typedef struct
_Eo_Event_Description 
Eo_Event_Description
 A convenience typedef for _Eo_Event_Description.
 
typedef short Eo_Callback_Priority
 Callback priority value.
 
typedef Eina_Bool(* Eo_Event_Cb )(void *data, Eo *obj, const Eo_Event_Description *desc, void *event_info)
 An event callback prototype.
 

Detailed Description

Macro Definition Documentation

#define EO_EVENT_DESCRIPTION (   name,
  doc 
)    { name, doc }

An helper macro to help populating Eo_Event_Description.

Parameters
nameThe name of the event.
docAdditional doc for the event.
See Also
Eo_Event_Description
#define EO_CALLBACK_STOP   EINA_FALSE

Stop calling callbacks for the even of which the callback was called for.

See Also
EO_CALLBACK_CONTINUE
#define EO_CALLBACK_CONTINUE   EINA_TRUE

Continue calling callbacks for the even of which the callback was called for.

See Also
EO_CALLBACK_STOP
#define eo_event_callback_forwarder_add (   desc,
  new_obj 
)    EO_BASE_ID(EO_BASE_SUB_ID_EVENT_CALLBACK_FORWARDER_ADD), EO_TYPECHECK(const Eo_Event_Description *, desc), EO_TYPECHECK(Eo *, new_obj)

Add an event callback forwarder for an event and an object.

Parameters
[in]descThe description of the event to listen to.
[in]new_objThe object to emit events from.
See Also
eo_event_callback_forwarder_del()
#define eo_event_callback_forwarder_del (   desc,
  new_obj 
)    EO_BASE_ID(EO_BASE_SUB_ID_EVENT_CALLBACK_FORWARDER_DEL), EO_TYPECHECK(const Eo_Event_Description *, desc), EO_TYPECHECK(Eo *, new_obj)

Remove an event callback forwarder for an event and an object.

Parameters
[in]descThe description of the event to listen to.
[in]new_objThe object to emit events from.
See Also
eo_event_callback_forwarder_add()
#define eo_event_freeze ( )    EO_BASE_ID(EO_BASE_SUB_ID_EVENT_FREEZE)

freeze events of object.

Prevents event callbacks from being called for the object.

See Also
eo_event_thaw

Referenced by ecore_animator_freeze(), ecore_timer_freeze(), and evas_event_freeze().

#define eo_event_thaw ( )    EO_BASE_ID(EO_BASE_SUB_ID_EVENT_THAW)

thaw events of object.

Lets event callbacks be called for the object.

See Also
eo_event_freeze

Referenced by ecore_animator_thaw(), ecore_timer_thaw(), and evas_event_thaw().

#define eo_event_freeze_get (   fcount)    EO_BASE_ID(EO_BASE_SUB_ID_EVENT_FREEZE_GET), EO_TYPECHECK(int *, fcount)

return freeze events of object.

Parameters
[out]fcountThe event freeze count of the object.

Return event freeze count.

See Also
eo_event_freeze
eo_event_thaw

Referenced by evas_event_freeze_get().

#define eo_event_global_freeze ( )    EO_BASE_ID(EO_BASE_SUB_ID_EVENT_GLOBAL_FREEZE)

freeze events of object.

Prevents event callbacks from being called for the object.

See Also
eo_event_freeze
eo_event_global_thaw
#define eo_event_global_thaw ( )    EO_BASE_ID(EO_BASE_SUB_ID_EVENT_GLOBAL_THAW)

thaw events of object.

Lets event callbacks be called for the object.

See Also
eo_event_thaw
eo_event_global_freeze
#define eo_event_global_freeze_get (   fcount)    EO_BASE_ID(EO_BASE_SUB_ID_EVENT_GLOBAL_FREEZE_GET), EO_TYPECHECK(int *, fcount)

return freeze events of object.

Parameters
[out]fcountThe event freeze count of the object.

Return event freeze count.

See Also
eo_event_freeze_get
eo_event_global_freeze
eo_event_global_thaw
#define eo_event_callback_add (   desc,
  cb,
  data 
)
Value:

Add a callback for an event.

Parameters
[in]descThe description of the event to listen to.
[in]cbthe callback to call.
[in]dataadditional data to pass to the callback.

callbacks of the same priority are called in reverse order of creation.

See Also
eo_event_callback_priority_add()
#define eo_event_callback_priority_add (   desc,
  priority,
  cb,
  data 
)    EO_BASE_ID(EO_BASE_SUB_ID_EVENT_CALLBACK_PRIORITY_ADD), EO_TYPECHECK(const Eo_Event_Description *, desc), EO_TYPECHECK(Eo_Callback_Priority, priority), EO_TYPECHECK(Eo_Event_Cb, cb), EO_TYPECHECK(const void *, data)

Add a callback for an event with a specific priority.

Parameters
[in]descThe description of the event to listen to.
[in]priorityThe priority of the callback.
[in]cbthe callback to call.
[in]dataadditional data to pass to the callback.

callbacks of the same priority are called in reverse order of creation.

See Also
eo_event_callback_add
#define eo_event_callback_del (   desc,
  func,
  user_data 
)    EO_BASE_ID(EO_BASE_SUB_ID_EVENT_CALLBACK_DEL), EO_TYPECHECK(const Eo_Event_Description *, desc), EO_TYPECHECK(Eo_Event_Cb, func), EO_TYPECHECK(const void *, user_data)

Del a callback with a specific data associated to it for an event.

Parameters
[in]descThe description of the event to listen to.
[in]functhe callback to delete.
[in]user_dataThe data to compare.
#define eo_event_callback_call (   desc,
  event_info,
  aborted 
)    EO_BASE_ID(EO_BASE_SUB_ID_EVENT_CALLBACK_CALL), EO_TYPECHECK(const Eo_Event_Description *, desc), EO_TYPECHECK(const void *, event_info), EO_TYPECHECK(Eina_Bool *, aborted)

Call the callbacks for an event of an object.

Parameters
[in]descThe description of the event to call.
[in]event_infoExtra event info to pass to the callbacks.
[out]abortedEINA_TRUE if one of the callbacks aborted the call, EINA_FALSE otherwise.

Referenced by evas_object_smart_callback_call().

Typedef Documentation

Callback priority value.

Range is -32k - 32k. The lower the number, the higher the priority.

See Also
EO_CALLBACK_PRIORITY_AFTER
EO_CALLBACK_PRIORITY_BEFORE
EO_CALLBACK_PRIORITY_DEFAULT
Eo_Event_Cb

An event callback prototype.

Parameters
dataThe user data registered with the callback.
objThe object which initiated the event.
descThe event's description.
event_infoadditional data passed with the event.
Returns
EO_CALLBACK_STOP to stop calling additional callbacks for the event, EO_CALLBACK_CONTINUE to continue.