An opaque handle to an Evas canvas.

See also:

evas_new()

evas_free()

Public data for an Evas.

Get the changed marker for the canvas.

Parameters:

[in]

obj

The object.

Returns:

true if changed, false otherwise

Since (EFL) :

1.11

Since :

4.0b

Convert/scale an output screen coordinate into canvas coordinates.

This function takes in a horizontal coordinate as the x parameter and converts it into canvas units, accounting for output size, viewport size and location, returning it as the function return value. If e is invalid, the results are undefined.

Parameters:

[in]	obj	The object.
[in]	x	The screen/output x coordinate.

Returns:

The screen coordinate translated to canvas unit coordinates.

Since :

2.3

Convert/scale an output screen coordinate into canvas coordinates.

This function takes in a vertical coordinate as the y parameter and converts it into canvas units, accounting for output size, viewport size and location, returning it as the function return value. If e is invalid, the results are undefined.

Parameters:

[in]	obj	The object.
[in]	y	The screen/output y coordinate.

Returns:

The screen coordinate translated to canvas unit coordinates.

Since :

2.3

Convert/scale a canvas coordinate into output screen coordinates.

This function takes in a horizontal coordinate as the x parameter and converts it into output units, accounting for output size, viewport size and location, returning it as the function return value. If e is invalid, the results are undefined.

Parameters:

[in]	obj	The object.
[in]	x	The canvas X coordinate.

Returns:

The output/screen coordinate translated to output coordinates.

Since :

2.3

Convert/scale a canvas coordinate into output screen coordinates.

This function takes in a vertical coordinate as the x parameter and converts it into output units, accounting for output size, viewport size and location, returning it as the function return value. If e is invalid, the results are undefined.

Parameters:

[in]	obj	The object.
[in]	y	The canvas y coordinate.

Returns:

The output/screen coordinate translated to output coordinates.

Since :

2.3

Add a damage rectangle.

This is the function by which one tells evas that a part of the canvas has to be repainted.

Note:

All newly created Evas rectangles get the default color values of 255 255 255 255 (opaque white).

Parameters:

[in]	obj	The object.
[in]	x	The rectangle's left position.
[in]	y	The rectangle's top position.
[in]	w	The rectangle's width.
[in]	h	The rectangle's height.

Since :

2.3

Examples:

evas-events.c.

Returns the pointer attached by evas_data_attach_set.

Parameters:

[in]

obj

The object.

Returns:

The attached pointer.

Since :

2.3

Attaches a specific pointer to the evas for fetching later.

Parameters:

[in]	obj	The object.
[in]	data	The attached pointer.

Since :

2.3

Return the default device of a given type.

Note:

Currently EFL only creates a seat, mouse and keyboard.

Parameters:

[in]	obj	The object.
[in]	type	The class of the default device to fetch.

Returns:

The default device or null on error.

Since (EFL) :

1.19

Retrieves the current render engine info struct from the given evas.

The returned structure is publicly modifiable. The contents are valid until either evas_engine_info_set or evas_render are called.

This structure does not need to be freed by the caller.

Returns:

The pointer to the engine info to use.

Since :

2.3

Examples:

evas-buffer-simple.c.

Applies the engine settings for the given evas from the given Evas_Engine_Info structure.

To get the Evas_Engine_Info structure to use, call evas_engine_info_get. Do not try to obtain a pointer to an Evas_Engine_Info structure in any other way.

You will need to call this function at least once before you can create objects on an evas or render that evas. Some engines allow their settings to be changed more than once.

Once called, the info pointer should be considered invalid.

Parameters:

[in]

info

The pointer to the engine info to use.

Returns:

true if no error occurred, false otherwise.

Since :

2.3

Examples:

evas-buffer-simple.c.

Get the default set of flags an event begins with.

This gets the default event flags events are produced with when fed in.

Parameters:

[in]

obj

The object.

Returns:

The default flags to use.

Since (EFL) :

1.2

Since :

2.3

Set the default set of flags an event begins with.

Events in evas can have an event_flags member. This starts out with an initial value (no flags). This lets you set the default flags that an event begins with to flags.

Parameters:

[in]	obj	The object.
[in]	flags	The default flags to use.

Since (EFL) :

1.2

Since :

2.3

Get the number of mouse or multi presses currently active.

Parameters:

[in]

obj

The object.

Returns:

Mouse or multi presses currently active

Since (EFL) :

1.2

Since :

3.0

Retrieve the object focused by the default seat.

Focused objects will be the ones having key events delivered to, which the programmer can act upon by means of evas_object_event_callback_add usage.

Note:

Most users wouldn't be dealing directly with Evas' focused objects. Instead, they would be using a higher level library for that (like a toolkit, as Elementary) to handle focus and who's receiving input for them.

This call returns the object that currently has focus on the canvas e or null, if none.

See also evas_object_focus_set, evas_object_focus_get, evas_object_key_grab, evas_object_key_ungrab, evas_seat_focus_get, Efl::Canvas::Object::seat_focus_check, Efl::Canvas::Object::seat_focus_add, Efl::Canvas::Object::seat_focus_del.

Parameters:

[in]

obj

The object.

Returns:

The object that has focus or null if there is not one.

Since :

3.0

Examples:

ecore_imf_example.c, and evas-events.c.

Inform to the evas that it got the focus from the default seat.

Since :

2.3

Inform the evas that it lost the focus from the default seat.

Since :

2.3

Get the focus state for the default seat.

Parameters:

[in]

obj

The object.

Returns:

true if focused, false otherwise

Since :

2.3

List of available font descriptions known or found by this evas.

