d5a3eb2a34d2ab8c8b333dcc9e5ea97133c499b5
[platform/upstream/elementary.git] / src / mobile_lib / elc_ctxpopup.h
1 /**
2  * @defgroup Ctxpopup Ctxpopup
3  * @ingroup elm_widget_group
4  *
5  * @image html ctxpopup_inheritance_tree.png
6  * @image latex ctxpopup_inheritance_tree.eps
7  *
8  *
9  * @brief Context popup widget.
10  *
11  * A ctxpopup is a widget that, when shown, pops up a list of items.
12  * It automatically chooses an area inside its parent object's view
13  * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
14  * optimally fit into it. In the default theme, it will also point an
15  * arrow to it's top left position at the time one shows it. Ctxpopup
16  * items have a label and/or an icon. It is intended for a small
17  * number of items (hence the use of list, not genlist).
18  *
19  * This widget inherits from the Layout one, so that all the
20  * functions acting on it also work for context popup objects (since 1.8).
21  *
22  * This widget emits the following signals, besides the ones sent from
23  * @ref Layout:
24  * - @c "dismissed" - This is called when 1. the outside of ctxpopup was clicked
25  * or 2. its parent area is changed or 3. the language is changed and also when
26  * 4. the parent object is resized due to the window rotation. Then ctxpopup is
27  * dismissed.
28  * - @c "language,changed" - This is called when the program's language is
29  * changed.
30  * - @c "focused" - When the ctxpopup has received focus. (since 1.8)
31  * - @c "unfocused" - When the ctxpopup has lost focus. (since 1.8)
32  * Default content parts of the ctxpopup widget that you can use for are:
33  * @li "default" - A content of the ctxpopup
34  *
35  * Default content parts of the ctxpopup items that you can use for are:
36  * @li "icon" - An icon in the title area
37  *
38  * Default text parts of the ctxpopup items that you can use for are:
39  * @li "default" - A title label in the title area
40  *
41  * Supported elm_object common APIs.
42  * @li @ref elm_object_disabled_set
43  * @li @ref elm_object_disabled_get
44  *
45  * Supported elm_object_item common APIs.
46  * @li @ref elm_object_item_del
47  * @li @ref elm_object_item_disabled_set
48  * @li @ref elm_object_item_disabled_get
49  * @li @ref elm_object_item_part_text_set
50  * @li @ref elm_object_item_part_text_get
51  * @li @ref elm_object_item_part_content_set
52  * @li @ref elm_object_item_part_content_get
53  * @li @ref elm_object_item_signal_emit
54  * @li @ref elm_object_item_focus_set
55  * @li @ref elm_object_item_focus_get
56  *
57  * @{
58  */
59
60 #ifdef EFL_EO_API_SUPPORT
61 #include "elc_ctxpopup_eo.h"
62 #endif
63 #ifndef EFL_NOLEGACY_API_SUPPORT
64 #include "elc_ctxpopup_legacy.h"
65 #endif
66 /**
67  * @}
68  */