Tizen Native API  4.0
Functions | Typedefs | Defines
Ecore Input
Ecore

Since :
2.3

Functions

int ecore_event_shutdown (void)
unsigned int ecore_event_modifier_mask (Ecore_Event_Modifier modifier)
Ecore_Event_Modifier ecore_event_update_modifier (const char *key, Ecore_Event_Modifiers *modifiers, int inc)
Ecore_Compose_State ecore_compose_get (const Eina_List *seq, char **seqstr_ret)
EINA_DEPRECATED int ecore_input_joystick_init (void)
EINA_DEPRECATED int ecore_input_joystick_shutdown (void)
void ecore_input_joystick_event_axis_deadzone_set (int event_axis_deadzone)
int ecore_input_joystick_event_axis_deadzone_get (void)

Typedefs

typedef struct
_Ecore_Event_Axis_Update 		Ecore_Event_Axis_Update
typedef struct _Ecore_Axis Ecore_Axis
typedef struct
_Ecore_Event_Joystick 		Ecore_Event_Joystick
typedef enum _Ecore_Event_Modifier Ecore_Event_Modifier
typedef enum _Ecore_Event_Press Ecore_Event_Press
typedef enum _Ecore_Event_IO Ecore_Event_IO
typedef enum _Ecore_Compose_State Ecore_Compose_State
typedef enum
_Ecore_Event_Joystick_Button 		Ecore_Event_Joystick_Button
typedef enum
_Ecore_Event_Joystick_Axis 		Ecore_Event_Joystick_Axis
typedef enum
_Ecore_Event_Joystick_Event 		Ecore_Event_Joystick_Event_Type
typedef enum _Ecore_Axis_Label Ecore_Axis_Label

Defines

#define ECORE_EVENT_MODIFIER_ALTGR   0x0400

Define Documentation

#define ECORE_EVENT_MODIFIER_ALTGR   0x0400
Since (EFL) :
1.7

Typedef Documentation

typedef struct _Ecore_Axis Ecore_Axis
Since (EFL) :
1.13
typedef enum _Ecore_Axis_Label Ecore_Axis_Label
Since (EFL) :
1.13
Ecore_Compose_State

An enum of Compose states.

typedef struct _Ecore_Event_Axis_Update Ecore_Event_Axis_Update
Since (EFL) :
1.13
Ecore_Event_IO

An enum of Input/Output events.

typedef struct _Ecore_Event_Joystick Ecore_Event_Joystick
Since (EFL) :
1.18
typedef enum _Ecore_Event_Joystick_Axis Ecore_Event_Joystick_Axis
Since (EFL) :
1.18
typedef enum _Ecore_Event_Joystick_Button Ecore_Event_Joystick_Button
Since (EFL) :
1.18
typedef enum _Ecore_Event_Joystick_Event Ecore_Event_Joystick_Event_Type
Since (EFL) :
1.18
Ecore_Event_Modifier

An enum of modifier events.

Ecore_Event_Press

An enum of press events.

Enumeration Type Documentation

enum _Ecore_Axis_Label
Enumerator:
ECORE_AXIS_LABEL_UNKNOWN 

Axis type is not known. Range: Unbounded. Unit: Undefined.

Since (EFL) :
1.13
ECORE_AXIS_LABEL_X 

Position along physical X axis; not window relative. Range: Unbounded. Unit: Undefined.

Since (EFL) :
1.13
ECORE_AXIS_LABEL_Y 

Position along physical Y axis; not window relative. Range: Unbounded. Unit: Undefined.

Since (EFL) :
1.13
ECORE_AXIS_LABEL_PRESSURE 

Force applied to tool tip. Range: [0.0, 1.0]. Unit: Unitless.

Since (EFL) :
1.13
ECORE_AXIS_LABEL_DISTANCE 

Relative distance along physical Z axis. Range: [0.0, 1.0]. Unit: Unitless.

Since (EFL) :
1.13
ECORE_AXIS_LABEL_AZIMUTH 

Angle of tool about the Z axis from positive X axis. Range: [-PI, PI]. Unit: Radians.

Since (EFL) :
1.13
ECORE_AXIS_LABEL_TILT 

Angle of tool about plane of sensor from positive Z axis. Range: [0.0, PI]. Unit: Radians.

Since (EFL) :
1.13
ECORE_AXIS_LABEL_TWIST 

Rotation of tool about its major axis from its "natural" position. Range: [-PI, PI] Unit: Radians.

