2 * DO NOT INCLUDE THIS HEADER INSIDE ANY SOURCE.
3 * THIS IS ONLY FOR ELEMENTARY API DEPRECATION HISTORY AND WILL BE REMOVED LATER.
4 * THIS WILL BE MAINLY MANAGED BY JIYOUN PARK (jypark).
6 * (deprecation process)
7 * 1. mark EINA_DEPRECATED and move declarations to elm_deprecated.h.
8 * 2. remove it from elm_deprecated.h and apply it to all trunk.
9 * 3. move it to elm_removed.h.
12 #error "do not include this"
15 * @brief Get Elementary's rendering engine in use.
17 * @return The rendering engine's name
18 * @note there's no need to free the returned string, here.
20 * This gets the global rendering engine that is applied to all Elementary
23 * @see elm_engine_set()
24 * @deprecated Use elm_engine_get() instead.
26 EINA_DEPRECATED EAPI const char *elm_engine_current_get(void);
29 * Set the configured finger size for all applications on the display
31 * This sets the globally configured finger size in pixels for all
32 * applications on the display
34 * @param size The finger size
36 * @deprecated Use elm_finger_size_set() and elm_config_all_flush()
38 EINA_DEPRECATED EAPI void elm_finger_size_all_set(Evas_Coord size);
41 * Set the global scaling factor for all applications on the display
43 * This sets the globally configured scaling factor that is applied to all
44 * objects for all applications.
45 * @param scale The scaling factor to set
47 * @deprecated use elm_scale_set() and elm_config_all_flush()
49 EINA_DEPRECATED EAPI void elm_scale_all_set(double scale);
52 * Apply the changes made with elm_font_overlay_set() and
53 * elm_font_overlay_unset() on all Elementary application windows.
57 * This applies all font overlays set to all objects in the UI.
58 * @deprecated Use elm_font_overlay_apply and elm_config_all_flush()
60 EINA_DEPRECATED EAPI void elm_font_overlay_all_apply(void);
63 * Set the configured cache flush interval time for all applications on the
66 * This sets the globally configured cache flush interval time -- in ticks
67 * -- for all applications on the display.
69 * @param size The cache flush interval time
70 * @deprecated Use elm_cache_flush_interval_set() and elm_config_all_flush()
73 EINA_DEPRECATED EAPI void elm_cache_flush_interval_all_set(int size);
76 * Set the configured cache flush enabled state for all applications on the
79 * This sets the globally configured cache flush enabled state for all
80 * applications on the display.
82 * @param enabled The cache flush enabled state
83 * @deprecated Use elm_cache_flush_enabled_set adnd elm_config_all_flush()
86 EINA_DEPRECATED EAPI void elm_cache_flush_enabled_all_set(Eina_Bool enabled);
89 * Set the configured font cache size for all applications on the
92 * This sets the globally configured font cache size -- in bytes
93 * -- for all applications on the display.
95 * @param size The font cache size
96 * @deprecated Use elm_font_cache_set() and elm_config_all_flush()
99 EINA_DEPRECATED EAPI void elm_font_cache_all_set(int size);
102 * Set the configured image cache size for all applications on the
105 * This sets the globally configured image cache size -- in bytes
106 * -- for all applications on the display.
108 * @param size The image cache size
109 * @deprecated Use elm_image_cache_set() and elm_config_all_flush()
112 EINA_DEPRECATED EAPI void elm_image_cache_all_set(int size);
115 * Set the configured edje file cache size for all applications on the
118 * This sets the globally configured edje file cache size -- in number
119 * of files -- for all applications on the display.
121 * @param size The edje file cache size
122 * @deprecated Use elm_edje_file_cache_set() and elm_config_all_flush()
125 EINA_DEPRECATED EAPI void elm_edje_file_cache_all_set(int size);
128 * Set the configured edje collections (groups) cache size for all
129 * applications on the display
131 * This sets the globally configured edje collections cache size -- in
132 * number of collections -- for all applications on the display.
134 * @param size The edje collections cache size
135 * @deprecated Use elm_edje_collection_cache_set() and elm_config_all_flush()
138 EINA_DEPRECATED EAPI void elm_edje_collection_cache_all_set(int size);
141 * Set Elementary's profile.
143 * This sets the global profile that is applied to all Elementary
144 * applications. All running Elementary windows will be affected.
146 * @param profile The profile's name
147 * @deprecated Use elm_profile_set() and elm_config_all_flush()
151 EINA_DEPRECATED EAPI void elm_profile_all_set(const char *profile);
154 * Set whether scrollers should bounce when they reach their
155 * viewport's edge during a scroll, for all Elementary application
158 * @param enabled the thumb scroll bouncing state
160 * @see elm_thumbscroll_bounce_enabled_get()
161 * @deprecated Use elm_scroll_bounce_enabled_set() and elm_config_all_flush()
164 EINA_DEPRECATED EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
167 * Set the amount of inertia a scroller will impose at bounce
168 * animations, for all Elementary application windows.
170 * @param friction the thumb scroll bounce friction
172 * @see elm_thumbscroll_bounce_friction_get()
173 * @deprecated Use elm_scroll_bounce_friction_set() and elm_config_all_flush()
176 EINA_DEPRECATED EAPI void elm_scroll_bounce_friction_all_set(double friction);
179 * Set the amount of inertia a <b>paged</b> scroller will impose at
180 * page fitting animations, for all Elementary application windows.
182 * @param friction the page scroll friction
184 * @see elm_thumbscroll_page_scroll_friction_get()
185 * @deprecated Use elm_scroll_page_scroll_friction_set() and
186 * elm_config_all_flush()
189 EINA_DEPRECATED EAPI void elm_scroll_page_scroll_friction_all_set(double friction);
192 * Set the amount of inertia a scroller will impose at region bring
193 * animations, for all Elementary application windows.
195 * @param friction the bring in scroll friction
197 * @see elm_thumbscroll_bring_in_scroll_friction_get()
198 * @deprecated Use elm_scroll_bring_in_scroll_friction_set() and
199 * elm_config_all_flush()
202 EINA_DEPRECATED EAPI void elm_scroll_bring_in_scroll_friction_all_set(double friction);
205 * Set the amount of inertia scrollers will impose at animations
206 * triggered by Elementary widgets' zooming API, for all Elementary
207 * application windows.
209 * @param friction the zoom friction
211 * @see elm_thumbscroll_zoom_friction_get()
212 * @deprecated Use elm_scroll_zoom_friction_set() and elm_config_all_flush()
215 EINA_DEPRECATED EAPI void elm_scroll_zoom_friction_all_set(double friction);
218 * Set whether scrollers should be draggable from any point in their
219 * views, for all Elementary application windows.
221 * @param enabled the thumb scroll state
223 * @see elm_thumbscroll_enabled_get()
224 * @deprecated Use elm_scroll_thumbscroll_enabled_set()
225 * and elm_config_all_flush()
229 EINA_DEPRECATED EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
233 * Set the number of pixels one should travel while dragging a
234 * scroller's view to actually trigger scrolling, for all Elementary
235 * application windows.
237 * @param threshold the thumb scroll threshold
239 * @see elm_thumbscroll_threshold_get()
240 * @deprecated Use elm_scroll_thumbscroll_threshold_set()
241 * and elm_config_all_flush()
245 EINA_DEPRECATED EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
248 * Set the minimum speed of mouse cursor movement which will trigger
249 * list self scrolling animation after a mouse up event
250 * (pixels/second), for all Elementary application windows.
252 * @param threshold the thumb scroll momentum threshold
254 * @see elm_thumbscroll_momentum_threshold_get()
255 * @deprecated Use elm_scroll_thumbscroll_momentum_threshold_set()
256 * and elm_config_all_flush()
260 EINA_DEPRECATED EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
263 * Set the amount of inertia a scroller will impose at self scrolling
264 * animations, for all Elementary application windows.
266 * @param friction the thumb scroll friction
268 * @see elm_thumbscroll_friction_get()
269 * @deprecated Use elm_scroll_thumbscroll_friction_set()
270 * and elm_config_all_flush()
274 EINA_DEPRECATED EAPI void elm_scroll_thumbscroll_friction_all_set(double friction);
277 * Set the amount of lag between your actual mouse cursor dragging
278 * movement and a scroller's view movement itself, while pushing it
279 * into bounce state manually, for all Elementary application windows.
281 * @param friction the thumb scroll border friction. @c 0.0 for
282 * perfect synchrony between two movements, @c 1.0 for maximum
285 * @see elm_thumbscroll_border_friction_get()
286 * @note parameter value will get bound to 0.0 - 1.0 interval, always
287 * @deprecated Use elm_scroll_thumbscroll_border_friction_set()
288 * and elm_config_all_flush()
292 EINA_DEPRECATED EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction);
295 * Set the sensitivity amount which is be multiplied by the length of
296 * mouse dragging, for all Elementary application windows.
298 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
299 * minimum sensitivity, @c 1.0 for maximum sensitivity. 0.25
302 * @see elm_thumbscroll_sensitivity_friction_get()
303 * @note parameter value will get bound to 0.1 - 1.0 interval, always
304 * @deprecated Use elm_scroll_thumbscroll_sensitivity_friction_set()
305 * and elm_config_all_flush()
309 EINA_DEPRECATED EAPI void elm_scroll_thumbscroll_sensitivity_friction_all_set(double friction);
311 EINA_DEPRECATED EAPI void elm_gen_clear(Evas_Object *obj);
312 EINA_DEPRECATED EAPI void elm_gen_item_selected_set(Elm_Gen_Item *it, Eina_Bool selected);
313 EINA_DEPRECATED EAPI Eina_Bool elm_gen_item_selected_get(const Elm_Gen_Item *it);
314 EINA_DEPRECATED EAPI void elm_gen_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select);
315 EINA_DEPRECATED EAPI Eina_Bool elm_gen_always_select_mode_get(const Evas_Object *obj);
316 EINA_DEPRECATED EAPI void elm_gen_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select);
317 EINA_DEPRECATED EAPI Eina_Bool elm_gen_no_select_mode_get(const Evas_Object *obj);
318 EINA_DEPRECATED EAPI void elm_gen_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
319 EINA_DEPRECATED EAPI void elm_gen_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
320 EINA_DEPRECATED EAPI void elm_gen_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel);
321 EINA_DEPRECATED EAPI void elm_gen_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel);
323 EINA_DEPRECATED EAPI void elm_gen_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize);
324 EINA_DEPRECATED EAPI void elm_gen_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
325 EINA_DEPRECATED EAPI void elm_gen_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
326 EINA_DEPRECATED EAPI void elm_gen_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber);
327 EINA_DEPRECATED EAPI void elm_gen_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber);
328 EINA_DEPRECATED EAPI Elm_Gen_Item *elm_gen_first_item_get(const Evas_Object *obj);
329 EINA_DEPRECATED EAPI Elm_Gen_Item *elm_gen_last_item_get(const Evas_Object *obj);
330 EINA_DEPRECATED EAPI Elm_Gen_Item *elm_gen_item_next_get(const Elm_Gen_Item *it);
331 EINA_DEPRECATED EAPI Elm_Gen_Item *elm_gen_item_prev_get(const Elm_Gen_Item *it);
332 EINA_DEPRECATED EAPI Evas_Object *elm_gen_item_widget_get(const Elm_Gen_Item *it);
335 * Get the widget object's handle which contains a given item
337 * @param it The Elementary object item
338 * @return The widget object
340 * @note This returns the widget object itself that an item belongs to.
341 * @note Every elm_object_item supports this API
342 * @deprecated Use elm_object_item_widget_get() instead
345 EINA_DEPRECATED EAPI Evas_Object *elm_object_item_object_get(const Elm_Object_Item *it);
348 * Set the text to show in the anchorblock
350 * Sets the text of the anchorblock to @p text. This text can include markup
351 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
352 * of text that will be specially styled and react to click events, ended
353 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
354 * "anchor,clicked" signal that you can attach a callback to with
355 * evas_object_smart_callback_add(). The name of the anchor given in the
356 * event info struct will be the one set in the href attribute, in this
359 * Other markup can be used to style the text in different ways, but it's
360 * up to the style defined in the theme which tags do what.
361 * @deprecated use elm_object_text_set() instead.
363 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text);
366 * Get the markup text set for the anchorblock
368 * Retrieves the text set on the anchorblock, with markup tags included.
370 * @param obj The anchorblock object
371 * @return The markup text set or @c NULL if nothing was set or an error
373 * @deprecated use elm_object_text_set() instead.
375 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj);
378 * Set the text to show in the anchorview
380 * Sets the text of the anchorview to @p text. This text can include markup
381 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
382 * text that will be specially styled and react to click events, ended with
383 * either of \</a\> or \</\>. When clicked, the anchor will emit an
384 * "anchor,clicked" signal that you can attach a callback to with
385 * evas_object_smart_callback_add(). The name of the anchor given in the
386 * event info struct will be the one set in the href attribute, in this
389 * Other markup can be used to style the text in different ways, but it's
390 * up to the style defined in the theme which tags do what.
391 * @deprecated use elm_object_text_set() instead.
393 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text);
396 * Get the markup text set for the anchorview
398 * Retrieves the text set on the anchorview, with markup tags included.
400 * @param obj The anchorview object
401 * @return The markup text set or @c NULL if nothing was set or an error
403 * @deprecated use elm_object_text_set() instead.
405 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj);
408 * @brief Get the ctxpopup item's disabled/enabled state.
410 * @param it Ctxpopup item to be enabled/disabled
411 * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
413 * @see elm_ctxpopup_item_disabled_set()
414 * @deprecated use elm_object_item_disabled_get() instead
418 EINA_DEPRECATED EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it);
421 * @brief Set the ctxpopup item's state as disabled or enabled.
423 * @param it Ctxpopup item to be enabled/disabled
424 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
426 * When disabled the item is greyed out to indicate it's state.
427 * @deprecated use elm_object_item_disabled_set() instead
431 EINA_DEPRECATED EAPI void elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled);
434 * @brief Get the icon object for the given ctxpopup item.
436 * @param it Ctxpopup item
437 * @return icon object or @c NULL, if the item does not have icon or an error
440 * @see elm_ctxpopup_item_append()
441 * @see elm_ctxpopup_item_icon_set()
443 * @deprecated use elm_object_item_part_content_get() instead
447 EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it);
450 * @brief Sets the side icon associated with the ctxpopup item
452 * @param it Ctxpopup item
453 * @param icon Icon object to be set
455 * Once the icon object is set, a previously set one will be deleted.
456 * @warning Setting the same icon for two items will cause the icon to
457 * disappear from the first item.
459 * @see elm_ctxpopup_item_append()
461 * @deprecated use elm_object_item_part_content_set() instead
465 EINA_DEPRECATED EAPI void elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon);
468 * @brief Get the label for the given ctxpopup item.
470 * @param it Ctxpopup item
471 * @return label string or @c NULL, if the item does not have label or an
474 * @see elm_ctxpopup_item_append()
475 * @see elm_ctxpopup_item_label_set()
477 * @deprecated use elm_object_item_text_get() instead
481 EINA_DEPRECATED EAPI const char *elm_ctxpopup_item_label_get(const Elm_Object_Item *it);
484 * @brief (Re)set the label on the given ctxpopup item.
486 * @param it Ctxpopup item
487 * @param label String to set as label
489 * @deprecated use elm_object_item_text_set() instead
493 EINA_DEPRECATED EAPI void elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label);
496 * @brief Set an elm widget as the content of the ctxpopup.
498 * @param obj Ctxpopup object
499 * @param content Content to be swallowed
501 * If the content object is already set, a previous one will be deleted. If
502 * you want to keep that old content object, use the
503 * elm_ctxpopup_content_unset() function.
505 * @warning Ctxpopup can't hold both a item list and a content at the same
506 * time. When a content is set, any previous items will be removed.
508 * @deprecated use elm_object_content_set() instead
512 EINA_DEPRECATED EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content);
515 * @brief Unset the ctxpopup content
517 * @param obj Ctxpopup object
518 * @return The content that was being used
520 * Unparent and return the content object which was set for this widget.
522 * @deprecated use elm_object_content_unset()
524 * @see elm_ctxpopup_content_set()
526 * @deprecated use elm_object_content_unset() instead
530 EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj);
533 * @brief Delete the given item in a ctxpopup object.
535 * @param it Ctxpopup item to be deleted
537 * @deprecated Use elm_object_item_del() instead
538 * @see elm_ctxpopup_item_append()
542 EINA_DEPRECATED EAPI void elm_ctxpopup_item_del(Elm_Object_Item *it);
545 * Set the label for a given file selector button widget
547 * @param obj The file selector button widget
548 * @param label The text label to be displayed on @p obj
550 * @deprecated use elm_object_text_set() instead.
552 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label);
555 * Get the label set for a given file selector button widget
557 * @param obj The file selector button widget
558 * @return The button label
560 * @deprecated use elm_object_text_set() instead.
562 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj);
565 * Set the icon on a given file selector button widget
567 * @param obj The file selector button widget
568 * @param icon The icon object for the button
570 * Once the icon object is set, a previously set one will be
571 * deleted. If you want to keep the latter, use the
572 * elm_fileselector_button_icon_unset() function.
574 * @deprecated Use elm_object_part_content_set() instead
575 * @see elm_fileselector_button_icon_get()
577 EINA_DEPRECATED EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon);
580 * Get the icon set for a given file selector button widget
582 * @param obj The file selector button widget
583 * @return The icon object currently set on @p obj or @c NULL, if
586 * @deprecated Use elm_object_part_content_get() instead
587 * @see elm_fileselector_button_icon_set()
589 EINA_DEPRECATED EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj);
592 * Unset the icon used in a given file selector button widget
594 * @param obj The file selector button widget
595 * @return The icon object that was being used on @p obj or @c
598 * Unparent and return the icon object which was set for this
601 * @deprecated Use elm_object_part_content_unset() instead
602 * @see elm_fileselector_button_icon_set()
604 EINA_DEPRECATED EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj);
607 * Set the label for a given file selector entry widget's button
609 * @param obj The file selector entry widget
610 * @param label The text label to be displayed on @p obj widget's
613 * @deprecated use elm_object_text_set() instead.
615 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label);
618 * Get the label set for a given file selector entry widget's button
620 * @param obj The file selector entry widget
621 * @return The widget button's label
623 * @deprecated use elm_object_text_set() instead.
625 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj);
628 * Set the icon on a given file selector entry widget's button
630 * @param obj The file selector entry widget
631 * @param icon The icon object for the entry's button
633 * Once the icon object is set, a previously set one will be
634 * deleted. If you want to keep the latter, use the
635 * elm_fileselector_entry_button_icon_unset() function.
637 * @deprecated Use elm_object_part_content_set() instead
638 * @see elm_fileselector_entry_button_icon_get()
640 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon);
643 * Get the icon set for a given file selector entry widget's button
645 * @param obj The file selector entry widget
646 * @return The icon object currently set on @p obj widget's button
647 * or @c NULL, if none is
649 * @deprecated Use elm_object_part_content_get() instead
650 * @see elm_fileselector_entry_button_icon_set()
652 EINA_DEPRECATED EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj);
655 * Unset the icon used in a given file selector entry widget's
658 * @param obj The file selector entry widget
659 * @return The icon object that was being used on @p obj widget's
660 * button or @c NULL, on errors
662 * Unparent and return the icon object which was set for this
665 * @deprecated Use elm_object_part_content_unset() instead
666 * @see elm_fileselector_entry_button_icon_set()
668 EINA_DEPRECATED EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj);
671 * @brief Sets the content of the hover object and the direction in which it
674 * @param obj The hover object
675 * @param swallow The direction that the object will be displayed
676 * at. Accepted values are "left", "top-left", "top", "top-right",
677 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
679 * @param content The content to place at @p swallow
681 * Once the content object is set for a given direction, a previously
682 * set one (on the same direction) will be deleted. If you want to
683 * keep that old content object, use the elm_object_part_content_unset()
686 * All directions may have contents at the same time, except for
687 * "smart". This is a special placement hint and its use case
688 * depends of the calculations coming from
689 * elm_hover_best_content_location_get(). Its use is for cases when
690 * one desires only one hover content, but with a dynamic special
691 * placement within the hover area. The content's geometry, whenever
692 * it changes, will be used to decide on a best location, not
693 * extrapolating the hover's parent object view to show it in (still
694 * being the hover's target determinant of its medium part -- move and
695 * resize it to simulate finger sizes, for example). If one of the
696 * directions other than "smart" are used, a previously content set
697 * using it will be deleted, and vice-versa.
699 * @deprecated Use elm_object_part_content_set() instead
701 EINA_DEPRECATED EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content);
704 * @brief Get the content of the hover object, in a given direction.
706 * Return the content object which was set for this widget in the
707 * @p swallow direction.
709 * @param obj The hover object
710 * @param swallow The direction that the object was display at.
711 * @return The content that was being used
713 * @deprecated Use elm_object_part_content_get() instead
714 * @see elm_object_part_content_set()
716 EINA_DEPRECATED EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow);
719 * @brief Unset the content of the hover object, in a given direction.
721 * Unparent and return the content object set at @p swallow direction.
723 * @param obj The hover object
724 * @param swallow The direction that the object was display at.
725 * @return The content that was being used.
727 * @deprecated Use elm_object_part_content_unset() instead
728 * @see elm_object_part_content_set()
730 EINA_DEPRECATED EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow);
733 * @brief Set the hoversel button label
735 * @param obj The hoversel object
736 * @param label The label text.
738 * This sets the label of the button that is always visible (before it is
739 * clicked and expanded).
741 * @deprecated elm_object_text_set()
743 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label);
746 * @brief Get the hoversel button label
748 * @param obj The hoversel object
749 * @return The label text.
751 * @deprecated elm_object_text_get()
753 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj);
756 * @brief Set the icon of the hoversel button
758 * @param obj The hoversel object
759 * @param icon The icon object
761 * Sets the icon of the button that is always visible (before it is clicked
762 * and expanded). Once the icon object is set, a previously set one will be
763 * deleted, if you want to keep that old content object, use the
764 * elm_hoversel_icon_unset() function.
766 * @see elm_object_content_set() for the button widget
767 * @deprecated Use elm_object_item_part_content_set() instead
769 EINA_DEPRECATED EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon);
772 * @brief Get the icon of the hoversel button
774 * @param obj The hoversel object
775 * @return The icon object
777 * Get the icon of the button that is always visible (before it is clicked
778 * and expanded). Also see elm_object_content_get() for the button widget.
780 * @see elm_hoversel_icon_set()
781 * @deprecated Use elm_object_item_part_content_get() instead
783 EINA_DEPRECATED EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj);
786 * @brief Get and unparent the icon of the hoversel button
788 * @param obj The hoversel object
789 * @return The icon object that was being used
791 * Unparent and return the icon of the button that is always visible
792 * (before it is clicked and expanded).
794 * @see elm_hoversel_icon_set()
795 * @see elm_object_content_unset() for the button widget
796 * @deprecated Use elm_object_item_part_content_unset() instead
798 EINA_DEPRECATED EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj);
801 * @brief This returns the data pointer supplied with elm_hoversel_item_add()
802 * that will be passed to associated function callbacks.
804 * @param it The item to get the data from
805 * @return The data pointer set with elm_hoversel_item_add()
807 * @see elm_hoversel_item_add()
808 * @deprecated Use elm_object_item_data_get() instead
810 EINA_DEPRECATED EAPI void *elm_hoversel_item_data_get(const Elm_Object_Item *it);
813 * @brief This returns the label text of the given hoversel item.
815 * @param it The item to get the label
816 * @return The label text of the hoversel item
818 * @see elm_hoversel_item_add()
819 * @deprecated Use elm_object_item_text_get() instead
821 EINA_DEPRECATED EAPI const char *elm_hoversel_item_label_get(const Elm_Object_Item *it);
824 * @brief Set the function to be called when an item from the hoversel is
827 * @param it The item to set the callback on
828 * @param func The function called
830 * That function will receive these parameters:
831 * @li void * item data
832 * @li Evas_Object * hoversel object
833 * @li Elm_Object_Item * hoversel item
835 * @see elm_hoversel_item_add()
836 * @deprecated Use elm_object_item_del_cb_set() instead
838 EINA_DEPRECATED EAPI void elm_hoversel_item_del_cb_set(Elm_Object_Item *it, Evas_Smart_Cb func);
841 * @brief Delete an item from the hoversel
843 * @param it The item to delete
845 * This deletes the item from the hoversel (should not be called while the
846 * hoversel is active; use elm_hoversel_expanded_get() to check first).
848 * @deprecated Use elm_object_item_del() instead
849 * @see elm_hoversel_item_add()
851 EINA_DEPRECATED EAPI void elm_hoversel_item_del(Elm_Object_Item *it);
854 * Set the overlay object used for the background object.
856 * @param obj The bg object
857 * @param overlay The overlay object
859 * This provides a way for elm_bg to have an 'overlay' that will be on top
860 * of the bg. Once the over object is set, a previously set one will be
861 * deleted, even if you set the new one to NULL. If you want to keep that
862 * old content object, use the elm_bg_overlay_unset() function.
864 * @deprecated use elm_object_part_content_set() instead
869 EINA_DEPRECATED EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay);
872 * Get the overlay object used for the background object.
874 * @param obj The bg object
875 * @return The content that is being used
877 * Return the content object which is set for this widget
879 * @deprecated use elm_object_part_content_get() instead
883 EINA_DEPRECATED EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj);
886 * Get the overlay object used for the background object.
888 * @param obj The bg object
889 * @return The content that was being used
891 * Unparent and return the overlay object which was set for this widget
893 * @deprecated use elm_object_part_content_unset() instead
897 EINA_DEPRECATED EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj);
901 * Set the label of the bubble
903 * @param obj The bubble object
904 * @param label The string to set in the label
906 * This function sets the title of the bubble. Where this appears depends on
907 * the selected corner.
908 * @deprecated use elm_object_text_set() instead.
910 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label);
913 * Get the label of the bubble
915 * @param obj The bubble object
916 * @return The string of set in the label
918 * This function gets the title of the bubble.
919 * @deprecated use elm_object_text_get() instead.
921 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj);
924 * Set the info of the bubble
926 * @param obj The bubble object
927 * @param info The given info about the bubble
929 * This function sets the info of the bubble. Where this appears depends on
930 * the selected corner.
931 * @deprecated use elm_object_part_text_set() instead. (with "info" as the parameter).
933 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info);
936 * Get the info of the bubble
938 * @param obj The bubble object
940 * @return The "info" string of the bubble
942 * This function gets the info text.
943 * @deprecated use elm_object_part_text_get() instead. (with "info" as the parameter).
945 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj);
948 * Set the content to be shown in the bubble
950 * Once the content object is set, a previously set one will be deleted.
951 * If you want to keep the old content object, use the
952 * elm_bubble_content_unset() function.
954 * @param obj The bubble object
955 * @param content The given content of the bubble
957 * This function sets the content shown on the middle of the bubble.
959 * @deprecated use elm_object_content_set() instead
962 EINA_DEPRECATED EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content);
965 * Get the content shown in the bubble
967 * Return the content object which is set for this widget.
969 * @param obj The bubble object
970 * @return The content that is being used
972 * @deprecated use elm_object_content_get() instead
975 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj);
978 * Unset the content shown in the bubble
980 * Unparent and return the content object which was set for this widget.
982 * @param obj The bubble object
983 * @return The content that was being used
985 * @deprecated use elm_object_content_unset() instead
988 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj);
991 * Set the icon of the bubble
993 * Once the icon object is set, a previously set one will be deleted.
994 * If you want to keep the old content object, use the
995 * elm_icon_content_unset() function.
997 * @param obj The bubble object
998 * @param icon The given icon for the bubble
1000 * @deprecated use elm_object_part_content_set() instead
1003 EINA_DEPRECATED EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon);
1006 * Get the icon of the bubble
1008 * @param obj The bubble object
1009 * @return The icon for the bubble
1011 * This function gets the icon shown on the top left of bubble.
1013 * @deprecated use elm_object_part_content_get() instead
1016 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj);
1019 * Unset the icon of the bubble
1021 * Unparent and return the icon object which was set for this widget.
1023 * @param obj The bubble object
1024 * @return The icon that was being used
1026 * @deprecated use elm_object_part_content_unset() instead
1029 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj);
1033 * Set the label used in the button
1035 * The passed @p label can be NULL to clean any existing text in it and
1036 * leave the button as an icon only object.
1038 * @param obj The button object
1039 * @param label The text will be written on the button
1040 * @deprecated use elm_object_text_set() instead.
1042 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label);
1045 * Get the label set for the button
1047 * The string returned is an internal pointer and should not be freed or
1048 * altered. It will also become invalid when the button is destroyed.
1049 * The string returned, if not NULL, is a stringshare, so if you need to
1050 * keep it around even after the button is destroyed, you can use
1051 * eina_stringshare_ref().
1053 * @param obj The button object
1054 * @return The text set to the label, or NULL if nothing is set
1055 * @deprecated use elm_object_text_set() instead.
1057 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj);
1060 * Set the icon used for the button
1062 * Setting a new icon will delete any other that was previously set, making
1063 * any reference to them invalid. If you need to maintain the previous
1064 * object alive, unset it first with elm_button_icon_unset().
1066 * @param obj The button object
1067 * @param icon The icon object for the button
1068 * @deprecated use elm_object_part_content_set() instead.
1070 EINA_DEPRECATED EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon);
1073 * Get the icon used for the button
1075 * Return the icon object which is set for this widget. If the button is
1076 * destroyed or another icon is set, the returned object will be deleted
1077 * and any reference to it will be invalid.
1079 * @param obj The button object
1080 * @return The icon object that is being used
1082 * @deprecated use elm_object_part_content_get() instead
1084 EINA_DEPRECATED EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj);
1087 * Remove the icon set without deleting it and return the object
1089 * This function drops the reference the button holds of the icon object
1090 * and returns this last object. It is used in case you want to remove any
1091 * icon, or set another one, without deleting the actual object. The button
1092 * will be left without an icon set.
1094 * @param obj The button object
1095 * @return The icon object that was being used
1096 * @deprecated use elm_object_part_content_unset() instead.
1098 EINA_DEPRECATED EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj);
1101 * @brief Set the text label of the check object
1103 * @param obj The check object
1104 * @param label The text label string in UTF-8
1106 * @deprecated use elm_object_text_set() instead.
1108 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label);
1111 * @brief Get the text label of the check object
1113 * @param obj The check object
1114 * @return The text label string in UTF-8
1116 * @deprecated use elm_object_text_get() instead.
1118 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj);
1121 * @brief Set the icon object of the check object
1123 * @param obj The check object
1124 * @param icon The icon object
1126 * Once the icon object is set, a previously set one will be deleted.
1127 * If you want to keep that old content object, use the
1128 * elm_object_content_unset() function.
1130 * @deprecated use elm_object_part_content_set() instead.
1133 EINA_DEPRECATED EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon);
1136 * @brief Get the icon object of the check object
1138 * @param obj The check object
1139 * @return The icon object
1141 * @deprecated use elm_object_part_content_get() instead.
1144 EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj);
1147 * @brief Unset the icon used for the check object
1149 * @param obj The check object
1150 * @return The icon object that was being used
1152 * Unparent and return the icon object which was set for this widget.
1154 * @deprecated use elm_object_part_content_unset() instead.
1157 EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj);
1160 * @brief Set the text label of the check object
1162 * @param obj The check object
1163 * @param label The text label string in UTF-8
1165 * @deprecated use elm_object_text_set() instead.
1167 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label);
1170 * @brief Get the text label of the check object
1172 * @param obj The check object
1173 * @return The text label string in UTF-8
1175 * @deprecated use elm_object_text_get() instead.
1177 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj);
1180 * @brief Set the icon object of the check object
1182 * @param obj The check object
1183 * @param icon The icon object
1185 * Once the icon object is set, a previously set one will be deleted.
1186 * If you want to keep that old content object, use the
1187 * elm_object_content_unset() function.
1189 * @deprecated use elm_object_part_content_set() instead.
1192 EINA_DEPRECATED EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon);
1195 * @brief Get the icon object of the check object
1197 * @param obj The check object
1198 * @return The icon object
1200 * @deprecated use elm_object_part_content_get() instead.
1203 EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj);
1206 * @brief Unset the icon used for the check object
1208 * @param obj The check object
1209 * @return The icon object that was being used
1211 * Unparent and return the icon object which was set for this widget.
1213 * @deprecated use elm_object_part_content_unset() instead.
1216 EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj);
1218 EINA_DEPRECATED EAPI void elm_check_states_labels_set(Evas_Object *obj, const char *ontext, const char *offtext);
1219 EINA_DEPRECATED EAPI void elm_check_states_labels_get(const Evas_Object *obj, const char **ontext, const char **offtext);
1223 * Set the interval on time updates for a user mouse button hold
1224 * on clock widgets' time edition.
1226 * @param obj The clock object
1227 * @param interval The (first) interval value in seconds
1229 * This interval value is @b decreased while the user holds the
1230 * mouse pointer either incrementing or decrementing a given the
1231 * clock digit's value.
1233 * This helps the user to get to a given time distant from the
1234 * current one easier/faster, as it will start to flip quicker and
1235 * quicker on mouse button holds.
1237 * The calculation for the next flip interval value, starting from
1238 * the one set with this call, is the previous interval divided by
1239 * 1.05, so it decreases a little bit.
1241 * The default starting interval value for automatic flips is
1244 * @deprecated elm_clock_first_interval_set()
1247 EINA_DEPRECATED EAPI void elm_clock_interval_set(Evas_Object *obj, double interval);
1250 * Get the interval on time updates for a user mouse button hold
1251 * on clock widgets' time edition.
1253 * @param obj The clock object
1254 * @return The (first) interval value, in seconds, set on it
1256 * @elm_clock_first_interval_get()
1258 EINA_DEPRECATED EAPI double elm_clock_interval_get(const Evas_Object *obj);
1261 * Set what digits of the given clock widget should be editable
1262 * when in edition mode.
1264 * @param obj The clock object
1265 * @param digedit Bit mask indicating the digits to be editable
1266 * (values in #Elm_Clock_Edit_Mode).
1268 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
1269 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
1272 * @deprecated elm_clock_edit_mode_set()
1274 EINA_DEPRECATED EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Edit_Mode digedit);
1277 * Retrieve what digits of the given clock widget should be
1278 * editable when in edition mode.
1280 * @param obj The clock object
1281 * @return Bit mask indicating the digits to be editable
1282 * (values in #Elm_Clock_Edit_Mode).
1284 * @deprecated elm_clock_edit_mode_get()
1286 EINA_DEPRECATED EAPI Elm_Clock_Edit_Mode elm_clock_digit_edit_get(const Evas_Object *obj);
1289 * Set the content of the conformant widget.
1291 * @param obj The conformant object.
1292 * @param content The content to be displayed by the conformant.
1294 * Content will be sized and positioned considering the space required
1295 * to display a virtual keyboard. So it won't fill all the conformant
1296 * size. This way is possible to be sure that content won't resize
1297 * or be re-positioned after the keyboard is displayed.
1299 * Once the content object is set, a previously set one will be deleted.
1300 * If you want to keep that old content object, use the
1301 * elm_object_content_unset() function.
1303 * @see elm_object_content_unset()
1304 * @see elm_object_content_get()
1306 * @deprecated use elm_object_content_set() instead
1308 * @ingroup Conformant
1310 EINA_DEPRECATED EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content);
1313 * Get the content of the conformant widget.
1315 * @param obj The conformant object.
1316 * @return The content that is being used.
1318 * Return the content object which is set for this widget.
1319 * It won't be unparent from conformant. For that, use
1320 * elm_object_content_unset().
1322 * @see elm_object_content_set().
1323 * @see elm_object_content_unset()
1325 * @deprecated use elm_object_content_get() instead
1327 * @ingroup Conformant
1329 EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj);
1332 * Unset the content of the conformant widget.
1334 * @param obj The conformant object.
1335 * @return The content that was being used.
1337 * Unparent and return the content object which was set for this widget.
1339 * @see elm_object_content_set().
1341 * @deprecated use elm_object_content_unset() instead
1343 * @ingroup Conformant
1345 EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj);
1348 * Returns the Evas_Object that represents the content area.
1350 * @param obj The conformant object.
1351 * @return The content area of the widget.
1353 * @deprecated use elm_object_content_get() instead
1355 EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj);
1358 * Get the side labels max length.
1360 * @deprecated use elm_diskselector_side_label_length_get() instead:
1362 * @param obj The diskselector object.
1363 * @return The max length defined for side labels, or 0 if not a valid
1366 * @ingroup Diskselector
1368 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj);
1371 * Set the side labels max length.
1373 * @deprecated use elm_diskselector_side_label_length_set() instead:
1375 * @param obj The diskselector object.
1376 * @param len The max length defined for side labels.
1378 * @ingroup Diskselector
1380 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len);
1383 * Get the data associated to the item.
1385 * @param it The diskselector item
1386 * @return The data associated to @p it
1388 * The return value is a pointer to data associated to @p item when it was
1389 * created, with function elm_diskselector_item_append(). If no data
1390 * was passed as argument, it will return @c NULL.
1392 * @see elm_diskselector_item_append()
1393 * @deprecated Use elm_object_item_data_get()
1395 * @ingroup Diskselector
1397 EINA_DEPRECATED EAPI void *elm_diskselector_item_data_get(const Elm_Object_Item *it);
1400 * Set the icon associated to the item.
1402 * @param it The diskselector item
1403 * @param icon The icon object to associate with @p it
1405 * The icon object to use at left side of the item. An
1406 * icon can be any Evas object, but usually it is an icon created
1407 * with elm_icon_add().
1409 * Once the icon object is set, a previously set one will be deleted.
1410 * @warning Setting the same icon for two items will cause the icon to
1411 * disappear from the first item.
1413 * If an icon was passed as argument on item creation, with function
1414 * elm_diskselector_item_append(), it will be already
1415 * associated to the item.
1417 * @see elm_diskselector_item_append()
1418 * @see elm_diskselector_item_icon_get()
1420 * @deprecated Use elm_object_item_part_content_set() instead
1421 * @ingroup Diskselector
1423 EINA_DEPRECATED EAPI void elm_diskselector_item_icon_set(Elm_Object_Item *it, Evas_Object *icon);
1426 * Get the icon associated to the item.
1428 * @param it The diskselector item
1429 * @return The icon associated to @p it
1431 * The return value is a pointer to the icon associated to @p item when it was
1432 * created, with function elm_diskselector_item_append(), or later
1433 * with function elm_diskselector_item_icon_set. If no icon
1434 * was passed as argument, it will return @c NULL.
1436 * @see elm_diskselector_item_append()
1437 * @see elm_diskselector_item_icon_set()
1439 * @deprecated Use elm_object_item_part_content_set() instead
1440 * @ingroup Diskselector
1442 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Object_Item *it);
1445 * Set the label of item.
1447 * @param it The item of diskselector.
1448 * @param label The label of item.
1450 * The label to be displayed by the item.
1452 * If no icon is set, label will be centered on item position, otherwise
1453 * the icon will be placed at left of the label, that will be shifted
1456 * An item with label "January" would be displayed on side position as
1457 * "Jan" if max length is set to 3 with function
1458 * elm_diskselector_side_label_length_set(), or "Janu", if this property
1461 * When this @p item is selected, the entire label will be displayed,
1462 * except for width restrictions.
1463 * In this case label will be cropped and "..." will be concatenated,
1464 * but only for display purposes. It will keep the entire string, so
1465 * if diskselector is resized the remaining characters will be displayed.
1467 * If a label was passed as argument on item creation, with function
1468 * elm_diskselector_item_append(), it will be already
1469 * displayed by the item.
1471 * @see elm_diskselector_side_label_length_set()
1472 * @see elm_diskselector_item_label_get()
1473 * @see elm_diskselector_item_append()
1475 * @deprecated Use elm_object_item_text_set() instead
1476 * @ingroup Diskselector
1478 EINA_DEPRECATED EAPI void elm_diskselector_item_label_set(Elm_Object_Item *it, const char *label);
1481 * Get the label of item.
1483 * @param it The item of diskselector.
1484 * @return The label of item.
1486 * The return value is a pointer to the label associated to @p item when it was
1487 * created, with function elm_diskselector_item_append(), or later
1488 * with function elm_diskselector_item_label_set. If no label
1489 * was passed as argument, it will return @c NULL.
1491 * @see elm_diskselector_item_label_set() for more details.
1492 * @see elm_diskselector_item_append()
1493 * @deprecated Use elm_object_item_text_get() instead
1495 * @ingroup Diskselector
1497 EINA_DEPRECATED EAPI const char *elm_diskselector_item_label_get(const Elm_Object_Item *it);
1500 * Set the function called when a diskselector item is freed.
1502 * @param it The item to set the callback on
1503 * @param func The function called
1505 * If there is a @p func, then it will be called prior item's memory release.
1506 * That will be called with the following arguments:
1508 * @li item's Evas object;
1511 * This way, a data associated to a diskselector item could be properly
1513 * @deprecated Use elm_object_item_del_cb_set() instead
1515 * @ingroup Diskselector
1517 EINA_DEPRECATED EAPI void elm_diskselector_item_del_cb_set(Elm_Object_Item *it, Evas_Smart_Cb func);
1520 * Delete them item from the diskselector.
1522 * @param it The item of diskselector to be deleted.
1524 * If deleting all diskselector items is required, elm_diskselector_clear()
1525 * should be used instead of getting items list and deleting each one.
1527 * @deprecated Use elm_object_item_del() instead
1528 * @see elm_diskselector_clear()
1529 * @see elm_diskselector_item_append()
1531 * @ingroup Diskselector
1533 EINA_DEPRECATED EAPI void elm_diskselector_item_del(Elm_Object_Item *it);
1536 * Set the text to be shown in the diskselector item.
1538 * @param it Target item
1539 * @param text The text to set in the content
1541 * Setup the text as tooltip to object. The item can have only one tooltip,
1542 * so any previous tooltip data is removed.
1544 * @deprecated Use elm_object_item_tooltip_text_set() instead
1545 * @see elm_object_tooltip_text_set() for more details.
1547 * @ingroup Diskselector
1549 EINA_DEPRECATED EAPI void elm_diskselector_item_tooltip_text_set(Elm_Object_Item *it, const char *text);
1552 * Set the content to be shown in the tooltip item.
1554 * Setup the tooltip to item. The item can have only one tooltip,
1555 * so any previous tooltip data is removed. @p func(with @p data) will
1556 * be called every time that need show the tooltip and it should
1557 * return a valid Evas_Object. This object is then managed fully by
1558 * tooltip system and is deleted when the tooltip is gone.
1560 * @param it the diskselector item being attached a tooltip.
1561 * @param func the function used to create the tooltip contents.
1562 * @param data what to provide to @a func as callback data/context.
1563 * @param del_cb called when data is not needed anymore, either when
1564 * another callback replaces @p func, the tooltip is unset with
1565 * elm_diskselector_item_tooltip_unset() or the owner @a item
1566 * dies. This callback receives as the first parameter the
1567 * given @a data, and @c event_info is the item.
1569 * @deprecated Use elm_object_item_tooltip_content_cb_set() instead
1570 * @see elm_object_tooltip_content_cb_set() for more details.
1572 * @ingroup Diskselector
1574 EINA_DEPRECATED EAPI void elm_diskselector_item_tooltip_content_cb_set(Elm_Object_Item *it, Elm_Tooltip_Item_Content_Cb func, const void *data, Evas_Smart_Cb del_cb);
1577 * Unset tooltip from item.
1579 * @param it diskselector item to remove previously set tooltip.
1581 * Remove tooltip from item. The callback provided as del_cb to
1582 * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
1583 * it is not used anymore.
1585 * @deprecated Use elm_object_item_tooltip_unset() instead
1586 * @see elm_object_tooltip_unset() for more details.
1587 * @see elm_diskselector_item_tooltip_content_cb_set()
1589 * @ingroup Diskselector
1591 EINA_DEPRECATED EAPI void elm_diskselector_item_tooltip_unset(Elm_Object_Item *it);
1594 * Sets a different style for this item tooltip.
1596 * @note before you set a style you should define a tooltip with
1597 * elm_diskselector_item_tooltip_content_cb_set() or
1598 * elm_diskselector_item_tooltip_text_set()
1600 * @param it diskselector item with tooltip already set.
1601 * @param style the theme style to use (default, transparent, ...)
1603 * @deprecated Use elm_object_item_tooltip_style_set() instead
1604 * @see elm_object_tooltip_style_set() for more details.
1606 * @ingroup Diskselector
1608 EINA_DEPRECATED EAPI void elm_diskselector_item_tooltip_style_set(Elm_Object_Item *it, const char *style);
1611 * Get the style for this item tooltip.
1613 * @param it diskselector item with tooltip already set.
1614 * @return style the theme style in use, defaults to "default". If the
1615 * object does not have a tooltip set, then NULL is returned.
1617 * @deprecated Use elm_object_item_tooltip_style_get() instead
1618 * @see elm_object_tooltip_style_get() for more details.
1619 * @see elm_diskselector_item_tooltip_style_set()
1621 * @ingroup Diskselector
1623 EINA_DEPRECATED EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Object_Item *it);
1626 * Set the cursor to be shown when mouse is over the diskselector item
1628 * @param it Target item
1629 * @param cursor the cursor name to be used.
1631 * @see elm_object_cursor_set() for more details.
1632 * @deprecated Use elm_object_item_cursor_set() instead
1634 * @ingroup Diskselector
1636 EINA_DEPRECATED EAPI void elm_diskselector_item_cursor_set(Elm_Object_Item *it, const char *cursor);
1639 * Get the cursor to be shown when mouse is over the diskselector item
1641 * @param it diskselector item with cursor already set.
1642 * @return the cursor name.
1644 * @see elm_object_cursor_get() for more details.
1645 * @see elm_diskselector_item_cursor_set()
1646 * @deprecated Use elm_object_item_cursor_get() instead
1648 * @ingroup Diskselector
1650 EINA_DEPRECATED EAPI const char *elm_diskselector_item_cursor_get(const Elm_Object_Item *it);
1653 * Unset the cursor to be shown when mouse is over the diskselector item
1655 * @param it Target item
1657 * @see elm_object_cursor_unset() for more details.
1658 * @see elm_diskselector_item_cursor_set()
1659 * @deprecated use elm_object_item_cursor_unset() instead
1661 * @ingroup Diskselector
1663 EINA_DEPRECATED EAPI void elm_diskselector_item_cursor_unset(Elm_Object_Item *it);
1666 * Sets a different style for this item cursor.
1668 * @note before you set a style you should define a cursor with
1669 * elm_diskselector_item_cursor_set()
1671 * @param it diskselector item with cursor already set.
1672 * @param style the theme style to use (default, transparent, ...)
1674 * @see elm_object_cursor_style_set() for more details.
1675 * @deprecated Use elm_object_item_cursor_style_set() instead
1677 * @ingroup Diskselector
1679 EINA_DEPRECATED EAPI void elm_diskselector_item_cursor_style_set(Elm_Object_Item *it, const char *style);
1682 * Get the style for this item cursor.
1684 * @param it diskselector item with cursor already set.
1685 * @return style the theme style in use, defaults to "default". If the
1686 * object does not have a cursor set, then @c NULL is returned.
1688 * @see elm_object_cursor_style_get() for more details.
1689 * @see elm_diskselector_item_cursor_style_set()
1690 * @deprecated Use elm_object_item_cursor_style_get() instead
1692 * @ingroup Diskselector
1694 EINA_DEPRECATED EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Object_Item *it);
1697 * Set if the cursor set should be searched on the theme or should use
1698 * the provided by the engine, only.
1700 * @note before you set if should look on theme you should define a cursor
1701 * with elm_diskselector_item_cursor_set().
1702 * By default it will only look for cursors provided by the engine.
1704 * @param it widget item with cursor already set.
1705 * @param engine_only boolean to define if cursors set with
1706 * elm_diskselector_item_cursor_set() should be searched only
1707 * between cursors provided by the engine or searched on widget's
1710 * @deprecated Use elm_object_item_cursor_engine_only_set() instead
1712 * @ingroup Diskselector
1714 EINA_DEPRECATED EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Object_Item *it, Eina_Bool engine_only);
1717 * Get the cursor engine only usage for this item cursor.
1719 * @param it widget item with cursor already set.
1720 * @return engine_only boolean to define it cursors should be looked only
1721 * between the provided by the engine or searched on widget's theme as well.
1722 * If the item does not have a cursor set, then @c EINA_FALSE is returned.
1724 * @see elm_diskselector_item_cursor_engine_only_set()
1725 * @deprecated Use elm_object_item_cursor_engine_only_get() instead
1727 * @ingroup Diskselector
1729 EINA_DEPRECATED EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Object_Item *it);
1731 EINA_DEPRECATED EAPI void elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
1732 EINA_DEPRECATED EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
1735 * Get the label of a given flip selector widget's item.
1737 * @param it The item to get label from
1738 * @return The text label of @p item or @c NULL, on errors
1740 * @see elm_object_item_text_set()
1742 * @deprecated see elm_object_item_text_get() instead
1743 * @ingroup Flipselector
1745 EINA_DEPRECATED EAPI const char *elm_flipselector_item_label_get(const Elm_Object_Item *it);
1748 * Set the label of a given flip selector widget's item.
1750 * @param it The item to set label on
1751 * @param label The text label string, in UTF-8 encoding
1753 * @see elm_object_item_text_get()
1755 * @deprecated see elm_object_item_text_set() instead
1756 * @ingroup Flipselector
1758 EINA_DEPRECATED EAPI void elm_flipselector_item_label_set(Elm_Object_Item *it, const char *label);
1761 * Delete a given item from a flip selector widget.
1763 * @param it The item to delete
1765 * @deprecated Use elm_object_item_del() instead
1766 * @ingroup Flipselector
1768 EINA_DEPRECATED EAPI void elm_flipselector_item_del(Elm_Object_Item *it);
1771 * Set the interval on time updates for a user mouse button hold
1772 * on a flip selector widget.
1774 * @param obj The flip selector object
1775 * @param interval The (first) interval value in seconds
1777 * This interval value is @b decreased while the user holds the
1778 * mouse pointer either flipping up or flipping down a given flip
1781 * This helps the user to get to a given item distant from the
1782 * current one easier/faster, as it will start to flip quicker and
1783 * quicker on mouse button holds.
1785 * The calculation for the next flip interval value, starting from
1786 * the one set with this call, is the previous interval divided by
1787 * 1.05, so it decreases a little bit.
1789 * The default starting interval value for automatic flips is
1792 * @see elm_flipselector_interval_get()
1793 * @deprecated Use elm_flipselector_first_interval_set()
1795 * @ingroup Flipselector
1797 EINA_DEPRECATED EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval);
1800 * Get the interval on time updates for an user mouse button hold
1801 * on a flip selector widget.
1803 * @param obj The flip selector object
1804 * @return The (first) interval value, in seconds, set on it
1806 * @see elm_flipselector_interval_set() for more details
1807 * @deprecated Use elm_flipselector_first_interval_get()
1809 * @ingroup Flipselector
1811 EINA_DEPRECATED EAPI double elm_flipselector_interval_get(const Evas_Object *obj);
1814 * Make a given Elementary object the focused one.
1816 * @param obj The Elementary object to make focused.
1818 * @note This object, if it can handle focus, will take the focus
1819 * away from the one who had it previously and will, for now on, be
1820 * the one receiving input events.
1822 * @see elm_object_focus_get()
1823 * @deprecated use elm_object_focus_set() instead.
1827 EINA_DEPRECATED EAPI void elm_object_focus(Evas_Object *obj);
1830 * Remove the focus from an Elementary object
1832 * @param obj The Elementary to take focus from
1834 * This removes the focus from @p obj, passing it back to the
1835 * previous element in the focus chain list.
1837 * @see elm_object_focus() and elm_object_focus_custom_chain_get()
1838 * @deprecated use elm_object_focus_set() instead.
1842 EINA_DEPRECATED EAPI void elm_object_unfocus(Evas_Object *obj);
1845 * Give focus to near object in one direction.
1847 * Give focus to near object in direction of one object.
1848 * If none focusable object in given direction, the focus will not change.
1850 * @param obj The reference object
1851 * @param x Horizontal component of direction to focus
1852 * @param y Vertical component of direction to focus
1854 * @deprecated Support it later.
1857 EINA_DEPRECATED EAPI void elm_object_focus_direction_go(Evas_Object *obj, int x, int y);
1860 * @brief Set the frame label
1862 * @param obj The frame object
1863 * @param label The label of this frame object
1865 * @deprecated use elm_object_text_set() instead.
1867 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label);
1870 * @brief Get the frame label
1872 * @param obj The frame object
1874 * @return The label of this frame object or NULL if unable to get frame
1876 * @deprecated use elm_object_text_get() instead.
1878 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj);
1881 * @brief Set the content of the frame widget
1883 * Once the content object is set, a previously set one will be deleted.
1884 * If you want to keep that old content object, use the
1885 * elm_frame_content_unset() function.
1887 * @param obj The frame object
1888 * @param content The content will be filled in this frame object
1890 * @deprecated use elm_object_content_set() instead.
1892 EINA_DEPRECATED EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content);
1895 * @brief Get the content of the frame widget
1897 * Return the content object which is set for this widget
1899 * @param obj The frame object
1900 * @return The content that is being used
1902 * @deprecated use elm_object_content_get() instead.
1904 EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj);
1907 * @brief Unset the content of the frame widget
1909 * Unparent and return the content object which was set for this widget
1911 * @param obj The frame object
1912 * @return The content that was being used
1914 * @deprecated use elm_object_content_unset() instead.
1916 EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj);
1918 EINA_DEPRECATED EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode);
1919 EINA_DEPRECATED EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj);
1920 EINA_DEPRECATED EAPI void elm_genlist_item_icons_orphan(Elm_Object_Item *it);
1922 * This sets the horizontal stretching mode.
1924 * @param obj The genlist object
1925 * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
1927 * This sets the mode used for sizing items horizontally. Valid modes
1928 * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
1929 * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
1930 * the scroller will scroll horizontally. Otherwise items are expanded
1931 * to fill the width of the viewport of the scroller. If it is
1932 * ELM_LIST_LIMIT, items will be expanded to the viewport width and
1933 * limited to that size.
1935 * @see elm_genlist_horizontal_get()
1937 * @deprecated use elm_genlist_mode_set()
1940 EINA_DEPRECATED EAPI void elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode);
1943 * Gets the horizontal stretching mode.
1945 * @param obj The genlist object
1946 * @return The mode to use
1947 * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
1949 * @see elm_genlist_horizontal_set()
1951 * @deprecated use elm_genlist_mode_get()
1954 EINA_DEPRECATED EAPI Elm_List_Mode elm_genlist_horizontal_get(const Evas_Object *obj);
1957 * Return the data associated to a given genlist item
1959 * @param it The genlist item.
1960 * @return the data associated to this item.
1962 * This returns the @c data value passed on the
1963 * elm_genlist_item_append() and related item addition calls.
1965 * @see elm_genlist_item_append()
1966 * @see elm_genlist_item_data_set()
1968 * @deprecated Use elm_object_item_data_get() instead
1971 EINA_DEPRECATED EAPI void *elm_genlist_item_data_get(const Elm_Object_Item *it);
1974 * Set the data associated to a given genlist item
1976 * @param it The genlist item
1977 * @param data The new data pointer to set on it
1979 * This @b overrides the @c data value passed on the
1980 * elm_genlist_item_append() and related item addition calls. This
1981 * function @b won't call elm_genlist_item_update() automatically,
1982 * so you'd issue it afterwards if you want to hove the item
1983 * updated to reflect the that new data.
1985 * @see elm_genlist_item_data_get()
1987 * @deprecated Use elm_object_item_data_set() instead
1990 EINA_DEPRECATED EAPI void elm_genlist_item_data_set(Elm_Object_Item *it, const void *data);
1993 * Set whether a given genlist item is disabled or not.
1995 * @param it The item
1996 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
1997 * to enable it back.
1999 * A disabled item cannot be selected or unselected. It will also
2000 * change its appearance, to signal the user it's disabled.
2002 * @see elm_genlist_item_disabled_get()
2003 * @deprecated Use elm_object_item_disabled_set() instead
2007 EINA_DEPRECATED EAPI void elm_genlist_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled);
2010 * Get whether a given genlist item is disabled or not.
2012 * @param it The item
2013 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
2016 * @see elm_genlist_item_disabled_set() for more details
2017 * @deprecated Use elm_object_item_disabled_get() instead
2021 EINA_DEPRECATED EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Object_Item *it);
2024 * Remove a genlist item from the its parent, deleting it.
2026 * @param it The item to be removed.
2027 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
2029 * @see elm_genlist_clear(), to remove all items in a genlist at
2032 * @deprecated Use elm_object_item_del() instead
2035 EINA_DEPRECATED EAPI void elm_genlist_item_del(Elm_Object_Item *it);
2038 * Get the genlist object's handle which contains a given genlist
2041 * @param it The item to fetch the container from
2042 * @return The genlist (parent) object
2044 * This returns the genlist object itself that an item belongs to.
2045 * @deprecated Use elm_object_item_widget_get() instead
2049 EINA_DEPRECATED EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Object_Item *it);
2052 * Get the mode item style of items in the genlist
2053 * @param obj The genlist object
2054 * @return The mode item style string, or NULL if none is specified
2056 * This is a constant string and simply defines the name of the
2057 * style that will be used for mode animations. It can be
2058 * @c NULL if you don't plan to use Genlist mode. See
2059 * elm_genlist_item_mode_set() for more info.
2063 EINA_DEPRECATED EAPI const char *elm_genlist_mode_item_style_get(const Evas_Object *obj);
2066 * Set the mode item style of items in the genlist
2067 * @param obj The genlist object
2068 * @param style The mode item style string, or NULL if none is desired
2070 * This is a constant string and simply defines the name of the
2071 * style that will be used for mode animations. It can be
2072 * @c NULL if you don't plan to use Genlist mode. See
2073 * elm_genlist_item_mode_set() for more info.
2077 EINA_DEPRECATED EAPI void elm_genlist_mode_item_style_set(Evas_Object *obj, const char *style);
2080 * Get the real Evas object created to implement the view of a
2081 * given genlist item
2083 * @param it The genlist item.
2084 * @return the Evas object implementing this item's view.
2086 * This returns the actual Evas object used to implement the
2087 * specified genlist item's view. This may be @c NULL, as it may
2088 * not have been created or may have been deleted, at any time, by
2089 * the genlist. <b>Do not modify this object</b> (move, resize,
2090 * show, hide, etc.), as the genlist is controlling it. This
2091 * function is for querying, emitting custom signals or hooking
2092 * lower level callbacks for events on that object. Do not delete
2093 * this object under any circumstances.
2095 * @see elm_object_item_data_get()
2096 * @deprecated No more support
2100 EINA_DEPRECATED EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Object_Item *it);
2103 * Get the Item's Flags
2105 * @param it The genlist item
2106 * @return The item type.
2108 * This function returns the item's type. Normally the item's type.
2109 * If it failed, return value is ELM_GENLIST_ITEM_MAX
2111 * @deprecated Use elm_genlist_item_type_get() instead
2114 EINA_DEPRECATED EAPI Elm_Genlist_Item_Type elm_genlist_item_flags_get(const Elm_Object_Item *it);
2117 * Tells genlist to "orphan" contents fetched by the item class
2119 * @param it The item
2121 * This instructs genlist to release references to contents in the item,
2122 * meaning that they will no longer be managed by genlist and are
2123 * floating "orphans" that can be re-used elsewhere if the user wants
2126 * @deprecated Use elm_genlist_item_all_contents_unset() instead