Macros | Functions
Check

The check widget allows for toggling a value between true and false. More...

Macros

#define ELM_CHECK_CLASS   elm_check_class_get()
 Check widget. More...
 
#define EFL_UI_CHECK_EVENT_CHANGED   (&(_EFL_UI_CHECK_EVENT_CHANGED))
 This is called whenever the user changes the state of the check objects (event_info is always NULL).
 

Functions

EOAPI void efl_ui_check_selected_set (Eo *obj, Eina_Bool value)
 The on/off state of the check object. More...
 
EOAPI Eina_Bool efl_ui_check_selected_get (const Eo *obj)
 The on/off state of the check object. More...
 
void elm_check_selected_set (Elm_Check *obj, Eina_Bool value)
 Check widget. More...
 
Eina_Bool elm_check_selected_get (const Elm_Check *obj)
 The on/off state of the check object. More...
 
Evas_Objectelm_check_add (Evas_Object *parent)
 Add a new Check object. More...
 

Detailed Description

The check widget allows for toggling a value between true and false.

check_inheritance_tree.png
preview-00.png
preview-01.png
preview-02.png

Check objects are a lot like radio objects in layout and functionality, except they do not work as a group, but independently, and only toggle the value of a boolean between false and true. elm_check_state_set() sets the boolean state and elm_check_state_get() returns the current state. For convenience, like the radio objects, you can set a pointer to a boolean directly with elm_check_state_pointer_set() for it to modify.

This widget inherits from the Layout one, so that all the functions acting on it also work for check objects.

This widget emits the following signals, besides the ones sent from Layout:

Default content parts of the check widget that you can use for are:

Default text parts of the check widget that you can use for are:

Supported elm_object common APIs.

tutorial_check should give you a firm grasp of how to use this widget.

Macro Definition Documentation

◆ ELM_CHECK_CLASS

#define ELM_CHECK_CLASS   elm_check_class_get()

Check widget.

The check widget allows for toggling a value between true and false. Check objects are a lot like radio objects in layout and functionality, except they do not work as a group, but independently, and only toggle the value of a boolean between false and true.

Function Documentation

◆ efl_ui_check_selected_set()

EOAPI void efl_ui_check_selected_set ( Eo obj,
Eina_Bool  value 
)

The on/off state of the check object.

Parameters
[in]valuetrue if the check object is selected, false otherwise

Referenced by elm_check_selected_set().

◆ efl_ui_check_selected_get()

EOAPI Eina_Bool efl_ui_check_selected_get ( const Eo obj)

The on/off state of the check object.

Returns
true if the check object is selected, false otherwise

Referenced by elm_check_selected_get().

◆ elm_check_selected_set()

void elm_check_selected_set ( Elm_Check *  obj,
Eina_Bool  value 
)

Check widget.

The check widget allows for toggling a value between true and false. Check objects are a lot like radio objects in layout and functionality, except they do not work as a group, but independently, and only toggle the value of a boolean between false and true. The on/off state of the check object.

Parameters
[in]valuetrue if the check object is selected, false otherwise

References efl_ui_check_selected_set().

◆ elm_check_selected_get()

Eina_Bool elm_check_selected_get ( const Elm_Check *  obj)

The on/off state of the check object.

Returns
true if the check object is selected, false otherwise

References efl_ui_check_selected_get().

◆ elm_check_add()

Evas_Object* elm_check_add ( Evas_Object parent)

Add a new Check object.

Parameters
parentThe parent object
Returns
The new object or NULL if it cannot be created