The check widget allows for toggling a value between true and false. More...
|Evas_Object *||elm_check_add (Evas_Object *parent)|
|Add a new Check object. |
|void||elm_check_state_set (Evas_Object *obj, Eina_Bool state)|
|Set the on/off state of the check object. |
|Eina_Bool||elm_check_state_get (const Evas_Object *obj)|
|Get the state of the check object. |
|void||elm_check_state_pointer_set (Evas_Object *obj, Eina_Bool *statep)|
|Set a convenience pointer to a boolean to change. |
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. 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:
"changed"- This is called whenever the user changes the state of the check objects (
Default content parts of the check widget that you can use for are:
- "icon" - An icon of the check
Default text parts of the check widget that you can use for are:
- "default" - A label of the check
- "on" - On state label of the check
- "off" - Off state label of the check
Supported elm_object common APIs.
Check example should give you a firm grasp of how to use this widget.
|Evas_Object* elm_check_add||(||Evas_Object *||parent )|
Add a new Check object.
parent The parent object
- The new object or NULL if it cannot be created
|Eina_Bool elm_check_state_get||(||const Evas_Object *||obj )|
Get the state of the check object.
obj The check object
- The boolean state
Referenced by elm_dayselector_day_selected_get().
|void elm_check_state_pointer_set||(||Evas_Object *||obj,|
Set a convenience pointer to a boolean to change.
obj The check object statep Pointer to the boolean to modify
This sets a pointer to a boolean, that, in addition to the check objects state will also be modified directly. To stop setting the object pointed to simply use NULL as the
statep parameter. If
statep is not NULL, then when this is called, the check objects state will also be modified to reflect the value of the boolean
statep points to, just like calling elm_check_state_set().
|void elm_check_state_set||(||Evas_Object *||obj,|
Set the on/off state of the check object.
obj The check object state The state to use (1 == on, 0 == off)
This sets the state of the check. If set with elm_check_state_pointer_set() the state of that variable is also changed. Calling this doesn't cause the "changed" signal to be emitted.
Referenced by elm_dayselector_day_selected_set().