Tizen Native API  6.0
Functions | Typedefs | Defines
Efl Extension Rotary Event
Efl Extension

This module provides functionalities to handle rotary events.

This rotary object emits the following signals.

  • "rotary,activated": A circle object is activated.
  • "rotary,deactivated": A circle object is deactivated.

Functions

Eina_Bool eext_rotary_object_event_callback_add (Evas_Object *obj, Eext_Rotary_Event_Cb func, void *data)
 Add (register) a rotary event callback for evas object obj.
Eina_Bool eext_rotary_object_event_callback_priority_add (Evas_Object *obj, Eext_Callback_Priority priority, Eext_Rotary_Event_Cb func, void *data)
 Add (register) a rotary event callback for evas object obj with priority priority.
void * eext_rotary_object_event_callback_del (Evas_Object *obj, Eext_Rotary_Event_Cb func)
 Remove registered rotary event callback from evas object obj.
Eina_Bool eext_rotary_event_handler_add (Eext_Rotary_Handler_Cb func, void *data)
 Add (register) a handler for rotary event.
void * eext_rotary_event_handler_del (Eext_Rotary_Handler_Cb func)
 Remove registered rotary event handler.
void eext_rotary_object_event_activated_set (Evas_Object *obj, Eina_Bool activated)
 Set an object obj as activated object.
Eina_Bool eext_rotary_object_event_activated_get (Evas_Object *obj)
 Get the activated status of the given object.
Evas_Object * eext_rotary_event_activated_object_get ()
 Get the activated object which can receive the current rotary event.

Typedefs

typedef enum
_Eext_Rotary_Event_Direction 		Eext_Rotary_Event_Direction
 Enumeration of rotary direction.
typedef struct
_Eext_Rotary_Event_Info 		Eext_Rotary_Event_Info
 Rotary event information structure.
typedef Eina_Bool(* Eext_Rotary_Event_Cb )(void *data, Evas_Object *obj, Eext_Rotary_Event_Info *info)
 Rotary object event callback function signature.
typedef Eina_Bool(* Eext_Rotary_Handler_Cb )(void *data, Eext_Rotary_Event_Info *info)
 Rotary event handler function signature.
typedef short Eext_Callback_Priority

Defines

#define EEXT_CALLBACK_PRIORITY_BEFORE   -100
#define EEXT_CALLBACK_PRIORITY_DEFAULT   0
#define EEXT_CALLBACK_PRIORITY_AFTER   100

Define Documentation

#define EEXT_CALLBACK_PRIORITY_AFTER   100

Slightly less prioritized than default.

Since :
2.3.1
#define EEXT_CALLBACK_PRIORITY_BEFORE   -100

Slightly more prioritized than default.

Since :
2.3.1
#define EEXT_CALLBACK_PRIORITY_DEFAULT   0

Default callback priority level

Since :
2.3.1

Typedef Documentation

Eext_Callback_Priority

Callback priority value. Range is -32k - 32k. The lower the number, the higher the priority.

See also:
EEXT_CALLBACK_PRIORITY_AFTER
EEXT_CALLBACK_PRIORITY_BEFORE
EEXT_CALLBACK_PRIORITY_DEFAULT
Since :
2.3.1
typedef Eina_Bool(* Eext_Rotary_Event_Cb)(void *data, Evas_Object *obj, Eext_Rotary_Event_Info *info)

Rotary object event callback function signature.

Since :
2.3.1
typedef enum _Eext_Rotary_Event_Direction Eext_Rotary_Event_Direction

Enumeration of rotary direction.

Since :
2.3.1
typedef struct _Eext_Rotary_Event_Info Eext_Rotary_Event_Info

Rotary event information structure.

Since :
2.3.1
typedef Eina_Bool(* Eext_Rotary_Handler_Cb)(void *data, Eext_Rotary_Event_Info *info)

Rotary event handler function signature.

Since :
2.3.1

Enumeration Type Documentation

enum _Eext_Rotary_Event_Direction

Enumeration of rotary direction.

Since :
2.3.1
Enumerator:
EEXT_ROTARY_DIRECTION_CLOCKWISE 

Rotary is rotated clockwise direction

EEXT_ROTARY_DIRECTION_COUNTER_CLOCKWISE 

Rotary is rotated counter clockwise direction

Function Documentation

Evas_Object* eext_rotary_event_activated_object_get ( )

Get the activated object which can receive the current rotary event.

