Tizen Native API
|
Functions | |
const Evas_Modifier * | evas_key_modifier_get (const Evas *e) |
Gets a handle to the list of modifier keys registered in the canvas e. | |
const Evas_Lock * | evas_key_lock_get (const Evas *e) |
Gets a handle to the list of lock keys registered in the canvas e. | |
Eina_Bool | evas_key_modifier_is_set (const Evas_Modifier *m, const char *keyname) |
Checks whether a given modifier key is set at the time of the call. | |
Eina_Bool | evas_key_lock_is_set (const Evas_Lock *l, const char *keyname) |
Checks whether the given lock key is set at the time of the call. | |
void | evas_key_modifier_add (Evas *e, const char *keyname) |
Adds the keyname key to the current list of modifier keys. | |
void | evas_key_modifier_del (Evas *e, const char *keyname) |
Removes the keyname key from the current list of modifier keys on canvas e. | |
void | evas_key_lock_add (Evas *e, const char *keyname) |
Adds the keyname key to the current list of lock keys. | |
void | evas_key_lock_del (Evas *e, const char *keyname) |
Removes the keyname key from the current list of lock keys on canvas e. | |
void | evas_key_modifier_on (Evas *e, const char *keyname) |
Enables or turns on programmatically the modifier key with name keyname. | |
void | evas_key_modifier_off (Evas *e, const char *keyname) |
Disables or turns off programmatically the modifier key with name keyname. | |
void | evas_key_lock_on (Evas *e, const char *keyname) |
Enables or turns on programmatically the lock key with name keyname. | |
void | evas_key_lock_off (Evas *e, const char *keyname) |
Disables or turns off programmatically the lock key with name keyname. | |
Evas_Modifier_Mask | evas_key_modifier_mask_get (const Evas *e, const char *keyname) |
Creates a bit mask from the keyname modifier key. | |
Eina_Bool | evas_object_key_grab (Evas_Object *obj, const char *keyname, Evas_Modifier_Mask modifiers, Evas_Modifier_Mask not_modifiers, Eina_Bool exclusive) |
Requests keyname key events be directed to obj. | |
void | evas_object_key_ungrab (Evas_Object *obj, const char *keyname, Evas_Modifier_Mask modifiers, Evas_Modifier_Mask not_modifiers) |
Removes the grab on keyname key events by obj. |
This group provides functions which feed key events to the canvas.
Evas is not aware of input systems at all. Then, the user, if using it crudely (evas_new()), has to feed it with input events, so that it can react somehow. If, however, the user creates a canvas by means of the Ecore_Evas wrapper, it automatically binds the chosen display engine's input events to the canvas, for you.
This group presents the functions dealing with the feeding of key events to the canvas. On most of them, one has to reference a given key by a name (keyname
argument). Those are platform dependent symbolic names for the keys. Sometimes you get the right keyname
by simply using an ASCII value of the key name, but it is not like that always.
Typical platforms are Linux frame buffer (Ecore_FB) and X server (Ecore_X) when using Evas with Ecore and Ecore_Evas. Please refer to your display engine's documentation when using evas through an Ecore helper wrapper when you need the keyname
s.
void evas_key_lock_add | ( | Evas * | e, |
const char * | keyname | ||
) |
Adds the keyname key to the current list of lock keys.
[in] | e | The pointer to the Evas canvas |
[in] | keyname | The name of the key to add to the locks list |
void evas_key_lock_del | ( | Evas * | e, |
const char * | keyname | ||
) |
Removes the keyname key from the current list of lock keys on canvas e.
[in] | e | The pointer to the Evas canvas |
[in] | keyname | The name of the key to remove from the locks list |
const Evas_Lock* evas_key_lock_get | ( | const Evas * | e | ) |
Gets a handle to the list of lock keys registered in the canvas e.
[in] | e | The pointer to the Evas canvas |
NULL
on errorEina_Bool evas_key_lock_is_set | ( | const Evas_Lock * | l, |
const char * | keyname | ||
) |
Checks whether the given lock key is set at the time of the call.
Eina_True
.[in] | l | The current locks set, as returned by evas_key_lock_get() |
[in] | keyname | The name of the lock key to check status for |
Eina_False
if the lock key is not setvoid evas_key_lock_off | ( | Evas * | e, |
const char * | keyname | ||
) |
Disables or turns off programmatically the lock key with name keyname.
[in] | e | The pointer to the Evas canvas |
[in] | keyname | The name of the lock to disable |
void evas_key_lock_on | ( | Evas * | e, |
const char * | keyname | ||
) |
Enables or turns on programmatically the lock key with name keyname.
[in] | e | The pointer to the Evas canvas |
[in] | keyname | The name of the lock to enable |
void evas_key_modifier_add | ( | Evas * | e, |
const char * | keyname | ||
) |
Adds the keyname key to the current list of modifier keys.
[in] | e | The pointer to the Evas canvas |
[in] | keyname | The name of the modifier key to add to the list of Evas modifiers |
void evas_key_modifier_del | ( | Evas * | e, |
const char * | keyname | ||
) |
Removes the keyname key from the current list of modifier keys on canvas e.
[in] | e | The pointer to the Evas canvas |
[in] | keyname | The name of the key to remove from the modifiers list |
const Evas_Modifier* evas_key_modifier_get | ( | const Evas * | e | ) |
Gets a handle to the list of modifier keys registered in the canvas e.
[in] | e | The pointer to the Evas canvas |
NULL
on errorEina_Bool evas_key_modifier_is_set | ( | const Evas_Modifier * | m, |
const char * | keyname | ||
) |
Checks whether a given modifier key is set at the time of the call.
Eina_True
.[in] | m | The current modifiers set, as returned by evas_key_modifier_get() |
[in] | keyname | The name of the modifier key to check status for |
Evas_Modifier_Mask evas_key_modifier_mask_get | ( | const Evas * | e, |
const char * | keyname | ||
) |
Creates a bit mask from the keyname modifier key.
[in] | e | The canvas to query the bit mask from |
[in] | keyname | The name of the modifier key to create the mask for |
0
if the keyname key is not registered as a modifier for canvas e void evas_key_modifier_off | ( | Evas * | e, |
const char * | keyname | ||
) |
Disables or turns off programmatically the modifier key with name keyname.
[in] | e | The pointer to the Evas canvas |
[in] | keyname | The name of the modifier to disable |
void evas_key_modifier_on | ( | Evas * | e, |
const char * | keyname | ||
) |
Enables or turns on programmatically the modifier key with name keyname.
[in] | e | The pointer to the Evas canvas |
[in] | keyname | The name of the modifier to enable |
Eina_Bool evas_object_key_grab | ( | Evas_Object * | obj, |
const char * | keyname, | ||
Evas_Modifier_Mask | modifiers, | ||
Evas_Modifier_Mask | not_modifiers, | ||
Eina_Bool | exclusive | ||
) |
Requests keyname key events be directed to obj.
0
for empty masks.[in] | obj | The object to direct keyname events to |
[in] | keyname | The key to request events for |
[in] | modifiers | A mask of modifiers that must be present to trigger the event |
[in] | not_modifiers | A mask of modifiers that must not be present to trigger the event |
[in] | exclusive | Set EINA_TRUE to request that the obj is the only object receiving the keyname events, otherwise set EINA_FALSE |
void evas_object_key_ungrab | ( | Evas_Object * | obj, |
const char * | keyname, | ||
Evas_Modifier_Mask | modifiers, | ||
Evas_Modifier_Mask | not_modifiers | ||
) |
Removes the grab on keyname key events by obj.
[in] | obj | The object that has an existing key grab |
[in] | keyname | The key the grab is set for |
[in] | modifiers | A mask of modifiers that must be present to trigger the event |
[in] | not_modifiers | A mask of modifiers that must not be present to trigger the event |