Efl.Input.Key (class)


Represents a single key event from a keyboard or similar device.

Since 1.18


Efl.Object (class)

Full hierarchy


compose (get, set)

A UTF8 string if this keystroke has modified a string in the middle of being composed.
const char *efl_input_key_compose_get(const Eo *obj);
void efl_input_key_compose_set(Eo *obj, const char *val);

constructor [Overridden from Efl.Object]

Call the object's constructor.
Efl_Object *efl_constructor(Eo *obj);

destructor [Overridden from Efl.Object]

Call the object's destructor.
void efl_destructor(Eo *obj);

device (get, set) [Overridden from Efl.Input.Event]

Input device that originated this event.
Efl_Input_Device *efl_input_device_get(const Eo *obj);
void efl_input_device_set(Eo *obj, Efl_Input_Device *dev);

duplicate [Overridden from Efl.Duplicate]

Creates a copy of this event. Efl.Input.Event.fake is true.
Efl_Duplicate *efl_duplicate(const Eo *obj);

event_flags (get, set) [Overridden from Efl.Input.Event]

Extra flags for this event, may be changed by the user.
Efl_Input_Flags efl_input_event_flags_get(const Eo *obj);
void efl_input_event_flags_set(Eo *obj, Efl_Input_Flags flags);

fake (get) [Overridden from Efl.Input.Event]

true if the event was fake, not triggered by real hardware.
Eina_Bool efl_input_fake_get(const Eo *obj);

key (get, set)

Logical key.
const char *efl_input_key_get(const Eo *obj);
void efl_input_key_set(Eo *obj, const char *val);

key_code (get, set)

Key scan code numeric value.
int efl_input_key_code_get(const Eo *obj);
void efl_input_key_code_set(Eo *obj, int val);

key_name (get, set)

Name string of the key.
const char *efl_input_key_name_get(const Eo *obj);
void efl_input_key_name_set(Eo *obj, const char *val);

lock_enabled (get) [Overridden from Efl.Input.State]

Indicates whether a key lock is on, such as NumLock, CapsLock, ...
Eina_Bool efl_input_lock_enabled_get(const Eo *obj, Efl_Input_Lock lock, const Efl_Input_Device *seat);

modifier_enabled (get) [Overridden from Efl.Input.State]

Indicates whether a key modifier is on, such as Ctrl, Shift, ...
Eina_Bool efl_input_modifier_enabled_get(const Eo *obj, Efl_Input_Modifier mod, const Efl_Input_Device *seat);

pressed (get, set)

true if the key is down, false if it is released.
Eina_Bool efl_input_key_pressed_get(const Eo *obj);
void efl_input_key_pressed_set(Eo *obj, Eina_Bool val);

reset [Overridden from Efl.Input.Event]

Resets the internal data to 0 or default values.
void efl_input_reset(Eo *obj);

string (get, set)

A UTF8 string if this keystroke has produced a visible string to be added.
const char *efl_input_key_string_get(const Eo *obj);
void efl_input_key_string_set(Eo *obj, const char *val);

timestamp (get, set) [Overridden from Efl.Input.Event]

The time at which an event was generated.
double efl_input_timestamp_get(const Eo *obj);
void efl_input_timestamp_set(Eo *obj, double ms);


processed (get, set) true if Efl.Input.Event.event_flags indicates the event is on hold.
scrolling (get, set) true if Efl.Input.Event.event_flags indicates the event happened while scrolling.
allow_parent_unref (get, set) Allow an object to be deleted by unref even if it has a parent.
children_iterator_new Get an iterator on all childrens
comment (get, set) A human readable comment for the object
composite_attach Make an object a composite object of another.
composite_detach Detach a composite object from another object.
composite_part_is Check if an object is part of a composite object.
debug_name_override Build a read-only name for this object used for debugging.
del Unrefs the object and reparents it to NULL.
event_callback_forwarder_add Add an event callback forwarder for an event and an object.
event_callback_forwarder_del Remove an event callback forwarder for an event and an object.
event_callback_stop Stop the current callback call.
event_freeze Freeze events of object.
event_freeze_count (get) Return freeze events of object.
class event_global_freeze Freeze events of object.
class event_global_freeze_count (get) Return freeze events of object.
class event_global_thaw Thaw events of object.
event_thaw Thaw events of object.
finalize Called at the end of efl_add. Should not be called, just overridden.
finalized (get) True if the object is already finalized, otherwise false.
name (get, set) The name of the object.
name_find Find a child object with the given name and return it.
parent (get, set) The parent of an object.
provider_find Searches upwards in the object tree for a provider which knows the given class/interface.



callback,add A callback was added.
callback,del A callback was deleted.
del Object is being deleted.
destruct Object has been fully destroyed. It can not be used beyond this point. This event should only serve to clean up any dangling pointer.