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);