The list depends on Evas compile time configuration, such as fontconfig support, and the paths provided at runtime as explained in Font Path Functions.

Parameters:

[in]

obj

The object.

Returns:

A newly allocated list of strings. Do not change the strings. Be sure to call evas_font_available_list_free after you're done.

Since :

3.0

Force the given evas and associated engine to flush its font cache.

Since :

3.0

Get the size of font cache of the given evas in bytes.

Parameters:

[in]

obj

The object.

Returns:

The size in bytes.

Since :

3.0

Changes the size of font cache of the given evas.

Parameters:

[in]	obj	The object.
[in]	size	The size in bytes.

Since :

3.0

Checks if the font hinting is supported by the given evas.

One of #EVAS_FONT_HINTING_NONE, #EVAS_FONT_HINTING_AUTO, #EVAS_FONT_HINTING_BYTECODE.

Parameters:

[in]

hinting

The hinting to use.

Returns:

true if it is supported, false otherwise.

Since :

3.0

Appends a font path to the list of font paths used by the given evas.

Parameters:

[in]	obj	The object.
[in]	path	The new font path.

Since :

3.0

Removes all font paths loaded into memory for the given evas.

Since :

3.0

Retrieves the list of font paths used by the given evas.

Parameters:

[in]

obj

The object.

Returns:

The list of font paths used.

Since :

3.0

Prepends a font path to the list of font paths used by the given evas.

Parameters:

[in]	obj	The object.
[in]	path	The new font path.

Since :

3.0

Frees the given evas and any objects created on it.

Any objects with 'free' callbacks will have those callbacks called in this function.

Parameters:

e	The given evas.

Since :

2.3

Examples:

evas-buffer-simple.c.

Flush the image cache of the canvas.

This function flushes image cache of canvas.

Parameters:

[in]

obj

The object.

Since :

3.0

Get the image cache.

This function returns the image cache size of canvas in bytes.

Parameters:

[in]

obj

The object.

Returns:

The cache size.

Since :

3.0

Reload the image cache.

This function reloads the image cache of canvas.

Parameters:

[in]

obj

The object.

Since :

3.0

Set the image cache.

This function sets the image cache of canvas in bytes.

Parameters:

[in]	obj	The object.
[in]	size	The cache size.

Since :

3.0

Adds the keyname key to the current list of lock keys.

Locks are keys like caps lock, num lock or scroll lock, i.e., keys which are meant to be pressed once -- toggling a binary state which is bound to it -- and thus altering the behavior of all subsequently pressed keys somehow, depending on its state. Evas is so that these keys can be defined by the user.

This allows custom locks to be added to the evas system at run time. It is then possible to set and unset lock keys programmatically for other parts of the program to check and act on. Programmers using Evas would check for lock keys on key event callbacks using evas_key_lock_is_set.

Note:

If the programmer instantiates the canvas by means of the ecore_evas_new() family of helper functions, Ecore will take care of registering on it all standard lock keys: "Caps_Lock", "Num_Lock", "Scroll_Lock".

Parameters:

[in]	obj	The object.
[in]	keyname	The name of the key to add to the locks list.

Since :

2.3

Removes the keyname key from the current list of lock keys on canvas e.

Parameters:

[in]	obj	The object.
[in]	keyname	The name of the key to remove from the locks list.

Since :

2.3

Returns a handle to the list of lock keys registered in the canvas e.

This is required to check for which locks are set at a given time with the evas_key_lock_is_set function.

Returns:

An Evas_Lock handle to query Evas' keys subsystem with evas_key_lock_is_set or evas_seat_key_lock_is_set, or null on error.

Since :

2.3

Disables or turns off programmatically the lock key with name keyname for the default seat.

The effect will be as if the key was put on its inactive state after this call.

See also evas_key_lock_on, evas_seat_key_lock_on, evas_seat_key_lock_off.

Parameters:

[in]	obj	The object.
[in]	keyname	The name of the lock to disable.

Since :

2.3

Enables or turns on programmatically the lock key with name keyname for the default seat.

The effect will be as if the key was put on its active state after this call.

See also evas_key_lock_add, evas_key_lock_del, evas_key_lock_del, evas_key_lock_off, evas_seat_key_lock_on, evas_seat_key_lock_off.

Parameters:

[in]	obj	The object.
[in]	keyname	The name of the lock to enable.

Since :

2.3

Adds the keyname key to the current list of modifier keys.

Modifiers are keys like shift, alt and ctrl, i.e. keys which are meant to be pressed together with others, altering the behavior of the second keys pressed. Evas is so that these keys can be user defined.

This call allows custom modifiers to be added to the Evas system at run time. It is then possible to set and unset modifier keys programmatically for other parts of the program to check and act on. Programmers using Evas would check for modifier keys on key event callbacks using evas_key_modifier_is_set.

Note:

If the programmer instantiates the canvas by means of the ecore_evas_new family of helper functions, Ecore will take care of registering on it all standard modifiers: "Shift", "Control", "Alt", "Meta", "Hyper", "Super".

Parameters:

[in]	obj	The object.
[in]	keyname	The name of the modifier key to add to the list of Evas modifiers.

Since :

2.3

Removes the keyname key from the current list of modifier keys on canvas e.

See also evas_key_modifier_add.

Parameters:

[in]	obj	The object.
[in]	keyname	The name of the key to remove from the modifiers list.

Since :

2.3

Returns a handle to the list of modifier keys registered in the canvas e.

This is required to check for which modifiers are set at a given time with the evas_key_modifier_is_set function.

See also evas_key_modifier_add, evas_key_modifier_del, evas_key_modifier_on, evas_key_modifier_off, evas_seat_key_modifier_on, evas_seat_key_modifier_off.