Since (EFL) :
1.13
ECORE_AXIS_LABEL_TOUCH_WIDTH_MAJOR 

Length of contact ellipse along AZIMUTH. Range: Unbounded: Unit: Same as ECORE_AXIS_LABEL_{X,Y}.

Since (EFL) :
1.13
ECORE_AXIS_LABEL_TOUCH_WIDTH_MINOR 

Length of contact ellipse perpendicular to AZIMUTH. Range: Unbounded. Unit: Same as ECORE_AXIS_LABEL_{X,Y}.

Since (EFL) :
1.13
ECORE_AXIS_LABEL_TOOL_WIDTH_MAJOR 

Length of tool ellipse along AZIMUTH. Range: Unbounded. Unit: Same as ECORE_AXIS_LABEL_{X,Y}.

Since (EFL) :
1.13
ECORE_AXIS_LABEL_TOOL_WIDTH_MINOR 

Length of tool ellipse perpendicular to AZIMUTH. Range: Unbounded. Unit: Same as ECORE_AXIS_LABEL_{X,Y}.

Since (EFL) :
1.13
ECORE_AXIS_LABEL_TOUCH_PALM 

Size of palm contact. Range: Unbounded. Unit: undefined. May be a boolean or a distance value, depending on the underlying H/W.

Since (EFL) :
1.20
enum _Ecore_Event_Modifier
Enumerator:
ECORE_MODE 
Since (EFL) :
1.7

Function Documentation

Ecore_Compose_State ecore_compose_get ( const Eina_List *  seq,
char **  seqstr_ret 
)

Handles a sequence of key symbols to make a final compose string.

The final compose string seqstr_ret is allocated in this function and thus shall be freed when not needed anymore.

Parameters:
seqThe sequence of key symbols in a Eina_List.
seqstr_retThe final compose string.
Returns:
The status of the composition.
Since :
2.4
unsigned int ecore_event_modifier_mask ( Ecore_Event_Modifier  modifier)

Returns the Ecore modifier event integer associated to a Ecore_Event_Modifier modifier event.

Parameters:
modifierA Ecore_Event_Modifier event.
Returns:
A event_modifier integer that matches with the provided modifier event.
Since :
2.4
int ecore_event_shutdown ( void  )

Shutdowns the Ecore Event system.

Returns:
How many times the lib has been initialized.
Since :
2.4
Ecore_Event_Modifier ecore_event_update_modifier ( const char *  key,
Ecore_Event_Modifiers *  modifiers,
int  inc 
)

Update a Ecore_Event_Modifiers array with "key" modifier.

Parameters:
keyA string describing a modifier key.
modifiersA Ecore_Event_Modifiers structure.
incThe value to increment in the modifiers array.
Returns:
ECORE_NONE if the key does not match with an existing one, else the corresponding Ecore_Event_Modifier.
Since :
2.4
int ecore_input_joystick_event_axis_deadzone_get ( void  )

Get deadzone of joystick event for an axis.

Returns:
deadzone of joystick event for an axis.
Since (EFL) :
1.19
void ecore_input_joystick_event_axis_deadzone_set ( int  event_axis_deadzone)

Set deadzone of joystick event for an axis.

The axis type joystick event occurs without user's control if joystick is too sensitive. The deadzone prevents unnecessary events. The default value is 200. The event value for an axis is a signed integer between -32767 and +32767.

Parameters:
event_axis_deadzoneThe joystick event axis deadzone.
Since (EFL) :
1.19
EINA_DEPRECATED int ecore_input_joystick_init ( void  )

Initializes the Ecore Input Joystick system.

Returns:
How many times the lib has been initialized.
Since (EFL) :
1.15
Since :
2.4
Deprecated:
Deprecated since Tizen 4.0 ecore_event_init calls this by default
EINA_DEPRECATED int ecore_input_joystick_shutdown ( void  )

Shutdowns the Ecore Input Joystick system.

Returns:
How many times the lib has been initialized.
Since (EFL) :
1.15
Since :
2.4
Deprecated:
Deprecated since Tizen 4.0 ecore_event_shutdown calls this by default

Variable Documentation

int ECORE_EVENT_AXIS_UPDATE
Since (EFL) :
1.13
int ECORE_EVENT_JOYSTICK
Since (EFL) :
1.18
int ECORE_EVENT_MOUSE_BUTTON_CANCEL
Since (EFL) :
1.15