Download

Support

Evas Smart Object Functions

Functions dealing with evas smart objects. More...

Functions

EAPI void evas_object_smart_data_set (Evas_Object *obj, void *data)
 Store a pointer to user data for a smart object.
EAPI void * evas_object_smart_data_get (const Evas_Object *obj)
 Retrieve user data stored on a smart object.
EAPI Evas_Smartevas_object_smart_smart_get (const Evas_Object *obj)
 Get the Evas_Smart from which obj was created.
EAPI void evas_object_smart_member_add (Evas_Object *obj, Evas_Object *smart_obj)
 Set an evas object as a member of a smart object.
EAPI void evas_object_smart_member_del (Evas_Object *obj)
 Removes a member object from a smart object.
EAPI Evas_Objectevas_object_smart_parent_get (const Evas_Object *obj)
 Gets the smart parent of an Evas_Object.
EAPI Evas_Objectevas_object_smart_add (Evas *e, Evas_Smart *s)
 Instantiates a new smart object described by s.
EAPI void evas_object_smart_callback_add (Evas_Object *obj, const char *event, void(*func)(void *data, Evas_Object *obj, void *event_info), const void *data)
 Add a callback for the smart event specified by event.
EAPI void * evas_object_smart_callback_del (Evas_Object *obj, const char *event, void(*func)(void *data, Evas_Object *obj, void *event_info))
 Remove a smart callback.
EAPI void evas_object_smart_callback_call (Evas_Object *obj, const char *event, void *event_info)
 Call any smart callbacks on obj for event.

Detailed Description

Functions dealing with evas smart objects.

Smart objects are groupings of primitive evas objects that behave as a cohesive group. For instance, a file manager icon may be a smart object composed of an image object, a text label and two rectangles that appear behind the image and text when the icon is selected. As a smart object, the normal evas api could be used on the icon object.


Function Documentation

EAPI Evas_Object* evas_object_smart_add ( Evas e,
Evas_Smart s 
)

Instantiates a new smart object described by s.

Parameters:
e the evas on which to add the object
s the Evas_Smart describing the smart object
Returns:
a new Evas_Object

EAPI void evas_object_smart_callback_add ( Evas_Object obj,
const char *  event,
void(*)(void *data, Evas_Object *obj, void *event_info)  func,
const void *  data 
)

Add a callback for the smart event specified by event.

Parameters:
obj a smart object
event the event name
func the callback function
data user data to be passed to the callback function

References evas_list_prepend().

EAPI void evas_object_smart_callback_call ( Evas_Object obj,
const char *  event,
void *  event_info 
)

Call any smart callbacks on obj for event.

Parameters:
obj the smart object
event the event name
event_info an event specific struct of info to pass to the callback
This should be called internally in the smart object when some specific event has occured. The documentation for the smart object should include a list of possible events and what type of event_info to expect.

References _Evas_List::data, and _Evas_List::next.

EAPI void* evas_object_smart_callback_del ( Evas_Object obj,
const char *  event,
void(*)(void *data, Evas_Object *obj, void *event_info)  func 
)

Remove a smart callback.

Removes a callback that was added by evas_object_smart_callback_add()

Parameters:
obj a smart object
event the event name
func the callback function
Returns:
the data pointer

References _Evas_List::data, and _Evas_List::next.

EAPI void* evas_object_smart_data_get ( const Evas_Object obj  ) 

Retrieve user data stored on a smart object.

Parameters:
obj The smart object
Returns:
A pointer to data stored using evas_object_smart_data_set(), or NULL if none has been set.

EAPI void evas_object_smart_data_set ( Evas_Object obj,
void *  data 
)

Store a pointer to user data for a smart object.

Parameters:
obj The smart object
data A pointer to user data

EAPI void evas_object_smart_member_add ( Evas_Object obj,
Evas_Object smart_obj 
)

Set an evas object as a member of a smart object.

Parameters:
obj The member object
smart_obj The smart object
Members will automatically be stacked and layered with the smart object. The various stacking function will operate on members relative to the other members instead of the entire canvas.

Non-member objects can not interleave a smart object's members.

References evas_object_smart_member_del().

EAPI void evas_object_smart_member_del ( Evas_Object obj  ) 

Removes a member object from a smart object.

Parameters:
obj the member object
This removes a member object from a smart object. The object will still be on the canvas, but no longer associated with whichever smart object it was associated with.

Referenced by evas_object_smart_member_add().

EAPI Evas_Object* evas_object_smart_parent_get ( const Evas_Object obj  ) 

Gets the smart parent of an Evas_Object.

Parameters:
obj the Evas_Object you want to get the parent
Returns:
Returns the smart parent of obj, or NULL if obj is not a smart member of another Evas_Object

EAPI Evas_Smart* evas_object_smart_smart_get ( const Evas_Object obj  ) 

Get the Evas_Smart from which obj was created.

Parameters:
obj a smart object
Returns:
the Evas_Smart


Copyright © Enlightenment.org

Evas Documentation Generated: Sat May 17 14:22:22 2008