Returns:

An Evas_Modifier handle to query Evas' keys subsystem with evas_key_modifier_is_set or evas_seat_key_modifier_is_set, or null on error.

Since :

2.3

Examples:

edje-box2.c, evas-aspect-hints.c, evas-box.c, evas-events.c, evas-hints.c, and web_example_02.c.

Creates a bit mask from the keyname modifier key. Values returned from different calls to it may be ORed together, naturally.

This function is meant to be using in conjunction with evas_object_key_grab/@ref evas_object_key_ungrab. Go check their documentation for more information.

See also evas_key_modifier_add, evas_key_modifier_get, evas_key_modifier_on, evas_key_modifier_off, evas_seat_key_modifier_on, evas_seat_key_modifier_off, evas_key_modifier_is_set, evas_seat_key_modifier_is_set..

Parameters:

[in]

keyname

The name of the modifier key to create the mask for.

Returns:

The bit mask or 0 if the keyname key wasn't registered as a modifier for canvas e.

Since :

2.3

Examples:

evas-events.c, and web_example_02.c.

Disables or turns off programmatically the modifier key with name keyname for the default seat.

See also evas_key_modifier_add, evas_key_modifier_get, evas_key_modifier_on, evas_seat_key_modifier_off, evas_seat_key_modifier_off, evas_key_modifier_is_set, evas_seat_key_modifier_is_set.

Parameters:

[in]	obj	The object.
[in]	keyname	The name of the modifier to disable.

Since :

2.3

Enables or turns on programmatically the modifier key with name keyname for the default seat.

The effect will be as if the key was pressed for the whole time between this call and a matching evas_key_modifier_off().

See also evas_key_modifier_off, evas_seat_key_modifier_on, evas_seat_key_modifier_off.

Parameters:

[in]	obj	The object.
[in]	keyname	The name of the modifier to enable.

Since :

2.3

Creates a new empty evas.

Note that before you can use the evas, you will to at a minimum:

• Set its render method with evas_output_method_set .
• Set its viewport size with evas_output_viewport_set .
• Set its size of the canvas with evas_output_size_set .
• Ensure that the render engine is given the correct settings with evas_engine_info_set .

This function should only fail if the memory allocation fails

Note:

this function is very low level. Instead of using it directly, consider using the high level functions in Ecore_Evas wrapper/helper set of functions such as ecore_evas_new(). See Ecore.

Attention:

it is recommended that one calls evas_init() before creating new canvas.

Returns:

A new uninitialised Evas canvas on success. Otherwise, NULL.

Since :

2.3

Examples:

evas-buffer-simple.c.

Pop the nochange flag down 1.

This tells evas, that while the nochange flag is greater than 0, do not mark objects as "changed" when making changes.

Warning:

Do not use this function unless you know what Evas exactly works with "changed" state.

Parameters:

[in]

obj

The object.

Since :

2.3

Push the nochange flag up 1.

This tells evas, that while the nochange flag is greater than 0, do not mark objects as "changed" when making changes.

Warning:

Do not use this function unless you know what Evas exactly works with "changed" state.

Parameters:

[in]

obj

The object.

Since :

2.3

Update the canvas internal objects but not triggering immediate renderization.

This function updates the canvas internal objects not triggering renderization. To force renderization function evas_render should be used.

Parameters:

[in]

obj

The object.

Since :

2.3

Get the lowest (stacked) Evas object on the canvas e.

This function will take all populated layers in the canvas into account, getting the lowest object for the lowest layer, naturally.

Warning:

This function will skip objects parented by smart objects, acting only on the ones at the "top level", with regard to object parenting.

See also evas_object_layer_get, evas_object_layer_set, evas_object_below_get, evas_object_below_set.

Parameters:

[in]

obj

The object.

Returns:

A pointer to the lowest object on it, if any, or null otherwise.

Since :

3.0

Retrieves the object on the given evas with the given name.

This looks for the evas object given a name by evas_object_name_set. If the name is not unique canvas-wide, then which one of the many objects with that name is returned is undefined, so only use this if you can ensure the object name is unique.

Parameters:

[in]	obj	The object.
[in]	name	The given name.

Returns:

If successful, the Evas object with the given name. Otherwise, null.

Since :

3.0

Examples:

evas-map-utils.c.

Instantiates a new smart object described by s.

Parameters:

e	the canvas on which to add the object
s	the #Evas_Smart describing the smart object

Returns:

a new Evas_Object handle

This is the function one should use when defining the public function adding an instance of the new smart object to a given canvas. It will take care of setting all of its internals to work as they should, if the user set things properly, as seem on the EVAS_SMART_SUBCLASS_NEW, for example.

Since :

2.3

Examples:

evas-smart-interface.c, and evas-smart-object.c.

Call the calculate() smart function immediately on a given smart object.

This will force immediate calculations (see Evas_Smart_Class) needed for renderization of this object and, besides, unset the flag on it telling it needs recalculation for the next rendering phase.

See also evas_object_smart_need_recalculate_set

Since :

3.0

Add (register) a callback function to the smart event specified by event on the smart object obj.

Parameters:

obj	a smart object
event	the event's name string
func	the callback function
data	user data to be passed to the callback function

Smart callbacks look very similar to Evas callbacks, but are implemented as smart object's custom ones.

This function adds a function callback to an smart object when the event named event occurs in it. The function is func.

In the event of a memory allocation error during addition of the callback to the object, evas_alloc_error() should be used to determine the nature of the error, if any, and the program should sensibly try and recover.

