Tizen Native API  3.0
Efl Extension Circle Object

Circle object is used for circular design of circular ui-controls. It can be combined with elementary widgets and be a part of design. Or it can make itself as a ui-control which is operated by rotary event.

A Circle object extends elementary widgets in a form of circular design. It can be rendered either independently or by Eext_Circle_Surface. When a circle object handle is added with surface parameter of NULL, it is rendered independently along with Evas_Object. On the other hand, if a circle object is created with surface parameter of Eext_Circle_Surface, passed surface will render the circle object.

eext_circle_object functions are same with eext_circle_object_item functions with "default" for item_name parameter. You can check what is the meaning of "default" item in each circle object's documentation.

Functions

void eext_circle_object_line_width_set (Evas_Object *obj, int line_width)
 Set the line width of the circle object.
int eext_circle_object_line_width_get (const Evas_Object *obj)
 Get the line width of a given circle object.
void eext_circle_object_angle_set (Evas_Object *obj, double angle)
 Set the angle in degree of a given circle object.
double eext_circle_object_angle_get (const Evas_Object *obj)
 Get the angle in degree of a given circle object.
void eext_circle_object_angle_offset_set (Evas_Object *obj, double angle_offset)
 Set the angle offset of a given circle object.
double eext_circle_object_angle_offset_get (const Evas_Object *obj)
 Get the angle offset of a given circle object.
void eext_circle_object_angle_min_max_set (Evas_Object *obj, double min_angle, double max_angle)
 Set the minimum and maximum angle for the circle object.
void eext_circle_object_angle_min_max_get (const Evas_Object *obj, double *min_angle, double *max_angle)
 Get the minimum and maximum angle of a given circle object.
void eext_circle_object_value_min_max_set (Evas_Object *obj, double min_value, double max_value)
 Set the minimum and maximum value for the circle object.
void eext_circle_object_value_min_max_get (const Evas_Object *obj, double *min_value, double *max_value)
 Get the minimum and maximum value of a given circle object.
void eext_circle_object_value_set (Evas_Object *obj, double value)
 Set the value of a given circle object.
double eext_circle_object_value_get (const Evas_Object *obj)
 Get the value of a given circle object.
void eext_circle_object_color_set (Evas_Object *obj, int r, int g, int b, int a)
 Set the color of circle line and font in a given circle object.
void eext_circle_object_color_get (const Evas_Object *obj, int *r, int *g, int *b, int *a)
 Get color of circle line and font color in a given circle object.
void eext_circle_object_radius_set (Evas_Object *obj, double radius)
 Set circle radius of a given circle object.
double eext_circle_object_radius_get (const Evas_Object *obj)
 Get circle radius of a given circle object.
void eext_circle_object_disabled_set (Evas_Object *obj, Eina_Bool disabled)
 Set the disabled state of the circle object.
Eina_Bool eext_circle_object_disabled_get (Evas_Object *obj)
 Get the disabled state of the circle object.
Evas_Objecteext_circle_object_add (Evas_Object *parent, Eext_Circle_Surface *surface)
 Add a new circle object.
void eext_circle_object_item_line_width_set (Evas_Object *obj, const char *item_name, int line_width)
 Set the line width of a given item of circle object.
int eext_circle_object_item_line_width_get (const Evas_Object *obj, const char *item_name)
 Get the line width of a given item of circle object.
void eext_circle_object_item_angle_set (Evas_Object *obj, const char *item_name, double angle)
 Set the angle in degree of a given item of circle object.
double eext_circle_object_item_angle_get (const Evas_Object *obj, const char *item_name)
 Get the angle in degree of a given item of circle object.
void eext_circle_object_item_angle_offset_set (Evas_Object *obj, const char *item_name, double angle_offset)
 Set the angle offset of a given item of circle object.
double eext_circle_object_item_angle_offset_get (const Evas_Object *obj, const char *item_name)
 Get the angle offset of a given item of circle object.
void eext_circle_object_item_angle_min_max_set (Evas_Object *obj, const char *item_name, double min_angle, double max_angle)
 Set the minimum and maximum angle for the item of circle object.
void eext_circle_object_item_angle_min_max_get (const Evas_Object *obj, const char *item_name, double *min_angle, double *max_angle)
 Get the minimum and maximum angle of a given item of circle object.
void eext_circle_object_item_value_min_max_set (Evas_Object *obj, const char *item_name, double min_value, double max_value)
 Set the minimum and maximum value for the item of circle object.
void eext_circle_object_item_value_min_max_get (const Evas_Object *obj, const char *item_name, double *min_value, double *max_value)
 Get the minimum and maximum value of a given item of circle object.
void eext_circle_object_item_value_set (Evas_Object *obj, const char *item_name, double value)
 Set the value of a given item of circle object.
