Input Events Feeding Functions

Functions to tell Evas that input events happened and should be processed. More...

Functions

int evas_event_down_count_get (const Evas *e)
 Get the number of mouse or multi presses currently active.
void evas_event_feed_mouse_down (Evas *e, int b, Evas_Button_Flags flags, unsigned int timestamp, const void *data)
 Mouse down event feed.
void evas_event_feed_mouse_up (Evas *e, int b, Evas_Button_Flags flags, unsigned int timestamp, const void *data)
 Mouse up event feed.
void evas_event_feed_mouse_move (Evas *e, int x, int y, unsigned int timestamp, const void *data)
 Mouse move event feed.
void evas_event_feed_mouse_in (Evas *e, unsigned int timestamp, const void *data)
 Mouse in event feed.
void evas_event_feed_mouse_out (Evas *e, unsigned int timestamp, const void *data)
 Mouse out event feed.
void evas_event_feed_mouse_cancel (Evas *e, unsigned int timestamp, const void *data)
 Mouse cancel event feed.
void evas_event_feed_mouse_wheel (Evas *e, int direction, int z, unsigned int timestamp, const void *data)
 Mouse wheel event feed.
void evas_event_feed_key_down (Evas *e, const char *keyname, const char *key, const char *string, const char *compose, unsigned int timestamp, const void *data)
 Key down event feed.
void evas_event_feed_key_up (Evas *e, const char *keyname, const char *key, const char *string, const char *compose, unsigned int timestamp, const void *data)
 Key up event feed.
void evas_event_feed_hold (Evas *e, int hold, unsigned int timestamp, const void *data)
 Hold event feed.
void evas_event_refeed_event (Evas *e, void *event_copy, Evas_Callback_Type event_type)
 Re feed event.

Detailed Description

Functions to tell Evas that input events happened and should be processed.

Warning
Most of the time these functions are not what you're looking for. These functions should only be used if you're not working with ecore evas(or another input handling system). If you're not using ecore evas please consider using it, in most situation it will make life a lot easier.

As explained in What Evas is not?, Evas does not know how to poll for input events, so the developer should do it and then feed such events to the canvas to be processed. This is only required if operating Evas directly. Modules such as Ecore_Evas do that for you.

Some of the functions in this group are exemplified here.

Function Documentation

int evas_event_down_count_get ( const Evas e)

Get the number of mouse or multi presses currently active.

e The given canvas pointer.

Returns
The numer of presses (0 if none active).
Since
1.2
void evas_event_feed_hold ( Evas e,
int  hold,
unsigned int  timestamp,
const void *  data 
)

Hold event feed.

Parameters
eThe given canvas pointer.
holdThe hold.
timestampThe timestamp of the mouse up event.
dataThe data for canvas.

This function makes the object to stop sending events.

References EVAS_CALLBACK_HOLD, and _Evas_Event_Hold::hold.

void evas_event_feed_key_down ( Evas e,
const char *  keyname,
const char *  key,
const char *  string,
const char *  compose,
unsigned int  timestamp,
const void *  data 
)

Key down event feed.

Parameters
eThe canvas to thaw out
keynameName of the key
keyThe key pressed.
stringA String
composeThe compose string
timestampTimestamp of the mouse up event
dataData for canvas.

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.

References _Evas_Event_Key_Down::compose, EVAS_CALLBACK_KEY_DOWN, _Evas_Event_Key_Down::key, _Evas_Event_Key_Down::keyname, _Evas_Event_Key_Down::modifiers, and _Evas_Event_Key_Down::string.

Referenced by evas_event_refeed_event().

void evas_event_feed_key_up ( Evas e,
const char *  keyname,
const char *  key,
const char *  string,
const char *  compose,
unsigned int  timestamp,
const void *  data 
)

Key up event feed.

Parameters
eThe canvas to thaw out
keynameName of the key
keyThe key released.
stringstring
composecompose
timestampTimestamp of the mouse up event
dataData for canvas.

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.

References _Evas_Event_Key_Up::compose, EVAS_CALLBACK_KEY_UP, _Evas_Event_Key_Up::key, _Evas_Event_Key_Up::keyname, _Evas_Event_Key_Up::modifiers, and _Evas_Event_Key_Up::string.

Referenced by evas_event_refeed_event().

void evas_event_feed_mouse_cancel ( Evas e,
unsigned int  timestamp,
const void *  data 
)

Mouse cancel event feed.

Parameters
eThe given canvas pointer.
timestampThe timestamp of the mouse up event.
dataThe data for canvas.

This function will call evas_event_feed_mouse_up() when a mouse cancel event happens.

References evas_event_feed_mouse_up().

void evas_event_feed_mouse_down ( Evas e,
int  b,
Evas_Button_Flags  flags,
unsigned int  timestamp,
const void *  data 
)

Mouse down event feed.

Parameters
eThe given canvas pointer.
bThe button number.
flagsThe evas button flags.
timestampThe timestamp of the mouse down event.
dataThe data for canvas.

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.