A smart callback function must have the ::Evas_Smart_Cb prototype definition. The first parameter (data) in this definition will have the same value passed to evas_object_smart_callback_add() as the data parameter, at runtime. The second parameter obj is a handle to the object on which the event occurred. The third parameter, event_info, is a pointer to data which is totally dependent on the smart object's implementation and semantic for the given event.

There is an infrastructure for introspection on smart objects' events (see evas_smart_callbacks_descriptions_get()), but no internal smart objects on Evas implement them yet.

See also:

Smart events and callbacks for more details.

evas_object_smart_callback_del()

Since :

2.3

Examples:

actionslider_example_01.c, bg_example_03.c, box_example_02.c, bubble_example_01.c, button_example_00.c, button_example_01.c, calendar_example_05.c, calendar_example_06.c, check_example_01.c, codegen_example.c, colorselector_example_01.c, combobox_example_01.c, ctxpopup_example_01.c, dayselector_example.c, diskselector_example_02.c, efl_thread_1.c, efl_thread_2.c, efl_thread_3.c, efl_thread_4.c, efl_thread_5.c, entry_example.c, evas-smart-interface.c, evas-smart-object.c, fileselector_button_example.c, fileselector_entry_example.c, fileselector_example.c, flip_example_01.c, flipselector_example.c, general_funcs_example.c, gengrid_example.c, genlist_example_02.c, genlist_example_04.c, genlist_example_05.c, glview_example_01.c, hover_example_01.c, hoversel_example_01.c, index_example_01.c, index_example_02.c, inwin_example.c, layout_example_01.c, layout_example_03.c, list_example_03.c, map_example_01.c, map_example_02.c, map_example_03.c, mapbuf_example.c, menu_example_01.c, naviframe_example.c, notify_example_01.c, panes_example.c, photocam_example_01.c, popup_example_01.c, popup_example_02.c, popup_example_03.c, prefs_example_01.c, prefs_example_02.c, prefs_example_03.c, progressbar_example.c, radio_example_01.c, slider_example.c, slideshow_example.c, spinner_example.c, theme_example_01.c, theme_example_02.c, thumb_example_01.c, transit_example_03.c, transit_example_04.c, web_example_02.c, and win_example.c.

Call a given smart callback on the smart object obj.

Parameters:

obj	the smart object
event	the event's name string
event_info	pointer to an event specific struct or information to pass to the callback functions registered on this smart event

This should be called internally, from the smart object's own code, when some specific event has occurred and the implementor wants is to pertain to the object's events API (see Smart events and callbacks). The documentation for the smart object should include a list of possible events and what type of event_info to expect for each of them. Also, when defining an Evas_Smart_Class, smart object implementors are strongly encouraged to properly set the Evas_Smart_Class::callbacks callbacks description array, so that the users of the smart object can have introspection on its events API at run time.

Since :

2.3

Examples:

evas-smart-interface.c, and evas-smart-object.c.

Delete (unregister) a callback function from the smart event specified by event on the smart object obj.

Parameters:

obj	a smart object
event	the event's name string
func	the callback function

Returns:

the data pointer

This function removes the first added smart callback on the object obj matching the event name event and the registered function pointer func. If the removal is successful it will also return the data pointer that was passed to evas_object_smart_callback_add() (that will be the same as the parameter) when the callback(s) was(were) added to the canvas. If not successful NULL will be returned.

See also:

evas_object_smart_callback_add() for more details.

Since :

2.3

Delete (unregister) a callback function from the smart event specified by event on the smart object obj.

Parameters:

obj	a smart object
event	the event's name string
func	the callback function
data	the data pointer that was passed to the callback

Returns:

the data pointer

This function removes the first added smart callback on the object obj matching the event name event, the registered function pointer func and the callback data pointer data. If the removal is successful it will also return the data pointer that was passed to evas_object_smart_callback_add() (that will be the same as the parameter) when the callback(s) was(were) added to the canvas. If not successful NULL will be returned. A common use would be to remove an exact match of a callback

See also:

evas_object_smart_callback_add() for more details.

Since (EFL) :

1.2

Note:

To delete all smart event callbacks which match type and func, use evas_object_smart_callback_del().

Since :

2.3

Find callback description for callback called name or null if not found.

If parameter is null, no search will be done on instance descriptions.

Parameters:

[in]	name	name of desired callback, must not be null. The search have a special case for name being the same pointer as registered with Evas_Smart_Cb_Description, one can use it to avoid excessive use of strcmp().
[out]	class_description	pointer to return class description or null if not found. If parameter is null, no search will be done on class descriptions.
[out]	instance_description	pointer to return instance description.

Since :

3.0

Add (register) a callback function to the smart event specified by event on the smart object obj. Except for the priority field, it's exactly the same as evas_object_smart_callback_add

Parameters:

obj	a smart object
event	the event's name string
priority	The priority of the callback, lower values called first.
func	the callback function
data	user data to be passed to the callback function

See also:

evas_object_smart_callback_add

Since (EFL) :

1.1

Since :

3.0

Retrieve an smart object's know smart callback descriptions (both instance and class ones).

This call searches for registered callback descriptions for both instance and class of the given smart object. These arrays will be sorted by Evas_Smart_Cb_Description.name and also null terminated, so both class_count and instance_count can be ignored, if the caller wishes so. The terminator null is not counted in these values.

Note:

If just class descriptions are of interest, try evas_smart_callbacks_descriptions_get() instead.

Use null pointers on the descriptions/counters you're not interested in: they'll be ignored by the function.

evas_smart_callbacks_descriptions_get().

Parameters:

