summaryrefslogtreecommitdiff
path: root/src/lib/elementary/efl_ui_flip_eo.legacy.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/elementary/efl_ui_flip_eo.legacy.h')
-rw-r--r--src/lib/elementary/efl_ui_flip_eo.legacy.h140
1 files changed, 140 insertions, 0 deletions
diff --git a/src/lib/elementary/efl_ui_flip_eo.legacy.h b/src/lib/elementary/efl_ui_flip_eo.legacy.h
new file mode 100644
index 0000000..a8993e3
--- /dev/null
+++ b/src/lib/elementary/efl_ui_flip_eo.legacy.h
@@ -0,0 +1,140 @@
1#ifndef _EFL_UI_FLIP_EO_LEGACY_H_
2#define _EFL_UI_FLIP_EO_LEGACY_H_
3
4/**
5 * @brief Set the interactive flip mode.
6 *
7 * This sets if the flip should be interactive (allow user to click and drag a
8 * side of the flip to reveal the back page and cause it to flip). By default a
9 * flip is not interactive. You may also need to set which sides of the flip
10 * are "active" for flipping and how much space they use (a minimum of a finger
11 * size) with @ref Efl.Ui.Flip.interaction_direction_enabled_set and
12 * @ref Efl.Ui.Flip.interaction_direction_hitsize_set.
13 *
14 * The four available mode of interaction are #ELM_FLIP_INTERACTION_NONE,
15 * #ELM_FLIP_INTERACTION_ROTATE, #ELM_FLIP_INTERACTION_CUBE and
16 * #ELM_FLIP_INTERACTION_PAGE.
17 *
18 * @note #ELM_FLIP_INTERACTION_ROTATE won't cause
19 * #ELM_FLIP_ROTATE_XZ_CENTER_AXIS or #ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
20 * happen, those can only be achieved with @ref elm_flip_go.
21 *
22 * @param[in] obj The object.
23 * @param[in] mode The interactive flip mode to use.
24 *
25 * @ingroup Elm_Flip_Group
26 */
27EAPI void elm_flip_interaction_set(Eo *obj, Elm_Flip_Interaction mode);
28
29/**
30 * @brief Get the interactive flip mode.
31 *
32 * @param[in] obj The object.
33 *
34 * @return The interactive flip mode to use.
35 *
36 * @ingroup Elm_Flip_Group
37 */
38EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Eo *obj);
39
40/**
41 * @brief Get flip front visibility state.
42 *
43 * @param[in] obj The object.
44 *
45 * @return @c true if front front is showing, @c false if the back is showing.
46 *
47 * @ingroup Elm_Flip_Group
48 */
49EAPI Eina_Bool elm_flip_front_visible_get(const Eo *obj);
50
51
52
53
54
55/**
56 * @brief Runs the flip animation.
57 *
58 * Flips the front and back contents using the @c mode animation. This
59 * effectively hides the currently visible content and shows the hidden one.
60 *
61 * There a number of possible animations to use for flipping, namely
62 * #ELM_FLIP_ROTATE_X_CENTER_AXIS (rotate the currently visible content around
63 * a horizontal axis in the middle of its height, the other content is shown as
64 * the other side of the flip), #ELM_FLIP_ROTATE_Y_CENTER_AXIS (rotate the
65 * currently visible content around a vertical axis in the middle of its width,
66 * the other content is shown as the other side of the flip),
67 * #ELM_FLIP_ROTATE_XZ_CENTER_AXIS (rotate the currently visible content around
68 * a diagonal axis in the middle of its width, the other content is shown as
69 * the other side of the flip), #ELM_FLIP_ROTATE_YZ_CENTER_AXIS (rotate the
70 * currently visible content around a diagonal axis in the middle of its
71 * height, the other content is shown as the other side of the flip).
72 * #ELM_FLIP_CUBE_LEFT (rotate the currently visible content to the left as if
73 * the flip was a cube, the other content is shown as the right face of the
74 * cube), #ELM_FLIP_CUBE_RIGHT (rotate the currently visible content to the
75 * right as if the flip was a cube, the other content is shown as the left face
76 * of the cube), #ELM_FLIP_CUBE_UP (rotate the currently visible content up as
77 * if the flip was a cube, the other content is shown as the bottom face of the
78 * cube), #ELM_FLIP_CUBE_DOWN (rotate the currently visible content down as if
79 * the flip was a cube, the other content is shown as the upper face of the
80 * cube), #ELM_FLIP_PAGE_LEFT (move the currently visible content to the left
81 * as if the flip was a book, the other content is shown as the page below
82 * that), #ELM_FLIP_PAGE_RIGHT (move the currently visible content to the right
83 * as if the flip was a book, the other content is shown as the page below it),
84 * #ELM_FLIP_PAGE_UP (move the currently visible content up as if the flip was
85 * a book, the other content is shown as the page below it),
86 * #ELM_FLIP_PAGE_DOWN (move the currently visible content down as if the flip
87 * was a book, the other content is shown as the page below that) and
88 * #ELM_FLIP_CROSS_FADE (fade out the currently visible content, while fading
89 * in the invisible content).
90 *
91 * @param[in] obj The object.
92 * @param[in] mode The mode type.
93 *
94 * @ingroup Elm_Flip_Group
95 */
96EAPI void elm_flip_go(Eo *obj, Elm_Flip_Mode mode);
97
98/**
99 * @brief Runs the flip animation to front or back.
100 *
101 * Flips the front and back contents using the @c mode animation. This
102 * effectively hides the currently visible content and shows he hidden one.
103 *
104 * There a number of possible animations to use for flipping, namely
105 * #ELM_FLIP_ROTATE_X_CENTER_AXIS (rotate the currently visible content around
106 * a horizontal axis in the middle of its height, the other content is shown as
107 * the other side of the flip), #ELM_FLIP_ROTATE_Y_CENTER_AXIS (rotate the
108 * currently visible content around a vertical axis in the middle of its width,
109 * the other content is shown as the other side of the flip),
110 * #ELM_FLIP_ROTATE_XZ_CENTER_AXIS (rotate the currently visible content around
111 * a diagonal axis in the middle of its width, the other content is shown as
112 * the other side of the flip), #ELM_FLIP_ROTATE_YZ_CENTER_AXIS (rotate the
113 * currently visible content around a diagonal axis in the middle of its
114 * height, the other content is shown as the other side of the flip).
115 * #ELM_FLIP_CUBE_LEFT (rotate the currently visible content to the left as if
116 * the flip was a cube, the other content is show as the right face of the
117 * cube), #ELM_FLIP_CUBE_RIGHT (rotate the currently visible content to the
118 * right as if the flip was a cube, the other content is show as the left face
119 * of the cube), #ELM_FLIP_CUBE_UP (rotate the currently visible content up as
120 * if the flip was a cube, the other content is shown as the bottom face of the
121 * cube), #ELM_FLIP_CUBE_DOWN (rotate the currently visible content down as if
122 * the flip was a cube, the other content is shown as the upper face of the
123 * cube), #ELM_FLIP_PAGE_LEFT (move the currently visible content to the left
124 * as if the flip was a book, the other content is shown as the page below
125 * that), #ELM_FLIP_PAGE_RIGHT (move the currently visible content to the right
126 * as if the flip was a book, the other content is shown as the page below it),
127 * #ELM_FLIP_PAGE_UP (move the currently visible content up as if the flip was
128 * a book, the other content is shown as the page below it) and
129 * #ELM_FLIP_PAGE_DOWN (move the currently visible content down as if the flip
130 * was a book, the other content is shown as the page below that).
131 *
132 * @param[in] obj The object.
133 * @param[in] front If @c true, makes front visible, otherwise makes back.
134 * @param[in] mode The mode type.
135 *
136 * @ingroup Elm_Flip_Group
137 */
138EAPI void elm_flip_go_to(Eo *obj, Eina_Bool front, Elm_Flip_Mode mode);
139
140#endif