2011-12-29 23:20:48 -08:00
|
|
|
/**
|
2016-03-16 08:05:31 -07:00
|
|
|
* @defgroup Elm_Check Check
|
2012-04-16 18:35:46 -07:00
|
|
|
* @ingroup Elementary
|
2011-12-29 23:20:48 -08:00
|
|
|
*
|
2012-06-05 15:41:21 -07:00
|
|
|
* @image html check_inheritance_tree.png
|
|
|
|
* @image latex check_inheritance_tree.eps
|
|
|
|
*
|
2011-12-29 23:20:48 -08:00
|
|
|
* @image html img/widget/check/preview-00.png
|
|
|
|
* @image latex img/widget/check/preview-00.eps
|
|
|
|
* @image html img/widget/check/preview-01.png
|
|
|
|
* @image latex img/widget/check/preview-01.eps
|
|
|
|
* @image html img/widget/check/preview-02.png
|
|
|
|
* @image latex img/widget/check/preview-02.eps
|
|
|
|
*
|
2012-05-03 15:42:03 -07:00
|
|
|
* @brief 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.
|
|
|
|
*
|
2017-10-23 23:13:07 -07:00
|
|
|
* This widget inherits from the @ref Elm_Layout one, so that all the
|
2012-05-03 15:42:03 -07:00
|
|
|
* functions acting on it also work for check objects.
|
|
|
|
*
|
|
|
|
* This widget emits the following signals, besides the ones sent from
|
2017-10-23 23:13:07 -07:00
|
|
|
* @ref Elm_Layout :
|
2012-05-03 15:42:03 -07:00
|
|
|
* - @c "changed" - This is called whenever the user changes the state of
|
2014-07-19 09:50:03 -07:00
|
|
|
* the check objects (@p event_info is always @c NULL).
|
elm: fixed focused and unfocused documentation.
1. ctxpopup, fileselector_entry, naviframe, popup, bubble, button, calendar, check, clock, colorselector, datetime, diskselector, flipselector, gengrid.
2. since 1.8
2013-06-09 21:44:25 -07:00
|
|
|
* - @c "focused" - When the check has received focus. (since 1.8)
|
|
|
|
* - @c "unfocused" - When the check has lost focus. (since 1.8)
|
2014-01-23 03:07:20 -08:00
|
|
|
* - @c "language,changed" - the program's language changed (since 1.9)
|
2011-12-29 23:20:48 -08:00
|
|
|
*
|
2012-02-27 18:39:31 -08:00
|
|
|
* Default content parts of the check widget that you can use for are:
|
2011-12-29 23:20:48 -08:00
|
|
|
* @li "icon" - An icon of the check
|
|
|
|
*
|
|
|
|
* Default text parts of the check widget that you can use for are:
|
2012-01-02 04:53:29 -08:00
|
|
|
* @li "default" - A label of the check
|
2013-06-11 22:14:25 -07:00
|
|
|
* @li "on" - On state label of the check (only valid for "toggle" style.)
|
|
|
|
* @li "off" - Off state label of the check (only valid for "toggle" style.)
|
2012-01-02 04:53:29 -08:00
|
|
|
*
|
|
|
|
* Supported elm_object common APIs.
|
2012-04-17 13:33:59 -07:00
|
|
|
* @li @ref elm_object_disabled_set
|
|
|
|
* @li @ref elm_object_disabled_get
|
|
|
|
* @li @ref elm_object_part_text_set
|
|
|
|
* @li @ref elm_object_part_text_get
|
|
|
|
* @li @ref elm_object_part_content_set
|
|
|
|
* @li @ref elm_object_part_content_get
|
|
|
|
* @li @ref elm_object_part_content_unset
|
|
|
|
* @li @ref elm_object_signal_emit
|
|
|
|
* @li @ref elm_object_signal_callback_add
|
|
|
|
* @li @ref elm_object_signal_callback_del
|
2011-12-29 23:20:48 -08:00
|
|
|
*
|
2011-12-29 23:41:47 -08:00
|
|
|
* @ref tutorial_check should give you a firm grasp of how to use this widget.
|
2012-03-28 02:02:22 -07:00
|
|
|
*
|
2011-12-29 23:20:48 -08:00
|
|
|
* @{
|
|
|
|
*/
|
2011-12-29 23:41:47 -08:00
|
|
|
|
2013-04-27 23:50:23 -07:00
|
|
|
#ifdef EFL_EO_API_SUPPORT
|
2017-05-19 03:05:10 -07:00
|
|
|
#include "efl_ui_check_eo.h"
|
2017-12-11 22:55:43 -08:00
|
|
|
#define EFL_UI_CHECK_EVENT_CHANGED EFL_UI_NSTATE_EVENT_CHANGED
|
2013-04-27 23:50:23 -07:00
|
|
|
#endif
|
|
|
|
#ifndef EFL_NOLEGACY_API_SUPPORT
|
|
|
|
#include "elm_check_legacy.h"
|
|
|
|
#endif
|
2011-12-29 23:20:48 -08:00
|
|
|
/**
|
|
|
|
* @}
|
|
|
|
*/
|