[out]	class_descriptions	Where to store class callbacks descriptions array, if any is known. If no descriptions are known, null is returned.
[out]	class_count	Returns how many class callbacks descriptions are known.
[out]	instance_descriptions	Where to store instance callbacks descriptions array, if any is known. If no descriptions are known, null is returned.
[out]	instance_count	Returns how many instance callbacks descriptions are known.

Since :

2.3

Examples:

evas-smart-interface.c, and evas-smart-object.c.

Set an smart object instance's smart callbacks descriptions.

These descriptions are hints to be used by introspection and are not enforced in any way.

It will not be checked if instance callbacks descriptions have the same name as respective possibly registered in the smart object class. Both are kept in different arrays and users of evas_object_smart_callbacks_descriptions_get() should handle this case as they wish.

Note:

Because descriptions must be null terminated, and because a null name makes little sense, too, Evas_Smart_Cb_Description.name must not be null.

While instance callbacks descriptions are possible, they are not recommended. Use class callbacks descriptions instead as they make you smart object user's life simpler and will use less memory, as descriptions and arrays will be shared among all instances.

Parameters:

[in]

descriptions

null terminated array with Evas_Smart_Cb_Description descriptions. Array elements won't be modified at run time, but references to them and their contents will be made, so this array should be kept alive during the whole object's lifetime.

Returns:

true on success, false on failure.

Since :

2.3

Mark smart object as changed, dirty.

This will flag the given object as needing recalculation, forcefully. As an effect, on the next rendering cycle its calculate() (see Evas_Smart_Class) smart function will be called.

See also evas_object_smart_need_recalculate_set and evas_object_smart_calculate.

Since :

2.3

Examples:

evas-aspect-hints.c, evas-smart-interface.c, and evas-smart-object.c.

Get the clipper object for the given clipped smart object.

Use this function if you want to change any of this clipper's properties, like colors.

Since :

3.0

Examples:

evas-smart-interface.c, and evas-smart-object.c.

Since :

2.3

Store a pointer to user data for a given smart object.

This data is stored independently of the one set by evas_object_data_set(), naturally.

See also evas_object_smart_data_get.

Parameters:

[in]

data

A pointer to user data.

Since :

2.3

Retrieve an Evas smart object interface's private data.

Parameters:

obj	An Evas smart object.
iface	The given object's interface handle.

Since (EFL) :

1.7

Returns:

The object interface's private data blob pointer, if found, NULL otherwise.

Since :

3.0

Examples:

evas-smart-interface.c.

Retrieve an Evas smart object's interface, by name string pointer.

Parameters:

obj	An Evas smart object.
name	Name string of the desired interface, which must be the same pointer used at the interface's declarion, when creating the smart object obj.

Since (EFL) :

1.7

Returns:

The interface's handle pointer, if found, NULL otherwise.

Since :

3.0

Examples:

evas-smart-interface.c.

Retrieves an iterator of the member objects of a given Evas smart object.

See also Efl::Canvas::Group::group_member_add and Efl::Canvas::Group::group_member_del

Returns:

Returns the iterator of the member objects of obj.

Since (EFL) :

1.8

Since :

3.0

Set an Evas object as a member of a given smart object.

Parameters:

obj	The member object
smart_obj	The smart object

Members will automatically be stacked and layered together with the smart object. The various stacking functions will operate on members relative to the other members instead of the entire canvas, since they now live on an exclusive layer (see evas_object_stack_above(), for more details).

Any smart_obj object's specific implementation of the member_add() smart function will take place too, naturally.

See also:

evas_object_smart_member_del()

evas_object_smart_members_get()

Since :

2.3

Examples:

evas-smart-interface.c, and evas-smart-object.c.

Removes a member object from a given smart object.

Parameters:

obj	the member object

This removes a member object from a smart object, if it was added to any. The object will still be on the canvas, but no longer associated with whichever smart object it was associated with.

See also:

evas_object_smart_member_add() for more details

evas_object_smart_members_get()

Since :

2.3

Examples:

evas-smart-interface.c, and evas-smart-object.c.

Retrieves the list of the member objects of a given Evas smart object.

The returned list should be freed with eina_list_free() when you no longer need it.

This function will return null when a non-smart object is passed.

See also Efl::Canvas::Group::group_member_add, Efl::Canvas::Group::group_member_del and evas_object_smart_iterator_new.

Returns:

Returns the list of the member objects of obj.

Since (EFL) :

1.7

Since :

2.3

Moves all children objects of a given smart object relative to a given offset.

This will make each of obj object's children to move, from where they before, with those delta values (offsets) on both directions.

Note:

This is most useful on custom smart move functions.

Clipped smart objects already make use of this function on their move smart function definition.

Parameters:

[in]	dx	Horizontal offset (delta).
[in]	dy	Vertical offset (delta).

Since :

3.0

Get the value of the flag signalling that a given smart object needs to get recalculated.

Note:

this flag will be unset during the rendering phase, when the calculate() smart function is called, if one is provided. If it's not provided, then the flag will be left unchanged after the rendering phase.

See also evas_object_smart_need_recalculate_set, for more details.

Returns:

whether one wants to set ($true) or to unset ($false) the flag.

Since :

3.0

Set or unset the flag signalling that a given smart object needs to get recalculated.

If this flag is set, then the calculate() smart function of obj will be called, if one is provided, during rendering phase of Evas (see evas_render()), after which this flag will be automatically unset.

If that smart function is not provided for the given object, this flag will be left unchanged.

Note:

just setting this flag will not make the canvas' whole scene dirty, by itself, and evas_render() will have no effect. To force that, use evas_object_smart_changed(), that will also call this function automatically, with true as parameter.

See also evas_object_smart_need_recalculate_get, evas_object_smart_calculate and evas_smart_objects_calculate().

Parameters:

[in]

value

