summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTom Hacohen <tom@stosb.com>2015-08-07 15:04:10 +0100
committerTom Hacohen <tom@stosb.com>2015-08-07 15:04:48 +0100
commitb0c09a6e354adde20c0190c5a2597f09615dd29e (patch)
tree4d7a35e43e59cc9962afceb366b71eabe23d5631
parentfd6a0f5b139d74379653ca5dff00e2fdf6bf34b8 (diff)
Widget item: migrate docs.
-rw-r--r--src/lib/elm_widget_item.eo611
1 files changed, 190 insertions, 421 deletions
diff --git a/src/lib/elm_widget_item.eo b/src/lib/elm_widget_item.eo
index af0f1af14..021b4c001 100644
--- a/src/lib/elm_widget_item.eo
+++ b/src/lib/elm_widget_item.eo
@@ -5,232 +5,132 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible,
5 legacy_prefix: elm_object_item; 5 legacy_prefix: elm_object_item;
6 methods { 6 methods {
7 @property tooltip_window_mode { 7 @property tooltip_window_mode {
8 get { 8 [[Control size restriction state of an object's tooltip
9 /*@
10 @brief Get size restriction state of an object's tooltip
11 9
12 This function returns whether a tooltip is allowed to expand beyond 10 This function returns whether a tooltip is allowed to expand beyond
13 its parent window's canvas. 11 its parent window's canvas.
14 It will instead be limited only by the size of the display. 12 It will instead be limited only by the size of the display.]]
15 */ 13 get {
16 } 14 }
17 set { 15 set {
18 /*@ 16 return: bool; [[$false on failure, $true on success]]
19 @brief Disable size restrictions on an object's tooltip
20
21 This function allows a tooltip to expand beyond its parent window's canvas.
22 It will instead be limited only by the size of the display.
23 */
24 return: bool; /*@ $false on failure, $true on success */
25 } 17 }
26 values { 18 values {
27 disable: bool; /*@ If $true, size restrictions are disabled */ 19 disable: bool; [[If $true, size restrictions are disabled]]
28 } 20 }
29 } 21 }
30 @property tooltip_style { 22 @property tooltip_style {
31 get { 23 [[Control a different style for this item tooltip.
32 /*@
33 Get the style for this item tooltip.
34 24
35 @see elm_object_tooltip_style_get() for more details. 25 Note: before you set a style you should define a tooltip with
36 @see elm_object_item_tooltip_style_set() 26 @.tooltip_content_cb_set or
27 @.tooltip_text_set
37 28
38 @ingroup General 29 See: elm_object_tooltip_style_set() for more details.]]
39 */ 30 get {
40 } 31 }
41 set { 32 set {
42 /*@
43 Sets a different style for this item tooltip.
44
45 @note before you set a style you should define a tooltip with
46 elm_object_item_tooltip_content_cb_set() or
47 elm_object_item_tooltip_text_set()
48
49 @see elm_object_tooltip_style_set() for more details.
50
51 @ingroup General
52 */
53 } 33 }
54 values { 34 values {
55 style: const (char)*; /*@ the theme style used/to use (default, transparent, ...) */ 35 style: const (char)*; [[the theme style used/to use (default, transparent, ...)]]
56 } 36 }
57 } 37 }
58 @property cursor { 38 @property cursor {
59 get { 39 [[Control the type of mouse pointer/cursor decoration to be shown,
60 /*@ 40 when the mouse pointer is over the given item
61 Get the type of mouse pointer/cursor decoration set to be shown,
62 when the mouse pointer is over the given item
63 41
64 @see elm_object_cursor_get() 42 This function works analogously as elm_object_cursor_set(), but
65 @see elm_object_item_cursor_set() 43 here the cursor's changing area is restricted to the item's
66 @see elm_object_item_cursor_unset() 44 area, and not the whole widget's. Note that that item cursors
45 have precedence over widget cursors, so that a mouse over an
46 item with custom cursor set will always show that cursor.
67 47
68 @ingroup General 48 If this function is called twice for an object, a previously set
69 */ 49 cursor will be unset on the second call.]]
50 get {
70 } 51 }
71 set { 52 set {
72 /*@
73 Set the type of mouse pointer/cursor decoration to be shown,
74 when the mouse pointer is over the given item
75
76 This function works analogously as elm_object_cursor_set(), but
77 here the cursor's changing area is restricted to the item's
78 area, and not the whole widget's. Note that that item cursors
79 have precedence over widget cursors, so that a mouse over an
80 item with custom cursor set will always show @b that cursor.
81
82 If this function is called twice for an object, a previously set
83 cursor will be unset on the second call.
84
85 @see elm_object_cursor_set()
86 @see elm_object_item_cursor_get()
87 @see elm_object_item_cursor_unset()
88
89 @ingroup General
90 */
91 } 53 }
92 values { 54 values {
93 cursor: const (char) *; /*@ the cursor type's name */ 55 cursor: const (char) *; [[the cursor type's name]]
94 } 56 }
95 } 57 }
96 @property cursor_style { 58 @property cursor_style {
97 get { 59 [[Conrol a different $style for a given custom cursor set for an item.
98 /*@
99 Get the current @b style set for a given item's custom
100 cursor
101 60
102 @see elm_object_item_cursor_style_set() for more details 61 This function only makes sense when one is using custom mouse
62 cursor decorations defined in a theme file, which can have,
63 given a cursor name/type, alternate styles on it. It
64 works analogously as elm_object_cursor_style_set(), but here
65 applies only to item objects.
103 66
104 @ingroup General 67 Warning: Before you set a cursor style you should have defined a
105 */ 68 custom cursor previously on the item, with @.cursor.set]]
69 get {
106 } 70 }
107 set { 71 set {
108 /*@
109 Set a different @b style for a given custom cursor set for an
110 item.
111
112 This function only makes sense when one is using custom mouse
113 cursor decorations <b>defined in a theme file</b>, which can have,
114 given a cursor name/type, <b>alternate styles</b> on it. It
115 works analogously as elm_object_cursor_style_set(), but here
116 applies only to item objects.
117
118 @warning Before you set a cursor style you should have defined a
119 custom cursor previously on the item, with
120 elm_object_item_cursor_set()
121
122 @see elm_object_item_cursor_engine_only_set()
123 @see elm_object_item_cursor_style_get()
124
125 @ingroup General
126 */
127 } 72 }
128 values { 73 values {
129 style: const (char) *; /*@ the <b>theme style</b> to use/in use (e.g. $"default", $"transparent", etc) */ 74 style: const (char) *; [[the theme style to use/in use (e.g. $"default", $"transparent", etc)]]
130 } 75 }
131 } 76 }
132 @property cursor_engine_only { 77 @property cursor_engine_only {
133 get { 78 [[Control if the (custom)cursor for a given item should be
134 /*@ 79 searched in its theme, also, or should only rely on the
135 Get if the (custom) cursor for a given item is being 80 rendering engine.
136 searched in its theme, also, or is only relying on the rendering
137 engine.
138
139 @return $true, if cursors are being looked for only on
140 those provided by the rendering engine, $false if they
141 are being searched on the widget's theme, as well.
142 81
143 @see elm_object_item_cursor_engine_only_set(), for more details 82 Note: This call is of use only if you've set a custom cursor
83 for items, with @.cursor.set.
144 84
145 @ingroup General 85 Note: By default, cursors will only be looked for between those
146 */ 86 provided by the rendering engine.]]
87 get {
147 } 88 }
148 set { 89 set {
149 /*@
150 Set if the (custom)cursor for a given item should be
151 searched in its theme, also, or should only rely on the
152 rendering engine.
153
154 @note This call is of use only if you've set a custom cursor
155 for items, with elm_object_item_cursor_set().
156
157 @note By default, cursors will only be looked for between those
158 provided by the rendering engine.
159
160 @ingroup General
161 */
162 } 90 }
163 values { 91 values {
164 engine_only: bool; /*@ Use $true to have cursors looked for only 92 engine_only: bool; [[Use $true to have cursors looked for only on those provided by the rendering engine, $false to have them searched on the widget's theme, as well.]]
165 on those provided by the rendering engine, $false
166 to have them searched on the widget's theme, as well. */
167 } 93 }
168 } 94 }
169 @property part_content { 95 @property part_content {
170 get { 96 [[Control a content of an object item
171 /*@
172 Get a content of an object item
173
174 @return content of the object item or NULL for any error
175 97
176 @note Elementary object items may have many contents 98 This sets a new object to an item as a content object. If any object was
177 99 already set as a content object in the same part, previous object will be
178 @ingroup General 100 deleted automatically.]]
179 */ 101 get {
180 } 102 }
181 set { 103 set {
182 /*@
183 Set a content of an object item
184
185 This sets a new object to an item as a content object. If any object was
186 already set as a content object in the same part, previous object will be
187 deleted automatically.
188
189 @note Elementary object items may have many contents
190
191 @ingroup General
192 */
193 } 104 }
194 keys { 105 keys {
195 part: const (char) * @nullable; /*@ The content part name (NULL for the default content) */ 106 part: const (char) * @nullable; [[The content part name (NULL for the default content)]]
196 } 107 }
197 values { 108 values {
198 content: Evas.Object *; /*@ The content of the object item */ 109 content: Evas.Object *; [[The content of the object item]]
199 } 110 }
200 } 111 }
201 @property part_text { 112 @property part_text {
202 get { 113 [[Control a label of an object item
203 /*@
204 Get a label of an object item
205 114
206 @note Elementary object items may have many labels 115 Note: Elementary object items may have many labels]]
207 116 get {
208 @ingroup General
209 */
210 } 117 }
211 set { 118 set {
212 /*@
213 Set a label of an object item
214
215 @note Elementary object items may have many labels
216
217 @ingroup General
218 */
219 } 119 }
220 keys { 120 keys {
221 part: const (char) * @nullable; /*@ The text part name (NULL for the default label) */ 121 part: const (char) * @nullable; [[The text part name (NULL for the default label)]]
222 } 122 }
223 values { 123 values {
224 label: const (char) *; /*@ Text of the label */ 124 label: const (char) *; [[Text of the label]]
225 } 125 }
226 } 126 }
227 @property part_text_custom @protected { 127 @property part_text_custom @protected {
228 get { 128 get {
229 /*@ Get additional text part content */ 129 [[Get additional text part content]]
230 legacy: null; 130 legacy: null;
231 } 131 }
232 set { 132 set {
233 /*@ Save additional text part content */ 133 [[Save additional text part content]]
234 legacy: null; 134 legacy: null;
235 } 135 }
236 keys { 136 keys {
@@ -241,277 +141,194 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible,
241 } 141 }
242 } 142 }
243 @property focus { 143 @property focus {
244 get { 144 [[Control the object item focused
245 /*@
246 Get whether the $it is focused or not.
247 145
248 @see elm_object_item_focus_set() 146 @since 1.10]]
249 147 get {
250 @ingroup Focus
251 @since 1.10
252 */
253 } 148 }
254 set { 149 set {
255 /*@
256 Set the object item focused
257
258 @see elm_object_item_focus_get()
259
260 @ingroup Focus
261 @since 1.10
262 */
263 } 150 }
264 values { 151 values {
265 focused: bool; /*@ The focused state */ 152 focused: bool; [[The focused state]]
266 } 153 }
267 } 154 }
268 @property style { 155 @property style {
269 get { 156 [[Control the style of an object item
270 /*@
271 Get the style of an object item
272
273 @since 1.9
274 157
275 @ingroup General 158 @since 1.9]]
276 */ 159 get {
277 } 160 }
278 set { 161 set {
279 /*@
280 Set a style of an object item
281
282 @since 1.9
283
284 @ingroup General
285 */
286 } 162 }
287 values { 163 values {
288 style: const (char) *; /*@ The style of object item */ 164 style: const (char) *; [[The style of object item]]
289 } 165 }
290 } 166 }
291 @property disabled { 167 @property disabled {
292 get { 168 [[Control the disabled state of an widget item.
293 /*@
294 Get the disabled state of an widget item.
295 169
296 This gets the state of the widget, which might be enabled or disabled. 170 Elementary object item can be disabled, in which state they won't
171 receive input and, in general, will be themed differently from
172 their normal state, usually greyed out. Useful for contexts
173 where you don't want your users to interact with some of the
174 parts of you interface.
297 175
298 @ingroup Styles 176 This sets the state for the widget item, either disabling it or
299 */ 177 enabling it back.]]
178 get {
300 } 179 }
301 set { 180 set {
302 /*@
303 Set the disabled state of an widget item.
304
305 Elementary object item can be @b disabled, in which state they won't
306 receive input and, in general, will be themed differently from
307 their normal state, usually greyed out. Useful for contexts
308 where you don't want your users to interact with some of the
309 parts of you interface.
310
311 This sets the state for the widget item, either disabling it or
312 enabling it back.
313
314 @ingroup Styles
315 */
316 } 181 }
317 values { 182 values {
318 disable: bool; /*@ $true, if the widget item is disabled, $false if it's enabled (or on errors) */ 183 disable: bool; [[$true, if the widget item is disabled, $false if it's enabled (or on errors)]]
319 } 184 }
320 } 185 }
321 access_order_get { 186 access_order_get {
322 /*@ 187 [[Get highlight order
323 @brief Get highlight order
324 @since 1.8
325 188
326 @ingroup General 189 @since 1.8]]
327 */
328 return: const(list<Evas.Object *>) *; 190 return: const(list<Evas.Object *>) *;
329 } 191 }
330 access_order_set { 192 access_order_set {
331 /*@ 193 [[Set highlight order
332 @brief Set highlight order
333 @since 1.8
334 194
335 @ingroup General 195 @since 1.8]]
336 */
337 params { 196 params {
338 @in objs: own(list<Evas.Object *> *); /*@ Order of objects to pass highlight */ 197 @in objs: own(list<Evas.Object *> *); [[Order of objects to pass highlight]]
339 } 198 }
340 } 199 }
341 widget_get @const { 200 widget_get @const {
342 /*@ 201 [[Get the widget object's handle which contains a given item
343 Get the widget object's handle which contains a given item
344 202
345 @note This returns the widget object itself that an item belongs to. 203 Note: This returns the widget object itself that an item belongs to.
346 @note Every elm_object_item supports this API 204 Note: Every elm_object_item supports this API]]
347 @ingroup General 205 return: Evas.Object*; [[The widget object]]
348 */
349 return: Evas.Object*; /*@ The widget object */
350 } 206 }
351 del { 207 del {
352 /*@ 208 [[Delete the given item.]]
353 Delete the given item.
354
355 @ingroup General
356 */
357 } 209 }
358 pre_notify_del @protected { 210 pre_notify_del @protected {
359 /*@ notify deletion of widget item */ 211 [[notify deletion of widget item]]
360 legacy: null; 212 legacy: null;
361 } 213 }
362 tooltip_text_set { 214 tooltip_text_set {
363 /*@ 215 [[Set the text to be shown in a given object item's tooltips.
364 Set the text to be shown in a given object item's tooltips.
365 216
366 Setup the text as tooltip to object. The item can have only one tooltip, 217 Setup the text as tooltip to object. The item can have only one tooltip,
367 so any previous tooltip data - set with this function or 218 so any previous tooltip data - set with this function or
368 elm_object_item_tooltip_content_cb_set() - is removed. 219 @.tooltip_content_cb_set - is removed.
369 220
370 @see elm_object_tooltip_text_set() for more details. 221 See: elm_object_tooltip_text_set() for more details.]]
371
372 @ingroup General
373 */
374 params { 222 params {
375 text: const (char) *; /*@ The text to set in the content. */ 223 text: const (char) *; [[The text to set in the content.]]
376 } 224 }
377 } 225 }
378 tooltip_translatable_text_set @protected { 226 tooltip_translatable_text_set @protected {
379 /*@ Set widget item tooltip as a text string */ 227 [[Set widget item tooltip as a text string]]
380 legacy: null; 228 legacy: null;
381 params { 229 params {
382 text: const (char) *; 230 text: const (char) *;
383 } 231 }
384 } 232 }
385 tooltip_unset { 233 tooltip_unset {
386 /*@ 234 [[Unset tooltip from item.
387 Unset tooltip from item.
388 235
389 Remove tooltip from item. The callback provided as del_cb to 236 Remove tooltip from item. The callback provided as del_cb to
390 elm_object_item_tooltip_content_cb_set() will be called to notify 237 @.tooltip_content_cb_set will be called to notify
391 it is not used anymore. 238 it is not used anymore.
392 239
393 @see elm_object_tooltip_unset() for more details. 240 See: elm_object_tooltip_unset() for more details.
394 @see elm_object_item_tooltip_content_cb_set() 241 See: @.tooltip_content_cb_set]]
395
396 @ingroup General
397 */
398 } 242 }
399 cursor_unset { 243 cursor_unset {
400 /*@ 244 [[Unset any custom mouse pointer/cursor decoration set to be
401 Unset any custom mouse pointer/cursor decoration set to be
402 shown, when the mouse pointer is over the given 245 shown, when the mouse pointer is over the given
403 item, thus making it show the @b default cursor again. 246 item, thus making it show the default cursor again.
404 247
405 Use this call to undo any custom settings on this item's cursor 248 Use this call to undo any custom settings on this item's cursor
406 decoration, bringing it back to defaults (no custom style set). 249 decoration, bringing it back to defaults (no custom style set).
407 250
408 @see elm_object_cursor_unset() 251 See: elm_object_cursor_unset()
409 @see elm_object_item_cursor_set() 252 See: @.cursor.set]]
410
411 @ingroup General
412 */
413 } 253 }
414 part_content_unset { 254 part_content_unset {
415 /*@ 255 [[Unset a content of an object item
416 Unset a content of an object item
417
418 @note Elementary object items may have many contents
419 256
420 @ingroup General 257 Note: Elementary object items may have many contents]]
421 */
422 params { 258 params {
423 part: const (char) *; /*@ The content part name to unset (NULL for the default content) */ 259 part: const (char) *; [[The content part name to unset (NULL for the default content)]]
424 } 260 }
425 return: Evas.Object*; 261 return: Evas.Object*;
426 } 262 }
427 part_text_custom_update @protected { 263 part_text_custom_update @protected {
428 /*@ Update additional text part content */ 264 [[Update additional text part content]]
429 legacy: null; 265 legacy: null;
430 } 266 }
431 signal_callback_add { 267 signal_callback_add {
432 /*@ 268 [[Add a callback for a signal emitted by object item edje.
433 Add a callback for a signal emitted by object item edje.
434 269
435 This function connects a callback function to a signal emitted by the 270 This function connects a callback function to a signal emitted by the
436 edje object of the object item. 271 edje object of the object item.
437 Globs can occur in either the emission or source name. 272 Globs can occur in either the emission or source name.
438 273
439 @since 1.8 274 @since 1.8]]
440
441 @ingroup General
442 */
443 params { 275 params {
444 emission: const (char) *; /*@ The signal's name. */ 276 emission: const (char) *; [[The signal's name.]]
445 source: const (char) *; /*@ The signal's source. */ 277 source: const (char) *; [[The signal's source.]]
446 func: Elm_Object_Item_Signal_Cb; /*@ The callback function to be executed when the signal is emitted. */ 278 func: Elm_Object_Item_Signal_Cb; [[The callback function to be executed when the signal is emitted.]]
447 data: void *; /*@ A pointer to data to pass to the callback function. */ 279 data: void *; [[A pointer to data to pass to the callback function.]]
448 } 280 }
449 } 281 }
450 signal_callback_del { 282 signal_callback_del {
451 /*@ 283 [[Remove a signal-triggered callback from a object item edje object.
452 Remove a signal-triggered callback from a object item edje object.
453 284
454 This function removes the @b last callback, previously attached to 285 This function removes the last callback, previously attached to
455 a signal emitted by an underlying Edje object of @a it, whose 286 a signal emitted by an underlying Edje object of $it, whose
456 parameters @a emission, @a source and $func match exactly with 287 parameters $emission, $source and $func match exactly with
457 those passed to a previous call to 288 those passed to a previous call to
458 elm_object_item_signal_callback_add(). The data pointer that was passed 289 @.signal_callback_add. The data pointer that was passed
459 to this call will be returned. 290 to this call will be returned.
460 291
461 @see elm_object_item_signal_callback_add() 292 See: @.signal_callback_add
462 @since 1.8
463 293
464 @ingroup General 294 @since 1.8]]
465 */
466 params { 295 params {
467 emission: const (char) *; /*@ The signal's name. */ 296 emission: const (char) *; [[The signal's name.]]
468 source: const (char) *; /*@ The signal's source. */ 297 source: const (char) *; [[The signal's source.]]
469 func: Elm_Object_Item_Signal_Cb; /*@ The callback function to be executed when the signal is emitted. */ 298 func: Elm_Object_Item_Signal_Cb; [[The callback function to be executed when the signal is emitted.]]
470 } 299 }
471 return: void*; /*@ The data pointer of the signal callback or $NULL, on errors. */ 300 return: void*; [[The data pointer of the signal callback or $NULL, on errors.]]
472 } 301 }
473 signal_emit { 302 signal_emit {
474 /*@ 303 [[Send a signal to the edje object of the widget item.
475 Send a signal to the edje object of the widget item.
476 304
477 This function sends a signal to the edje object of the obj item. An 305 This function sends a signal to the edje object of the obj item. An
478 edje program can respond to a signal by specifying matching 306 edje program can respond to a signal by specifying matching
479 'signal' and 'source' fields. 307 'signal' and 'source' fields.]]
480
481 @ingroup General
482 */
483 params { 308 params {
484 emission: const (char) *; /*@ The signal's name. */ 309 emission: const (char) *; [[The signal's name.]]
485 source: const (char) *; /*@ The signal's source. */ 310 source: const (char) *; [[The signal's source.]]
486 } 311 }
487 } 312 }
488 access_info_set { 313 access_info_set {
489 /*@ 314 [[Set the text to read out when in accessibility mode]]
490 Set the text to read out when in accessibility mode
491
492 @ingroup General
493 */
494 params { 315 params {
495 txt: const (char) *; /*@ The text that describes the widget to people with poor or no vision */ 316 txt: const (char) *; [[The text that describes the widget to people with poor or no vision]]
496 } 317 }
497 } 318 }
498 access_object_get @const { 319 access_object_get @const {
499 /*@ 320 [[Get an accessible object of the object item.
500 @brief Get an accessible object of the object item.
501 @since 1.8
502 321
503 @ingroup General 322 @since 1.8]]
504 */ 323 return: Evas.Object*; [[Accessible object of the object item or NULL for any error]]
505 return: Evas.Object*; /*@ Accessible object of the object item or NULL for any error */
506 } 324 }
507 domain_translatable_part_text_set { 325 domain_translatable_part_text_set {
508 /*@ 326 [[Set the text for an object item's part, marking it as translatable.
509 Set the text for an object item's part, marking it as translatable.
510 327
511 The string to set as $text must be the original one. Do not pass the 328 The string to set as $text must be the original one. Do not pass the
512 return of $gettext() here. Elementary will translate the string 329 return of $gettext() here. Elementary will translate the string
513 internally and set it on the object item using 330 internally and set it on the object item using
514 elm_object_item_part_text_set(), also storing the original string so that it 331 @.part_text.set, also storing the original string so that it
515 can be automatically translated when the language is changed with 332 can be automatically translated when the language is changed with
516 elm_language_set(). The $domain will be stored along to find the 333 elm_language_set(). The $domain will be stored along to find the
517 translation in the correct catalog. It can be NULL, in which case it will use 334 translation in the correct catalog. It can be NULL, in which case it will use
@@ -520,64 +337,54 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible,
520 its own translatable strings, that should not be mixed with those of programs 337 its own translatable strings, that should not be mixed with those of programs
521 using the library. 338 using the library.
522 339
523 @ingroup General 340 @since 1.8]]
524 @since 1.8
525 */
526 params { 341 params {
527 part: const (char) *; /*@ The name of the part to set */ 342 part: const (char) *; [[The name of the part to set]]
528 domain: const (char) *; /*@ The translation domain to use */ 343 domain: const (char) *; [[The translation domain to use]]
529 label: const (char) *; /*@ The original, non-translated text to set */ 344 label: const (char) *; [[The original, non-translated text to set]]
530 } 345 }
531 } 346 }
532 translatable_part_text_get @const { 347 translatable_part_text_get @const {
533 /*@ 348 [[Get the original string set as translatable for an object item.
534 Get the original string set as translatable for an object item.
535 349
536 When setting translated strings, the function elm_object_item_part_text_get() 350 When setting translated strings, the function @.part_text.get
537 will return the translation returned by $gettext(). To get the original 351 will return the translation returned by $gettext(). To get the original
538 string use this function. 352 string use this function.
539 353
540 @ingroup General 354 @since 1.8]]
541 @since 1.8
542 */
543 params { 355 params {
544 part: const (char) *; /*@ The name of the part that was set */ 356 part: const (char) *; [[The name of the part that was set]]
545 } 357 }
546 return: const (char)*; /*@ The original, untranslated string */ 358 return: const (char)*; [[The original, untranslated string]]
547 } 359 }
548 translate @protected { 360 translate @protected {
549 /*@ Query translate */ 361 [[Query translate]]
550 legacy: null; 362 legacy: null;
551 } 363 }
552 domain_part_text_translatable_set { 364 domain_part_text_translatable_set {
553 /*@ 365 [[Mark the part text to be translatable or not.
554 Mark the part text to be translatable or not.
555 366
556 Once you mark the part text to be translatable, the text will be translated 367 Once you mark the part text to be translatable, the text will be translated
557 internally regardless of elm_object_item_part_text_set() and 368 internally regardless of @.part_text.set and
558 elm_object_item_domain_translatable_part_text_set(). In other case, if you 369 @.domain_translatable_part_text_set. In other case, if you
559 set the Elementary policy that all text will be translatable in default, you 370 set the Elementary policy that all text will be translatable in default, you
560 can set the part text to not be translated by calling this API. 371 can set the part text to not be translated by calling this API.
561 372
562 @see elm_object_item_domain_translatable_part_text_set() 373 See: @.domain_translatable_part_text_set
563 @see elm_object_item_part_text_set() 374 See: @.part_text.set
564 @see elm_policy() 375 See: elm_policy()
565
566 @since 1.8
567 376
568 @ingroup General 377 @since 1.8]]
569 */
570 params { 378 params {
571 part: const (char) *; /*@ The part name of the translatable text */ 379 part: const (char) *; [[The part name of the translatable text]]
572 domain: const (char) *; /*@ The translation domain to use */ 380 domain: const (char) *; [[The translation domain to use]]
573 translatable: bool; /*@ $true, the part text will be translated internally. $false, otherwise. */ 381 translatable: bool; [[$true, the part text will be translated internally. $false, otherwise.]]
574 } 382 }
575 } 383 }
576 track { 384 track {
577 /*@ 385 [[This returns track object of the item.
578 This returns track object of the item.
579 386
580 @note This gets a rectangle object that represents the object item's internal 387 Note: This gets a rectangle object that represents the object item's internal
581 object. If you wanna check the geometry, visibility of the item, you 388 object. If you wanna check the geometry, visibility of the item, you
582 can call the evas apis such as evas_object_geometry_get(), 389 can call the evas apis such as evas_object_geometry_get(),
583 evas_object_visible_get() to the track object. Note that all of the 390 evas_object_visible_get() to the track object. Note that all of the
@@ -590,82 +397,60 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible,
590 at the moment you need to refer. Otherwise, you need to add some 397 at the moment you need to refer. Otherwise, you need to add some
591 callbacks to the track object to track it's attributes changes. 398 callbacks to the track object to track it's attributes changes.
592 399
593 @warning After use the track object, please call the 400 Warning: After use the track object, please call the
594 elm_object_item_untrack() paired to elm_object_item_track() 401 @.untrack() paired to elm_object_item_track
595 definitely to free the track object properly. Don't delete the 402 definitely to free the track object properly. Don't delete the
596 track object. 403 track object.
597 404
598 @see elm_object_item_untrack() 405 See: @.untrack
599 @see elm_object_item_track_get() 406 See: @.track_get
600 407
601 @since 1.8 408 @since 1.8]]
602 409 return: Evas.Object*; [[The track object]]
603 @ingroup General
604 */
605 return: Evas.Object*; /*@ The track object */
606 } 410 }
607 untrack { 411 untrack {
608 /*@ 412 [[This retrieve the track object of the item.
609 This retrieve the track object of the item.
610
611 @note This retrieves the track object that was returned from
612 elm_object_item_track().
613 413
614 @see elm_object_item_track() 414 Note: This retrieves the track object that was returned from
615 @see elm_object_item_track_get() 415 @.track.
616 416
617 @since 1.8 417 See: @.track
418 See: @.track_get
618 419
619 @ingroup General 420 @since 1.8]]
620 */
621 } 421 }
622 track_get @const { 422 track_get @const {
623 /*@ 423 [[Get the track object reference count.
624 Get the track object reference count.
625 424
626 @note This gets the reference count for the track object. Whenever you call 425 Note: This gets the reference count for the track object. Whenever you call
627 the elm_object_item_track(), the reference count will be increased by 426 the @.track, the reference count will be increased by
628 one. Likely the referece count will be decreased again when you call 427 one. Likely the referece count will be decreased again when you call
629 the elm_object_item_untrack(). Unless the reference count reaches to 428 the @.untrack. Unless the reference count reaches to
630 zero, the track object won't be deleted. So please be sure to call 429 zero, the track object won't be deleted. So please be sure to call
631 elm_object_item_untrack() paired to the elm_object_item_track() call 430 @.untrack() paired to the elm_object_item_track call
632 count. 431 count.
633 432
634 @see elm_object_item_track() 433 See: @.track
635 @see elm_object_item_track_get() 434 See: @.track_get
636 435
637 @since 1.8 436 @since 1.8]]
638
639 @ingroup General
640 */
641 return: int; 437 return: int;
642 } 438 }
643 track_cancel @protected { 439 track_cancel @protected {
644 /*@ Query track_cancel */ 440 [[Query track_cancel]]
645 legacy: null; 441 legacy: null;
646 } 442 }
647 del_cb_set { 443 del_cb_set {
648 /*@ 444 [[Set the function to be called when an item from the widget is
649 @brief Set the function to be called when an item from the widget is
650 freed. 445 freed.
651 446
652 That function will receive these parameters: 447 Note: Every elm_object_item supports this API]]
653 @li void * item data
654 @li Evas_Object * widget object
655 @li Elm.Widget_Item * widget item
656
657 @note Every elm_object_item supports this API
658
659 @see elm_object_item_del()
660 @ingroup General
661 */
662 params { 448 params {
663 del_cb: Evas_Smart_Cb @nullable; /*@ The function called */ 449 del_cb: Evas_Smart_Cb @nullable; [[The function called]]
664 } 450 }
665 } 451 }
666 tooltip_content_cb_set { 452 tooltip_content_cb_set {
667 /*@ 453 [[Set the content to be shown in the tooltip item.
668 Set the content to be shown in the tooltip item.
669 454
670 Setup the tooltip to item. The item can have only one tooltip, 455 Setup the tooltip to item. The item can have only one tooltip,
671 so any previous tooltip data is removed. $func(with $data) will 456 so any previous tooltip data is removed. $func(with $data) will
@@ -673,45 +458,29 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible,
673 return a valid Evas_Object. This object is then managed fully by 458 return a valid Evas_Object. This object is then managed fully by
674 tooltip system and is deleted when the tooltip is gone. 459 tooltip system and is deleted when the tooltip is gone.
675 460
676 @see elm_object_tooltip_content_cb_set() for more details. 461 See: elm_object_tooltip_content_cb_set() for more details.]]
677
678 @ingroup General
679 */
680 params { 462 params {
681 func: Elm_Tooltip_Item_Content_Cb @nullable; /*@ the function used to create the tooltip contents. */ 463 func: Elm_Tooltip_Item_Content_Cb @nullable; [[the function used to create the tooltip contents.]]
682 data: const (void) * @optional; /*@ what to provide to @a func as callback data/context. */ 464 data: const (void) * @optional; [[what to provide to $func as callback data/context.]]
683 del_cb: Evas_Smart_Cb @optional; /*@ called when data is not needed anymore, either when 465 del_cb: Evas_Smart_Cb @optional; [[called when data is not needed anymore, either when another callback replaces $func, the tooltip is unset with @.tooltip_unset or the owner $item dies. This callback receives as the first parameter the given $data, and $event_info is the item.]]
684 another callback replaces @a func, the tooltip is unset with
685 elm_object_item_tooltip_unset() or the owner @a item
686 dies. This callback receives as the first parameter the
687 given @a data, and $event_info is the item. */
688 466
689 } 467 }
690 } 468 }
691 access_register { 469 access_register {
692 /*@ 470 [[Register object item as an accessible object.
693 @brief Register object item as an accessible object.
694 @since 1.8
695 471
696 @ingroup General 472 @since 1.8]]
697 */ 473 return: Evas.Object*; [[Accessible object of the object item or NULL for any error]]
698 return: Evas.Object*; /*@ Accessible object of the object item or NULL for any error */
699 } 474 }
700 access_unregister { 475 access_unregister {
701 /*@ 476 [[Unregister accessible object of the object item.
702 @brief Unregister accessible object of the object item.
703 @since 1.8
704 477
705 @ingroup General 478 @since 1.8]]
706 */
707 } 479 }
708 access_order_unset { 480 access_order_unset {
709 /*@ 481 [[Unset highlight order
710 @brief Unset highlight order
711 @since 1.8
712 482
713 @ingroup General 483 @since 1.8]]
714 */
715 } 484 }
716 disable @protected { 485 disable @protected {
717 legacy: null; 486 legacy: null;