summaryrefslogtreecommitdiff
path: root/src/lib/elementary/elc_ctxpopup.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/elc_ctxpopup.h
parent9340855597e7e465435c69b6278650346688da14 (diff)
elementary: move all legacy files to their expected new location.
Diffstat (limited to 'src/lib/elementary/elc_ctxpopup.h')
-rw-r--r--src/lib/elementary/elc_ctxpopup.h74
1 files changed, 74 insertions, 0 deletions
diff --git a/src/lib/elementary/elc_ctxpopup.h b/src/lib/elementary/elc_ctxpopup.h
new file mode 100644
index 0000000000..7d05a6882f
--- /dev/null
+++ b/src/lib/elementary/elc_ctxpopup.h
@@ -0,0 +1,74 @@
1/**
2 * @defgroup Elm_Ctxpopup Ctxpopup
3 * @ingroup Elementary
4 *
5 * @image html ctxpopup_inheritance_tree.png
6 * @image latex ctxpopup_inheritance_tree.eps
7 *
8 * @image html img/widget/ctxpopup/preview-00.png
9 * @image latex img/widget/ctxpopup/preview-00.eps
10 *
11 * @brief Context popup widget.
12 *
13 * A ctxpopup is a widget that, when shown, pops up a list of items.
14 * It automatically chooses an area inside its parent object's view
15 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
16 * optimally fit into it. In the default theme, it will also point an
17 * arrow to it's top left position at the time one shows it. Ctxpopup
18 * items have a label and/or an icon. It is intended for a small
19 * number of items (hence the use of list, not genlist).
20 *
21 * This widget inherits from the Layout one, so that all the
22 * functions acting on it also work for context popup objects (since 1.8).
23 *
24 * This widget emits the following signals, besides the ones sent from
25 * @ref Layout:
26 * - @c "dismissed" - This is called when 1. the outside of ctxpopup was clicked
27 * or 2. its parent area is changed or 3. the language is changed and also when
28 * 4. the parent object is resized due to the window rotation. Then ctxpopup is
29 * dismissed.
30 * - @c "language,changed" - This is called when the program's language is
31 * changed.
32 * - @c "focused" - When the ctxpopup has received focus. (since 1.8)
33 * - @c "unfocused" - When the ctxpopup has lost focus. (since 1.8)
34 * - @c "geometry,update" - When the ctxpopup geometry is updated. This smart event passes the ctxpopup geometry information with the given event_info argument which type is Evas_Coord_Rectangle. (since 1.18)
35
36 *
37 * Default content parts of the ctxpopup widget that you can use for are:
38 * @li "default" - A content of the ctxpopup
39 *
40 * Default content parts of the ctxpopup items that you can use for are:
41 * @li "icon" - An icon in the title area
42 *
43 * Default text parts of the ctxpopup items that you can use for are:
44 * @li "default" - A title label in the title area
45 *
46 * Supported elm_object common APIs.
47 * @li @ref elm_object_disabled_set
48 * @li @ref elm_object_disabled_get
49 *
50 * Supported elm_object_item common APIs.
51 * @li @ref elm_object_item_del
52 * @li @ref elm_object_item_disabled_set
53 * @li @ref elm_object_item_disabled_get
54 * @li @ref elm_object_item_part_text_set
55 * @li @ref elm_object_item_part_text_get
56 * @li @ref elm_object_item_part_content_set
57 * @li @ref elm_object_item_part_content_get
58 * @li @ref elm_object_item_signal_emit
59 * @li @ref elm_object_item_focus_set
60 * @li @ref elm_object_item_focus_get
61 *
62 * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
63 * @{
64 */
65
66#ifdef EFL_EO_API_SUPPORT
67#include "elc_ctxpopup_eo.h"
68#endif
69#ifndef EFL_NOLEGACY_API_SUPPORT
70#include "elc_ctxpopup_legacy.h"
71#endif
72/**
73 * @}
74 */