whether one wants to set ($true) or to unset ($false) the flag.

Since :

3.0

Get the Evas_Smart from which obj smart object was created.

Returns:

the Evas_Smart handle or null, on errors.

Since :

3.0

Checks whether a given smart object or any of its smart object parents is of a given smart class.

If obj is not a smart object, this call will fail immediately.

This function supports Eo and legacy inheritance mechanisms. However, it is recommended to use efl_isa instead if your object is using Eo from top to bottom.

The checks use smart classes names and string comparison. There is a version of this same check using pointer comparison, since a smart class' name is a single string in Evas.

See also evas_object_smart_type_check_ptr.

Parameters:

[in]

type

The name (type) of the smart class to check for.

Since :

2.3

Examples:

evas-smart-interface.c, and evas-smart-object.c.

Checks whether a given smart object or any of its smart object parents is of a given smart class, using pointer comparison.

Parameters:

[in]

type

The type (name string) to check for. Must be the name.

Returns:

true if obj or any of its parents is of type type, false otherwise.

Since :

3.0

Get the highest (stacked) Evas object on the canvas e.

This function will take all populated layers in the canvas into account, getting the highest object for the highest layer, naturally.

Warning:

This function will skip objects parented by smart objects, acting only on the ones at the "top level", with regard to object parenting.

See also evas_object_layer_get, evas_object_layer_set, evas_object_below_get, evas_object_above_get.

Parameters:

[in]

obj

The object.

Returns:

A pointer to the highest object on it (if any) or null otherwise.

Since :

3.0

Examples:

evas-stacking.c.

Retrieve the Evas object stacked at the top of a given rectangular region in a canvas.

This function will traverse all the layers of the given canvas, from top to bottom, querying for objects with areas overlapping with the given rectangular region inside e. The user can remove from the query objects which are hidden and/or which are set to pass events.

Warning:

This function will skip objects parented by smart objects, acting only on the ones at the "top level", with regard to object parenting.

Parameters:

[in]	obj	The object.
[in]	x	The top left corner's horizontal coordinate for the rectangular region.
[in]	y	The top left corner's vertical coordinate for the rectangular region.
[in]	w	The width of the rectangular region.
[in]	h	The height of the rectangular region.
[in]	include_pass_events_objects	Boolean flag to include or not objects which pass events in this calculation.
[in]	include_hidden_objects	Boolean flag to include or not hidden objects in this calculation.

Returns:

The Evas object that is over all other objects at the given rectangular region.

Since :

3.0

Remove all "obscured regions" from an Evas canvas.

This function removes all the rectangles from the obscured regions list of the canvas e. It takes obscured areas added with evas_obscured_rectangle_add and make them again a regions that have to be repainted on rendering updates.

Note:

This is a very low level function, which most of Evas' users wouldn't care about.

This function does not flag the canvas as having its state changed. If you want to re-render it afterwards expecting new contents, you have to add "damage" regions yourself (see evas_damage_rectangle_add).

Parameters:

[in]

obj

The object.

Since :

2.3

Examples:

evas-events.c.

Add an "obscured region" to an Evas canvas.

This is the function by which one tells an Evas canvas that a part of it must not be repainted. The region must be rectangular and its coordinates inside the canvas viewport are passed in the call. After this call, the region specified won't participate in any form in Evas' calculations and actions during its rendering updates, having its displaying content frozen as it was just after this function took place.

We call it "obscured region" because the most common use case for this rendering (partial) freeze is something else (most probably other canvas) being on top of the specified rectangular region, thus shading it completely from the user's final scene in a display. To avoid unnecessary processing, one should indicate to the obscured canvas not to bother about the non-important area.

The majority of users won't have to worry about this function, as they'll be using just one canvas in their applications, with nothing inset or on top of it in any form.

To make this region one that has to be repainted again, call the function evas_obscured_clear.

Note:

This is a very low level function, which most of Evas' users wouldn't care about.

This function does not flag the canvas as having its state changed. If you want to re-render it afterwards expecting new contents, you have to add "damage" regions yourself (see evas_damage_rectangle_add).

Parameters:

[in]	obj	The object.
[in]	x	The rectangle's top left corner's horizontal coordinate.
[in]	y	The rectangle's top left corner's vertical coordinate.
[in]	w	The rectangle's width.
[in]	h	The rectangle's height.

Since :

2.3

Examples:

evas-events.c.

Get the render engine's output framespace coordinates in canvas units.

Parameters:

[out]	x	The left coordinate in output units, usually pixels.
[out]	y	The top coordinate in output units, usually pixels.
[out]	w	The width in output units, usually pixels.
[out]	h	The height in output units, usually pixels.

Since (EFL) :

1.1

Since :

2.3

Sets the output framespace size of the render engine of the given evas.

The framespace size is used in the Wayland engines to denote space in the viewport which is occupied by the window frame. This is mainly used in ecore_evas to draw borders.

The units used for w and h depend on the engine used by the evas.

Parameters:

[in]	x	The left coordinate in output units, usually pixels.
[in]	y	The top coordinate in output units, usually pixels.
[in]	w	The width in output units, usually pixels.
[in]	h	The height in output units, usually pixels.

Since (EFL) :

1.1

Since :

2.3

Retrieves the number of the output engine used for the given evas.

Returns:

The numeric engine value to use.

Since :

2.3

Sets the output engine for the given evas.

Once the output engine for an evas is set, any attempt to change it will be ignored. The value for render_method can be found using evas_render_method_lookup.

Note:

it is mandatory that one calls evas_init before setting the output method.

Parameters:

[in]

render_method

The numeric engine value to use.

Since :

2.3

Examples:

