Add a new device type

Parameters:

e	The canvas to create the device node for.

Adds a new device node to the given canvas e. All devices created as part of the canvas e will automatically be deleted when the canvas is freed.

Returns:

the device node created or NULL if an error occurred.

See also:

evas_device_del

evas_device_add_full

Since (EFL) :

1.8

Since :

3.0

Add a new device type

Parameters:

e	The canvas to create the device node for.
name	The name of the device.
desc	The description of the device.
parent_dev	The parent device.
emulation_dev	The source device.
clas	The device class.
sub_class	The device subclass.

Adds a new device node to the given canvas e. All devices created as part of the canvas e will automatically be deleted when the canvas is freed.

Returns:

the device node created or NULL if an error occurred.

See also:

evas_device_del

Since (EFL) :

1.19

Get the major class of a device

Parameters:

dev	The devise to query

Returns:

The device class to set

This gets the device class set by evas_device_class_set().

Since (EFL) :

1.8

Since :

3.0

Set the major class of device

Parameters:

dev	The device whose class to set
clas	The class to set it to

This sets the "primary" class of device (a broad thing like mouse, keyboard, touch, pen etc.).

Deprecated:

The class of a device can not be changed after creation.

Since (EFL) :

1.8

Since :

3.0

Delete a new device type

Parameters:

dev	The device node you want to delete.

See also:

evas_device_add

evas_device_push

evas_device_pop

Since (EFL) :

1.8

Since :

3.0

Get the description of a device

dev The device to query

Returns:

The device description string or NULL if none is set

This gets the description set by evas_device_description_set(). This is a readable UTF8 C string, or NULL if no description is set.

A description is meant to be a longer string describing the device so a human may make sense of it. For example "Wireless 6 button mouse in Black with red buttons" would be a good description, so a user may identify precisely which device is being talked about.

Since (EFL) :

1.8

Since :

3.0

Set the description of a device as a string

dev The device to set the description of name The description string as a readable C UTF8 string

Since (EFL) :

1.8

Since :

3.0

Get the emulation source device

Parameters:

dev	The device to query

Returns:

The source emulation device set by evas_device_emulation_source_set().

Since (EFL) :

1.8

Since :

3.0

Set the emulation source device

Parameters:

dev	The device being emulated
src	The primary source device producing events in the emulated device

Devices may not be real, but may be emulated by listening to input on other devices and modifying or interpeting it to generate output on an emulated device (example a finger on a touchscreen will often emulate a mouse when it presses). This allows you to set which device primarily emulates dev so the user can choose to ignore events from emulated devices if they also pay attention to source device events for example.

Since (EFL) :

1.8

Since :

3.0

Get a device by its name

Parameters:

e	The canvas to find the device on
name	The name of the device.

Gets the first ocurrence of a device named as name on Evas e list of devices.

Returns:

the device or NULL if an error occurred, no name was provided, or no device with a matching name was found.

Since (EFL) :

1.19

Get a device by its seat id

Parameters:

e	The canvas to find the device on
id	The seat id of the device.

Gets the device with id id on Evas e list of devices.

Returns:

the device or NULL if no device with a matching id was found.

Since (EFL) :

1.20

List all current devices attached to the given canvas and/or device

Parameters:

e	The canvas to query for a device list
dev	A specific device inside the canvas to query for child devices or NULL if just querying the base canvas devices

Returns:

An internal list of Evas_Device pointers, or NULL if no devices are found

This will list all devices belonging to a specific evas canvas e, at the top-level in the device tree if dev passed in is NULL. If dev is a valid device for the given canvas e, then a list of child devices of dev will be returned, allowing you to walk the device tree.

The list returned is only valid so long as no changes are made to the device tree in the given canvas e. If there are no devices or children then NULL is returned.

See also:

evas_device_parent_get

evas_device_name_get

evas_device_description_get

evas_device_class_get

evas_device_subclass_get

evas_device_emulation_source_get

Since (EFL) :

1.8

Since :

3.0

Get the name of a device

dev The device to query

Returns:

The device name string or NULL if none is set

This gets the name set by evas_device_name_set(). This is a readable UTF8 C string, or NULL if no name is set.

The name should be a short name like "Wireless Mouse", "Joystick", "Finger", "Keyboard" or "Numberpad" etc.

Since (EFL) :

1.8

Since :

3.0

Set the name of a device as a string

dev The device to set the name of name The name string as a readable C UTF8 string

Since (EFL) :

1.8

Since :

3.0

Get the parent of a device

Parameters:

dev	The device to query

Returns:

The parent device or NULL if it is a toplevel

This returns the parent device of any given device entry, or NULL if no parent device exists (is a toplevel device).

Since (EFL) :

1.8

Since :

3.0

Set the parent of a device

dev The device to set the parent of parent The new parent device

