summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Kolesa <d.kolesa@osg.samsung.com>2015-08-07 13:30:06 +0100
committerDaniel Kolesa <d.kolesa@osg.samsung.com>2015-08-07 13:30:50 +0100
commit3548e0b4d5fed67eb1aeba77fede444e3fc77ae8 (patch)
treec28576e3dfa4646a597a79ee31d4c53b3064afea
parentc32c71ad0035afa9c41e2d527c3573def75d8b6f (diff)
flip: convert docs
-rw-r--r--src/lib/elm_flip.eo339
1 files changed, 146 insertions, 193 deletions
diff --git a/src/lib/elm_flip.eo b/src/lib/elm_flip.eo
index d41b367cd..77819bd38 100644
--- a/src/lib/elm_flip.eo
+++ b/src/lib/elm_flip.eo
@@ -39,237 +39,190 @@ class Elm.Flip (Elm.Container)
39 methods { 39 methods {
40 @property interaction { 40 @property interaction {
41 set { 41 set {
42 /*@ 42 [[Set the interactive flip mode.
43 @brief Set the interactive flip mode 43
44 44 This sets if the flip should be interactive (allow user to
45 This sets if the flip should be interactive (allow user to click and 45 click and drag a side of the flip to reveal the back page
46 drag a side of the flip to reveal the back page and cause it to flip). 46 and cause it to flip). By default a flip is not interactive.
47 By default a flip is not interactive. You may also need to set which 47 You may also need to set which sides of the flip are "active"
48 sides of the flip are "active" for flipping and how much space they use 48 for flipping and how much space they use (a minimum of a
49 (a minimum of a finger size) with elm_flip_interaction_direction_enabled_set() 49 finger size) with \@ref @.interaction_direction_enabled_set
50 and elm_flip_interaction_direction_hitsize_set() 50 and @.interaction_direction_hitsize_set.
51 51
52 The four available mode of interaction are: 52 The four available mode of interaction are
53 @li #ELM_FLIP_INTERACTION_NONE - No interaction is allowed 53 #ELM_FLIP_INTERACTION_NONE, #ELM_FLIP_INTERACTION_ROTATE,
54 @li #ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation 54 #ELM_FLIP_INTERACTION_CUBE and #ELM_FLIP_INTERACTION_PAGE.
55 @li #ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation 55
56 @li #ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation 56 Note: #ELM_FLIP_INTERACTION_ROTATE won't cause
57 57 #ELM_FLIP_ROTATE_XZ_CENTER_AXIS or #ELM_FLIP_ROTATE_YZ_CENTER_AXIS
58 @note #ELM_FLIP_INTERACTION_ROTATE won't cause 58 to happen, those can only be achieved with @.go.
59 #ELM_FLIP_ROTATE_XZ_CENTER_AXIS or #ELM_FLIP_ROTATE_YZ_CENTER_AXIS to 59 ]]
60 happen, those can only be achieved with elm_flip_go();
61
62 @ingroup Flip */
63 } 60 }
64 get { 61 get {
65 /*@ 62 [[Get the interactive flip mode.]]
66 @brief Get the interactive flip mode
67
68 @return The interactive flip mode
69
70 Returns the interactive flip mode set by elm_flip_interaction_set()
71
72 @ingroup Flip */
73 } 63 }
74 values { 64 values {
75 mode: Elm.Flip.Interaction; /*@ The interactive flip mode to use */ 65 mode: Elm.Flip.Interaction; [[The interactive flip mode to use.]]
76 } 66 }
77 } 67 }
78 @property front_visible { 68 @property front_visible {
79 get { 69 get {
80 /*@ 70 [[Get flip front visibility state.]]
81 @brief Get flip front visibility state 71 return: bool; [[$true if front front is showing, $false if
82 72 the back is showing.]]
83 @return true if front front is showing, false if the back is
84 showing.
85
86 @ingroup Flip */
87 return: bool;
88 } 73 }
89 } 74 }
90 interaction_direction_hitsize_set { 75 interaction_direction_hitsize_set {
91 /*@ 76 [[Set the amount of the flip that is sensitive to interactive flip.
92 @brief Set the amount of the flip that is sensitive to interactive flip
93 77
94 Set the amount of the flip that is sensitive to interactive flip, with 0 78 Set the amount of the flip that is sensitive to interactive flip,
95 representing no area in the flip and 1 representing the entire flip. There 79 with 0 representing no area in the flip and 1 representing the
96 is however a consideration to be made in that the area will never be 80 entire flip. There is however a consideration to be made in that
97 smaller than the finger size set (as set in your Elementary configuration), 81 the area will never be smaller than the finger size set (as set
98 and dragging must always start from the opposite half of the flip (eg. right 82 in your Elementary configuration), and dragging must always start
99 half of the flip when dragging to the left). 83 from the opposite half of the flip (eg. right half of the flip
84 when dragging to the left).
100 85
101 Note that the $dir parameter is not actually related to the direction of 86 Note: The $dir parameter is not actually related to the direction
102 the drag, it only refers to the area in the flip where interaction can 87 of the drag, it only refers to the area in the flip where
103 occur (top, bottom, left, right). 88 interaction can occur (top, bottom, left, right).
104 89
105 Negative values of $hitsize will disable this hit area. 90 Negative values of $hitsize will disable this hit area.
106
107 @see elm_flip_interaction_set()
108
109 @ingroup Flip */
110 91
92 See also @.interaction.set.
93 ]]
111 params { 94 params {
112 @in dir: Elm.Flip.Direction; /*@ The hit area to set */ 95 @in dir: Elm.Flip.Direction; [[The hit area to set.]]
113 @in hitsize: double; /*@ The amount of that dimension (0.0 to 1.0) to use */ 96 @in hitsize: double; [[The amount of that dimension (0.0 to 1.0) to use.]]
114 } 97 }
115 } 98 }
116 interaction_direction_hitsize_get { 99 interaction_direction_hitsize_get {
117 /*@ 100 [[Get the amount of the flip that is sensitive to interactive flip.]]
118 @brief Get the amount of the flip that is sensitive to interactive flip 101 return: double; [[The size set for that direction.]]
119
120 @return The size set for that direction
121
122 Returns the amount of sensitive area set by
123 elm_flip_interaction_direction_hitsize_set().
124
125 @ingroup Flip */
126
127 return: double;
128 params { 102 params {
129 @in dir: Elm.Flip.Direction; /*@ The direction to check */ 103 @in dir: Elm.Flip.Direction; [[The direction to check.]]
130 } 104 }
131 } 105 }
132 interaction_direction_enabled_set { 106 interaction_direction_enabled_set {
133 /*@ 107 [[Set which directions of the flip respond to interactive flip
134 @brief Set which directions of the flip respond to interactive flip
135
136 By default all directions are disabled, so you may want to enable the
137 desired directions for flipping if you need interactive flipping. You must
138 call this function once for each direction that should be enabled.
139
140 You can also set the appropriate hit area size by calling
141 $elm_flip_interaction_direction_hitsize_set(). By default, a minimum
142 hit area will be created on the opposite edge of the flip.
143
144 @see elm_flip_interaction_set()
145 108
146 @ingroup Flip */ 109 By default all directions are disabled, so you may want to
110 enable the desired directions for flipping if you need
111 interactive flipping. You must call this function once for
112 each direction that should be enabled.
147 113
114 You can also set the appropriate hit area size by calling
115 @.interaction_direction_hitsize_set. By default, a minimum
116 hit area will be created on the opposite edge of the flip.
117 ]]
148 params { 118 params {
149 @in dir: Elm.Flip.Direction; /*@ The direction to change */ 119 @in dir: Elm.Flip.Direction; [[The direction to change.]]
150 @in enabled: bool; /*@ If that direction is enabled or not */ 120 @in enabled: bool; [[If that direction is enabled or not.]]
151 } 121 }
152 } 122 }
153 interaction_direction_enabled_get { 123 interaction_direction_enabled_get {
154 /*@ 124 [[Get the enabled state of that flip direction.]]
155 @brief Get the enabled state of that flip direction 125 return: bool; [[If that direction is enabled or not.]]
156
157 @return If that direction is enabled or not
158
159 Get the enabled state set by elm_flip_interaction_direction_enabled_set()
160
161 @see elm_flip_interaction_set()
162
163 @ingroup Flip */
164
165 return: bool;
166 params { 126 params {
167 @in dir: Elm.Flip.Direction; /*@ The direction to check */ 127 @in dir: Elm.Flip.Direction; [[The direction to check.]]
168 } 128 }
169 } 129 }
170 go { 130 go {
171 /*@ 131 [[Runs the flip animation.
172 @brief Runs the flip animation 132
173 133 Flips the front and back contents using the $mode animation.
174 Flips the front and back contents using the $mode animation. This 134 This effectively hides the currently visible content and shows
175 effectively hides the currently visible content and shows the hidden one. 135 the hidden one.
176 136
177 There a number of possible animations to use for the flipping: 137 There a number of possible animations to use for the flipping,
178 @li #ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content 138 these being #ELM_FLIP_ROTATE_X_CENTER_AXIS (rotate the currently
179 around a horizontal axis in the middle of its height, the other content 139 visible content around a horizontal axis in the middle of its
180 is shown as the other side of the flip. 140 height, the other content is shown as the other side of the flip),
181 @li #ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content 141 #ELM_FLIP_ROTATE_Y_CENTER_AXIS (rotate the currently visible
182 around a vertical axis in the middle of its width, the other content is 142 content around a vertical axis in the middle of its width, the
183 shown as the other side of the flip. 143 other content is shown as the other side of the flip),
184 @li #ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content 144 #ELM_FLIP_ROTATE_XZ_CENTER_AXIS (rotate the currently visible
185 around a diagonal axis in the middle of its width, the other content is 145 content around a diagonal axis in the middle of its width, the
186 shown as the other side of the flip. 146 other content is shown as the other side of the flip),
187 @li #ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content 147 #ELM_FLIP_ROTATE_YZ_CENTER_AXIS (rotate the currently visible
188 around a diagonal axis in the middle of its height, the other content is 148 content around a diagonal axis in the middle of its height, the
189 shown as the other side of the flip. 149 other content is hown as the other side of the flip).
190 @li #ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left 150 #ELM_FLIP_CUBE_LEFT (rotate the currently visible content to the
191 as if the flip was a cube, the other content is show as the right face of 151 left as if the flip was a cube, the other content is show as the
192 the cube. 152 right face of the cube), #ELM_FLIP_CUBE_RIGHT (rotate the
193 @li #ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the 153 currently visible content to the right as if the flip was a
194 right as if the flip was a cube, the other content is show as the left 154 cube, the other content is show as the left face of the cube),
195 face of the cube. 155 #ELM_FLIP_CUBE_UP (rotate the currently visible content up as if
196 @li #ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the 156 the flip was a cube, the other content is show as the bottom face
197 flip was a cube, the other content is show as the bottom face of the cube. 157 of the cube), #ELM_FLIP_CUBE_DOWN (rotate the currently visible
198 @li #ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if 158 content down as if the flip was a cube, the other content is show
199 the flip was a cube, the other content is show as the upper face of the 159 as the upper face of the cube), #ELM_FLIP_PAGE_LEFT (move the
200 cube. 160 currently visible content to the left as if the flip was a book,
201 @li #ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as 161 the other content is shown as the page below that),
202 if the flip was a book, the other content is shown as the page below that. 162 #ELM_FLIP_PAGE_RIGHT (move the currently visible content to the
203 @li #ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right 163 right s if the flip was a book, the other content is shown as the
204 as if the flip was a book, the other content is shown as the page below 164 page below that), #ELM_FLIP_PAGE_UP (move the currently visible
205 that. 165 content up as if the flip was a book, the other content is shown
206 @li #ELM_FLIP_PAGE_UP - Move the currently visible content up as if the 166 as the page below that) and #ELM_FLIP_PAGE_DOWN (move the
207 flip was a book, the other content is shown as the page below that. 167 currently visible content down as if the flip was a book, the
208 @li #ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the 168 other content is shown as the page below that).
209 flip was a book, the other content is shown as the page below that. 169 ]]
210 170 /* FIXME-doc
211 @image html elm_flip.png 171 * @image html elm_flip.png
212 @image latex elm_flip.eps width=\textwidth 172 * @image latex elm_flip.eps width=\textwidth
213 173 */
214 @see elm_flip_go_to()
215
216 @ingroup Flip */
217
218 params { 174 params {
219 @in mode: Elm.Flip.Mode; /*@ The mode type */ 175 @in mode: Elm.Flip.Mode; [[The mode type.]]
220 } 176 }
221 } 177 }
222 go_to { 178 go_to {
223 /*@ 179 [[Runs the flip animation to front or back.
224 @brief Runs the flip animation to front or back. 180
225 181 Flips the front and back contents using the $mode animation.
226 Flips the front and back contents using the $mode animation. This 182 This effectively hides the currently visible content and shows
227 effectively hides the currently visible content and shows the hidden one. 183 he hidden one.
228 184
229 There a number of possible animations to use for the flipping: 185 There a number of possible animations to use for the flipping,
230 @li #ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content 186 these being #ELM_FLIP_ROTATE_X_CENTER_AXIS (rotate the currently
231 around a horizontal axis in the middle of its height, the other content 187 visible content around a horizontal axis in the middle of its
232 is shown as the other side of the flip. 188 height, the other content is shown as the other side of the flip),
233 @li #ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content 189 #ELM_FLIP_ROTATE_Y_CENTER_AXIS (rotate the currently visible
234 around a vertical axis in the middle of its width, the other content is 190 content around a vertical axis in the middle of its width, the
235 shown as the other side of the flip. 191 other content is shown as the other side of the flip),
236 @li #ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content 192 #ELM_FLIP_ROTATE_XZ_CENTER_AXIS (rotate the currently visible
237 around a diagonal axis in the middle of its width, the other content is 193 content around a diagonal axis in the middle of its width, the
238 shown as the other side of the flip. 194 other content is shown as the other side of the flip),
239 @li #ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content 195 #ELM_FLIP_ROTATE_YZ_CENTER_AXIS (rotate the currently visible
240 around a diagonal axis in the middle of its height, the other content is 196 content around a diagonal axis in the middle of its height, the
241 shown as the other side of the flip. 197 other content is hown as the other side of the flip).
242 @li #ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left 198 #ELM_FLIP_CUBE_LEFT (rotate the currently visible content to the
243 as if the flip was a cube, the other content is show as the right face of 199 left as if the flip was a cube, the other content is show as the
244 the cube. 200 right face of the cube), #ELM_FLIP_CUBE_RIGHT (rotate the
245 @li #ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the 201 currently visible content to the right as if the flip was a
246 right as if the flip was a cube, the other content is show as the left 202 cube, the other content is show as the left face of the cube),
247 face of the cube. 203 #ELM_FLIP_CUBE_UP (rotate the currently visible content up as if
248 @li #ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the 204 the flip was a cube, the other content is show as the bottom face
249 flip was a cube, the other content is show as the bottom face of the cube. 205 of the cube), #ELM_FLIP_CUBE_DOWN (rotate the currently visible
250 @li #ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if 206 content down as if the flip was a cube, the other content is show
251 the flip was a cube, the other content is show as the upper face of the 207 as the upper face of the cube), #ELM_FLIP_PAGE_LEFT (move the
252 cube. 208 currently visible content to the left as if the flip was a book,
253 @li #ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as 209 the other content is shown as the page below that),
254 if the flip was a book, the other content is shown as the page below that. 210 #ELM_FLIP_PAGE_RIGHT (move the currently visible content to the
255 @li #ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right 211 right s if the flip was a book, the other content is shown as the
256 as if the flip was a book, the other content is shown as the page below 212 page below that), #ELM_FLIP_PAGE_UP (move the currently visible
257 that. 213 content up as if the flip was a book, the other content is shown
258 @li #ELM_FLIP_PAGE_UP - Move the currently visible content up as if the 214 as the page below that) and #ELM_FLIP_PAGE_DOWN (move the
259 flip was a book, the other content is shown as the page below that. 215 currently visible content down as if the flip was a book, the
260 @li #ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the 216 other content is shown as the page below that).
261 flip was a book, the other content is shown as the page below that. 217 ]]
262 218 /* FIXME-doc
263 @image html elm_flip.png 219 * @image html elm_flip.png
264 @image latex elm_flip.eps width=\textwidth 220 * @image latex elm_flip.eps width=\textwidth
265 221 */
266 @since 1.7
267
268 @ingroup Flip */
269
270 params { 222 params {
271 @in front: bool; /*@ if $true, makes front visible, otherwise makes back. */ 223 @in front: bool; [[If $true, makes front visible, otherwise
272 @in mode: Elm.Flip.Mode; /*@ The mode type */ 224 makes back.]]
225 @in mode: Elm.Flip.Mode; [[The mode type.]]
273 } 226 }
274 } 227 }
275 } 228 }