double eext_circle_object_item_value_get (const Evas_Object *obj, const char *item_name)
 Get the value of a given item of circle object.
void eext_circle_object_item_color_set (Evas_Object *obj, const char *item_name, int r, int g, int b, int a)
 Set the color of circle line and font in a given item of circle object.
void eext_circle_object_item_color_get (const Evas_Object *obj, const char *item_name, int *r, int *g, int *b, int *a)
 Get color of circle line and font color in a given item of circle object.
void eext_circle_object_item_radius_set (Evas_Object *obj, const char *item_name, double radius)
 Set circle radius of a given item of circle object.
double eext_circle_object_item_radius_get (const Evas_Object *obj, const char *item_name)
 Get circle radius of a given item of circle object.
void eext_circle_object_mirrored_set (const Evas_Object *obj, Eext_Circle_Mirrored_State state)
 Set mirrored state of a given circle object.
Eext_Circle_Mirrored_State eext_circle_object_mirrored_get (const Evas_Object *obj)
 Get mirrored state of a given circle object.

Typedefs

typedef enum
_Eext_Circle_Mirrored_State 
Eext_Circle_Mirrored_State
 Circle Object Mirrored State.

Typedef Documentation


Enumeration Type Documentation

Circle Object Mirrored State.

See also:
eext_circle_object_mirrored_set()
eext_circle_object_mirrored_get()
Since :
3.0
Enumerator:
EEXT_CIRCLE_MIRRORED_OFF 

Disables Mirrored Mode

EEXT_CIRCLE_MIRRORED_ON 

Enables Mirrored Mode

EEXT_CIRCLE_MIRRORED_CONFIG 

Follows System Mirrored Mode


Function Documentation

Add a new circle object.

Parameters:
[in]parentThe parent object
[in]surfaceThe Eext_Circle_Surface object to render the circle object. If NULL, circle object will be rendered independently.
Returns:
A new circle object handle, otherwise NULL if it cannot be created
See also:
Efl Extension Circle Surface
Since :
2.3.1
double eext_circle_object_angle_get ( const Evas_Object obj)

Get the angle in degree of a given circle object.

Parameters:
[in]objThe circle object
Returns:
The angle of circle
See also:
eext_circle_angle_set()
Since :
2.3.1
void eext_circle_object_angle_min_max_get ( const Evas_Object obj,
double *  min_angle,
double *  max_angle 
)

Get the minimum and maximum angle of a given circle object.

Parameters:
[in]objThe circle object
[out]min_angleThe pointer to store the minimum angle in degree
[out]max_angleThe pointer to store the minimum angle in degree
See also:
eext_circle_angle_min_max_set()
Since :
2.3.1
void eext_circle_object_angle_min_max_set ( Evas_Object obj,
double  min_angle,
double  max_angle 
)

Set the minimum and maximum angle for the circle object.

Parameters:
[in]objThe circle object
[in]min_angleThe minimum angle in degree
[in]max_angleThe maximum angle in degree
See also:
eext_circle_angle_min_max_get()
Since :
2.3.1

Get the angle offset of a given circle object.

Parameters:
[in]objThe circle object
Returns:
The angle offset of the circle object
See also:
eext_circle_angle_offset_set()
Since :
2.3.1
void eext_circle_object_angle_offset_set ( Evas_Object obj,
double  angle_offset 
)

Set the angle offset of a given circle object.

Parameters:
[in]objThe circle object
[in]angle_offsetThe angle offset value of the circle object
See also:
eext_circle_angle_offset_get()
Since :
2.3.1
void eext_circle_object_angle_set ( Evas_Object obj,
double  angle 
)

Set the angle in degree of a given circle object.

Parameters:
[in]objThe circle object
[in]angleThe angle in degree of the circle object
See also:
eext_circle_angle_get()
Since :
2.3.1
void eext_circle_object_color_get ( const Evas_Object obj,
int *  r,
int *  g,
int *  b,
int *  a 
)

Get color of circle line and font color in a given circle object.

Parameters:
[in]objThe circle object
[out]rThe pointer to an integer in which to store the red component of the color
[out]gThe pointer to an integer in which to store the green component of the color
[out]bThe pointer to an integer in which to store the blue component of the color
[out]aThe pointer to an integer in which to store the alpha component of the color
See also:
eext_circle_color_set()
Since :
2.3.1
void eext_circle_object_color_set ( Evas_Object obj,
int  r,
int  g,
int  b,
int  a 
)

Set the color of circle line and font in a given circle object.

Parameters:
[in]objThe circle object
[in]rThe red component of the given color
[in]gThe green component of the given color
[in]bThe blue component of the given color
[in]aThe alpha component of the given color
See also:
eext_circle_color_get()
Since :
2.3.1

Get the disabled state of the circle object.