This sets the parent of a device dev to the parent given by parent. If the device already has a parent, it is removed from that parent's list. If parent is NULL then the device is unparented and placed back as a root device in the canvas.

When a device is deleted with evas_device_del(), all children are also deleted along with it.

See also:

evas_device_del

evas_device_parent_get

evas_device_list

Since (EFL) :

1.8

Since :

3.0

This pops the top of the device stack for the canvas

Parameters:

e	The canvas to pop the device stack from

This pops the top of the device stack making the current device context used for device events being what is now at the top of the stack after popping.

See also:

evas_device_push

Since (EFL) :

1.8

Since :

3.0

Push the current context device onto the device stack

Parameters:

e	The canvas to push the device on to
dev	The device to push.

This pushes the given device dev onto the stack for the canvas e resulting in the dev pointer in all events that get fed to the canvas being the device at the top of the device stack for that canvas.

If a device is pushed onto the device stack, it will not be deleted until a canvas free OR until it has been popped from the stack even if evas_device_del() is called.

The device dev must have been created as a device for the canvas it is pushed onto (and not another canvas).

Example:

 evas_device_push(canvas, dev);
 evas_event_feed_mouse_move(canvas, 20, 30, 0, NULL);
 evas_device_pop(canvas);

See also:

evas_device_pop

Since (EFL) :

1.8

Since :

3.0

Get the seat id of a device

dev The device to query

Returns:

The device seat id or 0 if none is set

This gets the seat id set by evas_device_seat id_set().

A seat id is the hardware id of the seat.

Since (EFL) :

1.20

Set the seat id of a device

dev The device to set the seat id of name The seat id

Since (EFL) :

1.20

Get the device sub-class

Parameters:

dev	The device to query

Returns:

The device sub-class set by evas_device_subclass_set().

Since (EFL) :

1.8

Since :

3.0

Set the sub-class of a device

Parameters:

dev	The device to modify
clas	The sub-class to set

This sets the sub-class of a device, giving much more detailed usage within a broader category.

Since (EFL) :

1.8

Since :

3.0

Input device axis update event feed.

This function will set some evas properties that is necessary when an e.g. stylus axis is updated. It prepares information to be treated by the callback function.

Parameters:

[in]	device	System-provided device identifier.
[in]	toolid	Type of tool currently being used.
[in]	naxes	Number of elements in the axis array.
[in]	axis	Array containing the current value of all updated axes.
[in]	data	Data for canvas.

Since (EFL) :

1.13

Since :

3.0

Hold event feed.

This function makes the object to stop sending events.

Parameters:

[in]	timestamp	The timestamp of the mouse up event.
[in]	data	The data for canvas.

Since :

3.0

Key down event feed.

This function will set some evas properties that is necessary when a key is pressed. It prepares information to be treated by the callback function.

Parameters:

[in]	key	The key pressed.
[in]	string	A string.
[in]	compose	The compose string.
[in]	timestamp	Timestamp of the mouse up event.
[in]	data	Data for canvas.

Since :

3.0

Key down event feed with keycode.

This function will set some evas properties that is necessary when a key is pressed. It prepares information to be treated by the callback function.

Parameters:

[in]	key	The key released.
[in]	string	A string.
[in]	compose	Compose.
[in]	timestamp	Timestamp of the mouse up event.
[in]	data	Data for canvas.
[in]	keycode	Key scan code numeric value for canvas.

Since (EFL) :

1.10

Since :

3.0

Key up event feed.

This function will set some evas properties that is necessary when a key is released. It prepares information to be treated by the callback function.

Parameters:

[in]	key	The key released.
[in]	string	A string.
[in]	compose	Compose.
[in]	timestamp	Timestamp of the mouse up event.
[in]	data	Data for canvas.

Since :

3.0

Key up event feed with keycode.

This function will set some evas properties that is necessary when a key is released. It prepares information to be treated by the callback function.

Parameters:

[in]	key	The key released.
[in]	string	A string.
[in]	compose	Compose.
[in]	timestamp	Timestamp of the mouse up event.
[in]	data	Data for canvas.
[in]	keycode	Key scan code numeric value for canvas.

Since (EFL) :

1.10

Since :

3.0

Mouse cancel event feed.

This function will call generate a mouse up event.

Parameters:

[in]

data

The data for canvas.

Since :

3.0

Mouse down event feed.

This function will set some evas properties that is necessary when the mouse button is pressed. It prepares information to be treated by the callback function.

Parameters:

[in]	flags	Evas button flags.
[in]	timestamp	The timestamp of the mouse up event.
[in]	data	The data for canvas.

Since :

3.0

Mouse in event feed.

This function will set some evas properties that is necessary when the mouse in event happens. It prepares information to be treated by the callback function.

Parameters:

[in]

data

