summaryrefslogtreecommitdiff
path: root/src/lib/elementary/elm_check.h
diff options
context:
space:
mode:
authorCedric BAIL <cedric@osg.samsung.com>2016-03-23 12:56:14 -0700
committerCedric BAIL <cedric@osg.samsung.com>2016-03-23 13:24:41 -0700
commitc2a1c49ab2042f559b28e840e54feb8494888e0e (patch)
treec6eb110b7c479499854eede9d0c3ab0a80c9a11a /src/lib/elementary/elm_check.h
parent9340855597e7e465435c69b6278650346688da14 (diff)
elementary: move all legacy files to their expected new location.
Diffstat (limited to 'src/lib/elementary/elm_check.h')
-rw-r--r--src/lib/elementary/elm_check.h70
1 files changed, 70 insertions, 0 deletions
diff --git a/src/lib/elementary/elm_check.h b/src/lib/elementary/elm_check.h
new file mode 100644
index 0000000000..dfac2f7e1b
--- /dev/null
+++ b/src/lib/elementary/elm_check.h
@@ -0,0 +1,70 @@
1/**
2 * @defgroup Elm_Check Check
3 * @ingroup Elementary
4 *
5 * @image html check_inheritance_tree.png
6 * @image latex check_inheritance_tree.eps
7 *
8 * @image html img/widget/check/preview-00.png
9 * @image latex img/widget/check/preview-00.eps
10 * @image html img/widget/check/preview-01.png
11 * @image latex img/widget/check/preview-01.eps
12 * @image html img/widget/check/preview-02.png
13 * @image latex img/widget/check/preview-02.eps
14 *
15 * @brief The check widget allows for toggling a value between true
16 * and false.
17 *
18 * Check objects are a lot like radio objects in layout and
19 * functionality, except they do not work as a group, but
20 * independently, and only toggle the value of a boolean between false
21 * and true. elm_check_state_set() sets the boolean state and
22 * elm_check_state_get() returns the current state. For convenience,
23 * like the radio objects, you can set a pointer to a boolean directly
24 * with elm_check_state_pointer_set() for it to modify.
25 *
26 * This widget inherits from the @ref Layout one, so that all the
27 * functions acting on it also work for check objects.
28 *
29 * This widget emits the following signals, besides the ones sent from
30 * @ref Layout:
31 * - @c "changed" - This is called whenever the user changes the state of
32 * the check objects (@p event_info is always @c NULL).
33 * - @c "focused" - When the check has received focus. (since 1.8)
34 * - @c "unfocused" - When the check has lost focus. (since 1.8)
35 * - @c "language,changed" - the program's language changed (since 1.9)
36 *
37 * Default content parts of the check widget that you can use for are:
38 * @li "icon" - An icon of the check
39 *
40 * Default text parts of the check widget that you can use for are:
41 * @li "default" - A label of the check
42 * @li "on" - On state label of the check (only valid for "toggle" style.)
43 * @li "off" - Off state label of the check (only valid for "toggle" style.)
44 *
45 * Supported elm_object common APIs.
46 * @li @ref elm_object_disabled_set
47 * @li @ref elm_object_disabled_get
48 * @li @ref elm_object_part_text_set
49 * @li @ref elm_object_part_text_get
50 * @li @ref elm_object_part_content_set
51 * @li @ref elm_object_part_content_get
52 * @li @ref elm_object_part_content_unset
53 * @li @ref elm_object_signal_emit
54 * @li @ref elm_object_signal_callback_add
55 * @li @ref elm_object_signal_callback_del
56 *
57 * @ref tutorial_check should give you a firm grasp of how to use this widget.
58 *
59 * @{
60 */
61
62#ifdef EFL_EO_API_SUPPORT
63#include "elm_check_eo.h"
64#endif
65#ifndef EFL_NOLEGACY_API_SUPPORT
66#include "elm_check_legacy.h"
67#endif
68/**
69 * @}
70 */