evas-buffer-simple.c.

Retrieve the output size of the render engine of the given evas.

The output size is given in whatever the output units are for the engine.

If either w or h is null, then it is ignored. If e is invalid, the returned results are undefined.

Parameters:

[out]	w	The width in output units, usually pixels.
[out]	h	The height in output units, usually pixels.

Since :

2.3

Examples:

ecore_evas_buffer_example_01.c, evas-buffer-simple.c, and evas-map-utils.c.

Sets the output size of the render engine of the given evas.

The evas will render to a rectangle of the given size once this function is called. The output size is independent of the viewport size. The viewport will be stretched to fill the given rectangle.

The units used for w and h depend on the engine used by the evas.

Parameters:

[in]	w	The width in output units, usually pixels.
[in]	h	The height in output units, usually pixels.

Since :

2.3

Examples:

evas-buffer-simple.c.

Gets the viewport region of the canvas that the output display.

Parameters:

[in]	obj	The object
[out]	x
[out]	y
[out]	w
[out]	h

Since :

3.0

Deprecated:

evas_output_view_get

Get the render engine's output viewport coordinates in canvas units.

Calling this function writes the current canvas output viewport size and location values into the variables pointed to by x, y, w and h. On success the variables have the output location and size values written to them in canvas units. Any of x, y, w or h that are null will not be written to. If e is invalid, the results are undefined.

Parameters:

[out]	x	The top-left corner x value of the viewport.
[out]	y	The top-left corner y value of the viewport.
[out]	w	The width of the viewport. Must be greater than 0.
[out]	h	The height of the viewport. Must be greater than 0.

Since :

2.3

Examples:

evas-events.c.

Sets the output viewport of the given evas in evas units.

The output viewport is the area of the evas that will be visible to the viewer. The viewport will be stretched to fit the output target of the evas when rendering is performed.

Note:

The coordinate values do not have to map 1-to-1 with the output target. However, it is generally advised that it is done for ease of use.

Parameters:

[in]	x	The top-left corner x value of the viewport.
[in]	y	The top-left corner y value of the viewport.
[in]	w	The width of the viewport. Must be greater than 0.
[in]	h	The height of the viewport. Must be greater than 0.

Since :

2.3

Examples:

evas-buffer-simple.c.

Returns a bitmask with the mouse buttons currently pressed, set to 1.

Parameters:

[in]	obj	The object.
[in]	dev	The mouse device.

Returns:

A bitmask of the currently depressed buttons on the canvas.

Returns a bitmask with the default mouse buttons currently pressed, set to 1.

Calling this function will return a 32-bit integer with the appropriate bits set to 1, which correspond to a mouse button being depressed. This limits Evas to a mouse devices with a maximum of 32 buttons, but that is generally in excess of any host system's pointing device abilities.

A canvas by default begins with no mouse buttons being pressed and only pointer move events can alter that.

The least significant bit corresponds to the first mouse button (button 1) and the most significant bit corresponds to the last mouse button (button 32).

If e is not a valid canvas, the return value is undefined.

Parameters:

[in]

obj

The object.

Returns:

A bitmask of the currently depressed buttons on the canvas.

Since :

2.3

This function returns the current known default pointer coordinates.

Parameters:

[in]	obj	The object.
[in]	dev	The pointer device.
[out]	x	The pointer to a Evas_Coord to be filled in.
[out]	y	The pointer to a Evas_Coord to be filled in.

Since (EFL) :

1.19

This function returns the current known default pointer coordinates.

This function returns the current known canvas unit coordinates of the mouse pointer and sets the contents of the Evas_Coords pointed to by x and y to contain these coordinates. If e is not a valid canvas the results of this function are undefined.

Parameters:

[in]	obj	The object.
[out]	x	The pointer to a Evas_Coord to be filled in.
[out]	y	The pointer to a Evas_Coord to be filled in.

Since :

2.3

Examples:

ctxpopup_example_01.c, and evas-map-utils.c.

Returns whether the mouse pointer is logically inside the canvas.

Parameters:

[in]	obj	The object.
[in]	dev	The pointer device.

Returns:

true if the pointer is inside, false otherwise.

Since (EFL) :

1.19

Returns whether the default mouse pointer is logically inside the canvas.

When this function is called it will return a value of either false or true, depending on if event_feed_mouse_in or event_feed_mouse_out have been called to feed in a mouse enter event into the canvas.

A return value of true indicates the mouse is logically inside the canvas, and false implies it is logically outside the canvas.

A canvas begins with the mouse being assumed outside ($false).

If e is not a valid canvas, the return value is undefined.

Parameters:

[in]

obj

The object.

Returns:

true if the mouse pointer is inside the canvas, false otherwise

Since :

2.3

This function returns the current known pointer coordinates.

Parameters:

[in]	obj	The object.
[in]	dev	The mouse device.
[out]	x	The pointer to an integer to be filled in.
[out]	y	The pointer to an integer to be filled in.

Since (EFL) :

1.19

This function returns the current known default pointer coordinates.

This function returns the current known screen/output coordinates of the mouse pointer and sets the contents of the integers pointed to by x and y to contain these coordinates. If e is not a valid canvas the results of this function are undefined.

Parameters:

[in]	obj	The object.
[out]	x	The pointer to an integer to be filled in.
[out]	y	The pointer to an integer to be filled in.

Since :

2.3

Force renderization of the given canvas.

Since :

2.3

Render the given Evas canvas asynchronously.

This function only returns true when a frame will be rendered. If the previous frame is still rendering, false will be returned so the users know not to wait for the updates callback and just return to their main loop.

