summaryrefslogtreecommitdiff
path: root/legacy/elementary/src/lib/elm_layout.eo
diff options
context:
space:
mode:
authorDaniel Kolesa <d.kolesa@osg.samsung.com>2015-08-13 14:21:49 +0100
committerDaniel Kolesa <d.kolesa@osg.samsung.com>2015-08-13 14:21:49 +0100
commitcddca56dc11c4c572cac7958c40c86b5daf3f342 (patch)
treec9b8d6197dbb2068097a72b4c3776b4d732f372c /legacy/elementary/src/lib/elm_layout.eo
parent86e4264c3b97c787ea76c6e9140c2871577cd9fb (diff)
layout: convert docs
Diffstat (limited to 'legacy/elementary/src/lib/elm_layout.eo')
-rw-r--r--legacy/elementary/src/lib/elm_layout.eo665
1 files changed, 248 insertions, 417 deletions
diff --git a/legacy/elementary/src/lib/elm_layout.eo b/legacy/elementary/src/lib/elm_layout.eo
index 56c0e7569a..49d1b3b3ff 100644
--- a/legacy/elementary/src/lib/elm_layout.eo
+++ b/legacy/elementary/src/lib/elm_layout.eo
@@ -5,58 +5,45 @@ class Elm.Layout (Elm.Container, Efl.File)
5 methods { 5 methods {
6 @property edje_object_can_access { 6 @property edje_object_can_access {
7 set { 7 set {
8 /*@ 8 [[Set accessibility to all texblock(text) parts in the layout
9 Set accessibility to all texblock(text) parts in the layout object 9 object.
10 10
11 @return $true on success or $false on failure. If $obj is not 11 @since 1.7
12 a proper layout object, $false is returned. 12 ]]
13 13 return: bool; [[$true on success or $false on failure. If $obj
14 @since 1.7 14 is not a proper layout object, $false is returned.]]
15
16 @ingroup Layout */
17 return: bool;
18 } 15 }
19 get { 16 get {
20 /*@ 17 [[Get accessibility state of texblock(text) parts in the layout
21 Get accessibility state of texblock(text) parts in the layout object 18 object
22
23 @return $true, if all textblock(text) parts in the layout can be accessible
24 $EINA_FALSET if those cannot be accessible. If $obj is not a proper layout
25 object, $false is returned.
26
27 @see elm_layout_edje_object_access_set()
28
29 @since 1.7
30 19
31 @ingroup Layout */ 20 @since 1.7
21 ]]
32 } 22 }
33 values { 23 values {
34 can_access: bool; /*@ makes all textblock(text) parts in the layout $obj possible 24 can_access: bool; [[Makes all textblock(text) parts in the layout
35 to have accessibility. $true means textblock(text) parts can be accessible */ 25 $obj possible to have accessibility. $true
26 means textblock(text) parts can be accessible.]]
36 } 27 }
37 } 28 }
38 @property theme { 29 @property theme {
39 set { 30 set {
40 /*@ 31 [[Set the edje group from the elementary theme that will be used
41 Set the edje group from the elementary theme that will be used as layout 32 as layout.
42 33
43 @return (1 = success, 0 = error) 34 Note that $style will be the new style of $obj too, as in an
44 35 \@ref elm_object_style_set call.
45 Note that @a style will be the new style of @a obj too, as in an 36 ]]
46 elm_object_style_set() call.
47
48 @ingroup Layout */
49 return: bool; 37 return: bool;
50 } 38 }
51 values { 39 values {
52 klass: const(char)*; /*@ the class of the group */ 40 klass: const(char)*; [[The class of the group.]]
53 group: const(char)*; /*@ the group */ 41 group: const(char)*; [[The group.]]
54 style: const(char)*; /*@ the style to used */ 42 style: const(char)*; [[The style to used.]]
55 } 43 }
56 } 44 }
57 @property text_aliases { 45 @property text_aliases {
58 get { 46 get {
59 /*@ No description supplied by the EAPI. */
60 legacy: null; 47 legacy: null;
61 } 48 }
62 values { 49 values {
@@ -65,7 +52,6 @@ class Elm.Layout (Elm.Container, Efl.File)
65 } 52 }
66 @property content_aliases { 53 @property content_aliases {
67 get { 54 get {
68 /*@ No description supplied by the EAPI. */
69 legacy: null; 55 legacy: null;
70 } 56 }
71 values { 57 values {
@@ -74,357 +60,249 @@ class Elm.Layout (Elm.Container, Efl.File)
74 } 60 }
75 @property edje { 61 @property edje {
76 get { 62 get {
77 /*@ 63 [[Get the edje layout
78 Get the edje layout
79
80 @return A Evas_Object with the edje layout settings loaded
81 with function elm_layout_file_set
82 64
83 This returns the edje object. It is not expected to be used to then 65 This returns the edje object. It is not expected to be used
84 swallow objects via edje_object_part_swallow() for example. Use 66 to then swallow objects via \@ref edje_object_part_swallow
85 elm_layout_content_set() instead so child object handling and sizing is 67 for example. Use \@ref elm_layout_content_set instead so
86 done properly. 68 child object handling and sizing is done properly.
87 69
88 @note This function should only be used if you really need to call some 70 Note: This function should only be used if you really need
89 low level Edje function on this edje object. All the common stuff (setting 71 to call some low level Edje function on this edje object.
90 text, emitting signals, hooking callbacks to signals, etc.) can be done 72 All the common stuff (setting text, emitting signals,
91 with proper elementary functions. 73 hooking callbacks to signals, etc.) can be done with
92 74 proper elementary functions.
93 @see elm_layout_signal_callback_add() 75 ]]
94 @see elm_layout_signal_emit() 76 return: Evas.Object *; [[An Evas_Object with the edje layout
95 @see elm_layout_text_set() 77 settings loaded \@ref elm_layout_file_set.]]
96 @see elm_layout_content_set()
97 @see elm_layout_box_append()
98 @see elm_layout_table_pack()
99 @see elm_layout_data_get()
100
101 @ingroup Layout */
102 return: Evas.Object *;
103 } 78 }
104 } 79 }
105 box_remove_all { 80 box_remove_all {
106 /*@ 81 [[Remove all children of the given part box.
107 Remove all children of the given part box.
108
109 @return $true on success, $false otherwise
110
111 The objects will be removed from the box part and their lifetime will
112 not be handled by the layout anymore. This is equivalent to
113 elm_layout_box_remove() for all box children.
114
115 @see elm_layout_box_append()
116 @see elm_layout_box_remove()
117
118 @ingroup Layout */
119 82
83 The objects will be removed from the box part and their lifetime
84 will not be handled by the layout anymore. This is equivalent to
85 @.box_remove for all box children.
86 ]]
120 return: bool; 87 return: bool;
121 params { 88 params {
122 @in part: const(char)*; /*@ The box part name to remove child. */ 89 @in part: const(char)*; [[The box part name to remove child.]]
123 @in clear: bool; /*@ If true, then all objects will be deleted as 90 @in clear: bool; [[If true, then all objects will be deleted as
124 well, otherwise they will just be removed and will be 91 well, otherwise they will just be removed and
125 dangling on the canvas. */ 92 will be dangling on the canvas.]]
126 } 93 }
127 } 94 }
128 part_cursor_engine_only_set { 95 part_cursor_engine_only_set {
129 /*@ 96 [[Sets if the cursor set should be searched on the theme or should
130 Sets if the cursor set should be searched on the theme or should use 97 use the provided by the engine, only.
131 the provided by the engine, only. 98
132 99 Note: Before you set if should look on theme you should define a
133 @note before you set if should look on theme you should define a 100 cursor with @.part_cursor_set. By default it will only look for
134 cursor with elm_layout_part_cursor_set(). By default it will only 101 cursors provided by the engine.
135 look for cursors provided by the engine. 102 ]]
136 103 return: bool; [[$true on success or $false on failure, that may be
137 @return true on success or false on failure, that may be 104 part not exists or it did not had a cursor set.]]
138 part not exists or it did not had a cursor set.
139
140 @ingroup Layout */
141
142 return: bool;
143 params { 105 params {
144 @in part_name: const(char)*; /*@ a part from loaded edje group. */ 106 @in part_name: const(char)*; [[A part from loaded edje group.]]
145 @in engine_only: bool; /*@ if cursors should be just provided by the engine (true) 107 @in engine_only: bool; [[If cursors should be just provided by
146 or should also search on widget's theme as well (false) */ 108 the engine ($true) or should also search
109 on widget's theme as well ($false)]]
147 } 110 }
148 } 111 }
149 part_cursor_engine_only_get @const { 112 part_cursor_engine_only_get @const {
150 /*@ 113 [[Get a specific cursor engine_only for an edje part.]]
151 Get a specific cursor engine_only for an edje part. 114 return: bool; [[Whenever the cursor is just provided by engine
152 115 or also from theme.]]
153 @return whenever the cursor is just provided by engine or also from theme.
154
155 @ingroup Layout */
156 return: bool;
157 params { 116 params {
158 @in part_name: const(char)*; /*@ a part from loaded edje group. */ 117 @in part_name: const(char)*; [[A part from loaded edje group.]]
159 } 118 }
160 } 119 }
161 table_unpack { 120 table_unpack {
162 /*@ 121 [[Unpack (remove) a child of the given part table.
163 Unpack (remove) a child of the given part table.
164
165 @return The object that was being used, or NULL if not found.
166 122
167 The object will be unpacked from the table part and its lifetime 123 The object will be unpacked from the table part and its lifetime
168 will not be handled by the layout anymore. This is equivalent to 124 will not be handled by the layout anymore. This is equivalent to
169 elm_layout_content_unset() for table. 125 \@ref elm_layout_content_unset for table.
170 126 ]]
171 @see elm_layout_table_pack() 127 return: Evas.Object *; [[The object that was being used, or $null if not found.]]
172 @see elm_layout_table_clear()
173
174 @ingroup Layout */
175
176 return: Evas.Object *;
177 params { 128 params {
178 @in part: const(char)*; /*@ The table part name to remove child. */ 129 @in part: const(char)*; [[The table part name to remove child.]]
179 @in child: Evas.Object *; /*@ The object to remove from table. */ 130 @in child: Evas.Object *; [[The object to remove from table.]]
180 } 131 }
181 } 132 }
182 freeze { 133 freeze {
183 /*@ 134 [[Freezes the Elementary layout object.
184 @brief Freezes the Elementary layout object.
185 135
186 @return The frozen state or 0 on Error 136 This function puts all changes on hold. Successive freezes will
137 nest, requiring an equal number of thaws.
187 138
188 This function puts all changes on hold. Successive freezes will 139 See also @.thaw.
189 nest, requiring an equal number of thaws. 140 ]]
190 141 return: int; [[The frozen state or 0 on error.]]
191 @see elm_layout_thaw() */
192
193 return: int;
194 } 142 }
195 theme_enable { 143 theme_enable {
196 /*@ No description supplied by the EAPI. */
197 legacy: null; 144 legacy: null;
198 return: bool; 145 return: bool;
199 } 146 }
200 sizing_eval { 147 sizing_eval {
201 /*@ 148 [[Eval sizing.
202 Eval sizing
203
204 Manually forces a sizing re-evaluation. This is useful when the minimum
205 size required by the edje theme of this layout has changed. The change on
206 the minimum size required by the edje theme is not immediately reported to
207 the elementary layout, so one needs to call this function in order to tell
208 the widget (layout) that it needs to reevaluate its own size.
209 149
210 The minimum size of the theme is calculated based on minimum size of 150 Manually forces a sizing re-evaluation. This is useful when the
211 parts, the size of elements inside containers like box and table, etc. All 151 minimum size required by the edje theme of this layout has
212 of this can change due to state changes, and that's when this function 152 changed. The change on the minimum size required by the edje
213 should be called. 153 theme is not immediately reported to the elementary layout,
154 so one needs to call this function in order to tell the widget
155 (layout) that it needs to reevaluate its own size.
214 156
215 Also note that a standard signal of "size,eval" "elm" emitted from the 157 The minimum size of the theme is calculated based on minimum
216 edje object will cause this to happen too. 158 size of parts, the size of elements inside containers like box
217 159 and table, etc. All of this can change due to state changes,
218 @ingroup Layout */ 160 and that's when this function should be called.
219 161
162 Also note that a standard signal of "size,eval" "elm" emitted
163 from the edje object will cause this to happen too.
164 ]]
220 } 165 }
221 box_remove { 166 box_remove {
222 /*@ 167 [[Remove a child of the given part box.
223 Remove a child of the given part box.
224
225 @return The object that was being used, or NULL if not found.
226
227 The object will be removed from the box part and its lifetime will
228 not be handled by the layout anymore. This is equivalent to
229 elm_layout_content_unset() for box.
230 168
231 @see elm_layout_box_append() 169 The object will be removed from the box part and its lifetime
232 @see elm_layout_box_remove_all() 170 will not be handled by the layout anymore. This is equivalent to
233 171 \@ref elm_layout_content_unset for box.
234 @ingroup Layout */ 172 ]]
235 173 return: Evas.Object *; [[The object that was being used, or $null if not found.]]
236 return: Evas.Object *;
237 params { 174 params {
238 @in part: const(char)*; /*@ The box part name to remove child. */ 175 @in part: const(char)*; [[The box part name to remove child.]]
239 @in child: Evas.Object *; /*@ The object to remove from box. */ 176 @in child: Evas.Object *; [[The object to remove from box.]]
240 } 177 }
241 } 178 }
242 sizing_restricted_eval { 179 sizing_restricted_eval {
243 /*@ 180 [[Request sizing reevaluation, restricted to current width and/or
244 Request sizing reevaluation, restricted to current width and/or height 181 height.
245
246 Useful mostly when there are TEXTBLOCK parts defining the height of the
247 object and nothing else restricting it to a minimum width. Calling this
248 function will restrict the minimum size in the Edje calculation to whatever
249 size it the layout has at the moment.
250 182
251 @since 1.8 183 Useful mostly when there are TEXTBLOCK parts defining the height
252 184 of the object and nothing else restricting it to a minimum width.
253 @ingroup Layout */ 185 Calling this function will restrict the minimum size in the Edje
186 calculation to whatever size it the layout has at the moment.
254 187
188 @since 1.8
189 ]]
255 params { 190 params {
256 @in width: bool; /*@ Restrict minimum size to the current width */ 191 @in width: bool; [[Restrict minimum size to the current width.]]
257 @in height: bool; /*@ Restrict minimum size ot the current height */ 192 @in height: bool; [[Restrict minimum size ot the current height.]]
258 } 193 }
259 } 194 }
260 part_cursor_style_set { 195 part_cursor_style_set {
261 /*@ 196 [[Sets a specific cursor style for an edje part.]]
262 Sets a specific cursor style for an edje part. 197 return: bool; [[True on success or false on failure, that may be
263 198 part not exists or it did not had a cursor set.]]
264 @return true on success or false on failure, that may be
265 part not exists or it did not had a cursor set.
266
267 @ingroup Layout */
268
269 return: bool;
270 params { 199 params {
271 @in part_name: const(char)*; /*@ a part from loaded edje group. */ 200 @in part_name: const(char)*; [[A part from loaded edje group.]]
272 @in style: const(char)*; /*@ the theme style to use (default, transparent, ...) */ 201 @in style: const(char)*; [[The theme style to use (default,
202 transparent, ...).]]
273 } 203 }
274 } 204 }
275 part_cursor_style_get @const { 205 part_cursor_style_get @const {
276 /*@ 206 [[Get a specific cursor style for an edje part.]]
277 Get a specific cursor style for an edje part. 207 return: const(char)*; [[The theme style in use, defaults to "default".
278 208 If the object does not have a cursor set,
279 @return the theme style in use, defaults to "default". If the 209 then $null is returned.]]
280 object does not have a cursor set, then NULL is returned.
281
282 @ingroup Layout */
283 return: const(char)*;
284 params { 210 params {
285 @in part_name: const(char)*; /*@ a part from loaded edje group. */ 211 @in part_name: const(char)*; [[A part from loaded edje group.]]
286 } 212 }
287 } 213 }
288 text_set { 214 text_set {
289 /*@ 215 [[Set the text of the given part.]]
290 Set the text of the given part
291
292 @return $true on success, $false otherwise
293
294 @ingroup Layout */
295
296 return: bool; 216 return: bool;
297 params { 217 params {
298 @in part: const(char)* @nullable; /*@ The TEXT part where to set the text */ 218 @in part: const(char)* @nullable; [[The TEXT part where to set the text.]]
299 @in text: const(char)* @nullable; /*@ The text to set */ 219 @in text: const(char)* @nullable; [[The text to set.]]
300 } 220 }
301 } 221 }
302 text_get @const { 222 text_get @const {
303 /*@ 223 [[Get the text set in the given part.]]
304 Get the text set in the given part
305
306 @return The text set in $part
307
308 @ingroup Layout */
309 return: const(char)*; 224 return: const(char)*;
310 params { 225 params {
311 @in part: const(char)*; /*@ The TEXT part to retrieve the text off */ 226 @in part: const(char)*; [[The TEXT part to retrieve the text off.]]
312 } 227 }
313 } 228 }
314 signal_callback_add { 229 signal_callback_add {
315 /*@ 230 [[Add a callback for a (Edje) signal emitted by a layout widget's
316 Add a callback for a (Edje) signal emitted by a layout widget's 231 underlying Edje object.
317 underlying Edje object.
318
319 This function connects a callback function to a signal emitted by
320 the underlying Edje object of @a obj. Globs are accepted in either
321 the emission or source strings (see @c
322 edje_object_signal_callback_add()).
323
324 @ingroup Layout */
325 232
233 This function connects a callback function to a signal emitted by
234 the underlying Edje object of $obj. Globs are accepted in either
235 the emission or source strings.
236 ]]
326 params { 237 params {
327 @in emission: const(char)*; /*@ The signal's name string */ 238 @in emission: const(char)*; [[The signal's name string.]]
328 @in source: const(char)*; /*@ The signal's source string */ 239 @in source: const(char)*; [[The signal's source string.]]
329 @in func: Edje_Signal_Cb; /*@ The callback function to be executed when the signal is 240 @in func: Edje_Signal_Cb; [[The callback function to be executed
330 emitted. */ 241 when the signal is emitted.]]
331 @in data: void * @optional; /*@ A pointer to data to pass in to the callback function. */ 242 @in data: void * @optional; [[A pointer to data to pass in to the
243 callback function.]]
332 } 244 }
333 } 245 }
334 part_cursor_set { 246 part_cursor_set {
335 /*@ 247 [[Sets a specific cursor for an edje part.]]
336 Sets a specific cursor for an edje part. 248 return: bool; [[$true on success or $false on failure, that may be
337 249 part not exists or it has "mouse_events: 0".]]
338 @return true on success or false on failure, that may be
339 part not exists or it has "mouse_events: 0".
340
341 @ingroup Layout */
342
343 return: bool;
344 params { 250 params {
345 @in part_name: const(char)*; /*@ a part from loaded edje group. */ 251 @in part_name: const(char)*; [[A part from loaded edje group.]]
346 @in cursor: const(char)*; /*@ cursor name to use, see Elementary_Cursor.h */ 252 @in cursor: const(char)*; [[Cursor name to use, see Elementary_Cursor.h.]]
347 } 253 }
348 } 254 }
349 part_cursor_get @const { 255 part_cursor_get @const {
350 /*@ 256 [[Get the cursor to be shown when mouse is over an edje part.]]
351 Get the cursor to be shown when mouse is over an edje part
352
353 @return the cursor name.
354
355 @ingroup Layout */
356 return: const(char)*; 257 return: const(char)*;
357 params { 258 params {
358 @in part_name: const(char)*; /*@ a part from loaded edje group. */ 259 @in part_name: const(char)*; [[A part from loaded edje group.]]
359 } 260 }
360 } 261 }
361 box_insert_before { 262 box_insert_before {
362 /*@ 263 [[Insert child to layout box part before a reference object.
363 Insert child to layout box part before a reference object.
364
365 @return $true on success, $false otherwise
366
367 Once the object is inserted, it will become child of the layout. Its
368 lifetime will be bound to the layout, whenever the layout dies the child
369 will be deleted automatically. One should use elm_layout_box_remove() to
370 make this layout forget about the object.
371
372 @see elm_layout_box_append()
373 @see elm_layout_box_prepend()
374 @see elm_layout_box_insert_before()
375 @see elm_layout_box_remove()
376
377 @ingroup Layout */
378 264
265 Once the object is inserted, it will become child of the layout.
266 Its lifetime will be bound to the layout, whenever the layout
267 dies the child will be deleted automatically. One should use
268 @.box_remove to make this layout forget about the object.
269 ]]
379 return: bool; 270 return: bool;
380 params { 271 params {
381 @in part: const(char)*; /*@ the box part to insert. */ 272 @in part: const(char)*; [[The box part to insert.]]
382 @in child: own(Evas.Object *); /*@ the child object to insert into box. */ 273 @in child: own(Evas.Object *); [[The child object to insert into box.]]
383 @in reference: const(Evas.Object)*; /*@ another reference object to insert before in box. */ 274 @in reference: const(Evas.Object)*; [[Another reference object to insert before in box.]]
384 } 275 }
385 } 276 }
386 box_insert_at { 277 box_insert_at {
387 /*@ 278 [[Insert child to layout box part at a given position.
388 Insert child to layout box part at a given position.
389
390 @return $true on success, $false otherwise
391
392 Once the object is inserted, it will become child of the layout. Its
393 lifetime will be bound to the layout, whenever the layout dies the child
394 will be deleted automatically. One should use elm_layout_box_remove() to
395 make this layout forget about the object.
396
397 @see elm_layout_box_append()
398 @see elm_layout_box_prepend()
399 @see elm_layout_box_insert_before()
400 @see elm_layout_box_remove()
401
402 @ingroup Layout */
403 279
280 Once the object is inserted, it will become child of the layout.
281 Its lifetime will be bound to the layout, whenever the layout
282 dies the child will be deleted automatically. One should use
283 @.box_remove to make this layout forget about the object.
284 ]]
404 return: bool; 285 return: bool;
405 params { 286 params {
406 @in part: const(char)*; /*@ the box part to insert. */ 287 @in part: const(char)*; [[The box part to insert.]]
407 @in child: own(Evas.Object *); /*@ the child object to insert into box. */ 288 @in child: own(Evas.Object *); [[The child object to insert into box.]]
408 @in pos: uint; /*@ the numeric position >=0 to insert the child. */ 289 @in pos: uint; [[The numeric position >=0 to insert the child.]]
409 } 290 }
410 } 291 }
411 sub_object_add_enable { 292 sub_object_add_enable {
412 /*@ No description supplied by the EAPI. */
413 legacy: null; 293 legacy: null;
414 return: bool; 294 return: bool;
415 } 295 }
416 data_get @const { 296 data_get @const {
417 /*@ 297 [[Get the edje data from the given layout.
418 Get the edje data from the given layout
419
420 @return The edje data string
421 298
422 This function fetches data specified inside the edje theme of this layout. 299 This function fetches data specified inside the edje theme of
423 This function return NULL if data is not found. 300 this layout. This function return NULL if data is not found.
424
425 In EDC this comes from a data block within the group block that @p
426 obj was loaded from. E.g.
427 301
302 In EDC this comes from a data block within the group block that
303 $obj was loaded from.
304 ]]
305 /* FIXME-doc
428 @code 306 @code
429 collections { 307 collections {
430 group { 308 group {
@@ -436,128 +314,100 @@ class Elm.Layout (Elm.Container, Efl.File)
436 } 314 }
437 } 315 }
438 @endcode 316 @endcode
439 317 */
440 @ingroup Layout */ 318 return: const(char)*; [[The edje data string.]]
441 return: const(char)*;
442 params { 319 params {
443 @in key: const(char)*; /*@ The data key */ 320 @in key: const(char)*; [[The data key.]]
444 } 321 }
445 } 322 }
446 box_append { 323 box_append {
447 /*@ 324 [[Append child to layout box part.
448 Append child to layout box part.
449
450 @return $true on success, $false otherwise
451
452 Once the object is appended, it will become child of the layout. Its
453 lifetime will be bound to the layout, whenever the layout dies the child
454 will be deleted automatically. One should use elm_layout_box_remove() to
455 make this layout forget about the object.
456
457 @see elm_layout_box_prepend()
458 @see elm_layout_box_insert_before()
459 @see elm_layout_box_insert_at()
460 @see elm_layout_box_remove()
461
462 @ingroup Layout */
463 325
326 Once the object is appended, it will become child of the layout.
327 Its lifetime will be bound to the layout, whenever the layout
328 dies the child will be deleted automatically. One should use
329 @.box_remove to make this layout forget about the object.
330 ]]
464 return: bool; 331 return: bool;
465 params { 332 params {
466 @in part: const(char)*; /*@ the box part to which the object will be appended. */ 333 @in part: const(char)*; [[The box part to which the object will be appended.]]
467 @in child: own(Evas.Object *); /*@ the child object to append to box. */ 334 @in child: own(Evas.Object *); [[The child object to append to box.]]
468 } 335 }
469 } 336 }
470 signal_callback_del { 337 signal_callback_del {
471 /*@ 338 [[Remove a signal-triggered callback from a given layout widget.
472 Remove a signal-triggered callback from a given layout widget. 339
473 340 This function removes the last callback attached to a signal
474 @return The data pointer of the signal callback (passed on 341 emitted by the undelying Edje object of $obj, with parameters
475 elm_layout_signal_callback_add()) or $NULL, on errors. 342 $emission, $source and $func matching exactly those passed to a
476 343 previous call to @.signal_callback_add. The data pointer that
477 This function removes the @b last callback attached to a signal 344 was passed to this call will be returned.
478 emitted by the undelying Edje object of @a obj, with parameters @a 345 ]]
479 emission, @a source and $func matching exactly those passed to a 346 return: void *; [[The data pointer of the signal callback (passed on
480 previous call to elm_layout_signal_callback_add(). The data pointer 347 @.signal_callback_add) or $null on errors.]]
481 that was passed to this call will be returned.
482
483 @ingroup Layout */
484
485 return: void *;
486 params { 348 params {
487 @in emission: const(char)*; /*@ The signal's name string */ 349 @in emission: const(char)*; [[The signal's name string.]]
488 @in source: const(char)*; /*@ The signal's source string */ 350 @in source: const(char)*; [[The signal's source string.]]
489 @in func: Edje_Signal_Cb; /*@ The callback function being executed when the signal 351 @in func: Edje_Signal_Cb; [[The callback function being executed
490 was emitted. */ 352 when the signal was emitted.]]
491 } 353 }
492 } 354 }
493 thaw { 355 thaw {
494 /*@ 356 [[Thaws the Elementary object.
495 @brief Thaws the Elementary object.
496
497 @return The frozen state or 0 if the object is not frozen or on error.
498 357
499 This function thaws the given Edje object and the Elementary sizing calc. 358 This function thaws the given Edje object and the Elementary
359 sizing calc.
500 360
501 @note: If sucessives freezes were done, an equal number of 361 Note: If sucessives freezes were done, an equal number of
502 thaws will be required. 362 thaws will be required.
503 363
504 @see elm_layout_freeze() */ 364 See also @.freeze.
505 365 ]]
506 return: int; 366 return: int; [[The frozen state or 0 if the object is not frozen or on error.]]
507 } 367 }
508 box_prepend { 368 box_prepend {
509 /*@ 369 [[Prepend child to layout box part.
510 Prepend child to layout box part.
511
512 @return $true on success, $false otherwise
513
514 Once the object is prepended, it will become child of the layout. Its
515 lifetime will be bound to the layout, whenever the layout dies the child
516 will be deleted automatically. One should use elm_layout_box_remove() to
517 make this layout forget about the object.
518
519 @see elm_layout_box_append()
520 @see elm_layout_box_insert_before()
521 @see elm_layout_box_insert_at()
522 @see elm_layout_box_remove()
523
524 @ingroup Layout */
525 370
371 Once the object is prepended, it will become child of the layout.
372 Its lifetime will be bound to the layout, whenever the layout
373 dies the child will be deleted automatically. One should use
374 @.box_remove to make this layout forget about the object.
375 ]]
526 return: bool; 376 return: bool;
527 params { 377 params {
528 @in part: const(char)*; /*@ the box part to prepend. */ 378 @in part: const(char)*; [[The box part to which the object will be prepended.]]
529 @in child: own(Evas.Object *); /*@ the child object to prepend to box. */ 379 @in child: own(Evas.Object *); [[The child object to prepend to box.]]
530 } 380 }
531 } 381 }
532 signal_emit { 382 signal_emit {
533 /*@ 383 [[Send a (Edje) signal to a given layout widget's underlying Edje
534 Send a (Edje) signal to a given layout widget's underlying Edje 384 object.
535 object. 385
536 386 This function sends a signal to the underlying Edje object of
537 This function sends a signal to the underlying Edje object of @a 387 $obj. An Edje program on that Edje object's definition can
538 obj. An Edje program on that Edje object's definition can respond 388 respond to a signal by specifying matching 'signal' and
539 to a signal by specifying matching 'signal' and 'source' fields. 389 'source' fields.
540 390 ]]
541 @ingroup Layout */
542
543 params { 391 params {
544 @in emission: const(char)*; /*@ The signal's name string */ 392 @in emission: const(char)*; [[The signal's name string.]]
545 @in source: const(char)*; /*@ The signal's source string */ 393 @in source: const(char)*; [[The signal's source string.]]
546 } 394 }
547 } 395 }
548 table_pack { 396 table_pack {
549 /*@ 397 [[Insert child to layout table part.
550 Insert child to layout table part.
551 398
552 @return $true on success, $false otherwise 399 Once the object is inserted, it will become child of the table.
400 Its lifetime will be bound to the layout, and whenever the layout
401 dies the child will be deleted automatically. One should use
402 @.table_unpack to make this layout forget about the object.
553 403
554 Once the object is inserted, it will become child of the table. Its 404 If $colspan or $rowspan are bigger than 1, that object will occupy
555 lifetime will be bound to the layout, and whenever the layout dies the 405 more space than a single cell.
556 child will be deleted automatically. One should use
557 elm_layout_table_unpack() to make this layout forget about the object.
558 406
559 If $colspan or $rowspan are bigger than 1, that object will occupy 407 See also @.table_unpack, @.table_clear.
560 more space than a single cell. For instance, the following code: 408 ]]
409 /* FIXME-doc
410 For instance, the following code:
561 @code 411 @code
562 elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1); 412 elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
563 @endcode 413 @endcode
@@ -566,58 +416,39 @@ class Elm.Layout (Elm.Container, Efl.File)
566 416
567 @image html layout_colspan.png 417 @image html layout_colspan.png
568 @image latex layout_colspan.eps width=\textwidth 418 @image latex layout_colspan.eps width=\textwidth
569 419 */
570 @see elm_layout_table_unpack()
571 @see elm_layout_table_clear()
572
573 @ingroup Layout */
574
575 return: bool; 420 return: bool;
576 params { 421 params {
577 @in part: const(char)*; /*@ the box part to pack child. */ 422 @in part: const(char)*; [[The box part to pack child.]]
578 @in child: own(Evas.Object *); /*@ the child object to pack into table. */ 423 @in child: own(Evas.Object *); [[The child object to pack into table.]]
579 @in col: ushort; /*@ the column to which the child should be added. (>= 0) */ 424 @in col: ushort; [[The column to which the child should be added. (>= 0)]]
580 @in row: ushort; /*@ the row to which the child should be added. (>= 0) */ 425 @in row: ushort; [[The row to which the child should be added. (>= 0)]]
581 @in colspan: ushort; /*@ how many columns should be used to store this object. (>= 426 @in colspan: ushort; [[How many columns should be used to store this object. (>= 1)]]
582 1) */ 427 @in rowspan: ushort; [[How many rows should be used to store this object. (>= 1)]]
583 @in rowspan: ushort; /*@ how many rows should be used to store this object. (>= 1) */
584 } 428 }
585 } 429 }
586 part_cursor_unset { 430 part_cursor_unset {
587 /*@ 431 [[Unsets a cursor previously set with @.part_cursor_set.]]
588 Unsets a cursor previously set with elm_layout_part_cursor_set().
589
590 @return $true on success, $false otherwise
591
592 @ingroup Layout */
593
594 return: bool; 432 return: bool;
595 params { 433 params {
596 @in part_name: const(char)*; /*@ a part from loaded edje group, that had a cursor set 434 @in part_name: const(char)*; [[A part from loaded edje group,
597 with elm_layout_part_cursor_set(). */ 435 that had a cursor set wit
436 @.part_cursor_set.]]
598 } 437 }
599 } 438 }
600 table_clear { 439 table_clear {
601 /*@ 440 [[Remove all the child objects of the given part table.
602 Remove all the child objects of the given part table.
603
604 @return $true on success, $false otherwise
605
606 The objects will be removed from the table part and their lifetime will
607 not be handled by the layout anymore. This is equivalent to
608 elm_layout_table_unpack() for all table children.
609
610 @see elm_layout_table_pack()
611 @see elm_layout_table_unpack()
612
613 @ingroup Layout */
614 441
442 The objects will be removed from the table part and their
443 lifetime will not be handled by the layout anymore. This
444 is equivalent to @.table_unpack for all table children.
445 ]]
615 return: bool; 446 return: bool;
616 params { 447 params {
617 @in part: const(char)*; /*@ The table part name to remove child. */ 448 @in part: const(char)*; [[The table part name to remove child.]]
618 @in clear: bool; /*@ If true, then all objects will be deleted as 449 @in clear: bool; [[If true, then all objects will be deleted as
619 well, otherwise they will just be removed and will be 450 well, otherwise they will just be removed and
620 dangling on the canvas. */ 451 will be dangling on the canvas.]]
621 } 452 }
622 } 453 }
623 } 454 }