The data for canvas.

Since :

3.0

Mouse move event feed.

This function will set some evas properties that is necessary when the mouse is moved from its last position. It prepares information to be treated by the callback function.

Parameters:

[in]	y	The vertical position of the mouse pointer.
[in]	timestamp	The timestamp of the mouse up event.
[in]	data	The data for canvas.

Since :

3.0

Mouse out event feed.

This function will set some evas properties that is necessar when the mouse out event happens. It prepares information to be treated by the callback function.

Parameters:

[in]

data

The data for canvas.

Since :

3.0

Mouse up event feed.

This function will set some evas properties that is necessary when the mouse button is released. It prepares information to be treated by the callback function.

Parameters:

[in]	flags	Evas button flags.
[in]	timestamp	The timestamp of the mouse up event.
[in]	data	The data for canvas.

Since :

3.0

Mouse wheel event feed.

This function will set some evas properties that is necessary when the mouse wheel is scrolled up or down. It prepares information to be treated by the callback function.

Parameters:

[in]	z	How much mouse wheel was scrolled up or down.
[in]	timestamp	The timestamp of the mouse up event.
[in]	data	The data for canvas.

Since :

3.0

Since :

3.0

Since :

3.0

Since :

3.0

Freeze all input events processing.

Parameters:

e	The canvas to freeze input events processing on.

This function will indicate to Evas that the canvas e is to have all input event processing frozen until a matching evas_event_thaw() function is called on the same canvas. All events of this kind during the freeze will get discarded. Every freeze call must be matched by a thaw call in order to completely thaw out a canvas (i.e. these calls may be nested). The most common use is when you don't want the user to interact with your user interface when you're populating a view or changing the layout.

Example:

  "\tf - freeze input for 3 seconds\n"
  "\tp - toggle precise point collision detection on image\n"
  "\tControl + o - add an obscured rectangle\n"
  "\th - print help\n";

struct test_data
{
   Ecore_Evas  *ee;
   Evas        *canvas;
   Evas_Object *img, *bg;
   Ecore_Timer *resize_timer, *freeze_timer;
   Eina_Bool    obscured, focus;
};

/* let's have our events back */
static Eina_Bool
_thaw_cb(void *data EINA_UNUSED)
{
   printf("Canvas was frozen %d times, now thawing.\n",
          evas_event_freeze_get(d.canvas));
   evas_event_thaw(d.canvas);
   return EINA_FALSE; /* do not re-issue the timer */
}

See the full example.

If you run that example, you'll see the canvas ignoring all input events for 3 seconds, when the "f" key is pressed. In a more realistic code we would be freezing while a toolkit or Edje was doing some UI changes, thawing it back afterwards.

Since :

2.3

Examples:

evas-events.c.

Return the freeze count on input events of a given canvas.

Parameters:

e	The canvas to fetch the freeze count from.

This returns the number of times the canvas has been told to freeze input events. It is possible to call evas_event_freeze() multiple times, and these must be matched by evas_event_thaw() calls. This call allows the program to discover just how many times things have been frozen in case it may want to break out of a deep freeze state where the count is high.

Example:

 extern Evas *evas;

 while (evas_event_freeze_get(evas) > 0) evas_event_thaw(evas);

Since :

2.3

Examples:

evas-events.c.

Mouse move event feed from input.

Similar to the evas_event_feed_mouse_move, this function will inform Evas about mouse move events which were received by the input system, relative to the 0,0 of the window, not to the canvas 0,0. It will take care of doing any special transformation like adding the framespace offset to the mouse event.

Parameters:

[in]	y	The vertical position of the mouse pointer relative to the 0,0 of the window/surface.
[in]	timestamp	The timestamp of the mouse move event.
[in]	data	The data for canvas.

Since (EFL) :

1.8

Since :

3.0

Since :

3.0

Since :

3.0

Since :

3.0

Re feed event.

This function re-feeds the event pointed by event_copy.

This function call evas_event_feed_* functions, so it can cause havoc if not used wisely. Please use it responsibly.

Parameters:

[in]

event_type

Event type.

Since :

3.0

Thaw a canvas out after freezing (for input events).

Parameters:

e	The canvas to thaw out.

This will thaw out a canvas after a matching evas_event_freeze() call. If this call completely thaws out a canvas, i.e., there's no other unbalanced call to evas_event_freeze(), events will start to be processed again, but any "missed" events will not be evaluated.

See evas_event_freeze() for an example.

Since :

2.3

Examples:

evas-events.c.

After thaw of a canvas, re-evaluate the state of objects and call callbacks

Parameters:

e	The canvas to evaluate after a thaw

This is normally called after evas_event_thaw() to re-evaluate mouse containment and other states and thus also call callbacks for mouse in and out on new objects if the state change demands it.

Since :

2.3