Parameters:
[in]objThe circle object
Returns:
Disabled state. If EINA_TRUE, circle object will be disabled and will not recieve any event. If EINA_FALSE, circle object will be enabled.
See also:
eext_circle_object_disabled_set()
Since :
2.3.1
void eext_circle_object_disabled_set ( Evas_Object obj,
Eina_Bool  disabled 
)

Set the disabled state of the circle object.

This sets the disabled state of the circle object. If EINA_TRUE, circle object will be disabled and will not recieve any event. If EINA_FALSE, circle object will be enabled.

Parameters:
[in]objThe circle object
[in]disabledThe disabled state
See also:
eext_circle_object_disabled_get()
Since :
2.3.1
double eext_circle_object_item_angle_get ( const Evas_Object obj,
const char *  item_name 
)

Get the angle in degree of a given item of circle object.

Parameters:
[in]objThe circle object
[in]item_nameThe item name of circle object
Returns:
The angle of circle
See also:
eext_circle_object_item_angle_set()
Since :
2.3.1
void eext_circle_object_item_angle_min_max_get ( const Evas_Object obj,
const char *  item_name,
double *  min_angle,
double *  max_angle 
)

Get the minimum and maximum angle of a given item of circle object.

Parameters:
[in]objThe circle object
[in]item_nameThe item name of circle object
[out]min_angleThe pointer to store the minimum angle in degree
[out]max_angleThe pointer to store the minimum angle in degree
See also:
eext_circle_object_item_angle_min_max_set()
Since :
2.3.1
void eext_circle_object_item_angle_min_max_set ( Evas_Object obj,
const char *  item_name,
double  min_angle,
double  max_angle 
)

Set the minimum and maximum angle for the item of circle object.

Parameters:
[in]objThe circle object
[in]item_nameThe item name of circle object
[in]min_angleThe minimum angle in degree
[in]max_angleThe maximum angle in degree
See also:
eext_circle_object_item_angle_min_max_get()
Since :
2.3.1
double eext_circle_object_item_angle_offset_get ( const Evas_Object obj,
const char *  item_name 
)

Get the angle offset of a given item of circle object.

Parameters:
[in]objThe circle object
[in]item_nameThe item name of circle object
Returns:
The angle offset of the circle object
See also:
eext_circle_object_item_angle_offset_set()
Since :
2.3.1
void eext_circle_object_item_angle_offset_set ( Evas_Object obj,
const char *  item_name,
double  angle_offset 
)

Set the angle offset of a given item of circle object.

Parameters:
[in]objThe circle object
[in]item_nameThe item name of circle object
[in]angle_offsetThe angle offset value of the circle object
See also:
eext_circle_object_item_angle_offset_get()
Since :
2.3.1
void eext_circle_object_item_angle_set ( Evas_Object obj,
const char *  item_name,
double  angle 
)

Set the angle in degree of a given item of circle object.

Parameters:
[in]objThe circle object
[in]item_nameThe item name of circle object
[in]angleThe angle in degree of the circle object
See also:
eext_circle_object_item_angle_get()
Since :
2.3.1
void eext_circle_object_item_color_get ( const Evas_Object obj,
const char *  item_name,
int *  r,
int *  g,
int *  b,
int *  a 
)

Get color of circle line and font color in a given item of circle object.

Parameters:
[in]objThe circle object
[in]item_nameThe item name of circle object
[out]rThe pointer to an integer in which to store the red component of the color
[out]gThe pointer to an integer in which to store the green component of the color
[out]bThe pointer to an integer in which to store the blue component of the color
[out]aThe pointer to an integer in which to store the alpha component of the color
See also:
eext_circle_object_item_color_set()
Since :
2.3.1
void eext_circle_object_item_color_set ( Evas_Object obj,
const char *  item_name,
int  r,
int  g,
int  b,
int  a 
)

Set the color of circle line and font in a given item of circle object.

Parameters:
[in]objThe circle object
[in]item_nameThe item name of circle object
[in]rThe red component of the given color
[in]gThe green component of the given color
[in]bThe blue component of the given color
[in]aThe alpha component of the given color
See also:
eext_circle_object_item_color_get()
Since :
2.3.1
int eext_circle_object_item_line_width_get ( const Evas_Object obj,
const char *  item_name 
)

Get the line width of a given item of circle object.

Parameters:
[in]objThe circle object
[in]item_nameThe item name of circle object
Returns:
The line width value of the circle object if it succeeds to find the item, otherwise -1 if it fails to find the item.
See also:
eext_circle_object_item_line_width_set()
Since :
2.3.1
void eext_circle_object_item_line_width_set ( Evas_Object obj,
const char *  item_name,
int  line_width 
)

Set the line width of a given item of circle object.