References _Evas_Event_Mouse_Down::button, _Evas_Event_Mouse_Down::canvas, EVAS_CALLBACK_MOUSE_DOWN, EVAS_OBJECT_POINTER_MODE_AUTOGRAB, EVAS_OBJECT_POINTER_MODE_NOGRAB_NO_REPEAT_UPDOWN, EVAS_TOUCH_POINT_STILL, _Evas_Event_Mouse_Down::flags, _Evas_Event_Mouse_Down::modifiers, and _Evas_Event_Mouse_Down::output.

Referenced by evas_event_refeed_event().

void evas_event_feed_mouse_in ( Evas e,
unsigned int  timestamp,
const void *  data 
)

Mouse in event feed.

Parameters
eThe given canvas pointer.
timestampThe timestamp of the mouse up event.
dataThe data for canvas.

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.

References _Evas_Event_Mouse_In::buttons, _Evas_Event_Mouse_In::canvas, EVAS_CALLBACK_MOUSE_IN, evas_event_feed_mouse_move(), _Evas_Event_Mouse_In::modifiers, and _Evas_Event_Mouse_In::output.

Referenced by evas_event_refeed_event().

void evas_event_feed_mouse_move ( Evas e,
int  x,
int  y,
unsigned int  timestamp,
const void *  data 
)

Mouse move event feed.

Parameters
eThe given canvas pointer.
xThe horizontal position of the mouse pointer.
yThe vertical position of the mouse pointer.
timestampThe timestamp of the mouse up event.
dataThe data for canvas.

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.

References _Evas_Event_Mouse_In::buttons, _Evas_Event_Mouse_Out::buttons, _Evas_Event_Mouse_Move::buttons, _Evas_Event_Mouse_In::canvas, _Evas_Event_Mouse_Out::canvas, EVAS_CALLBACK_MOUSE_IN, EVAS_CALLBACK_MOUSE_MOVE, EVAS_CALLBACK_MOUSE_OUT, evas_object_below_get(), EVAS_OBJECT_POINTER_MODE_NOGRAB_NO_REPEAT_UPDOWN, EVAS_TOUCH_POINT_MOVE, _Evas_Event_Mouse_In::modifiers, _Evas_Event_Mouse_Out::modifiers, _Evas_Event_Mouse_Move::modifiers, _Evas_Event_Mouse_In::output, and _Evas_Event_Mouse_Out::output.

Referenced by evas_event_feed_mouse_in(), evas_event_refeed_event(), evas_event_thaw_eval(), evas_object_clip_set(), evas_object_clip_unset(), evas_object_freeze_events_set(), evas_object_hide(), evas_object_layer_set(), evas_object_line_xy_set(), evas_object_lower(), evas_object_move(), evas_object_pass_events_set(), evas_object_polygon_point_add(), evas_object_polygon_points_clear(), evas_object_raise(), evas_object_repeat_events_set(), evas_object_resize(), evas_object_show(), evas_object_stack_above(), evas_object_stack_below(), evas_object_text_font_set(), evas_object_text_text_set(), and evas_object_textgrid_font_set().

void evas_event_feed_mouse_out ( Evas e,
unsigned int  timestamp,
const void *  data 
)

Mouse out event feed.

Parameters
eThe given canvas pointer.
timestampTimestamp of the mouse up event.
dataThe data for canvas.

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

References _Evas_Event_Mouse_Out::buttons, _Evas_Event_Mouse_Out::canvas, EVAS_CALLBACK_MOUSE_OUT, _Evas_Event_Mouse_Out::modifiers, and _Evas_Event_Mouse_Out::output.

Referenced by evas_event_refeed_event().

void evas_event_feed_mouse_up ( Evas e,
int  b,
Evas_Button_Flags  flags,
unsigned int  timestamp,
const void *  data 
)

Mouse up event feed.

Parameters
eThe given canvas pointer.
bThe button number.
flagsevas button flags.
timestampThe timestamp of the mouse up event.
dataThe data for canvas.

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.

References _Evas_Event_Mouse_Up::button, _Evas_Event_Mouse_Up::canvas, EVAS_CALLBACK_MOUSE_UP, EVAS_OBJECT_POINTER_MODE_AUTOGRAB, EVAS_OBJECT_POINTER_MODE_NOGRAB_NO_REPEAT_UPDOWN, EVAS_TOUCH_POINT_UP, _Evas_Event_Mouse_Up::flags, _Evas_Event_Mouse_Up::modifiers, and _Evas_Event_Mouse_Up::output.

Referenced by evas_event_feed_mouse_cancel(), and evas_event_refeed_event().

void evas_event_feed_mouse_wheel ( Evas e,
int  direction,
int  z,
unsigned int  timestamp,
const void *  data 
)

Mouse wheel event feed.

Parameters
eThe given canvas pointer.
directionThe wheel mouse direction.
zHow much mouse wheel was scrolled up or down.
timestampThe timestamp of the mouse up event.
dataThe data for canvas.

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.

References _Evas_Event_Mouse_Wheel::canvas, EVAS_CALLBACK_MOUSE_WHEEL, _Evas_Event_Mouse_Wheel::modifiers, and _Evas_Event_Mouse_Wheel::output.

Referenced by evas_event_refeed_event().