Modules

 Eo's Event Handling
 

Macros

#define EO_BASE_CLASS   eo_base_class_get()
 The class type for the Eo base class.
 
#define EO_BASE_ID(sub_id)   (EO_BASE_BASE_ID + (sub_id))
 Helper macro to get the full Op ID out of the sub_id for EO_BASE.
 
#define eo_base_data_set(key, data, free_func)   EO_BASE_ID(EO_BASE_SUB_ID_DATA_SET), EO_TYPECHECK(const char *, key), EO_TYPECHECK(const void *, data), EO_TYPECHECK(eo_base_data_free_func, free_func)
 Set generic data to object.
 
#define eo_base_data_get(key, data)   EO_BASE_ID(EO_BASE_SUB_ID_DATA_GET), EO_TYPECHECK(const char *, key), EO_TYPECHECK(void **, data)
 Get generic data from object.
 
#define eo_base_data_del(key)   EO_BASE_ID(EO_BASE_SUB_ID_DATA_DEL), EO_TYPECHECK(const char *, key)
 Del generic data from object.
 
#define eo_wref_add(wref)   EO_BASE_ID(EO_BASE_SUB_ID_WREF_ADD), EO_TYPECHECK(Eo **, wref)
 Add a new weak reference to obj.
 
#define eo_wref_del(wref)   EO_BASE_ID(EO_BASE_SUB_ID_WREF_DEL), EO_TYPECHECK(Eo **, wref)
 Delete the weak reference passed.
 
#define eo_wref_del_safe(wref)
 Delete the weak reference passed.
 
#define eo_constructor()   EO_BASE_ID(EO_BASE_SUB_ID_CONSTRUCTOR)
 Call the object's constructor.
 
#define eo_destructor()   EO_BASE_ID(EO_BASE_SUB_ID_DESTRUCTOR)
 Call the object's destructor.
 
#define EO_EV_CALLBACK_ADD   (&(_EO_EV_CALLBACK_ADD))
 The event description (of type Eo_Event_Description) for The "Callback listener added" event.
 
#define EO_EV_CALLBACK_DEL   (&(_EO_EV_CALLBACK_DEL))
 The event description (of type Eo_Event_Description) for The "Callback listener deleted" event.
 
#define EO_EV_DEL   (&(_EO_EV_DEL))
 Object is being deleted.
 

Typedefs

typedef void(* eo_base_data_free_func )(void *)
 Data free func prototype.
 

Enumerations

enum  {
  EO_BASE_SUB_ID_CONSTRUCTOR,
  EO_BASE_SUB_ID_DESTRUCTOR,
  EO_BASE_SUB_ID_DATA_SET,
  EO_BASE_SUB_ID_DATA_GET,
  EO_BASE_SUB_ID_DATA_DEL,
  EO_BASE_SUB_ID_WREF_ADD,
  EO_BASE_SUB_ID_WREF_DEL,
  EO_BASE_SUB_ID_EVENT_CALLBACK_PRIORITY_ADD,
  EO_BASE_SUB_ID_EVENT_CALLBACK_DEL,
  EO_BASE_SUB_ID_EVENT_CALLBACK_CALL,
  EO_BASE_SUB_ID_EVENT_CALLBACK_FORWARDER_ADD,
  EO_BASE_SUB_ID_EVENT_CALLBACK_FORWARDER_DEL,
  EO_BASE_SUB_ID_EVENT_FREEZE,
  EO_BASE_SUB_ID_EVENT_THAW,
  EO_BASE_SUB_ID_EVENT_FREEZE_GET,
  EO_BASE_SUB_ID_EVENT_GLOBAL_FREEZE,
  EO_BASE_SUB_ID_EVENT_GLOBAL_THAW,
  EO_BASE_SUB_ID_EVENT_GLOBAL_FREEZE_GET,
  EO_BASE_SUB_ID_LAST
}
 

Functions

const Eo_Classeo_base_class_get (void)
 Use EO_BASE_CLASS.
 

Variables

Eo_Op EO_BASE_BASE_ID
 EO_BASE_CLASS 's base id.
 
const Eo_Event_Description _EO_EV_CALLBACK_ADD
 see EO_EV_CALLBACK_ADD
 
const Eo_Event_Description _EO_EV_CALLBACK_DEL
 see EO_EV_CALLBACK_DEL
 
const Eo_Event_Description _EO_EV_DEL
 see EO_EV_DEL
 

Detailed Description

Macro Definition Documentation

#define EO_BASE_ID (   sub_id)    (EO_BASE_BASE_ID + (sub_id))

Helper macro to get the full Op ID out of the sub_id for EO_BASE.

Parameters
sub_idthe sub id inside EO_BASE.
#define eo_base_data_set (   key,
  data,
  free_func 
)    EO_BASE_ID(EO_BASE_SUB_ID_DATA_SET), EO_TYPECHECK(const char *, key), EO_TYPECHECK(const void *, data), EO_TYPECHECK(eo_base_data_free_func, free_func)

Set generic data to object.

Parameters
[in]keythe key associated with the data
[in]datathe data to set.
[in]free_functhe func to free data with (NULL means "do nothing").
See Also
eo_base_data_get
eo_base_data_del

Referenced by evas_object_data_set().

#define eo_base_data_get (   key,
  data 
)    EO_BASE_ID(EO_BASE_SUB_ID_DATA_GET), EO_TYPECHECK(const char *, key), EO_TYPECHECK(void **, data)

Get generic data from object.

Parameters
[in]keythe key associated with the data
[out]datathe data for the key
See Also
eo_base_data_set
eo_base_data_del

Referenced by evas_object_data_del(), and evas_object_data_get().

#define eo_base_data_del (   key)    EO_BASE_ID(EO_BASE_SUB_ID_DATA_DEL), EO_TYPECHECK(const char *, key)

Del generic data from object.

Parameters
[in]keythe key associated with the data
See Also
eo_base_data_set
eo_base_data_get

Referenced by evas_object_data_del().

#define eo_wref_add (   wref)    EO_BASE_ID(EO_BASE_SUB_ID_WREF_ADD), EO_TYPECHECK(Eo **, wref)

Add a new weak reference to obj.

Parameters
wrefThe pointer to use for the weak ref.

This function registers the object handle pointed by wref to obj so when obj is deleted it'll be updated to NULL. This functions should be used when you want to keep track of an object in a safe way, but you don't want to prevent it from being freed.

See Also
eo_wref_del
#define eo_wref_del (   wref)    EO_BASE_ID(EO_BASE_SUB_ID_WREF_DEL), EO_TYPECHECK(Eo **, wref)

Delete the weak reference passed.

Parameters
wrefthe weak reference to free.
See Also
eo_wref_add
#define eo_wref_del_safe (   wref)
Value:
do { \
if (*wref) eo_do(*wref, eo_wref_del(wref)); \
} while (0)

Delete the weak reference passed.

Parameters
wrefthe weak reference to free.

Same as eo_wref_del(), with the different that it's not called from eobj_do() so you don't need to check if *wref is not NULL.

See Also
eo_wref_del
#define eo_constructor ( )    EO_BASE_ID(EO_BASE_SUB_ID_CONSTRUCTOR)

Call the object's constructor.

Should not be used with eo_do. Only use it with eo_do_super.

See Also
eo_destructor
#define eo_destructor ( )    EO_BASE_ID(EO_BASE_SUB_ID_DESTRUCTOR)

Call the object's destructor.

Should not be used with eo_do. Only use it with eo_do_super.

See Also
eo_constructor