Parameters:
[in]objThe circle object
[in]item_nameThe item name of circle object
[in]line_widthThe line width value of the circle object
See also:
eext_circle_object_item_line_width_get()
Since :
2.3.1
double eext_circle_object_item_radius_get ( const Evas_Object obj,
const char *  item_name 
)

Get circle radius of a given item of circle object.

Parameters:
[in]objThe circle object
[in]item_nameThe item name of circle object
Returns:
The radius of the circle object if it succeeds to find the item, otherwise -1.0 if it fails to find the item.
See also:
eext_circle_object_item_radius_set()
Since :
2.3.1
void eext_circle_object_item_radius_set ( Evas_Object obj,
const char *  item_name,
double  radius 
)

Set circle radius of a given item of circle object.

Parameters:
[in]objThe circle object
[in]item_nameThe item name of circle object
[in]radiusThe radius value of a given circle object
See also:
eext_circle_object_item_radius_get()
Since :
2.3.1
double eext_circle_object_item_value_get ( const Evas_Object obj,
const char *  item_name 
)

Get the value of a given item of circle object.

Parameters:
[in]objThe circle object
[in]item_nameThe item name of circle object
Returns:
The value of circle
See also:
eext_circle_object_item_value_set()
Since :
2.3.1
void eext_circle_object_item_value_min_max_get ( const Evas_Object obj,
const char *  item_name,
double *  min_value,
double *  max_value 
)

Get the minimum and maximum value of a given item of circle object.

Parameters:
[in]objThe circle object
[in]item_nameThe item name of circle object
[out]min_valueThe pointer to store the minimum value
[out]max_valueThe pointer to store the minimum value
See also:
eext_circle_object_item_value_min_max_set()
Since :
2.3.1
void eext_circle_object_item_value_min_max_set ( Evas_Object obj,
const char *  item_name,
double  min_value,
double  max_value 
)

Set the minimum and maximum value for the item of circle object.

Parameters:
[in]objThe circle object
[in]item_nameThe item name of circle object
[in]min_valueThe minimum value
[in]max_valueThe maximum value
See also:
eext_circle_object_item_value_min_max_get()
Since :
2.3.1
void eext_circle_object_item_value_set ( Evas_Object obj,
const char *  item_name,
double  value 
)

Set the value of a given item of circle object.

Parameters:
[in]objThe circle object
[in]item_nameThe item name of circle object
[in]valueThe value of circle object
See also:
eext_circle_object_item_value_get()
Since :
2.3.1

Get the line width of a given circle object.

Parameters:
[in]objThe circle object
Returns:
The line width value of the circle object
See also:
eext_circle_line_width_set()
Since :
2.3.1
void eext_circle_object_line_width_set ( Evas_Object obj,
int  line_width 
)

Set the line width of the circle object.

Parameters:
[in]objThe circle object
[in]line_widthThe line width value of the circle object
See also:
eext_circle_line_width_get()
Since :
2.3.1

Get mirrored state of a given circle object.

Parameters:
[in]objThe circle object
Returns:
The mirrored state
Since :
3.0

Set mirrored state of a given circle object.

Parameters:
[in]objThe circle object
[in]stateThe mirrored state
Since :
3.0
double eext_circle_object_radius_get ( const Evas_Object obj)

Get circle radius of a given circle object.

Parameters:
[in]objThe circle object
Returns:
The radius of circle
See also:
eext_circle_color_set()
Since :
2.3.1
void eext_circle_object_radius_set ( Evas_Object obj,
double  radius 
)

Set circle radius of a given circle object.

Parameters:
[in]objThe circle object
[in]radiusThe radius value of a given circle object
See also:
eext_circle_radius_get()
Since :
2.3.1
double eext_circle_object_value_get ( const Evas_Object obj)

Get the value of a given circle object.

Parameters:
[in]objThe circle object
Returns:
The value of circle
See also:
eext_circle_object_value_set()
Since :
2.3.1
void eext_circle_object_value_min_max_get ( const Evas_Object obj,
double *  min_value,
double *  max_value 
)

Get the minimum and maximum value of a given circle object.

Parameters:
[in]objThe circle object
[out]min_valueThe pointer to store the minimum value
[out]max_valueThe pointer to store the minimum value
See also:
eext_circle_value_min_max_set()
Since :
2.3.1
void eext_circle_object_value_min_max_set ( Evas_Object obj,
double  min_value,
double  max_value 
)

Set the minimum and maximum value for the circle object.

Parameters:
[in]objThe circle object
[in]min_valueThe minimum value
[in]max_valueThe maximum value
See also:
eext_circle_value_min_max_get()
Since :
2.3.1
void eext_circle_object_value_set ( Evas_Object obj,
double  value 
)

Set the value of a given circle object.

Parameters:
[in]objThe circle object
[in]valueThe value of circle object
See also:
eext_circle_object_value_get()
Since :
2.3.1