summaryrefslogtreecommitdiff
path: root/src/lib/elementary/elm_hover_eo.legacy.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/elementary/elm_hover_eo.legacy.h')
-rw-r--r--src/lib/elementary/elm_hover_eo.legacy.h88
1 files changed, 88 insertions, 0 deletions
diff --git a/src/lib/elementary/elm_hover_eo.legacy.h b/src/lib/elementary/elm_hover_eo.legacy.h
new file mode 100644
index 0000000..8f18695
--- /dev/null
+++ b/src/lib/elementary/elm_hover_eo.legacy.h
@@ -0,0 +1,88 @@
1#ifndef _ELM_HOVER_EO_LEGACY_H_
2#define _ELM_HOVER_EO_LEGACY_H_
3
4#ifndef _ELM_HOVER_EO_CLASS_TYPE
5#define _ELM_HOVER_EO_CLASS_TYPE
6
7typedef Eo Elm_Hover;
8
9#endif
10
11#ifndef _ELM_HOVER_EO_TYPES
12#define _ELM_HOVER_EO_TYPES
13
14/** The orientation axis for the hover object
15 *
16 * @ingroup Elm_Hover
17 */
18typedef enum
19{
20 ELM_HOVER_AXIS_NONE = 0, /**< ELM_HOVER_AXIS_NONE -- no preferred orientation.
21 */
22 ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal. */
23 ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical. */
24 ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both. */
25} Elm_Hover_Axis;
26
27
28#endif
29
30/**
31 * @brief Sets the target object for the hover.
32 *
33 * This function will cause the hover to be centered on the target object.
34 *
35 * @param[in] obj The object.
36 * @param[in] target The target object.
37 *
38 * @ingroup Elm_Hover_Group
39 */
40EAPI void elm_hover_target_set(Elm_Hover *obj, Efl_Canvas_Object *target);
41
42/**
43 * @brief Get the target object for the hover.
44 *
45 * @param[in] obj The object.
46 *
47 * @return The target object.
48 *
49 * @ingroup Elm_Hover_Group
50 */
51EAPI Efl_Canvas_Object *elm_hover_target_get(const Elm_Hover *obj);
52
53/**
54 * @brief Returns the best swallow location for content in the hover.
55 *
56 * Best is defined here as the location at which there is the most available
57 * space.
58 *
59 * @c pref_axis may be either #ELM_HOVER_AXIS_NONE (for no preferred
60 * orientation), #ELM_HOVER_AXIS_HORIZONTAL, #ELM_HOVER_AXIS_VERTICAL or
61 * #ELM_HOVER_AXIS_BOTH.
62 *
63 * If #ELM_HOVER_AXIS_HORIZONTAL is chosen the returned position will
64 * necessarily be along the horizontal axis("left" or "right"). If
65 * #ELM_HOVER_AXIS_VERTICAL is chosen the returned position will necessarily be
66 * along the vertical axis("top" or "bottom"). Choosing #ELM_HOVER_AXIS_BOTH or
67 * #ELM_HOVER_AXIS_NONE has the same effect and the returned position may be in
68 * either axis.
69 *
70 * See also @ref elm_object_part_content_set.
71 *
72 * @param[in] obj The object.
73 * @param[in] pref_axis The preferred orientation axis for the hover object to
74 * use
75 *
76 * @return Swallow location
77 *
78 * @ingroup Elm_Hover_Group
79 */
80EAPI const char *elm_hover_best_content_location_get(const Elm_Hover *obj, Elm_Hover_Axis pref_axis);
81
82/** Dismiss a hover object
83 *
84 * @ingroup Elm_Hover_Group
85 */
86EAPI void elm_hover_dismiss(Elm_Hover *obj);
87
88#endif