summaryrefslogtreecommitdiff
path: root/src/lib/elementary/elm_radio.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_radio.h
parent9340855597e7e465435c69b6278650346688da14 (diff)
elementary: move all legacy files to their expected new location.
Diffstat (limited to 'src/lib/elementary/elm_radio.h')
-rw-r--r--src/lib/elementary/elm_radio.h75
1 files changed, 75 insertions, 0 deletions
diff --git a/src/lib/elementary/elm_radio.h b/src/lib/elementary/elm_radio.h
new file mode 100644
index 0000000..be1fad2
--- /dev/null
+++ b/src/lib/elementary/elm_radio.h
@@ -0,0 +1,75 @@
1/**
2 * @defgroup Elm_Radio Radio
3 * @ingroup Elementary
4 *
5 * @image html radio_inheritance_tree.png
6 * @image latex radio_inheritance_tree.eps
7 *
8 * @image html img/widget/radio/preview-00.png
9 * @image latex img/widget/radio/preview-00.eps
10 *
11 * @brief Radio is a widget that allows for 1 or more options to be displayed
12 * and have the user choose only 1 of them.
13 *
14 * A radio object contains an indicator, an optional Label and an optional
15 * icon object. While it's possible to have a group of only one radio they,
16 * are normally used in groups of 2 or more.
17 *
18 * elm_radio objects are grouped in a slightly different, compared to other
19 * UI toolkits. There is no separate group name/id to remember or manage.
20 * The members represent the group, there are the group. To make a group,
21 * use elm_radio_group_add() and pass existing radio object and the new radio
22 * object.
23 *
24 * The radio object(s) will select from one of a set
25 * of integer values, so any value they are configuring needs to be mapped to
26 * a set of integers. To configure what value that radio object represents,
27 * use elm_radio_state_value_set() to set the integer it represents. To set
28 * the value the whole group(which one is currently selected) is to indicate
29 * use elm_radio_value_set() on any group member, and to get the groups value
30 * use elm_radio_value_get(). For convenience the radio objects are also able
31 * to directly set an integer(int) to the value that is selected. To specify
32 * the pointer to this integer to modify, use elm_radio_value_pointer_set().
33 * The radio objects will modify this directly. That implies the pointer must
34 * point to valid memory for as long as the radio objects exist.
35 *
36 * This widget inherits from the @ref Layout one, so that all the
37 * functions acting on it also work for radio objects.
38 *
39 * This widget emits the following signals, besides the ones sent from
40 * @ref Layout:
41 * @li @c "changed" - This is called when the radio object is selected. If you
42 * want to trace the state change of a radio group, you should add this callback
43 * to all the radio objects in that group.
44 * @li @c "focused" - When the radio has received focus. (since 1.8)
45 * @li @c "unfocused" - When the radio has lost focus. (since 1.8)
46 * @li @c "language,changed" - the program's language changed (since 1.9)
47 *
48 * Default content parts of the radio widget that you can use for are:
49 * @li "icon" - An icon of the radio
50 *
51 * Default text parts of the radio widget that you can use for are:
52 * @li "default" - A label of the radio
53 *
54 * Supported elm_object common APIs.
55 * @li @ref elm_object_part_text_set
56 * @li @ref elm_object_part_text_get
57 * @li @ref elm_object_part_content_set
58 * @li @ref elm_object_part_content_get
59 * @li @ref elm_object_part_content_unset
60 * @li @ref elm_object_disabled_set
61 * @li @ref elm_object_disabled_get
62 *
63 * @ref tutorial_radio show most of this API in action.
64 * @{
65 */
66
67#ifdef EFL_EO_API_SUPPORT
68#include "elm_radio_eo.h"
69#endif
70#ifndef EFL_NOLEGACY_API_SUPPORT
71#include "elm_radio_legacy.h"
72#endif
73/**
74 * @}
75 */