summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Kolesa <d.kolesa@osg.samsung.com>2015-05-11 15:11:28 +0100
committerDaniel Kolesa <d.kolesa@osg.samsung.com>2015-05-11 15:11:48 +0100
commit3bb97fd0e80ffa27efc5b2ec4150e9b0638f3cdb (patch)
tree3cfea5cbc7d0bd0fc4fe14940f57789d5ba5352e
parent7253de7df2de95ce8e3ddd1ee55ab12f78218b0b (diff)
elm_widget_item: fix doc comments
-rw-r--r--src/lib/elm_widget_item.eo90
1 files changed, 45 insertions, 45 deletions
diff --git a/src/lib/elm_widget_item.eo b/src/lib/elm_widget_item.eo
index 94ba27b0a..c40ce2811 100644
--- a/src/lib/elm_widget_item.eo
+++ b/src/lib/elm_widget_item.eo
@@ -5,7 +5,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
5 methods { 5 methods {
6 @property tooltip_window_mode { 6 @property tooltip_window_mode {
7 get { 7 get {
8 /** 8 /*@
9 @brief Get size restriction state of an object's tooltip 9 @brief Get size restriction state of an object's tooltip
10 10
11 This function returns whether a tooltip is allowed to expand beyond 11 This function returns whether a tooltip is allowed to expand beyond
@@ -14,7 +14,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
14 */ 14 */
15 } 15 }
16 set { 16 set {
17 /** 17 /*@
18 @brief Disable size restrictions on an object's tooltip 18 @brief Disable size restrictions on an object's tooltip
19 19
20 This function allows a tooltip to expand beyond its parent window's canvas. 20 This function allows a tooltip to expand beyond its parent window's canvas.
@@ -28,7 +28,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
28 } 28 }
29 @property tooltip_style { 29 @property tooltip_style {
30 get { 30 get {
31 /** 31 /*@
32 Get the style for this item tooltip. 32 Get the style for this item tooltip.
33 33
34 @see elm_object_tooltip_style_get() for more details. 34 @see elm_object_tooltip_style_get() for more details.
@@ -38,7 +38,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
38 */ 38 */
39 } 39 }
40 set { 40 set {
41 /** 41 /*@
42 Sets a different style for this item tooltip. 42 Sets a different style for this item tooltip.
43 43
44 @note before you set a style you should define a tooltip with 44 @note before you set a style you should define a tooltip with
@@ -56,7 +56,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
56 } 56 }
57 @property cursor { 57 @property cursor {
58 get { 58 get {
59 /* 59 /*@
60 Get the type of mouse pointer/cursor decoration set to be shown, 60 Get the type of mouse pointer/cursor decoration set to be shown,
61 when the mouse pointer is over the given item 61 when the mouse pointer is over the given item
62 62
@@ -68,7 +68,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
68 */ 68 */
69 } 69 }
70 set { 70 set {
71 /** 71 /*@
72 Set the type of mouse pointer/cursor decoration to be shown, 72 Set the type of mouse pointer/cursor decoration to be shown,
73 when the mouse pointer is over the given item 73 when the mouse pointer is over the given item
74 74
@@ -94,7 +94,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
94 } 94 }
95 @property cursor_style { 95 @property cursor_style {
96 get { 96 get {
97 /** 97 /*@
98 Get the current @b style set for a given item's custom 98 Get the current @b style set for a given item's custom
99 cursor 99 cursor
100 100
@@ -104,7 +104,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
104 */ 104 */
105 } 105 }
106 set { 106 set {
107 /** 107 /*@
108 Set a different @b style for a given custom cursor set for an 108 Set a different @b style for a given custom cursor set for an
109 item. 109 item.
110 110
@@ -130,7 +130,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
130 } 130 }
131 @property cursor_engine_only { 131 @property cursor_engine_only {
132 get { 132 get {
133 /** 133 /*@
134 Get if the (custom) cursor for a given item is being 134 Get if the (custom) cursor for a given item is being
135 searched in its theme, also, or is only relying on the rendering 135 searched in its theme, also, or is only relying on the rendering
136 engine. 136 engine.
@@ -145,7 +145,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
145 */ 145 */
146 } 146 }
147 set { 147 set {
148 /** 148 /*@
149 Set if the (custom)cursor for a given item should be 149 Set if the (custom)cursor for a given item should be
150 searched in its theme, also, or should only rely on the 150 searched in its theme, also, or should only rely on the
151 rendering engine. 151 rendering engine.
@@ -160,14 +160,14 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
160 */ 160 */
161 } 161 }
162 values { 162 values {
163 bool engine_only; /* Use @c EINA_TRUE to have cursors looked for only 163 bool engine_only; /*@ Use @c EINA_TRUE to have cursors looked for only
164 on those provided by the rendering engine, @c EINA_FALSE 164 on those provided by the rendering engine, @c EINA_FALSE
165 to have them searched on the widget's theme, as well. */ 165 to have them searched on the widget's theme, as well. */
166 } 166 }
167 } 167 }
168 @property part_content { 168 @property part_content {
169 get { 169 get {
170 /** 170 /*@
171 Get a content of an object item 171 Get a content of an object item
172 172
173 @return content of the object item or NULL for any error 173 @return content of the object item or NULL for any error
@@ -178,7 +178,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
178 */ 178 */
179 } 179 }
180 set { 180 set {
181 /** 181 /*@
182 Set a content of an object item 182 Set a content of an object item
183 183
184 This sets a new object to an item as a content object. If any object was 184 This sets a new object to an item as a content object. If any object was
@@ -199,7 +199,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
199 } 199 }
200 @property part_text { 200 @property part_text {
201 get { 201 get {
202 /** 202 /*@
203 Get a label of an object item 203 Get a label of an object item
204 204
205 @note Elementary object items may have many labels 205 @note Elementary object items may have many labels
@@ -208,7 +208,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
208 */ 208 */
209 } 209 }
210 set { 210 set {
211 /** 211 /*@
212 Set a label of an object item 212 Set a label of an object item
213 213
214 @note Elementary object items may have many labels 214 @note Elementary object items may have many labels
@@ -241,7 +241,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
241 } 241 }
242 @property focus { 242 @property focus {
243 get { 243 get {
244 /** 244 /*@
245 Get whether the @p it is focused or not. 245 Get whether the @p it is focused or not.
246 246
247 @see elm_object_item_focus_set() 247 @see elm_object_item_focus_set()
@@ -251,7 +251,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
251 */ 251 */
252 } 252 }
253 set { 253 set {
254 /** 254 /*@
255 Set the object item focused 255 Set the object item focused
256 256
257 @see elm_object_item_focus_get() 257 @see elm_object_item_focus_get()
@@ -266,7 +266,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
266 } 266 }
267 @property style { 267 @property style {
268 get { 268 get {
269 /** 269 /*@
270 Get the style of an object item 270 Get the style of an object item
271 271
272 @since 1.9 272 @since 1.9
@@ -275,7 +275,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
275 */ 275 */
276 } 276 }
277 set { 277 set {
278 /** 278 /*@
279 Set a style of an object item 279 Set a style of an object item
280 280
281 @since 1.9 281 @since 1.9
@@ -289,7 +289,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
289 } 289 }
290 @property disabled { 290 @property disabled {
291 get { 291 get {
292 /** 292 /*@
293 Get the disabled state of an widget item. 293 Get the disabled state of an widget item.
294 294
295 This gets the state of the widget, which might be enabled or disabled. 295 This gets the state of the widget, which might be enabled or disabled.
@@ -298,7 +298,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
298 */ 298 */
299 } 299 }
300 set { 300 set {
301 /** 301 /*@
302 Set the disabled state of an widget item. 302 Set the disabled state of an widget item.
303 303
304 Elementary object item can be @b disabled, in which state they won't 304 Elementary object item can be @b disabled, in which state they won't
@@ -318,7 +318,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
318 } 318 }
319 } 319 }
320 access_order_get { 320 access_order_get {
321 /** 321 /*@
322 @brief Get highlight order 322 @brief Get highlight order
323 @since 1.8 323 @since 1.8
324 324
@@ -327,7 +327,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
327 return: const(list<Evas_Object *>) *; 327 return: const(list<Evas_Object *>) *;
328 } 328 }
329 access_order_set { 329 access_order_set {
330 /** 330 /*@
331 @brief Set highlight order 331 @brief Set highlight order
332 @since 1.8 332 @since 1.8
333 333
@@ -338,7 +338,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
338 } 338 }
339 } 339 }
340 widget_get @const { 340 widget_get @const {
341 /** 341 /*@
342 Get the widget object's handle which contains a given item 342 Get the widget object's handle which contains a given item
343 343
344 @note This returns the widget object itself that an item belongs to. 344 @note This returns the widget object itself that an item belongs to.
@@ -348,7 +348,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
348 return: Evas_Object*; /*@ The widget object */ 348 return: Evas_Object*; /*@ The widget object */
349 } 349 }
350 del { 350 del {
351 /** 351 /*@
352 Delete the given item. 352 Delete the given item.
353 353
354 @ingroup General 354 @ingroup General
@@ -359,7 +359,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
359 legacy: null; 359 legacy: null;
360 } 360 }
361 tooltip_text_set { 361 tooltip_text_set {
362 /** 362 /*@
363 Set the text to be shown in a given object item's tooltips. 363 Set the text to be shown in a given object item's tooltips.
364 364
365 Setup the text as tooltip to object. The item can have only one tooltip, 365 Setup the text as tooltip to object. The item can have only one tooltip,
@@ -382,7 +382,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
382 } 382 }
383 } 383 }
384 tooltip_unset { 384 tooltip_unset {
385 /** 385 /*@
386 Unset tooltip from item. 386 Unset tooltip from item.
387 387
388 Remove tooltip from item. The callback provided as del_cb to 388 Remove tooltip from item. The callback provided as del_cb to
@@ -396,7 +396,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
396 */ 396 */
397 } 397 }
398 cursor_unset { 398 cursor_unset {
399 /** 399 /*@
400 Unset any custom mouse pointer/cursor decoration set to be 400 Unset any custom mouse pointer/cursor decoration set to be
401 shown, when the mouse pointer is over the given 401 shown, when the mouse pointer is over the given
402 item, thus making it show the @b default cursor again. 402 item, thus making it show the @b default cursor again.
@@ -411,7 +411,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
411 */ 411 */
412 } 412 }
413 part_content_unset { 413 part_content_unset {
414 /** 414 /*@
415 Unset a content of an object item 415 Unset a content of an object item
416 416
417 @note Elementary object items may have many contents 417 @note Elementary object items may have many contents
@@ -428,7 +428,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
428 legacy: null; 428 legacy: null;
429 } 429 }
430 signal_callback_add { 430 signal_callback_add {
431 /** 431 /*@
432 Add a callback for a signal emitted by object item edje. 432 Add a callback for a signal emitted by object item edje.
433 433
434 This function connects a callback function to a signal emitted by the 434 This function connects a callback function to a signal emitted by the
@@ -447,7 +447,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
447 } 447 }
448 } 448 }
449 signal_callback_del { 449 signal_callback_del {
450 /** 450 /*@
451 Remove a signal-triggered callback from a object item edje object. 451 Remove a signal-triggered callback from a object item edje object.
452 452
453 This function removes the @b last callback, previously attached to 453 This function removes the @b last callback, previously attached to
@@ -470,7 +470,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
470 return: void*; /*@ The data pointer of the signal callback or @c NULL, on errors. */ 470 return: void*; /*@ The data pointer of the signal callback or @c NULL, on errors. */
471 } 471 }
472 signal_emit { 472 signal_emit {
473 /** 473 /*@
474 Send a signal to the edje object of the widget item. 474 Send a signal to the edje object of the widget item.
475 475
476 This function sends a signal to the edje object of the obj item. An 476 This function sends a signal to the edje object of the obj item. An
@@ -485,7 +485,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
485 } 485 }
486 } 486 }
487 access_info_set { 487 access_info_set {
488 /** 488 /*@
489 Set the text to read out when in accessibility mode 489 Set the text to read out when in accessibility mode
490 490
491 @ingroup General 491 @ingroup General
@@ -495,7 +495,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
495 } 495 }
496 } 496 }
497 access_object_get @const { 497 access_object_get @const {
498 /** 498 /*@
499 @brief Get an accessible object of the object item. 499 @brief Get an accessible object of the object item.
500 @since 1.8 500 @since 1.8
501 501
@@ -504,7 +504,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
504 return: Evas_Object*; /*@ Accessible object of the object item or NULL for any error */ 504 return: Evas_Object*; /*@ Accessible object of the object item or NULL for any error */
505 } 505 }
506 domain_translatable_part_text_set { 506 domain_translatable_part_text_set {
507 /** 507 /*@
508 Set the text for an object item's part, marking it as translatable. 508 Set the text for an object item's part, marking it as translatable.
509 509
510 The string to set as @p text must be the original one. Do not pass the 510 The string to set as @p text must be the original one. Do not pass the
@@ -529,7 +529,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
529 } 529 }
530 } 530 }
531 translatable_part_text_get @const { 531 translatable_part_text_get @const {
532 /** 532 /*@
533 Get the original string set as translatable for an object item. 533 Get the original string set as translatable for an object item.
534 534
535 When setting translated strings, the function elm_object_item_part_text_get() 535 When setting translated strings, the function elm_object_item_part_text_get()
@@ -549,7 +549,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
549 legacy: null; 549 legacy: null;
550 } 550 }
551 domain_part_text_translatable_set { 551 domain_part_text_translatable_set {
552 /** 552 /*@
553 Mark the part text to be translatable or not. 553 Mark the part text to be translatable or not.
554 554
555 Once you mark the part text to be translatable, the text will be translated 555 Once you mark the part text to be translatable, the text will be translated
@@ -573,7 +573,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
573 } 573 }
574 } 574 }
575 track { 575 track {
576 /** 576 /*@
577 This returns track object of the item. 577 This returns track object of the item.
578 578
579 @note This gets a rectangle object that represents the object item's internal 579 @note This gets a rectangle object that represents the object item's internal
@@ -604,7 +604,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
604 return: Evas_Object*; /*@ The track object */ 604 return: Evas_Object*; /*@ The track object */
605 } 605 }
606 untrack { 606 untrack {
607 /** 607 /*@
608 This retrieve the track object of the item. 608 This retrieve the track object of the item.
609 609
610 @note This retrieves the track object that was returned from 610 @note This retrieves the track object that was returned from
@@ -619,7 +619,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
619 */ 619 */
620 } 620 }
621 track_get @const { 621 track_get @const {
622 /** 622 /*@
623 Get the track object reference count. 623 Get the track object reference count.
624 624
625 @note This gets the reference count for the track object. Whenever you call 625 @note This gets the reference count for the track object. Whenever you call
@@ -644,7 +644,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
644 legacy: null; 644 legacy: null;
645 } 645 }
646 del_cb_set { 646 del_cb_set {
647 /** 647 /*@
648 @brief Set the function to be called when an item from the widget is 648 @brief Set the function to be called when an item from the widget is
649 freed. 649 freed.
650 650
@@ -663,7 +663,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
663 } 663 }
664 } 664 }
665 tooltip_content_cb_set { 665 tooltip_content_cb_set {
666 /** 666 /*@
667 Set the content to be shown in the tooltip item. 667 Set the content to be shown in the tooltip item.
668 668
669 Setup the tooltip to item. The item can have only one tooltip, 669 Setup the tooltip to item. The item can have only one tooltip,
@@ -688,7 +688,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
688 } 688 }
689 } 689 }
690 access_register { 690 access_register {
691 /** 691 /*@
692 @brief Register object item as an accessible object. 692 @brief Register object item as an accessible object.
693 @since 1.8 693 @since 1.8
694 694
@@ -697,7 +697,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
697 return: Evas_Object*; /*@ Accessible object of the object item or NULL for any error */ 697 return: Evas_Object*; /*@ Accessible object of the object item or NULL for any error */
698 } 698 }
699 access_unregister { 699 access_unregister {
700 /** 700 /*@
701 @brief Unregister accessible object of the object item. 701 @brief Unregister accessible object of the object item.
702 @since 1.8 702 @since 1.8
703 703
@@ -705,7 +705,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
705 */ 705 */
706 } 706 }
707 access_order_unset { 707 access_order_unset {
708 /** 708 /*@
709 @brief Unset highlight order 709 @brief Unset highlight order
710 @since 1.8 710 @since 1.8
711 711