Returns:
An Evas_Object handle which is rotary event activated, otherwise NULL in case of an error.
Since :
5.5
Eina_Bool eext_rotary_event_handler_add ( Eext_Rotary_Handler_Cb  func,
void *  data 
)

Add (register) a handler for rotary event.

This function adds a handler function for the rotary event, so that when rotary event happens, the handler can be called. A handler function must have the Eext_Rotary_Handler_Cb prototype definition.

Note:
Be carefull not to add the same handler multiple times, if that is not what you want, because Eext won't check if a handler existed before exactly as the one being registered (and thus, call it more than once on the event, in this case).
Parameters:
[in]funcHandler function.
[in]dataUser data to pass to handler function func.
Returns:
EINA_TRUE if the handler is successfully registered. EINA_FALSE otherwise.
Since :
2.3.1
void* eext_rotary_event_handler_del ( Eext_Rotary_Handler_Cb  func)

Remove registered rotary event handler.

Parameters:
[in]funcHandler function.
Returns:
The data which is passed when registers callback function.
See also:
eext_rotary_event_handler_add.
Since :
2.3.1
Eina_Bool eext_rotary_object_event_activated_get ( Evas_Object *  obj)

Get the activated status of the given object.

This function gets the activated status of the given object. eext_rotary_object_event_activated_set.

Parameters:
[in]objThe object to get the activated status.
Returns:
EINA_TRUE if the given object is activated. EINA_FALSE otherwise.
Since :
5.5
void eext_rotary_object_event_activated_set ( Evas_Object *  obj,
Eina_Bool  activated 
)

Set an object obj as activated object.

This function sets object as an activated object. The activated object and its parent are only objects to receive rotary event. Only one object is registered as activated object. If the new object is registered as activated object, the previous activated object will be de-activated. Set EINA_FALSE to activated parameter will set current activated object as non-activated object also. A signal named "rotary,activated" is emitted to the object when it is set as activated object and similar for "rotary,deactivated" signal. To receive the rotary event, the object must be visible and a callback function must be registered to the object with eext_rotary_object_event_callback_add or eext_rotary_object_event_callback_priority_add.

Parameters:
[in]objThe object to set as activated object.
[in]activatedSet EINA_TRUE to activate or EINA_FALSE to de-activate object.
Since :
2.3.1
Eina_Bool eext_rotary_object_event_callback_add ( Evas_Object *  obj,
Eext_Rotary_Event_Cb  func,
void *  data 
)

Add (register) a rotary event callback for evas object obj.

This function adds a callback function to object with default priority level, so that when rotary event happens, the callback can be called for that object. A callback function must have the Eext_Rotary_Event_Cb prototype definition.

Note:
Be carefull not to add the same callback multiple times, if that is not what you want, because Eext won't check if a callback existed before exactly as the one being registered (and thus, call it more than once on the event, in this case).
Parameters:
[in]objThe object that will receive rotary event.
[in]funcCallback function.
[in]dataUser data to pass to callback function func.
Returns:
EINA_TRUE if the callback is successfully registered. EINA_FALSE otherwise.
See also:
eext_rotary_object_event_callback_priority_add
Since :
2.3.1
void* eext_rotary_object_event_callback_del ( Evas_Object *  obj,
Eext_Rotary_Event_Cb  func 
)

Remove registered rotary event callback from evas object obj.

Parameters:
[in]objThe object from which the callback function is removed.
[in]funcCallback function.
Returns:
The data which is passed when registers callback function.
See also:
eext_rotary_object_event_callback_add.
eext_rotary_object_event_callback_priority_add.
Since :
2.3.1
Eina_Bool eext_rotary_object_event_callback_priority_add ( Evas_Object *  obj,
Eext_Callback_Priority  priority,
Eext_Rotary_Event_Cb  func,
void *  data 
)

Add (register) a rotary event callback for evas object obj with priority priority.

This function adds a callback function to object with priority level priority, so that when rotary event happens, the callback can be called for that object. Except for the priority field, it is exactly the same as eext_rotary_object_event_callback_add.

Parameters:
[in]objThe object that will receive rotary event.
[in]priorityThe priority of the callback, lower values called first.
[in]funcCallback function.
[in]dataUser data to pass to callback function func.
Returns:
EINA_TRUE if the callback is successfully registered. EINA_FALSE otherwise.
See also:
eext_rotary_object_event_callback_add
Since :
2.3.1