If a func callback is given, a list of updated areas will be generated and the function will be called from the main thread after the rendered frame is flushed to the screen. The resulting list should be freed with evas_render_updates_free.

The list is given in the event_info parameter of the callback function.

Parameters:

[in]

obj

The object.

Returns:

true if the canvas will render, false otherwise.

Since (EFL) :

1.8

Make the canvas discard as much data as possible used by the engine at runtime.

This function will unload images, delete textures and much more where possible. You may also want to call evas_render_idle_flush immediately prior to this to perhaps discard a little more, though this function should implicitly delete most of what evas_render_idle_flush might discard too.

Parameters:

[in]

obj

The object.

Since :

2.3

Make the canvas discard internally cached data used for rendering.

This function flushes the arrays of delete, active and render objects. Other things it may also discard are: shared memory segments, temporary scratch buffers, cached data to avoid re-compute of that data etc.

Parameters:

[in]

obj

The object.

Since :

2.3

Force immediate renderization of the given Evas canvas.

This function forces an immediate renderization update of the given canvas e.

Note:

This is a very low level function, which most of Evas' users wouldn't care about. You might use it, for instance, to grab an Evas' canvas update regions and paint them back, using the canvas' pixmap, on a displaying system working below Evas.

Evas is a stateful canvas. If no operations changing its state took place since the last rendering action, you won't see any changes and this call will be a no-op.

Parameters:

[in]

obj

The object.

Returns:

A newly allocated list of updated rectangles of the canvas ($Eina.Rect structs). Free this list with evas_render_updates_free.

Since :

2.3

Examples:

evas-buffer-simple.c, and evas-events.c.

Free the rectangles returned by evas_render_updates().

Parameters:

updates

The list of updated rectangles of the canvas.

This function removes the region from the render updates list. It makes the region doesn't be render updated anymore.

See also:

evas_render_updates() for an example

Since :

2.3

Examples:

evas-buffer-simple.c, and evas-events.c.

Return the focused object by a given seat.

Parameters:

[in]	obj	The object.
[in]	seat	The seat to fetch the focused object or null for the default seat.

Returns:

The object that has the focus or null if the seat has no focused object.

Since (EFL) :

1.19

Get the focus state by a given seat.

Parameters:

[in]	obj	The object.
[in]	seat	The seat to check the focus state. Use null for the default seat.

Returns:

true if the seat has the canvas focus, false otherwise.

Disables or turns off programmatically the lock key with name keyname for a given seat.

The effect will be as if the key was put on its inactive state after this call.

See also evas_key_lock_on, evas_seat_key_lock_on, evas_key_lock_off.

Parameters:

[in]	obj	The object.
[in]	keyname	The name of the lock to enable.
[in]	seat	The seat to disable the keylock. A null seat repesents the default seat.

Since (EFL) :

1.19

Enables or turns on programmatically the lock key with name keyname for a give seat.

The effect will be as if the key was put on its active state after this call.

See also evas_key_lock_add, evas_key_lock_del, evas_key_lock_del, evas_key_lock_off, evas_key_lock_on, evas_seat_key_lock_off.

Parameters:

[in]	obj	The object.
[in]	keyname	The name of the lock to enable.
[in]	seat	The seat to enable the keylock. A null seat repesents the default seat.

Since (EFL) :

1.19

Disables or turns off programmatically the modifier key with name keyname for a given seat.

See also evas_key_modifier_add, evas_key_modifier_get, evas_key_modifier_on, evas_seat_key_modifier_off, evas_seat_key_modifier_off, evas_key_modifier_is_set, evas_seat_key_modifier_is_set.

Parameters:

[in]	obj	The object.
[in]	keyname	The name of the lock to enable.
[in]	seat	The seat to disable the modifier. A null seat repesents the default seat.

Since (EFL) :

1.19

Enables or turns on programmatically the modifier key with name keyname for a given seat.

The effect will be as if the key was pressed for the whole time between this call and a matching evas_seat_key_modifier_off.

See also evas_key_modifier_off, evas_seat_key_modifier_on, evas_seat_key_modifier_off.

Parameters:

[in]	obj	The object.
[in]	keyname	The name of the lock to enable.
[in]	seat	The seat to enable the modifier. A null seat repesents the default seat.

Since (EFL) :

1.19

Call user-provided calculate smart functions and unset the flag signalling that the object needs to get recalculated to all smart objects in the canvas.

Since :

2.3

Examples:

map_example_01.c, map_example_02.c, and map_example_03.c.

This gets the internal counter that counts the number of smart calculations.

Whenever evas performs smart object calculations on the whole canvas it increments a counter by 1. This function returns the value of the smart object calculate counter. It starts with a value of 0 and will increase (and eventually wrap around to negative values and so on) by 1 every time objects are calculated. You can use this counter to ensure you don't re-do calculations withint the same calculation generation/run if the calculations maybe cause self-feeding effects.

Parameters:

[in]

obj

The object.

Returns:

Number of smart calculations

Since (EFL) :

1.1

Since :

2.3

Get if the canvas is currently calculating smart objects.

Parameters:

[in]

obj

The object.

Returns:

true if currently calculating smart objects.

Sync evas canvas

Since :

3.0

Retrieve a list of Evas objects lying over a given position in a canvas.

This function will traverse all the layers of the given canvas, from top to bottom, querying for objects with areas covering the given position. It will enter the smart objects. It will not append to the list pass events as hidden objects. Call eina_list_free on the returned list after usage.

Parameters:

[in]	obj	The object.
[in]	stop	An Evas Object where to stop searching.
[in]	x	The horizontal coordinate of the position.
[in]	y	The vertical coordinate of the position.

Returns:

List of objects

Since :

3.0