2 * @defgroup Toggle Toggle
4 * @image html img/widget/toggle/preview-00.png
5 * @image latex img/widget/toggle/preview-00.eps
7 * @brief A toggle is a slider which can be used to toggle between
8 * two values. It has two states: on and off.
10 * This widget is deprecated. Please use elm_check_add() instead using the
14 * obj = elm_check_add(parent);
15 * elm_object_style_set(obj, "toggle");
16 * elm_object_part_text_set(obj, "on", "ON");
17 * elm_object_part_text_set(obj, "off", "OFF");
20 * Signals that you can add callbacks for are:
21 * @li "changed" - Whenever the toggle value has been changed. Is not called
22 * until the toggle is released by the cursor (assuming it
23 * has been triggered by the cursor in the first place).
25 * Default content parts of the toggle widget that you can use for are:
26 * @li "icon" - An icon of the toggle
28 * Default text parts of the toggle widget that you can use for are:
29 * @li "elm.text" - Label of the toggle
31 * @ref tutorial_toggle show how to use a toggle.
36 * @brief Add a toggle to @p parent.
38 * @param parent The parent object
40 * @return The toggle object
42 EINA_DEPRECATED EAPI Evas_Object *elm_toggle_add(Evas_Object *parent);
45 * @brief Sets the label to be displayed with the toggle.
47 * @param obj The toggle object
48 * @param label The label to be displayed
50 * @deprecated use elm_object_text_set() instead.
52 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label);
55 * @brief Gets the label of the toggle
57 * @param obj toggle object
58 * @return The label of the toggle
60 * @deprecated use elm_object_text_get() instead.
62 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj);
65 * @brief Set the icon used for the toggle
67 * @param obj The toggle object
68 * @param icon The icon object for the button
70 * Once the icon object is set, a previously set one will be deleted
71 * If you want to keep that old content object, use the
72 * elm_toggle_icon_unset() function.
74 * @deprecated use elm_object_part_content_set() instead.
76 EINA_DEPRECATED EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon);
79 * @brief Get the icon used for the toggle
81 * @param obj The toggle object
82 * @return The icon object that is being used
84 * Return the icon object which is set for this widget.
86 * @see elm_toggle_icon_set()
88 * @deprecated use elm_object_part_content_get() instead.
90 EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj);
93 * @brief Unset the icon used for the toggle
95 * @param obj The toggle object
96 * @return The icon object that was being used
98 * Unparent and return the icon object which was set for this widget.
100 * @see elm_toggle_icon_set()
102 * @deprecated use elm_object_part_content_unset() instead.
104 EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj);
107 * @brief Sets the labels to be associated with the on and off states of the toggle.
109 * @param obj The toggle object
110 * @param onlabel The label displayed when the toggle is in the "on" state
111 * @param offlabel The label displayed when the toggle is in the "off" state
113 * @deprecated use elm_object_part_text_set() for "on" and "off" parts
116 EINA_DEPRECATED EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel);
119 * @brief Gets the labels associated with the on and off states of the
122 * @param obj The toggle object
123 * @param onlabel A char** to place the onlabel of @p obj into
124 * @param offlabel A char** to place the offlabel of @p obj into
126 * @deprecated use elm_object_part_text_get() for "on" and "off" parts
129 EINA_DEPRECATED EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel);
132 * @brief Sets the state of the toggle to @p state.
134 * @param obj The toggle object
135 * @param state The state of @p obj
137 * @deprecated use elm_check_state_set() instead.
139 EINA_DEPRECATED EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state);
142 * @brief Gets the state of the toggle to @p state.
144 * @param obj The toggle object
145 * @return The state of @p obj
147 * @deprecated use elm_check_state_get() instead.
149 EINA_DEPRECATED EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj);
152 * @brief Sets the state pointer of the toggle to @p statep.
154 * @param obj The toggle object
155 * @param statep The state pointer of @p obj
157 * @deprecated use elm_check_state_pointer_set() instead.
159 EINA_DEPRECATED EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep);
165 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent);
166 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line);
167 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj);
168 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password);
169 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj);
170 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry);
171 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj);
172 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry);
173 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj);
174 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj);
175 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry);
176 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap);
177 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable);
178 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj);
179 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj);
180 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj);
181 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj);
182 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj);
183 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj);
184 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj);
185 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj);
186 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj);
187 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj);
188 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj);
189 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj);
190 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj);
191 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj);
192 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj);
193 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj);
194 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos);
195 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj);
196 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj);
197 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj);
198 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj);
199 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj);
200 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_item_add(Evas_Object *obj, const char *label, const char *icon_file, Elm_Icon_Type icon_type, Evas_Smart_Cb func, const void *data);
201 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled);
202 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj);
203 EINA_DEPRECATED EAPI void elm_scrolled_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
204 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
205 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
206 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
207 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj);
208 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj);
209 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
210 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end);
211 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj);
212 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj);
213 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
214 EINA_DEPRECATED EAPI void elm_scrolled_entry_item_provider_append(Evas_Object *obj, Evas_Object * (*func)(void *data, Evas_Object * entry, const char *item), void *data);
215 EINA_DEPRECATED EAPI void elm_scrolled_entry_item_provider_prepend(Evas_Object *obj, Evas_Object * (*func)(void *data, Evas_Object * entry, const char *item), void *data);
216 EINA_DEPRECATED EAPI void elm_scrolled_entry_item_provider_remove(Evas_Object *obj, Evas_Object * (*func)(void *data, Evas_Object * entry, const char *item), void *data);
217 EINA_DEPRECATED EAPI void elm_scrolled_entry_text_filter_append(Evas_Object *obj, void (*func)(void *data, Evas_Object *entry, char **text), void *data);
218 EINA_DEPRECATED EAPI void elm_scrolled_entry_text_filter_prepend(Evas_Object *obj, void (*func)(void *data, Evas_Object *entry, char **text), void *data);
219 EINA_DEPRECATED EAPI void elm_scrolled_entry_text_filter_remove(Evas_Object *obj, void (*func)(void *data, Evas_Object *entry, char **text), void *data);
220 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format);
221 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format);
222 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj);
223 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave);
224 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj);
225 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly);
226 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj);
229 * @brief Sets the content of the hover object and the direction in which it
232 * @param obj The hover object
233 * @param swallow The direction that the object will be displayed
234 * at. Accepted values are "left", "top-left", "top", "top-right",
235 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
237 * @param content The content to place at @p swallow
239 * Once the content object is set for a given direction, a previously
240 * set one (on the same direction) will be deleted. If you want to
241 * keep that old content object, use the elm_object_part_content_unset()
244 * All directions may have contents at the same time, except for
245 * "smart". This is a special placement hint and its use case
246 * depends of the calculations coming from
247 * elm_hover_best_content_location_get(). Its use is for cases when
248 * one desires only one hover content, but with a dynamic special
249 * placement within the hover area. The content's geometry, whenever
250 * it changes, will be used to decide on a best location, not
251 * extrapolating the hover's parent object view to show it in (still
252 * being the hover's target determinant of its medium part -- move and
253 * resize it to simulate finger sizes, for example). If one of the
254 * directions other than "smart" are used, a previously content set
255 * using it will be deleted, and vice-versa.
257 * @deprecated Use elm_object_part_content_set() instead
259 EINA_DEPRECATED EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content);
262 * @brief Get the content of the hover object, in a given direction.
264 * Return the content object which was set for this widget in the
265 * @p swallow direction.
267 * @param obj The hover object
268 * @param swallow The direction that the object was display at.
269 * @return The content that was being used
271 * @deprecated Use elm_object_part_content_get() instead
272 * @see elm_object_part_content_set()
274 EINA_DEPRECATED EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow);
277 * @brief Unset the content of the hover object, in a given direction.
279 * Unparent and return the content object set at @p swallow direction.
281 * @param obj The hover object
282 * @param swallow The direction that the object was display at.
283 * @return The content that was being used.
285 * @deprecated Use elm_object_part_content_unset() instead
286 * @see elm_object_part_content_set()
288 EINA_DEPRECATED EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow);
291 * @brief Set the hoversel button label
293 * @param obj The hoversel object
294 * @param label The label text.
296 * This sets the label of the button that is always visible (before it is
297 * clicked and expanded).
299 * @deprecated elm_object_text_set()
301 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label);
304 * @brief Get the hoversel button label
306 * @param obj The hoversel object
307 * @return The label text.
309 * @deprecated elm_object_text_get()
311 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj);
314 * @brief Set the icon of the hoversel button
316 * @param obj The hoversel object
317 * @param icon The icon object
319 * Sets the icon of the button that is always visible (before it is clicked
320 * and expanded). Once the icon object is set, a previously set one will be
321 * deleted, if you want to keep that old content object, use the
322 * elm_hoversel_icon_unset() function.
324 * @see elm_object_content_set() for the button widget
325 * @deprecated Use elm_object_item_part_content_set() instead
327 EINA_DEPRECATED EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon);
330 * @brief Get the icon of the hoversel button
332 * @param obj The hoversel object
333 * @return The icon object
335 * Get the icon of the button that is always visible (before it is clicked
336 * and expanded). Also see elm_object_content_get() for the button widget.
338 * @see elm_hoversel_icon_set()
339 * @deprecated Use elm_object_item_part_content_get() instead
341 EINA_DEPRECATED EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj);
344 * @brief Get and unparent the icon of the hoversel button
346 * @param obj The hoversel object
347 * @return The icon object that was being used
349 * Unparent and return the icon of the button that is always visible
350 * (before it is clicked and expanded).
352 * @see elm_hoversel_icon_set()
353 * @see elm_object_content_unset() for the button widget
354 * @deprecated Use elm_object_item_part_content_unset() instead
356 EINA_DEPRECATED EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj);
359 * @brief This returns the data pointer supplied with elm_hoversel_item_add()
360 * that will be passed to associated function callbacks.
362 * @param it The item to get the data from
363 * @return The data pointer set with elm_hoversel_item_add()
365 * @see elm_hoversel_item_add()
366 * @deprecated Use elm_object_item_data_get() instead
368 EINA_DEPRECATED EAPI void *elm_hoversel_item_data_get(const Elm_Object_Item *it);
371 * @brief This returns the label text of the given hoversel item.
373 * @param it The item to get the label
374 * @return The label text of the hoversel item
376 * @see elm_hoversel_item_add()
377 * @deprecated Use elm_object_item_text_get() instead
379 EINA_DEPRECATED EAPI const char *elm_hoversel_item_label_get(const Elm_Object_Item *it);
382 * @brief Set the function to be called when an item from the hoversel is
385 * @param it The item to set the callback on
386 * @param func The function called
388 * That function will receive these parameters:
389 * @li void * item data
390 * @li Evas_Object * hoversel object
391 * @li Elm_Object_Item * hoversel item
393 * @see elm_hoversel_item_add()
394 * @deprecated Use elm_object_item_del_cb_set() instead
396 EINA_DEPRECATED EAPI void elm_hoversel_item_del_cb_set(Elm_Object_Item *it, Evas_Smart_Cb func);
399 * @brief Delete an item from the hoversel
401 * @param it The item to delete
403 * This deletes the item from the hoversel (should not be called while the
404 * hoversel is active; use elm_hoversel_expanded_get() to check first).
406 * @deprecated Use elm_object_item_del() instead
407 * @see elm_hoversel_item_add()
409 EINA_DEPRECATED EAPI void elm_hoversel_item_del(Elm_Object_Item *it);
412 * Set actionslider labels.
414 * @param obj The actionslider object
415 * @param left_label The label to be set on the left.
416 * @param center_label The label to be set on the center.
417 * @param right_label The label to be set on the right.
418 * @deprecated use elm_object_text_set() instead.
420 EINA_DEPRECATED EAPI void elm_actionslider_labels_set(Evas_Object *obj, const char *left_label, const char *center_label, const char *right_label);
423 * Get actionslider labels.
425 * @param obj The actionslider object
426 * @param left_label A char** to place the left_label of @p obj into.
427 * @param center_label A char** to place the center_label of @p obj into.
428 * @param right_label A char** to place the right_label of @p obj into.
429 * @deprecated use elm_object_text_set() instead.
431 EINA_DEPRECATED EAPI void elm_actionslider_labels_get(const Evas_Object *obj, const char **left_label, const char **center_label, const char **right_label);
434 * Set the label used on the indicator.
436 * @param obj The actionslider object
437 * @param label The label to be set on the indicator.
438 * @deprecated use elm_object_text_set() instead.
440 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label);
443 * Get the label used on the indicator object.
445 * @param obj The actionslider object
446 * @return The indicator label
447 * @deprecated use elm_object_text_get() instead.
449 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj);
452 * Set the overlay object used for the background object.
454 * @param obj The bg object
455 * @param overlay The overlay object
457 * This provides a way for elm_bg to have an 'overlay' that will be on top
458 * of the bg. Once the over object is set, a previously set one will be
459 * deleted, even if you set the new one to NULL. If you want to keep that
460 * old content object, use the elm_bg_overlay_unset() function.
462 * @deprecated use elm_object_part_content_set() instead
467 EINA_DEPRECATED EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay);
470 * Get the overlay object used for the background object.
472 * @param obj The bg object
473 * @return The content that is being used
475 * Return the content object which is set for this widget
477 * @deprecated use elm_object_part_content_get() instead
481 EINA_DEPRECATED EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj);
484 * Get the overlay object used for the background object.
486 * @param obj The bg object
487 * @return The content that was being used
489 * Unparent and return the overlay object which was set for this widget
491 * @deprecated use elm_object_part_content_unset() instead
495 EINA_DEPRECATED EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj);
499 * Set the label of the bubble
501 * @param obj The bubble object
502 * @param label The string to set in the label
504 * This function sets the title of the bubble. Where this appears depends on
505 * the selected corner.
506 * @deprecated use elm_object_text_set() instead.
508 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label);
511 * Get the label of the bubble
513 * @param obj The bubble object
514 * @return The string of set in the label
516 * This function gets the title of the bubble.
517 * @deprecated use elm_object_text_get() instead.
519 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj);
522 * Set the info of the bubble
524 * @param obj The bubble object
525 * @param info The given info about the bubble
527 * This function sets the info of the bubble. Where this appears depends on
528 * the selected corner.
529 * @deprecated use elm_object_part_text_set() instead. (with "info" as the parameter).
531 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info);
534 * Get the info of the bubble
536 * @param obj The bubble object
538 * @return The "info" string of the bubble
540 * This function gets the info text.
541 * @deprecated use elm_object_part_text_get() instead. (with "info" as the parameter).
543 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj);
546 * Set the content to be shown in the bubble
548 * Once the content object is set, a previously set one will be deleted.
549 * If you want to keep the old content object, use the
550 * elm_bubble_content_unset() function.
552 * @param obj The bubble object
553 * @param content The given content of the bubble
555 * This function sets the content shown on the middle of the bubble.
557 * @deprecated use elm_object_content_set() instead
560 EINA_DEPRECATED EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content);
563 * Get the content shown in the bubble
565 * Return the content object which is set for this widget.
567 * @param obj The bubble object
568 * @return The content that is being used
570 * @deprecated use elm_object_content_get() instead
573 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj);
576 * Unset the content shown in the bubble
578 * Unparent and return the content object which was set for this widget.
580 * @param obj The bubble object
581 * @return The content that was being used
583 * @deprecated use elm_object_content_unset() instead
586 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj);
589 * Set the icon of the bubble
591 * Once the icon object is set, a previously set one will be deleted.
592 * If you want to keep the old content object, use the
593 * elm_icon_content_unset() function.
595 * @param obj The bubble object
596 * @param icon The given icon for the bubble
598 * @deprecated use elm_object_part_content_set() instead
601 EINA_DEPRECATED EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon);
604 * Get the icon of the bubble
606 * @param obj The bubble object
607 * @return The icon for the bubble
609 * This function gets the icon shown on the top left of bubble.
611 * @deprecated use elm_object_part_content_get() instead
614 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj);
617 * Unset the icon of the bubble
619 * Unparent and return the icon object which was set for this widget.
621 * @param obj The bubble object
622 * @return The icon that was being used
624 * @deprecated use elm_object_part_content_unset() instead
627 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj);
631 * Set the label used in the button
633 * The passed @p label can be NULL to clean any existing text in it and
634 * leave the button as an icon only object.
636 * @param obj The button object
637 * @param label The text will be written on the button
638 * @deprecated use elm_object_text_set() instead.
640 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label);
643 * Get the label set for the button
645 * The string returned is an internal pointer and should not be freed or
646 * altered. It will also become invalid when the button is destroyed.
647 * The string returned, if not NULL, is a stringshare, so if you need to
648 * keep it around even after the button is destroyed, you can use
649 * eina_stringshare_ref().
651 * @param obj The button object
652 * @return The text set to the label, or NULL if nothing is set
653 * @deprecated use elm_object_text_set() instead.
655 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj);
658 * Set the icon used for the button
660 * Setting a new icon will delete any other that was previously set, making
661 * any reference to them invalid. If you need to maintain the previous
662 * object alive, unset it first with elm_button_icon_unset().
664 * @param obj The button object
665 * @param icon The icon object for the button
666 * @deprecated use elm_object_part_content_set() instead.
668 EINA_DEPRECATED EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon);
671 * Get the icon used for the button
673 * Return the icon object which is set for this widget. If the button is
674 * destroyed or another icon is set, the returned object will be deleted
675 * and any reference to it will be invalid.
677 * @param obj The button object
678 * @return The icon object that is being used
680 * @deprecated use elm_object_part_content_get() instead
682 EINA_DEPRECATED EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj);
685 * Remove the icon set without deleting it and return the object
687 * This function drops the reference the button holds of the icon object
688 * and returns this last object. It is used in case you want to remove any
689 * icon, or set another one, without deleting the actual object. The button
690 * will be left without an icon set.
692 * @param obj The button object
693 * @return The icon object that was being used
694 * @deprecated use elm_object_part_content_unset() instead.
696 EINA_DEPRECATED EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj);
699 * Set a day text color to the same that represents Saturdays.
701 * @param obj The calendar object.
702 * @param pos The text position. Position is the cell counter, from left
703 * to right, up to down. It starts on 0 and ends on 41.
705 * @deprecated use elm_calendar_mark_add() instead like:
708 * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
709 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
712 * @see elm_calendar_mark_add()
716 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos);
719 * Set a day text color to the same that represents Sundays.
721 * @param obj The calendar object.
722 * @param pos The text position. Position is the cell counter, from left
723 * to right, up to down. It starts on 0 and ends on 41.
725 * @deprecated use elm_calendar_mark_add() instead like:
728 * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
729 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
732 * @see elm_calendar_mark_add()
736 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos);
739 * Set a day text color to the same that represents Weekdays.
741 * @param obj The calendar object
742 * @param pos The text position. Position is the cell counter, from left
743 * to right, up to down. It starts on 0 and ends on 41.
745 * @deprecated use elm_calendar_mark_add() instead like:
748 * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
750 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
751 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
752 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
753 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
754 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
755 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
756 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
757 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
758 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
761 * @see elm_calendar_mark_add()
765 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos);
769 * @brief Set the text label of the check object
771 * @param obj The check object
772 * @param label The text label string in UTF-8
774 * @deprecated use elm_object_text_set() instead.
776 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label);
779 * @brief Get the text label of the check object
781 * @param obj The check object
782 * @return The text label string in UTF-8
784 * @deprecated use elm_object_text_get() instead.
786 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj);
789 * @brief Set the icon object of the check object
791 * @param obj The check object
792 * @param icon The icon object
794 * Once the icon object is set, a previously set one will be deleted.
795 * If you want to keep that old content object, use the
796 * elm_object_content_unset() function.
798 * @deprecated use elm_object_part_content_set() instead.
801 EINA_DEPRECATED EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon);
804 * @brief Get the icon object of the check object
806 * @param obj The check object
807 * @return The icon object
809 * @deprecated use elm_object_part_content_get() instead.
812 EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj);
815 * @brief Unset the icon used for the check object
817 * @param obj The check object
818 * @return The icon object that was being used
820 * Unparent and return the icon object which was set for this widget.
822 * @deprecated use elm_object_part_content_unset() instead.
825 EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj);
828 * @brief Set the text label of the check object
830 * @param obj The check object
831 * @param label The text label string in UTF-8
833 * @deprecated use elm_object_text_set() instead.
835 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label);
838 * @brief Get the text label of the check object
840 * @param obj The check object
841 * @return The text label string in UTF-8
843 * @deprecated use elm_object_text_get() instead.
845 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj);
848 * @brief Set the icon object of the check object
850 * @param obj The check object
851 * @param icon The icon object
853 * Once the icon object is set, a previously set one will be deleted.
854 * If you want to keep that old content object, use the
855 * elm_object_content_unset() function.
857 * @deprecated use elm_object_part_content_set() instead.
860 EINA_DEPRECATED EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon);
863 * @brief Get the icon object of the check object
865 * @param obj The check object
866 * @return The icon object
868 * @deprecated use elm_object_part_content_get() instead.
871 EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj);
874 * @brief Unset the icon used for the check object
876 * @param obj The check object
877 * @return The icon object that was being used
879 * Unparent and return the icon object which was set for this widget.
881 * @deprecated use elm_object_part_content_unset() instead.
884 EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj);
886 EINA_DEPRECATED EAPI void elm_check_states_labels_set(Evas_Object *obj, const char *ontext, const char *offtext);
887 EINA_DEPRECATED EAPI void elm_check_states_labels_get(const Evas_Object *obj, const char **ontext, const char **offtext);
891 * Set the content of the conformant widget.
893 * @param obj The conformant object.
894 * @param content The content to be displayed by the conformant.
896 * Content will be sized and positioned considering the space required
897 * to display a virtual keyboard. So it won't fill all the conformant
898 * size. This way is possible to be sure that content won't resize
899 * or be re-positioned after the keyboard is displayed.
901 * Once the content object is set, a previously set one will be deleted.
902 * If you want to keep that old content object, use the
903 * elm_object_content_unset() function.
905 * @see elm_object_content_unset()
906 * @see elm_object_content_get()
908 * @deprecated use elm_object_content_set() instead
910 * @ingroup Conformant
912 EINA_DEPRECATED EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content);
915 * Get the content of the conformant widget.
917 * @param obj The conformant object.
918 * @return The content that is being used.
920 * Return the content object which is set for this widget.
921 * It won't be unparent from conformant. For that, use
922 * elm_object_content_unset().
924 * @see elm_object_content_set().
925 * @see elm_object_content_unset()
927 * @deprecated use elm_object_content_get() instead
929 * @ingroup Conformant
931 EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj);
934 * Unset the content of the conformant widget.
936 * @param obj The conformant object.
937 * @return The content that was being used.
939 * Unparent and return the content object which was set for this widget.
941 * @see elm_object_content_set().
943 * @deprecated use elm_object_content_unset() instead
945 * @ingroup Conformant
947 EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj);
950 * Get the side labels max length.
952 * @deprecated use elm_diskselector_side_label_length_get() instead:
954 * @param obj The diskselector object.
955 * @return The max length defined for side labels, or 0 if not a valid
958 * @ingroup Diskselector
960 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj);
963 * Set the side labels max length.
965 * @deprecated use elm_diskselector_side_label_length_set() instead:
967 * @param obj The diskselector object.
968 * @param len The max length defined for side labels.
970 * @ingroup Diskselector
972 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len);
975 * Get the data associated to the item.
977 * @param it The diskselector item
978 * @return The data associated to @p it
980 * The return value is a pointer to data associated to @p item when it was
981 * created, with function elm_diskselector_item_append(). If no data
982 * was passed as argument, it will return @c NULL.
984 * @see elm_diskselector_item_append()
985 * @deprecated Use elm_object_item_data_get()
987 * @ingroup Diskselector
989 EINA_DEPRECATED EAPI void *elm_diskselector_item_data_get(const Elm_Object_Item *it);
992 * Set the icon associated to the item.
994 * @param it The diskselector item
995 * @param icon The icon object to associate with @p it
997 * The icon object to use at left side of the item. An
998 * icon can be any Evas object, but usually it is an icon created
999 * with elm_icon_add().
1001 * Once the icon object is set, a previously set one will be deleted.
1002 * @warning Setting the same icon for two items will cause the icon to
1003 * disappear from the first item.
1005 * If an icon was passed as argument on item creation, with function
1006 * elm_diskselector_item_append(), it will be already
1007 * associated to the item.
1009 * @see elm_diskselector_item_append()
1010 * @see elm_diskselector_item_icon_get()
1012 * @deprecated Use elm_object_item_part_content_set() instead
1013 * @ingroup Diskselector
1015 EINA_DEPRECATED EAPI void elm_diskselector_item_icon_set(Elm_Object_Item *it, Evas_Object *icon);
1018 * Get the icon associated to the item.
1020 * @param it The diskselector item
1021 * @return The icon associated to @p it
1023 * The return value is a pointer to the icon associated to @p item when it was
1024 * created, with function elm_diskselector_item_append(), or later
1025 * with function elm_diskselector_item_icon_set. If no icon
1026 * was passed as argument, it will return @c NULL.
1028 * @see elm_diskselector_item_append()
1029 * @see elm_diskselector_item_icon_set()
1031 * @deprecated Use elm_object_item_part_content_set() instead
1032 * @ingroup Diskselector
1034 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Object_Item *it);
1037 * Set the label of item.
1039 * @param it The item of diskselector.
1040 * @param label The label of item.
1042 * The label to be displayed by the item.
1044 * If no icon is set, label will be centered on item position, otherwise
1045 * the icon will be placed at left of the label, that will be shifted
1048 * An item with label "January" would be displayed on side position as
1049 * "Jan" if max length is set to 3 with function
1050 * elm_diskselector_side_label_length_set(), or "Janu", if this property
1053 * When this @p item is selected, the entire label will be displayed,
1054 * except for width restrictions.
1055 * In this case label will be cropped and "..." will be concatenated,
1056 * but only for display purposes. It will keep the entire string, so
1057 * if diskselector is resized the remaining characters will be displayed.
1059 * If a label was passed as argument on item creation, with function
1060 * elm_diskselector_item_append(), it will be already
1061 * displayed by the item.
1063 * @see elm_diskselector_side_label_length_set()
1064 * @see elm_diskselector_item_label_get()
1065 * @see elm_diskselector_item_append()
1067 * @deprecated Use elm_object_item_text_set() instead
1068 * @ingroup Diskselector
1070 EINA_DEPRECATED EAPI void elm_diskselector_item_label_set(Elm_Object_Item *it, const char *label);
1073 * Get the label of item.
1075 * @param it The item of diskselector.
1076 * @return The label of item.
1078 * The return value is a pointer to the label associated to @p item when it was
1079 * created, with function elm_diskselector_item_append(), or later
1080 * with function elm_diskselector_item_label_set. If no label
1081 * was passed as argument, it will return @c NULL.
1083 * @see elm_diskselector_item_label_set() for more details.
1084 * @see elm_diskselector_item_append()
1085 * @deprecated Use elm_object_item_text_get() instead
1087 * @ingroup Diskselector
1089 EINA_DEPRECATED EAPI const char *elm_diskselector_item_label_get(const Elm_Object_Item *it);
1092 * Set the function called when a diskselector item is freed.
1094 * @param it The item to set the callback on
1095 * @param func The function called
1097 * If there is a @p func, then it will be called prior item's memory release.
1098 * That will be called with the following arguments:
1100 * @li item's Evas object;
1103 * This way, a data associated to a diskselector item could be properly
1105 * @deprecated Use elm_object_item_del_cb_set() instead
1107 * @ingroup Diskselector
1109 EINA_DEPRECATED EAPI void elm_diskselector_item_del_cb_set(Elm_Object_Item *it, Evas_Smart_Cb func);
1112 * Delete them item from the diskselector.
1114 * @param it The item of diskselector to be deleted.
1116 * If deleting all diskselector items is required, elm_diskselector_clear()
1117 * should be used instead of getting items list and deleting each one.
1119 * @deprecated Use elm_object_item_del() instead
1120 * @see elm_diskselector_clear()
1121 * @see elm_diskselector_item_append()
1123 * @ingroup Diskselector
1125 EINA_DEPRECATED EAPI void elm_diskselector_item_del(Elm_Object_Item *it);
1128 * Set the text to be shown in the diskselector item.
1130 * @param it Target item
1131 * @param text The text to set in the content
1133 * Setup the text as tooltip to object. The item can have only one tooltip,
1134 * so any previous tooltip data is removed.
1136 * @deprecated Use elm_object_item_tooltip_text_set() instead
1137 * @see elm_object_tooltip_text_set() for more details.
1139 * @ingroup Diskselector
1141 EINA_DEPRECATED EAPI void elm_diskselector_item_tooltip_text_set(Elm_Object_Item *it, const char *text);
1144 * Set the content to be shown in the tooltip item.
1146 * Setup the tooltip to item. The item can have only one tooltip,
1147 * so any previous tooltip data is removed. @p func(with @p data) will
1148 * be called every time that need show the tooltip and it should
1149 * return a valid Evas_Object. This object is then managed fully by
1150 * tooltip system and is deleted when the tooltip is gone.
1152 * @param it the diskselector item being attached a tooltip.
1153 * @param func the function used to create the tooltip contents.
1154 * @param data what to provide to @a func as callback data/context.
1155 * @param del_cb called when data is not needed anymore, either when
1156 * another callback replaces @p func, the tooltip is unset with
1157 * elm_diskselector_item_tooltip_unset() or the owner @a item
1158 * dies. This callback receives as the first parameter the
1159 * given @a data, and @c event_info is the item.
1161 * @deprecated Use elm_object_item_tooltip_content_cb_set() instead
1162 * @see elm_object_tooltip_content_cb_set() for more details.
1164 * @ingroup Diskselector
1166 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);
1169 * Unset tooltip from item.
1171 * @param it diskselector item to remove previously set tooltip.
1173 * Remove tooltip from item. The callback provided as del_cb to
1174 * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
1175 * it is not used anymore.
1177 * @deprecated Use elm_object_item_tooltip_unset() instead
1178 * @see elm_object_tooltip_unset() for more details.
1179 * @see elm_diskselector_item_tooltip_content_cb_set()
1181 * @ingroup Diskselector
1183 EINA_DEPRECATED EAPI void elm_diskselector_item_tooltip_unset(Elm_Object_Item *it);
1186 * Sets a different style for this item tooltip.
1188 * @note before you set a style you should define a tooltip with
1189 * elm_diskselector_item_tooltip_content_cb_set() or
1190 * elm_diskselector_item_tooltip_text_set()
1192 * @param it diskselector item with tooltip already set.
1193 * @param style the theme style to use (default, transparent, ...)
1195 * @deprecated Use elm_object_item_tooltip_style_set() instead
1196 * @see elm_object_tooltip_style_set() for more details.
1198 * @ingroup Diskselector
1200 EINA_DEPRECATED EAPI void elm_diskselector_item_tooltip_style_set(Elm_Object_Item *it, const char *style);
1203 * Get the style for this item tooltip.
1205 * @param it diskselector item with tooltip already set.
1206 * @return style the theme style in use, defaults to "default". If the
1207 * object does not have a tooltip set, then NULL is returned.
1209 * @deprecated Use elm_object_item_tooltip_style_get() instead
1210 * @see elm_object_tooltip_style_get() for more details.
1211 * @see elm_diskselector_item_tooltip_style_set()
1213 * @ingroup Diskselector
1215 EINA_DEPRECATED EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Object_Item *it);
1218 * Set the cursor to be shown when mouse is over the diskselector item
1220 * @param it Target item
1221 * @param cursor the cursor name to be used.
1223 * @see elm_object_cursor_set() for more details.
1224 * @deprecated Use elm_object_item_cursor_set() instead
1226 * @ingroup Diskselector
1228 EINA_DEPRECATED EAPI void elm_diskselector_item_cursor_set(Elm_Object_Item *it, const char *cursor);
1231 * Get the cursor to be shown when mouse is over the diskselector item
1233 * @param it diskselector item with cursor already set.
1234 * @return the cursor name.
1236 * @see elm_object_cursor_get() for more details.
1237 * @see elm_diskselector_item_cursor_set()
1238 * @deprecated Use elm_object_item_cursor_get() instead
1240 * @ingroup Diskselector
1242 EINA_DEPRECATED EAPI const char *elm_diskselector_item_cursor_get(const Elm_Object_Item *it);
1245 * Unset the cursor to be shown when mouse is over the diskselector item
1247 * @param it Target item
1249 * @see elm_object_cursor_unset() for more details.
1250 * @see elm_diskselector_item_cursor_set()
1251 * @deprecated use elm_object_item_cursor_unset() instead
1253 * @ingroup Diskselector
1255 EINA_DEPRECATED EAPI void elm_diskselector_item_cursor_unset(Elm_Object_Item *it);
1258 * Sets a different style for this item cursor.
1260 * @note before you set a style you should define a cursor with
1261 * elm_diskselector_item_cursor_set()
1263 * @param it diskselector item with cursor already set.
1264 * @param style the theme style to use (default, transparent, ...)
1266 * @see elm_object_cursor_style_set() for more details.
1267 * @deprecated Use elm_object_item_cursor_style_set() instead
1269 * @ingroup Diskselector
1271 EINA_DEPRECATED EAPI void elm_diskselector_item_cursor_style_set(Elm_Object_Item *it, const char *style);
1274 * Get the style for this item cursor.
1276 * @param it diskselector item with cursor already set.
1277 * @return style the theme style in use, defaults to "default". If the
1278 * object does not have a cursor set, then @c NULL is returned.
1280 * @see elm_object_cursor_style_get() for more details.
1281 * @see elm_diskselector_item_cursor_style_set()
1282 * @deprecated Use elm_object_item_cursor_style_get() instead
1284 * @ingroup Diskselector
1286 EINA_DEPRECATED EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Object_Item *it);
1289 * Set if the cursor set should be searched on the theme or should use
1290 * the provided by the engine, only.
1292 * @note before you set if should look on theme you should define a cursor
1293 * with elm_diskselector_item_cursor_set().
1294 * By default it will only look for cursors provided by the engine.
1296 * @param it widget item with cursor already set.
1297 * @param engine_only boolean to define if cursors set with
1298 * elm_diskselector_item_cursor_set() should be searched only
1299 * between cursors provided by the engine or searched on widget's
1302 * @see elm_object_cursor_engine_only_set() for more details.
1303 * @deprecated Use elm_object_item_cursor_engine_only_set() instead
1305 * @ingroup Diskselector
1307 EINA_DEPRECATED EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Object_Item *it, Eina_Bool engine_only);
1310 * Get the cursor engine only usage for this item cursor.
1312 * @param it widget item with cursor already set.
1313 * @return engine_only boolean to define it cursors should be looked only
1314 * between the provided by the engine or searched on widget's theme as well.
1315 * If the item does not have a cursor set, then @c EINA_FALSE is returned.
1317 * @see elm_object_cursor_engine_only_get() for more details.
1318 * @see elm_diskselector_item_cursor_engine_only_set()
1319 * @deprecated Use elm_object_item_cursor_engine_only_get() instead
1321 * @ingroup Diskselector
1323 EINA_DEPRECATED EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Object_Item *it);
1325 EINA_DEPRECATED EAPI void elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
1326 EINA_DEPRECATED EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
1329 * Get the label of a given flip selector widget's item.
1331 * @param it The item to get label from
1332 * @return The text label of @p item or @c NULL, on errors
1334 * @see elm_object_item_text_set()
1336 * @deprecated see elm_object_item_text_get() instead
1337 * @ingroup Flipselector
1339 EINA_DEPRECATED EAPI const char *elm_flipselector_item_label_get(const Elm_Object_Item *it);
1342 * Set the label of a given flip selector widget's item.
1344 * @param it The item to set label on
1345 * @param label The text label string, in UTF-8 encoding
1347 * @see elm_object_item_text_get()
1349 * @deprecated see elm_object_item_text_set() instead
1350 * @ingroup Flipselector
1352 EINA_DEPRECATED EAPI void elm_flipselector_item_label_set(Elm_Object_Item *it, const char *label);
1355 * Delete a given item from a flip selector widget.
1357 * @param it The item to delete
1359 * @deprecated Use elm_object_item_del() instead
1360 * @ingroup Flipselector
1362 EINA_DEPRECATED EAPI void elm_flipselector_item_del(Elm_Object_Item *it);
1365 * Make a given Elementary object the focused one.
1367 * @param obj The Elementary object to make focused.
1369 * @note This object, if it can handle focus, will take the focus
1370 * away from the one who had it previously and will, for now on, be
1371 * the one receiving input events.
1373 * @see elm_object_focus_get()
1374 * @deprecated use elm_object_focus_set() instead.
1378 EINA_DEPRECATED EAPI void elm_object_focus(Evas_Object *obj);
1381 * Remove the focus from an Elementary object
1383 * @param obj The Elementary to take focus from
1385 * This removes the focus from @p obj, passing it back to the
1386 * previous element in the focus chain list.
1388 * @see elm_object_focus() and elm_object_focus_custom_chain_get()
1389 * @deprecated use elm_object_focus_set() instead.
1393 EINA_DEPRECATED EAPI void elm_object_unfocus(Evas_Object *obj);
1396 * Give focus to near object in one direction.
1398 * Give focus to near object in direction of one object.
1399 * If none focusable object in given direction, the focus will not change.
1401 * @param obj The reference object
1402 * @param x Horizontal component of direction to focus
1403 * @param y Vertical component of direction to focus
1405 * @deprecated Support it later.
1408 EINA_DEPRECATED EAPI void elm_object_focus_direction_go(Evas_Object *obj, int x, int y);
1411 * @brief Set the frame label
1413 * @param obj The frame object
1414 * @param label The label of this frame object
1416 * @deprecated use elm_object_text_set() instead.
1418 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label);
1421 * @brief Get the frame label
1423 * @param obj The frame object
1425 * @return The label of this frame object or NULL if unable to get frame
1427 * @deprecated use elm_object_text_get() instead.
1429 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj);
1432 * @brief Set the content of the frame widget
1434 * Once the content object is set, a previously set one will be deleted.
1435 * If you want to keep that old content object, use the
1436 * elm_frame_content_unset() function.
1438 * @param obj The frame object
1439 * @param content The content will be filled in this frame object
1441 * @deprecated use elm_object_content_set() instead.
1443 EINA_DEPRECATED EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content);
1446 * @brief Get the content of the frame widget
1448 * Return the content object which is set for this widget
1450 * @param obj The frame object
1451 * @return The content that is being used
1453 * @deprecated use elm_object_content_get() instead.
1455 EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj);
1458 * @brief Unset the content of the frame widget
1460 * Unparent and return the content object which was set for this widget
1462 * @param obj The frame object
1463 * @return The content that was being used
1465 * @deprecated use elm_object_content_unset() instead.
1467 EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj);
1469 EINA_DEPRECATED EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode);
1470 EINA_DEPRECATED EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj);
1471 EINA_DEPRECATED EAPI void elm_genlist_item_icons_orphan(Elm_Object_Item *it);
1473 * This sets the horizontal stretching mode.
1475 * @param obj The genlist object
1476 * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
1478 * This sets the mode used for sizing items horizontally. Valid modes
1479 * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
1480 * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
1481 * the scroller will scroll horizontally. Otherwise items are expanded
1482 * to fill the width of the viewport of the scroller. If it is
1483 * ELM_LIST_LIMIT, items will be expanded to the viewport width and
1484 * limited to that size.
1486 * @see elm_genlist_horizontal_get()
1488 * @deprecated use elm_genlist_mode_set()
1491 EINA_DEPRECATED EAPI void elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode);
1494 * Gets the horizontal stretching mode.
1496 * @param obj The genlist object
1497 * @return The mode to use
1498 * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
1500 * @see elm_genlist_horizontal_set()
1502 * @deprecated use elm_genlist_mode_get()
1505 EINA_DEPRECATED EAPI Elm_List_Mode elm_genlist_horizontal_get(const Evas_Object *obj);
1508 * Return the data associated to a given genlist item
1510 * @param it The genlist item.
1511 * @return the data associated to this item.
1513 * This returns the @c data value passed on the
1514 * elm_genlist_item_append() and related item addition calls.
1516 * @see elm_genlist_item_append()
1517 * @see elm_genlist_item_data_set()
1519 * @deprecated Use elm_object_item_data_get() instead
1522 EINA_DEPRECATED EAPI void *elm_genlist_item_data_get(const Elm_Object_Item *it);
1525 * Set the data associated to a given genlist item
1527 * @param it The genlist item
1528 * @param data The new data pointer to set on it
1530 * This @b overrides the @c data value passed on the
1531 * elm_genlist_item_append() and related item addition calls. This
1532 * function @b won't call elm_genlist_item_update() automatically,
1533 * so you'd issue it afterwards if you want to hove the item
1534 * updated to reflect the that new data.
1536 * @see elm_genlist_item_data_get()
1538 * @deprecated Use elm_object_item_data_set() instead
1541 EINA_DEPRECATED EAPI void elm_genlist_item_data_set(Elm_Object_Item *it, const void *data);
1544 * Set whether a given genlist item is disabled or not.
1546 * @param it The item
1547 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
1548 * to enable it back.
1550 * A disabled item cannot be selected or unselected. It will also
1551 * change its appearance, to signal the user it's disabled.
1553 * @see elm_genlist_item_disabled_get()
1554 * @deprecated Use elm_object_item_disabled_set() instead
1558 EINA_DEPRECATED EAPI void elm_genlist_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled);
1561 * Get whether a given genlist item is disabled or not.
1563 * @param it The item
1564 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
1567 * @see elm_genlist_item_disabled_set() for more details
1568 * @deprecated Use elm_object_item_disabled_get() instead
1572 EINA_DEPRECATED EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Object_Item *it);
1575 * Remove a genlist item from the its parent, deleting it.
1577 * @param it The item to be removed.
1578 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
1580 * @see elm_genlist_clear(), to remove all items in a genlist at
1583 * @deprecated Use elm_object_item_del() instead
1586 EINA_DEPRECATED EAPI void elm_genlist_item_del(Elm_Object_Item *it);
1589 * Get the genlist object's handle which contains a given genlist
1592 * @param it The item to fetch the container from
1593 * @return The genlist (parent) object
1595 * This returns the genlist object itself that an item belongs to.
1596 * @deprecated Use elm_object_item_widget_get() instead
1600 EINA_DEPRECATED EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Object_Item *it);
1603 * Get the mode item style of items in the genlist
1604 * @param obj The genlist object
1605 * @return The mode item style string, or NULL if none is specified
1607 * This is a constant string and simply defines the name of the
1608 * style that will be used for mode animations. It can be
1609 * @c NULL if you don't plan to use Genlist mode. See
1610 * elm_genlist_item_mode_set() for more info.
1614 EINA_DEPRECATED EAPI const char *elm_genlist_mode_item_style_get(const Evas_Object *obj);
1617 * Set the mode item style of items in the genlist
1618 * @param obj The genlist object
1619 * @param style The mode item style string, or NULL if none is desired
1621 * This is a constant string and simply defines the name of the
1622 * style that will be used for mode animations. It can be
1623 * @c NULL if you don't plan to use Genlist mode. See
1624 * elm_genlist_item_mode_set() for more info.
1628 EINA_DEPRECATED EAPI void elm_genlist_mode_item_style_set(Evas_Object *obj, const char *style);
1631 * Get the real Evas object created to implement the view of a
1632 * given genlist item
1634 * @param it The genlist item.
1635 * @return the Evas object implementing this item's view.
1637 * This returns the actual Evas object used to implement the
1638 * specified genlist item's view. This may be @c NULL, as it may
1639 * not have been created or may have been deleted, at any time, by
1640 * the genlist. <b>Do not modify this object</b> (move, resize,
1641 * show, hide, etc.), as the genlist is controlling it. This
1642 * function is for querying, emitting custom signals or hooking
1643 * lower level callbacks for events on that object. Do not delete
1644 * this object under any circumstances.
1646 * @see elm_object_item_data_get()
1647 * @deprecated No more support
1651 EINA_DEPRECATED EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Object_Item *it);
1653 #define ELM_IMAGE_ROTATE_90_CW 1
1654 #define ELM_IMAGE_ROTATE_180_CW 2
1655 #define ELM_IMAGE_ROTATE_90_CCW 3
1658 * Return the data associated with a given index widget item
1660 * @param item The index widget item handle
1661 * @return The data associated with @p it
1662 * @deprecated Use elm_object_item_data_get() instead
1664 * @see elm_index_item_data_set()
1668 EINA_DEPRECATED EAPI void *elm_index_item_data_get(const Elm_Object_Item *item);
1671 * Set the data associated with a given index widget item
1673 * @param it The index widget item handle
1674 * @param data The new data pointer to set to @p it
1676 * This sets new item data on @p it.
1678 * @warning The old data pointer won't be touched by this function, so
1679 * the user had better to free that old data himself/herself.
1681 * @deprecated Use elm_object_item_data_set() instead
1684 EINA_DEPRECATED EAPI void elm_index_item_data_set(Elm_Object_Item *it, const void *data);
1687 * Set the function to be called when a given index widget item is freed.
1689 * @param it The item to set the callback on
1690 * @param func The function to call on the item's deletion
1692 * When called, @p func will have both @c data and @c event_info
1693 * arguments with the @p it item's data value and, naturally, the
1694 * @c obj argument with a handle to the parent index widget.
1696 * @deprecated Use elm_object_item_del_cb_set() instead
1699 EINA_DEPRECATED EAPI void elm_index_item_del_cb_set(Elm_Object_Item *it, Evas_Smart_Cb func);
1702 * Remove an item from a given index widget, <b>to be referenced by
1703 * it's data value</b>.
1705 * @param obj The index object
1706 * @param item The item to be removed from @p obj
1708 * If a deletion callback is set, via elm_object_item_del_cb_set(),
1709 * that callback function will be called by this one.
1711 * @deprecated Use elm_object_item_del() instead
1714 EINA_DEPRECATED EAPI void elm_index_item_del(Evas_Object *obj, Elm_Object_Item *item);
1717 * @brief Set the label on the label object
1719 * @param obj The label object
1720 * @param label The label will be used on the label object
1721 * @deprecated See elm_object_text_set()
1723 EINA_DEPRECATED EAPI void elm_label_label_set(Evas_Object *obj, const char *label);
1726 * @brief Get the label used on the label object
1728 * @param obj The label object
1729 * @return The string inside the label
1730 * @deprecated See elm_object_text_get()
1732 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj);
1736 * Set the layout content.
1738 * @param obj The layout object
1739 * @param swallow The swallow part name in the edje file
1740 * @param content The child that will be added in this layout object
1742 * Once the content object is set, a previously set one will be deleted.
1743 * If you want to keep that old content object, use the
1744 * elm_object_part_content_unset() function.
1746 * @note In an Edje theme, the part used as a content container is called @c
1747 * SWALLOW. This is why the parameter name is called @p swallow, but it is
1748 * expected to be a part name just like the second parameter of
1749 * elm_layout_box_append().
1751 * @see elm_layout_box_append()
1752 * @see elm_object_part_content_get()
1753 * @see elm_object_part_content_unset()
1755 * @deprecated use elm_object_part_content_set() instead
1759 EINA_DEPRECATED EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content);
1762 * Get the child object in the given content part.
1764 * @param obj The layout object
1765 * @param swallow The SWALLOW part to get its content
1767 * @return The swallowed object or NULL if none or an error occurred
1769 * @deprecated use elm_object_part_content_get() instead
1773 EINA_DEPRECATED EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow);
1776 * Unset the layout content.
1778 * @param obj The layout object
1779 * @param swallow The swallow part name in the edje file
1780 * @return The content that was being used
1782 * Unparent and return the content object which was set for this part.
1784 * @deprecated use elm_object_part_content_unset() instead
1788 EINA_DEPRECATED EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow);
1791 * Set the text of the given part
1793 * @param obj The layout object
1794 * @param part The TEXT part where to set the text
1795 * @param text The text to set
1798 * @deprecated use elm_object_part_text_set() instead.
1800 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text);
1803 * Get the text set in the given part
1805 * @param obj The layout object
1806 * @param part The TEXT part to retrieve the text off
1808 * @return The text set in @p part
1811 * @deprecated use elm_object_part_text_get() instead.
1813 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part);
1816 * @def elm_layout_label_set
1817 * Convenience macro to set the label in a layout that follows the
1818 * Elementary naming convention for its parts.
1821 * @deprecated use elm_object_text_set() instead.
1823 #define elm_layout_label_set(_ly, _txt) \
1824 elm_layout_text_set((_ly), "elm.text", (_txt))
1827 * @def elm_layout_label_get
1828 * Convenience macro to get the label in a layout that follows the
1829 * Elementary naming convention for its parts.
1832 * @deprecated use elm_object_text_set() instead.
1834 #define elm_layout_label_get(_ly) \
1835 elm_layout_text_get((_ly), "elm.text")
1837 EINA_DEPRECATED EAPI Evas_Object *elm_list_item_base_get(const Elm_Object_Item *it);
1841 * Set the content of the mapbuf.
1843 * @param obj The mapbuf object.
1844 * @param content The content that will be filled in this mapbuf object.
1846 * Once the content object is set, a previously set one will be deleted.
1847 * If you want to keep that old content object, use the
1848 * elm_mapbuf_content_unset() function.
1850 * To enable map, elm_mapbuf_enabled_set() should be used.
1852 * @deprecated use elm_object_content_set() instead
1856 EINA_DEPRECATED EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content);
1859 * Get the content of the mapbuf.
1861 * @param obj The mapbuf object.
1862 * @return The content that is being used.
1864 * Return the content object which is set for this widget.
1866 * @see elm_mapbuf_content_set() for details.
1868 * @deprecated use elm_object_content_get() instead
1872 EINA_DEPRECATED EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj);
1875 * Unset the content of the mapbuf.
1877 * @param obj The mapbuf object.
1878 * @return The content that was being used.
1880 * Unparent and return the content object which was set for this widget.
1882 * @see elm_mapbuf_content_set() for details.
1884 * @deprecated use elm_object_content_unset() instead
1888 EINA_DEPRECATED EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj);
1891 * @brief Set the label of a menu item
1893 * @param it The menu item object.
1894 * @param label The label to set for @p item
1896 * @warning Don't use this function on items created with
1897 * elm_menu_item_add_object() or elm_menu_item_separator_add().
1899 * @deprecated Use elm_object_item_text_set() instead
1901 EINA_DEPRECATED EAPI void elm_menu_item_label_set(Elm_Object_Item *it, const char *label);
1904 * @brief Get the label of a menu item
1906 * @param it The menu item object.
1907 * @return The label of @p item
1908 * @deprecated Use elm_object_item_text_get() instead
1910 EINA_DEPRECATED EAPI const char *elm_menu_item_label_get(const Elm_Object_Item *it);
1913 * @brief Set the content object of a menu item
1915 * @param it The menu item object
1916 * @param The content object or NULL
1917 * @return EINA_TRUE on success, else EINA_FALSE
1919 * Use this function to change the object swallowed by a menu item, deleting
1920 * any previously swallowed object.
1922 * @deprecated Use elm_object_item_content_set() instead
1924 EINA_DEPRECATED EAPI Eina_Bool elm_menu_item_object_content_set(Elm_Object_Item *it, Evas_Object *obj);
1927 * @brief Get the content object of a menu item
1929 * @param it The menu item object
1930 * @return The content object or NULL
1931 * @note If @p item was added with elm_menu_item_add_object, this
1932 * function will return the object passed, else it will return the
1935 * @see elm_menu_item_object_content_set()
1937 * @deprecated Use elm_object_item_content_get() instead
1939 EINA_DEPRECATED EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Object_Item *it);
1942 * @brief Set the disabled state of @p item.
1944 * @param it The menu item object.
1945 * @param disabled The enabled/disabled state of the item
1946 * @deprecated Use elm_object_item_disabled_set() instead
1948 EINA_DEPRECATED EAPI void elm_menu_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled);
1951 * @brief Get the disabled state of @p item.
1953 * @param it The menu item object.
1954 * @return The enabled/disabled state of the item
1956 * @see elm_menu_item_disabled_set()
1957 * @deprecated Use elm_object_item_disabled_get() instead
1959 EINA_DEPRECATED EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Object_Item *it);
1962 * @brief Returns the data associated with menu item @p item.
1964 * @param it The item
1965 * @return The data associated with @p item or NULL if none was set.
1967 * This is the data set with elm_menu_add() or elm_menu_item_data_set().
1969 * @deprecated Use elm_object_item_data_get() instead
1971 EINA_DEPRECATED EAPI void *elm_menu_item_data_get(const Elm_Object_Item *it);
1974 * @brief Set the function called when a menu item is deleted.
1976 * @param it The item to set the callback on
1977 * @param func The function called
1979 * @see elm_menu_item_add()
1980 * @see elm_menu_item_del()
1981 * @deprecated Use elm_object_item_del_cb_set() instead
1983 EINA_DEPRECATED EAPI void elm_menu_item_del_cb_set(Elm_Object_Item *it, Evas_Smart_Cb func);
1986 * @brief Sets the data to be associated with menu item @p item.
1988 * @param it The item
1989 * @param data The data to be associated with @p item
1991 * @deprecated Use elm_object_item_data_set() instead
1993 EINA_DEPRECATED EAPI void elm_menu_item_data_set(Elm_Object_Item *it, const void *data);
1996 * @brief Deletes an item from the menu.
1998 * @param it The item to delete.
2000 * @deprecated Use elm_object_item_del() instead
2001 * @see elm_menu_item_add()
2003 EINA_DEPRECATED EAPI void elm_menu_item_del(Elm_Object_Item *it);
2006 * @brief @brief Return a menu item's owner menu
2008 * @param it The menu item
2009 * @return The menu object owning @p item, or NULL on failure
2011 * Use this function to get the menu object owning an item.
2012 * @deprecated Use elm_object_item_widget_get() instead
2014 EINA_DEPRECATED EAPI Evas_Object *elm_menu_item_menu_get(const Elm_Object_Item *it);
2017 * @brief Set the content of the notify widget
2019 * @param obj The notify object
2020 * @param content The content will be filled in this notify object
2022 * Once the content object is set, a previously set one will be deleted. If
2023 * you want to keep that old content object, use the
2024 * elm_notify_content_unset() function.
2026 * @deprecated use elm_object_content_set() instead
2029 EINA_DEPRECATED EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content);
2032 * @brief Unset the content of the notify widget
2034 * @param obj The notify object
2035 * @return The content that was being used
2037 * Unparent and return the content object which was set for this widget
2039 * @see elm_notify_content_set()
2040 * @deprecated use elm_object_content_unset() instead
2043 EINA_DEPRECATED EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj);
2046 * @brief Return the content of the notify widget
2048 * @param obj The notify object
2049 * @return The content that is being used
2051 * @see elm_notify_content_set()
2052 * @deprecated use elm_object_content_get() instead
2055 EINA_DEPRECATED EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj);
2058 * Set a label of an object
2060 * @param obj The Elementary object
2061 * @param part The text part name to set (NULL for the default label)
2062 * @param label The new text of the label
2064 * @note Elementary objects may have many labels (e.g. Action Slider)
2065 * @deprecated Use elm_object_part_text_set() instead.
2068 EINA_DEPRECATED EAPI void elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
2071 * Get a label of an object
2073 * @param obj The Elementary object
2074 * @param part The text part name to get (NULL for the default label)
2075 * @return text of the label or NULL for any error
2077 * @note Elementary objects may have many labels (e.g. Action Slider)
2078 * @deprecated Use elm_object_part_text_get() instead.
2081 EINA_DEPRECATED EAPI const char *elm_object_text_part_get(const Evas_Object *obj, const char *part);
2084 * Set a content of an object
2086 * @param obj The Elementary object
2087 * @param part The content part name to set (NULL for the default content)
2088 * @param content The new content of the object
2090 * @note Elementary objects may have many contents
2091 * @deprecated Use elm_object_part_content_set instead.
2094 EINA_DEPRECATED EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
2097 * Get a content of an object
2099 * @param obj The Elementary object
2100 * @param part The content part name to get (NULL for the default content)
2101 * @return content of the object or NULL for any error
2103 * @note Elementary objects may have many contents
2104 * @deprecated Use elm_object_part_content_get instead.
2107 EINA_DEPRECATED EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
2110 * Unset a content of an object
2112 * @param obj The Elementary object
2113 * @param part The content part name to unset (NULL for the default content)
2115 * @note Elementary objects may have many contents
2116 * @deprecated Use elm_object_part_content_unset instead.
2119 EINA_DEPRECATED EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
2122 * Set a content of an object item
2124 * @param it The Elementary object item
2125 * @param part The content part name to set (NULL for the default content)
2126 * @param content The new content of the object item
2128 * @note Elementary object items may have many contents
2129 * @deprecated Use elm_object_item_part_content_set instead.
2132 EINA_DEPRECATED EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
2135 * Get a content of an object item
2137 * @param it The Elementary object item
2138 * @param part The content part name to unset (NULL for the default content)
2139 * @return content of the object item or NULL for any error
2141 * @note Elementary object items may have many contents
2142 * @deprecated Use elm_object_item_part_content_get instead.
2145 EINA_DEPRECATED EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *part);
2148 * Unset a content of an object item
2150 * @param it The Elementary object item
2151 * @param part The content part name to unset (NULL for the default content)
2153 * @note Elementary object items may have many contents
2154 * @deprecated Use elm_object_item_part_content_unset instead.
2157 EINA_DEPRECATED EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
2160 * Get a label of an object item
2162 * @param it The Elementary object item
2163 * @param part The text part name to get (NULL for the default label)
2164 * @return text of the label or NULL for any error
2166 * @note Elementary object items may have many labels
2167 * @deprecated Use elm_object_item_part_text_get instead.
2170 EINA_DEPRECATED EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
2173 * Set a label of an object item
2175 * @param it The Elementary object item
2176 * @param part The text part name to set (NULL for the default label)
2177 * @param label The new text of the label
2179 * @note Elementary object items may have many labels
2180 * @deprecated Use elm_object_item_part_text_set instead.
2183 EINA_DEPRECATED EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
2186 * @brief Set the content of the panel.
2188 * @param obj The panel object
2189 * @param content The panel content
2191 * Once the content object is set, a previously set one will be deleted.
2192 * If you want to keep that old content object, use the
2193 * elm_panel_content_unset() function.
2195 * @deprecated use elm_object_content_set() instead
2198 EINA_DEPRECATED EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content);
2201 * @brief Get the content of the panel.
2203 * @param obj The panel object
2204 * @return The content that is being used
2206 * Return the content object which is set for this widget.
2208 * @see elm_panel_content_set()
2210 * @deprecated use elm_object_content_get() instead
2213 EINA_DEPRECATED EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj);
2216 * @brief Unset the content of the panel.
2218 * @param obj The panel object
2219 * @return The content that was being used
2221 * Unparent and return the content object which was set for this widget.
2223 * @see elm_panel_content_set()
2225 * @deprecated use elm_object_content_unset() instead
2228 EINA_DEPRECATED EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj);
2231 * Set the left content of the panes widget.
2233 * @param obj The panes object.
2234 * @param content The new left content object.
2236 * Once the content object is set, a previously set one will be deleted.
2237 * If you want to keep that old content object, use the
2238 * elm_panes_content_left_unset() function.
2240 * If panes is displayed vertically, left content will be displayed at
2243 * @see elm_panes_content_left_get()
2244 * @see elm_panes_content_right_set() to set content on the other side.
2246 * @deprecated use elm_object_part_content_set() instead
2250 EINA_DEPRECATED EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content);
2253 * Set the right content of the panes widget.
2255 * @param obj The panes object.
2256 * @param content The new right content object.
2258 * Once the content object is set, a previously set one will be deleted.
2259 * If you want to keep that old content object, use the
2260 * elm_panes_content_right_unset() function.
2262 * If panes is displayed vertically, left content will be displayed at
2265 * @see elm_panes_content_right_get()
2266 * @see elm_panes_content_left_set() to set content on the other side.
2268 * @deprecated use elm_object_part_content_set() instead
2272 EINA_DEPRECATED EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content);
2275 * Get the left content of the panes.
2277 * @param obj The panes object.
2278 * @return The left content object that is being used.
2280 * Return the left content object which is set for this widget.
2282 * @see elm_panes_content_left_set() for details.
2284 * @deprecated use elm_object_part_content_get() instead
2288 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj);
2291 * Get the right content of the panes.
2293 * @param obj The panes object
2294 * @return The right content object that is being used
2296 * Return the right content object which is set for this widget.
2298 * @see elm_panes_content_right_set() for details.
2300 * @deprecated use elm_object_part_content_get() instead
2304 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj);
2307 * Unset the left content used for the panes.
2309 * @param obj The panes object.
2310 * @return The left content object that was being used.
2312 * Unparent and return the left content object which was set for this widget.
2314 * @see elm_panes_content_left_set() for details.
2315 * @see elm_panes_content_left_get().
2317 * @deprecated use elm_object_part_content_unset() instead
2321 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj);
2324 * Unset the right content used for the panes.
2326 * @param obj The panes object.
2327 * @return The right content object that was being used.
2329 * Unparent and return the right content object which was set for this
2332 * @see elm_panes_content_right_set() for details.
2333 * @see elm_panes_content_right_get().
2335 * @deprecated use elm_object_part_content_unset() instead
2339 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj);
2341 * Set the label of a given progress bar widget
2343 * @param obj The progress bar object
2344 * @param label The text label string, in UTF-8
2346 * @ingroup Progressbar
2347 * @deprecated use elm_object_text_set() instead.
2349 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label);
2352 * Get the label of a given progress bar widget
2354 * @param obj The progressbar object
2355 * @return The text label string, in UTF-8
2357 * @ingroup Progressbar
2358 * @deprecated use elm_object_text_set() instead.
2360 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj);
2363 * Set the icon object of a given progress bar widget
2365 * @param obj The progress bar object
2366 * @param icon The icon object
2368 * Use this call to decorate @p obj with an icon next to it.
2370 * @note Once the icon object is set, a previously set one will be
2371 * deleted. If you want to keep that old content object, use the
2372 * elm_progressbar_icon_unset() function.
2374 * @see elm_progressbar_icon_get()
2375 * @deprecated use elm_object_part_content_set() instead.
2377 * @ingroup Progressbar
2379 EINA_DEPRECATED EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon);
2382 * Retrieve the icon object set for a given progress bar widget
2384 * @param obj The progress bar object
2385 * @return The icon object's handle, if @p obj had one set, or @c NULL,
2386 * otherwise (and on errors)
2388 * @see elm_progressbar_icon_set() for more details
2389 * @deprecated use elm_object_part_content_get() instead.
2391 * @ingroup Progressbar
2393 EINA_DEPRECATED EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj);
2396 * Unset an icon set on a given progress bar widget
2398 * @param obj The progress bar object
2399 * @return The icon object that was being used, if any was set, or
2400 * @c NULL, otherwise (and on errors)
2402 * This call will unparent and return the icon object which was set
2403 * for this widget, previously, on success.
2405 * @see elm_progressbar_icon_set() for more details
2406 * @deprecated use elm_object_part_content_unset() instead.
2408 * @ingroup Progressbar
2410 EINA_DEPRECATED EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj);
2413 * @brief Set the text label of the radio object
2415 * @param obj The radio object
2416 * @param label The text label string in UTF-8
2418 * @deprecated use elm_object_text_set() instead.
2420 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label);
2423 * @brief Get the text label of the radio object
2425 * @param obj The radio object
2426 * @return The text label string in UTF-8
2428 * @deprecated use elm_object_text_set() instead.
2430 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj);
2433 * @brief Set the icon object of the radio object
2435 * @param obj The radio object
2436 * @param icon The icon object
2438 * Once the icon object is set, a previously set one will be deleted. If you
2439 * want to keep that old content object, use the elm_radio_icon_unset()
2442 * @deprecated use elm_object_part_content_set() instead.
2445 EINA_DEPRECATED EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon);
2448 * @brief Get the icon object of the radio object
2450 * @param obj The radio object
2451 * @return The icon object
2453 * @see elm_radio_icon_set()
2455 * @deprecated use elm_object_part_content_get() instead.
2458 EINA_DEPRECATED EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj);
2461 * @brief Unset the icon used for the radio object
2463 * @param obj The radio object
2464 * @return The icon object that was being used
2466 * Unparent and return the icon object which was set for this widget.
2468 * @see elm_radio_icon_set()
2469 * @deprecated use elm_object_part_content_unset() instead.
2472 EINA_DEPRECATED EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj);
2475 * @brief Set the content of the scroller widget (the object to be scrolled around).
2477 * @param obj The scroller object
2478 * @param content The new content object
2480 * Once the content object is set, a previously set one will be deleted.
2481 * If you want to keep that old content object, use the
2482 * elm_scroller_content_unset() function.
2483 * @deprecated use elm_object_content_set() instead
2485 EINA_DEPRECATED EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child);
2488 * @brief Get the content of the scroller widget
2490 * @param obj The slider object
2491 * @return The content that is being used
2493 * Return the content object which is set for this widget
2495 * @see elm_scroller_content_set()
2496 * @deprecated use elm_object_content_get() instead.
2498 EINA_DEPRECATED EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj);
2501 * @brief Unset the content of the scroller widget
2503 * @param obj The slider object
2504 * @return The content that was being used
2506 * Unparent and return the content object which was set for this widget
2508 * @see elm_scroller_content_set()
2509 * @deprecated use elm_object_content_unset() instead.
2511 EINA_DEPRECATED EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj);
2514 * Set the label of a given slider widget
2516 * @param obj The progress bar object
2517 * @param label The text label string, in UTF-8
2520 * @deprecated use elm_object_text_set() instead.
2522 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label);
2525 * Get the label of a given slider widget
2527 * @param obj The progressbar object
2528 * @return The text label string, in UTF-8
2531 * @deprecated use elm_object_text_get() instead.
2533 EINA_DEPRECATED EAPI const char *elm_slider_label_get(const Evas_Object *obj);
2536 * Set the icon object of the slider object.
2538 * @param obj The slider object.
2539 * @param icon The icon object.
2541 * On horizontal mode, icon is placed at left, and on vertical mode,
2544 * @note Once the icon object is set, a previously set one will be deleted.
2545 * If you want to keep that old content object, use the
2546 * elm_slider_icon_unset() function.
2548 * @warning If the object being set does not have minimum size hints set,
2549 * it won't get properly displayed.
2552 * @deprecated use elm_object_part_content_set() instead.
2554 EINA_DEPRECATED EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon);
2557 * Unset an icon set on a given slider widget.
2559 * @param obj The slider object.
2560 * @return The icon object that was being used, if any was set, or
2561 * @c NULL, otherwise (and on errors).
2563 * On horizontal mode, icon is placed at left, and on vertical mode,
2566 * This call will unparent and return the icon object which was set
2567 * for this widget, previously, on success.
2569 * @see elm_slider_icon_set() for more details
2570 * @see elm_slider_icon_get()
2571 * @deprecated use elm_object_part_content_unset() instead.
2575 EINA_DEPRECATED EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj);
2578 * Retrieve the icon object set for a given slider widget.
2580 * @param obj The slider object.
2581 * @return The icon object's handle, if @p obj had one set, or @c NULL,
2582 * otherwise (and on errors).
2584 * On horizontal mode, icon is placed at left, and on vertical mode,
2587 * @see elm_slider_icon_set() for more details
2588 * @see elm_slider_icon_unset()
2590 * @deprecated use elm_object_part_content_get() instead.
2594 EINA_DEPRECATED EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj);
2597 * Set the end object of the slider object.
2599 * @param obj The slider object.
2600 * @param end The end object.
2602 * On horizontal mode, end is placed at left, and on vertical mode,
2605 * @note Once the icon object is set, a previously set one will be deleted.
2606 * If you want to keep that old content object, use the
2607 * elm_slider_end_unset() function.
2609 * @warning If the object being set does not have minimum size hints set,
2610 * it won't get properly displayed.
2612 * @deprecated use elm_object_part_content_set() instead.
2616 EINA_DEPRECATED EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end);
2619 * Unset an end object set on a given slider widget.
2621 * @param obj The slider object.
2622 * @return The end object that was being used, if any was set, or
2623 * @c NULL, otherwise (and on errors).
2625 * On horizontal mode, end is placed at left, and on vertical mode,
2628 * This call will unparent and return the icon object which was set
2629 * for this widget, previously, on success.
2631 * @see elm_slider_end_set() for more details.
2632 * @see elm_slider_end_get()
2634 * @deprecated use elm_object_part_content_unset() instead
2639 EINA_DEPRECATED EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj);
2642 * Retrieve the end object set for a given slider widget.
2644 * @param obj The slider object.
2645 * @return The end object's handle, if @p obj had one set, or @c NULL,
2646 * otherwise (and on errors).
2648 * On horizontal mode, icon is placed at right, and on vertical mode,
2651 * @see elm_slider_end_set() for more details.
2652 * @see elm_slider_end_unset()
2655 * @deprecated use elm_object_part_content_get() instead
2660 EINA_DEPRECATED EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj);
2663 * Return the data associated with a given slideshow item
2665 * @param it The slideshow item
2666 * @return Returns the data associated to this item
2668 * @deprecated use elm_object_item_data_get() instead
2669 * @ingroup Slideshow
2671 EINA_DEPRECATED EAPI void *elm_slideshow_item_data_get(const Elm_Object_Item *it);
2674 * Delete a given item from a slideshow widget.
2676 * @param it The slideshow item
2678 * @deprecated Use elm_object_item_de() instead
2679 * @ingroup Slideshow
2681 EINA_DEPRECATED EAPI void elm_slideshow_item_del(Elm_Object_Item *it);
2684 * Get the toolbar object from an item.
2686 * @param it The item.
2687 * @return The toolbar object.
2689 * This returns the toolbar object itself that an item belongs to.
2691 * @deprecated use elm_object_item_object_get() instead.
2694 EINA_DEPRECATED EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Object_Item *it);
2697 * Get the label of item.
2699 * @param it The item of toolbar.
2700 * @return The label of item.
2702 * The return value is a pointer to the label associated to @p item when
2703 * it was created, with function elm_toolbar_item_append() or similar,
2705 * with function elm_toolbar_item_label_set. If no label
2706 * was passed as argument, it will return @c NULL.
2708 * @see elm_toolbar_item_label_set() for more details.
2709 * @see elm_toolbar_item_append()
2711 * @deprecated use elm_object_item_text_get() instead.
2714 EINA_DEPRECATED EAPI const char *elm_toolbar_item_label_get(const Elm_Object_Item *it);
2717 * Set the label of item.
2719 * @param it The item of toolbar.
2720 * @param label The label of item.
2722 * The label to be displayed by the item.
2723 * Label will be placed at icons bottom (if set).
2725 * If a label was passed as argument on item creation, with function
2726 * elm_toolbar_item_append() or similar, it will be already
2727 * displayed by the item.
2729 * @see elm_toolbar_item_label_get()
2730 * @see elm_toolbar_item_append()
2732 * @deprecated use elm_object_item_text_set() instead
2735 EINA_DEPRECATED EAPI void elm_toolbar_item_label_set(Elm_Object_Item *it, const char *label);
2738 * Return the data associated with a given toolbar widget item.
2740 * @param it The toolbar widget item handle.
2741 * @return The data associated with @p item.
2743 * @see elm_toolbar_item_data_set()
2745 * @deprecated use elm_object_item_data_get() instead.
2748 EINA_DEPRECATED EAPI void *elm_toolbar_item_data_get(const Elm_Object_Item *it);
2751 * Set the data associated with a given toolbar widget item.
2753 * @param it The toolbar widget item handle
2754 * @param data The new data pointer to set to @p item.
2756 * This sets new item data on @p item.
2758 * @warning The old data pointer won't be touched by this function, so
2759 * the user had better to free that old data himself/herself.
2761 * @deprecated use elm_object_item_data_set() instead.
2764 EINA_DEPRECATED EAPI void elm_toolbar_item_data_set(Elm_Object_Item *it, const void *data);
2767 * Get a value whether toolbar item is disabled or not.
2769 * @param it The item.
2770 * @return The disabled state.
2772 * @see elm_toolbar_item_disabled_set() for more details.
2774 * @deprecated use elm_object_item_disabled_get() instead.
2777 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Object_Item *it);
2780 * Sets the disabled/enabled state of a toolbar item.
2782 * @param it The item.
2783 * @param disabled The disabled state.
2785 * A disabled item cannot be selected or unselected. It will also
2786 * change its appearance (generally greyed out). This sets the
2787 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
2790 * @deprecated use elm_object_item_disabled_set() instead.
2793 EINA_DEPRECATED EAPI void elm_toolbar_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled);
2796 * Change a toolbar's orientation
2797 * @param obj The toolbar object
2798 * @param vertical If @c EINA_TRUE, the toolbar is vertical
2799 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
2801 * @deprecated use elm_toolbar_horizontal_set() instead.
2803 EINA_DEPRECATED EAPI void elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical);
2806 * Get a toolbar's orientation
2807 * @param obj The toolbar object
2808 * @return If @c EINA_TRUE, the toolbar is vertical
2809 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
2811 * @deprecated use elm_toolbar_horizontal_get() instead.
2813 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_orientation_get(const Evas_Object *obj);
2816 * Set the function called when a toolbar item is freed.
2818 * @param it The item to set the callback on.
2819 * @param func The function called.
2821 * If there is a @p func, then it will be called prior item's memory release.
2822 * That will be called with the following arguments:
2824 * @li item's Evas object;
2827 * This way, a data associated to a toolbar item could be properly freed.
2829 * @deprecated Use elm_object_item_del_cb_set() instead
2832 EINA_DEPRECATED EAPI void elm_toolbar_item_del_cb_set(Elm_Object_Item *it, Evas_Smart_Cb func);
2835 * Delete them item from the toolbar.
2837 * @param it The item of toolbar to be deleted.
2839 * @deprecated Use elm_object_item_del() instead
2840 * @see elm_toolbar_item_append()
2844 EINA_DEPRECATED EAPI void elm_toolbar_item_del(Elm_Object_Item *it);
2847 * Set the text to be shown in a given toolbar item's tooltips.
2849 * @param it toolbar item.
2850 * @param text The text to set in the content.
2852 * Setup the text as tooltip to object. The item can have only one tooltip,
2853 * so any previous tooltip data - set with this function or
2854 * elm_toolbar_item_tooltip_content_cb_set() - is removed.
2856 * @deprecated Use elm_object_item_tooltip_text_set() instead
2857 * @see elm_object_tooltip_text_set() for more details.
2861 EINA_DEPRECATED EAPI void elm_toolbar_item_tooltip_text_set(Elm_Object_Item *it, const char *text);
2864 * Set the content to be shown in the tooltip item.
2866 * Setup the tooltip to item. The item can have only one tooltip,
2867 * so any previous tooltip data is removed. @p func(with @p data) will
2868 * be called every time that need show the tooltip and it should
2869 * return a valid Evas_Object. This object is then managed fully by
2870 * tooltip system and is deleted when the tooltip is gone.
2872 * @param it the toolbar item being attached a tooltip.
2873 * @param func the function used to create the tooltip contents.
2874 * @param data what to provide to @a func as callback data/context.
2875 * @param del_cb called when data is not needed anymore, either when
2876 * another callback replaces @a func, the tooltip is unset with
2877 * elm_toolbar_item_tooltip_unset() or the owner @a item
2878 * dies. This callback receives as the first parameter the
2879 * given @a data, and @c event_info is the item.
2881 * @deprecated Use elm_object_item_tooltip_content_cb_set() instead
2882 * @see elm_object_tooltip_content_cb_set() for more details.
2886 EINA_DEPRECATED EAPI void elm_toolbar_item_tooltip_content_cb_set(Elm_Object_Item *it, Elm_Tooltip_Item_Content_Cb func, const void *data, Evas_Smart_Cb del_cb);
2889 * Unset tooltip from item.
2891 * @param it toolbar item to remove previously set tooltip.
2893 * Remove tooltip from item. The callback provided as del_cb to
2894 * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
2895 * it is not used anymore.
2897 * @deprecated Use elm_object_item_tooltip_unset() instead
2898 * @see elm_object_tooltip_unset() for more details.
2899 * @see elm_toolbar_item_tooltip_content_cb_set()
2903 EINA_DEPRECATED EAPI void elm_toolbar_item_tooltip_unset(Elm_Object_Item *it);
2906 * Sets a different style for this item tooltip.
2908 * @note before you set a style you should define a tooltip with
2909 * elm_toolbar_item_tooltip_content_cb_set() or
2910 * elm_toolbar_item_tooltip_text_set()
2912 * @param it toolbar item with tooltip already set.
2913 * @param style the theme style to use (default, transparent, ...)
2915 * @deprecated Use elm_object_item_tooltip_style_set() instead
2916 * @see elm_object_tooltip_style_set() for more details.
2920 EINA_DEPRECATED EAPI void elm_toolbar_item_tooltip_style_set(Elm_Object_Item *it, const char *style);
2923 * Get the style for this item tooltip.
2925 * @param it toolbar item with tooltip already set.
2926 * @return style the theme style in use, defaults to "default". If the
2927 * object does not have a tooltip set, then NULL is returned.
2929 * @deprecated Use elm_object_item_style_get() instead
2930 * @see elm_object_tooltip_style_get() for more details.
2931 * @see elm_toolbar_item_tooltip_style_set()
2935 EINA_DEPRECATED EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Object_Item *it);
2938 * Set the type of mouse pointer/cursor decoration to be shown,
2939 * when the mouse pointer is over the given toolbar widget item
2941 * @param it toolbar item to customize cursor on
2942 * @param cursor the cursor type's name
2944 * This function works analogously as elm_object_cursor_set(), but
2945 * here the cursor's changing area is restricted to the item's
2946 * area, and not the whole widget's. Note that that item cursors
2947 * have precedence over widget cursors, so that a mouse over an
2948 * item with custom cursor set will always show @b that cursor.
2950 * If this function is called twice for an object, a previously set
2951 * cursor will be unset on the second call.
2953 * @see elm_object_cursor_set()
2954 * @see elm_toolbar_item_cursor_get()
2955 * @see elm_toolbar_item_cursor_unset()
2957 * @deprecated use elm_object_item_cursor_set() instead
2961 EINA_DEPRECATED EAPI void elm_toolbar_item_cursor_set(Elm_Object_Item *it, const char *cursor);
2964 * Get the type of mouse pointer/cursor decoration set to be shown,
2965 * when the mouse pointer is over the given toolbar widget item
2967 * @param it toolbar item with custom cursor set
2968 * @return the cursor type's name or @c NULL, if no custom cursors
2969 * were set to @p item (and on errors)
2971 * @see elm_object_cursor_get()
2972 * @see elm_toolbar_item_cursor_set()
2973 * @see elm_toolbar_item_cursor_unset()
2975 * @deprecated Use elm_object_item_cursor_get() instead
2979 EINA_DEPRECATED EAPI const char *elm_toolbar_item_cursor_get(const Elm_Object_Item *it);
2982 * Unset any custom mouse pointer/cursor decoration set to be
2983 * shown, when the mouse pointer is over the given toolbar widget
2984 * item, thus making it show the @b default cursor again.
2986 * @param it a toolbar item
2988 * Use this call to undo any custom settings on this item's cursor
2989 * decoration, bringing it back to defaults (no custom style set).
2991 * @see elm_object_cursor_unset()
2992 * @see elm_toolbar_item_cursor_set()
2994 * @deprecated Use elm_object_item_cursor_unset() instead
2998 EINA_DEPRECATED EAPI void elm_toolbar_item_cursor_unset(Elm_Object_Item *it);
3001 * Set a different @b style for a given custom cursor set for a
3004 * @param it toolbar item with custom cursor set
3005 * @param style the <b>theme style</b> to use (e.g. @c "default",
3006 * @c "transparent", etc)
3008 * This function only makes sense when one is using custom mouse
3009 * cursor decorations <b>defined in a theme file</b>, which can have,
3010 * given a cursor name/type, <b>alternate styles</b> on it. It
3011 * works analogously as elm_object_cursor_style_set(), but here
3012 * applies only to toolbar item objects.
3014 * @warning Before you set a cursor style you should have defined a
3015 * custom cursor previously on the item, with
3016 * elm_toolbar_item_cursor_set()
3018 * @see elm_toolbar_item_cursor_engine_only_set()
3019 * @see elm_toolbar_item_cursor_style_get()
3021 * @deprecated Use elm_object_item_cursor_style_set() instead
3025 EINA_DEPRECATED EAPI void elm_toolbar_item_cursor_style_set(Elm_Object_Item *it, const char *style);
3028 * Get the current @b style set for a given toolbar item's custom
3031 * @param it toolbar item with custom cursor set.
3032 * @return style the cursor style in use. If the object does not
3033 * have a cursor set, then @c NULL is returned.
3035 * @see elm_toolbar_item_cursor_style_set() for more details
3037 * @deprecated Use elm_object_item_cursor_style_get() instead
3041 EINA_DEPRECATED EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Object_Item *it);
3044 * Set if the (custom)cursor for a given toolbar item should be
3045 * searched in its theme, also, or should only rely on the
3048 * @param it item with custom (custom) cursor already set on
3049 * @param engine_only Use @c EINA_TRUE to have cursors looked for
3050 * only on those provided by the rendering engine, @c EINA_FALSE to
3051 * have them searched on the widget's theme, as well.
3053 * @note This call is of use only if you've set a custom cursor
3054 * for toolbar items, with elm_toolbar_item_cursor_set().
3056 * @note By default, cursors will only be looked for between those
3057 * provided by the rendering engine.
3059 * @deprecated Use elm_object_item_cursor_engine_only_set() instead
3063 EINA_DEPRECATED EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Object_Item *it, Eina_Bool engine_only);
3066 * Get if the (custom) cursor for a given toolbar item is being
3067 * searched in its theme, also, or is only relying on the rendering
3070 * @param it a toolbar item
3071 * @return @c EINA_TRUE, if cursors are being looked for only on
3072 * those provided by the rendering engine, @c EINA_FALSE if they
3073 * are being searched on the widget's theme, as well.
3075 * @see elm_toolbar_item_cursor_engine_only_set(), for more details
3077 * @deprecated Use elm_object_item_cursor_engine_only_get() instead
3081 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Object_Item *it);
3084 * @brief Link a Elm_Payer with an Elm_Video object.
3086 * @param player the Elm_Player object.
3087 * @param video The Elm_Video object.
3089 * This mean that action on the player widget will affect the
3090 * video object and the state of the video will be reflected in
3091 * the player itself.
3093 * @see elm_player_add()
3094 * @see elm_video_add()
3095 * @deprecated use elm_object_part_content_set() instead
3099 EINA_DEPRECATED EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
3102 * Set the label of item.
3104 * @param it The item of segment control.
3105 * @param label The label of item.
3107 * The label to be displayed by the item.
3108 * Label will be at right of the icon (if set).
3110 * If a label was passed as argument on item creation, with function
3111 * elm_control_segment_item_add(), it will be already
3112 * displayed by the item.
3114 * @see elm_segment_control_item_label_get()
3115 * @see elm_segment_control_item_add()
3116 * @deprecated Use elm_object_item_text_set() instead
3118 * @ingroup SegmentControl
3120 EINA_DEPRECATED EAPI void elm_segment_control_item_label_set(Elm_Object_Item *it, const char *label);
3124 * Set the icon associated to the item.
3126 * @param it The segment control item.
3127 * @param icon The icon object to associate with @p it.
3129 * The icon object to use at left side of the item. An
3130 * icon can be any Evas object, but usually it is an icon created
3131 * with elm_icon_add().
3133 * Once the icon object is set, a previously set one will be deleted.
3134 * @warning Setting the same icon for two items will cause the icon to
3135 * disappear from the first item.
3137 * If an icon was passed as argument on item creation, with function
3138 * elm_segment_control_item_add(), it will be already
3139 * associated to the item.
3141 * @see elm_segment_control_item_add()
3142 * @see elm_segment_control_item_icon_get()
3143 * @deprecated Use elm_object_item_part_content_set() instead
3145 * @ingroup SegmentControl
3147 EINA_DEPRECATED EAPI void elm_segment_control_item_icon_set(Elm_Object_Item *it, Evas_Object *icon);
3150 * Remove a segment control item from its parent, deleting it.
3152 * @param it The item to be removed.
3154 * Items can be added with elm_segment_control_item_add() or
3155 * elm_segment_control_item_insert_at().
3157 * @deprecated Use elm_object_item_del() instead
3158 * @ingroup SegmentControl
3160 EINA_DEPRECATED EAPI void elm_segment_control_item_del(Elm_Object_Item *it);
3165 * @param obj The multibuttonentry object
3166 * @return The label, or NULL if none
3168 * @deprecated Use elm_object_text_get() instead
3171 EINA_DEPRECATED EAPI const char *elm_multibuttonentry_label_get(const Evas_Object *obj);
3176 * @param obj The multibuttonentry object
3177 * @param label The text label string
3179 * @deprecated Use elm_object_text_set() instead
3182 EINA_DEPRECATED EAPI void elm_multibuttonentry_label_set(Evas_Object *obj, const char *label);
3185 * Get the label of a given item
3187 * @param it The item
3188 * @return The label of a given item, or NULL if none
3190 * @deprecated Use elm_object_item_text_get() instead
3193 EINA_DEPRECATED EAPI const char *elm_multibuttonentry_item_label_get(const Elm_Object_Item *it);
3196 * Set the label of a given item
3198 * @param it The item
3199 * @param str The text label string
3201 * @deprecated Use elm_object_item_text_set() instead
3203 EINA_DEPRECATED EAPI void elm_multibuttonentry_item_label_set(Elm_Object_Item *it, const char *str);
3206 * Delete a given item
3208 * @param it The item
3210 * @deprecated Use elm_object_item_del() instead
3213 EINA_DEPRECATED EAPI void elm_multibuttonentry_item_del(Elm_Object_Item *it);
3216 * @brief Delete the given item instantly.
3218 * @param it The naviframe item
3220 * This just deletes the given item from the naviframe item list instantly.
3221 * So this would not emit any signals for view transitions but just change
3222 * the current view if the given item is a top one.
3224 * @deprecated Use elm_object_item_del() instead
3225 * @ingroup Naviframe
3227 EINA_DEPRECATED EAPI void elm_naviframe_item_del(Elm_Object_Item *it);
3232 * Sets the disabled/enabled state of a list item.
3234 * @param it The item.
3235 * @param disabled The disabled state.
3237 * A disabled item cannot be selected or unselected. It will also
3238 * change its appearance (generally greyed out). This sets the
3239 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
3242 * @deprecated Use elm_object_item_disabled_set() instead
3246 EINA_DEPRECATED EAPI void elm_list_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled);
3249 * Get a value whether list item is disabled or not.
3251 * @param it The item.
3252 * @return The disabled state.
3254 * @see elm_list_item_disabled_set() for more details.
3256 * @deprecated Use elm_object_item_disabled_get() instead
3260 EINA_DEPRECATED EAPI Eina_Bool elm_list_item_disabled_get(const Elm_Object_Item *it);
3263 * Set the function called when a list item is freed.
3265 * @param it The item to set the callback on
3266 * @param func The function called
3268 * If there is a @p func, then it will be called prior item's memory release.
3269 * That will be called with the following arguments:
3271 * @li item's Evas object;
3274 * This way, a data associated to a list item could be properly freed.
3276 * @deprecated Please use elm_object_item_del_cb_set() instead.
3280 EINA_DEPRECATED EAPI void elm_list_item_del_cb_set(Elm_Object_Item *it, Evas_Smart_Cb func);
3283 * Get the data associated to the item.
3285 * @param it The list item
3286 * @return The data associated to @p item
3288 * The return value is a pointer to data associated to @p item when it was
3289 * created, with function elm_list_item_append() or similar. If no data
3290 * was passed as argument, it will return @c NULL.
3292 * @see elm_list_item_append()
3294 * @deprecated Please use elm_object_item_data_get() instead.
3298 EINA_DEPRECATED EAPI void *elm_list_item_data_get(const Elm_Object_Item *it);
3301 * Get the left side icon associated to the item.
3303 * @param it The list item
3304 * @return The left side icon associated to @p item
3306 * The return value is a pointer to the icon associated to @p item when
3308 * created, with function elm_list_item_append() or similar, or later
3309 * with function elm_list_item_icon_set(). If no icon
3310 * was passed as argument, it will return @c NULL.
3312 * @see elm_list_item_append()
3313 * @see elm_list_item_icon_set()
3315 * @deprecated Please use elm_object_item_part_content_get(item, NULL);
3318 EINA_DEPRECATED EAPI Evas_Object *elm_list_item_icon_get(const Elm_Object_Item *it);
3321 * Set the left side icon associated to the item.
3323 * @param it The list item
3324 * @param icon The left side icon object to associate with @p item
3326 * The icon object to use at left side of the item. An
3327 * icon can be any Evas object, but usually it is an icon created
3328 * with elm_icon_add().
3330 * Once the icon object is set, a previously set one will be deleted.
3331 * @warning Setting the same icon for two items will cause the icon to
3332 * disappear from the first item.
3334 * If an icon was passed as argument on item creation, with function
3335 * elm_list_item_append() or similar, it will be already
3336 * associated to the item.
3338 * @see elm_list_item_append()
3339 * @see elm_list_item_icon_get()
3341 * @deprecated Please use elm_object_item_part_content_set(item, NULL, icon);
3344 EINA_DEPRECATED EAPI void elm_list_item_icon_set(Elm_Object_Item *it, Evas_Object *icon);
3347 * Get the right side icon associated to the item.
3349 * @param it The list item
3350 * @return The right side icon associated to @p item
3352 * The return value is a pointer to the icon associated to @p item when
3354 * created, with function elm_list_item_append() or similar, or later
3355 * with function elm_list_item_icon_set(). If no icon
3356 * was passed as argument, it will return @c NULL.
3358 * @see elm_list_item_append()
3359 * @see elm_list_item_icon_set()
3361 * @deprecated Please use elm_object_item_part_content_get(item, "end");
3364 EINA_DEPRECATED EAPI Evas_Object *elm_list_item_end_get(const Elm_Object_Item *it);
3367 * Set the right side icon associated to the item.
3369 * @param it The list item
3370 * @param end The right side icon object to associate with @p item
3372 * The icon object to use at right side of the item. An
3373 * icon can be any Evas object, but usually it is an icon created
3374 * with elm_icon_add().
3376 * Once the icon object is set, a previously set one will be deleted.
3377 * @warning Setting the same icon for two items will cause the icon to
3378 * disappear from the first item.
3380 * If an icon was passed as argument on item creation, with function
3381 * elm_list_item_append() or similar, it will be already
3382 * associated to the item.
3384 * @see elm_list_item_append()
3385 * @see elm_list_item_end_get()
3387 * @deprecated Please use elm_object_item_part_content_set(item, "end", end);
3390 EINA_DEPRECATED EAPI void elm_list_item_end_set(Elm_Object_Item *it, Evas_Object *end);
3393 * Get the label of item.
3395 * @param it The item of list.
3396 * @return The label of item.
3398 * The return value is a pointer to the label associated to @p item when
3399 * it was created, with function elm_list_item_append(), or later
3400 * with function elm_list_item_label_set. If no label
3401 * was passed as argument, it will return @c NULL.
3403 * @see elm_list_item_label_set() for more details.
3404 * @see elm_list_item_append()
3406 * @deprecated Please use elm_object_item_text_get(item);
3409 EINA_DEPRECATED EAPI const char *elm_list_item_label_get(const Elm_Object_Item *it);
3412 * Set the label of item.
3414 * @param it The item of list.
3415 * @param text The label of item.
3417 * The label to be displayed by the item.
3418 * Label will be placed between left and right side icons (if set).
3420 * If a label was passed as argument on item creation, with function
3421 * elm_list_item_append() or similar, it will be already
3422 * displayed by the item.
3424 * @see elm_list_item_label_get()
3425 * @see elm_list_item_append()
3427 * @deprecated Please use elm_object_item_text_set(item, text);
3430 EINA_DEPRECATED EAPI void elm_list_item_label_set(Elm_Object_Item *it, const char *text);
3433 * Set the text to be shown in a given list item's tooltips.
3435 * @param it Target item.
3436 * @param text The text to set in the content.
3438 * Setup the text as tooltip to object. The item can have only one tooltip,
3439 * so any previous tooltip data - set with this function or
3440 * elm_list_item_tooltip_content_cb_set() - is removed.
3442 * @deprecated Use elm_object_item_tooltip_text_set() instead
3443 * @see elm_object_tooltip_text_set() for more details.
3447 EINA_DEPRECATED EAPI void elm_list_item_tooltip_text_set(Elm_Object_Item *it, const char *text);
3450 * @brief Disable size restrictions on an object's tooltip
3451 * @param it The tooltip's anchor object
3452 * @param disable If EINA_TRUE, size restrictions are disabled
3453 * @return EINA_FALSE on failure, EINA_TRUE on success
3455 * This function allows a tooltip to expand beyond its parent window's canvas.
3456 * It will instead be limited only by the size of the display.
3458 * @deprecated Use elm_object_item_tooltip_window_mode_set() instead
3461 EINA_DEPRECATED EAPI Eina_Bool elm_list_item_tooltip_window_mode_set(Elm_Object_Item *it, Eina_Bool disable);
3464 * @brief Retrieve size restriction state of an object's tooltip
3465 * @param obj The tooltip's anchor object
3466 * @return If EINA_TRUE, size restrictions are disabled
3468 * This function returns whether a tooltip is allowed to expand beyond
3469 * its parent window's canvas.
3470 * It will instead be limited only by the size of the display.
3472 * @deprecated Use elm_object_item_tooltip_window_mode_get() instead
3475 EINA_DEPRECATED EAPI Eina_Bool elm_list_item_tooltip_window_mode_get(const Elm_Object_Item *it);
3478 * Set the content to be shown in the tooltip item.
3480 * Setup the tooltip to item. The item can have only one tooltip,
3481 * so any previous tooltip data is removed. @p func(with @p data) will
3482 * be called every time that need show the tooltip and it should
3483 * return a valid Evas_Object. This object is then managed fully by
3484 * tooltip system and is deleted when the tooltip is gone.
3486 * @param it the list item being attached a tooltip.
3487 * @param func the function used to create the tooltip contents.
3488 * @param data what to provide to @a func as callback data/context.
3489 * @param del_cb called when data is not needed anymore, either when
3490 * another callback replaces @a func, the tooltip is unset with
3491 * elm_list_item_tooltip_unset() or the owner @a item
3492 * dies. This callback receives as the first parameter the
3493 * given @a data, and @c event_info is the item.
3495 * @deprecated Use elm_object_item_tooltip_content_cb_set() instead
3497 * @see elm_object_tooltip_content_cb_set() for more details.
3501 EINA_DEPRECATED EAPI void elm_list_item_tooltip_content_cb_set(Elm_Object_Item *it, Elm_Tooltip_Item_Content_Cb func, const void *data, Evas_Smart_Cb del_cb);
3504 * Unset tooltip from item.
3506 * @param it list item to remove previously set tooltip.
3508 * Remove tooltip from item. The callback provided as del_cb to
3509 * elm_list_item_tooltip_content_cb_set() will be called to notify
3510 * it is not used anymore.
3512 * @deprecated Use elm_object_item_tooltip_unset() instead
3513 * @see elm_object_tooltip_unset() for more details.
3514 * @see elm_list_item_tooltip_content_cb_set()
3518 EINA_DEPRECATED EAPI void elm_list_item_tooltip_unset(Elm_Object_Item *it);
3521 * Sets a different style for this item tooltip.
3523 * @note before you set a style you should define a tooltip with
3524 * elm_list_item_tooltip_content_cb_set() or
3525 * elm_list_item_tooltip_text_set()
3527 * @param it list item with tooltip already set.
3528 * @param style the theme style to use (default, transparent, ...)
3531 * @deprecated Use elm_object_item_tooltip_style_set() instead
3532 * @see elm_object_tooltip_style_set() for more details.
3536 EINA_DEPRECATED EAPI void elm_list_item_tooltip_style_set(Elm_Object_Item *it, const char *style);
3539 * Get the style for this item tooltip.
3541 * @param it list item with tooltip already set.
3542 * @return style the theme style in use, defaults to "default". If the
3543 * object does not have a tooltip set, then NULL is returned.
3545 * @deprecated Use elm_object_item_tooltip_style_get() instead
3547 * @see elm_object_tooltip_style_get() for more details.
3548 * @see elm_list_item_tooltip_style_set()
3552 EINA_DEPRECATED EAPI const char *elm_list_item_tooltip_style_get(const Elm_Object_Item *it);
3555 * Set the type of mouse pointer/cursor decoration to be shown,
3556 * when the mouse pointer is over the given list widget item
3558 * @param it list item to customize cursor on
3559 * @param cursor the cursor type's name
3561 * This function works analogously as elm_object_cursor_set(), but
3562 * here the cursor's changing area is restricted to the item's
3563 * area, and not the whole widget's. Note that that item cursors
3564 * have precedence over widget cursors, so that a mouse over an
3565 * item with custom cursor set will always show @b that cursor.
3567 * If this function is called twice for an object, a previously set
3568 * cursor will be unset on the second call.
3570 * @see elm_object_cursor_set()
3571 * @see elm_list_item_cursor_get()
3572 * @see elm_list_item_cursor_unset()
3574 * @deprecated Please use elm_object_item_cursor_set() instead
3577 EINA_DEPRECATED EAPI void elm_list_item_cursor_set(Elm_Object_Item *it, const char *cursor);
3580 * Get the type of mouse pointer/cursor decoration set to be shown,
3581 * when the mouse pointer is over the given list widget item
3583 * @param it list item with custom cursor set
3584 * @return the cursor type's name or @c NULL, if no custom cursors
3585 * were set to @p item (and on errors)
3587 * @see elm_object_cursor_get()
3588 * @see elm_list_item_cursor_set()
3589 * @see elm_list_item_cursor_unset()
3591 * @deprecated Please use elm_object_item_cursor_get() instead
3594 EINA_DEPRECATED EAPI const char *elm_list_item_cursor_get(const Elm_Object_Item *it);
3597 * Unset any custom mouse pointer/cursor decoration set to be
3598 * shown, when the mouse pointer is over the given list widget
3599 * item, thus making it show the @b default cursor again.
3601 * @param it a list item
3603 * Use this call to undo any custom settings on this item's cursor
3604 * decoration, bringing it back to defaults (no custom style set).
3606 * @see elm_object_cursor_unset()
3607 * @see elm_list_item_cursor_set()
3609 * @deprecated Please use elm_list_item_cursor_unset() instead
3612 EINA_DEPRECATED EAPI void elm_list_item_cursor_unset(Elm_Object_Item *it);
3615 * Set a different @b style for a given custom cursor set for a
3618 * @param it list item with custom cursor set
3619 * @param style the <b>theme style</b> to use (e.g. @c "default",
3620 * @c "transparent", etc)
3622 * This function only makes sense when one is using custom mouse
3623 * cursor decorations <b>defined in a theme file</b>, which can have,
3624 * given a cursor name/type, <b>alternate styles</b> on it. It
3625 * works analogously as elm_object_cursor_style_set(), but here
3626 * applies only to list item objects.
3628 * @warning Before you set a cursor style you should have defined a
3629 * custom cursor previously on the item, with
3630 * elm_list_item_cursor_set()
3632 * @see elm_list_item_cursor_engine_only_set()
3633 * @see elm_list_item_cursor_style_get()
3635 * @deprecated Please use elm_list_item_cursor_style_set() instead
3638 EINA_DEPRECATED EAPI void elm_list_item_cursor_style_set(Elm_Object_Item *it, const char *style);
3641 * Get the current @b style set for a given list item's custom
3644 * @param it list item with custom cursor set.
3645 * @return style the cursor style in use. If the object does not
3646 * have a cursor set, then @c NULL is returned.
3648 * @see elm_list_item_cursor_style_set() for more details
3650 * @deprecated Please use elm_list_item_cursor_style_get() instead
3653 EINA_DEPRECATED EAPI const char *elm_list_item_cursor_style_get(const Elm_Object_Item *it);
3656 * Set if the (custom)cursor for a given list item should be
3657 * searched in its theme, also, or should only rely on the
3660 * @param it item with custom (custom) cursor already set on
3661 * @param engine_only Use @c EINA_TRUE to have cursors looked for
3662 * only on those provided by the rendering engine, @c EINA_FALSE to
3663 * have them searched on the widget's theme, as well.
3665 * @note This call is of use only if you've set a custom cursor
3666 * for list items, with elm_list_item_cursor_set().
3668 * @note By default, cursors will only be looked for between those
3669 * provided by the rendering engine.
3671 * @deprecated Please use elm_list_item_cursor_engine_only_set() instead
3674 EINA_DEPRECATED EAPI void elm_list_item_cursor_engine_only_set(Elm_Object_Item *it, Eina_Bool engine_only);
3677 * Get if the (custom) cursor for a given list item is being
3678 * searched in its theme, also, or is only relying on the rendering
3681 * @param it a list item
3682 * @return @c EINA_TRUE, if cursors are being looked for only on
3683 * those provided by the rendering engine, @c EINA_FALSE if they
3684 * are being searched on the widget's theme, as well.
3686 * @see elm_list_item_cursor_engine_only_set(), for more details
3688 * @deprecated Please use elm_list_item_cursor_engine_only_get() instead
3691 EINA_DEPRECATED EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_Object_Item *it);
3694 * Delete the item from the list.
3696 * @param it The item of list to be deleted.
3698 * If deleting all list items is required, elm_list_clear()
3699 * should be used instead of getting items list and deleting each one.
3701 * @see elm_list_clear()
3702 * @see elm_list_item_append()
3703 * @see elm_widget_item_del_cb_set()
3704 * @deprecated Use elm_object_item_del() instead
3708 EINA_DEPRECATED EAPI void elm_list_item_del(Elm_Object_Item *it);
3711 * Set the shrink state of toolbar @p obj.
3713 * @param obj The toolbar object.
3714 * @param shrink_mode Toolbar's items display behavior.
3716 * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
3717 * but will enforce a minimum size so all the items will fit, won't scroll
3718 * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
3719 * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
3720 * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
3722 * @deprecated Please use elm_toolbar_shrink_mode_set(obj, shrink_mode);
3725 EINA_DEPRECATED EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode);
3728 * Get the shrink mode of toolbar @p obj.
3730 * @param obj The toolbar object.
3731 * @return Toolbar's items display behavior.
3733 * @see elm_toolbar_shrink_mode_set() for details.
3735 * @deprecated Please use elm_toolbar_shrink_mode_get(obj);
3738 EINA_DEPRECATED EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj);
3741 * This sets a widget to be displayed to the left of a scrolled entry.
3743 * @param obj The scrolled entry object
3744 * @param icon The widget to display on the left side of the scrolled
3747 * @note A previously set widget will be destroyed.
3748 * @note If the object being set does not have minimum size hints set,
3749 * it won't get properly displayed.
3751 * @deprecated Use elm_object_part_content_set(entry, "icon", content) instead
3752 * @see elm_entry_end_set()
3754 EINA_DEPRECATED EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
3757 * Gets the leftmost widget of the scrolled entry. This object is
3758 * owned by the scrolled entry and should not be modified.
3760 * @param obj The scrolled entry object
3761 * @return the left widget inside the scroller
3763 * @deprecated Use elm_object_part_content_get(entry, "icon") instead
3765 EINA_DEPRECATED EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
3768 * Unset the leftmost widget of the scrolled entry, unparenting and
3771 * @param obj The scrolled entry object
3772 * @return the previously set icon sub-object of this entry, on
3775 * @deprecated Use elm_object_part_content_unset(entry, "icon") instead
3776 * @see elm_entry_icon_set()
3778 EINA_DEPRECATED EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
3781 * This sets a widget to be displayed to the end of a scrolled entry.
3783 * @param obj The scrolled entry object
3784 * @param end The widget to display on the right side of the scrolled
3787 * @note A previously set widget will be destroyed.
3788 * @note If the object being set does not have minimum size hints set,
3789 * it won't get properly displayed.
3791 * @deprecated Use elm_object_part_content_set(entry, "end", content) instead
3792 * @see elm_entry_icon_set
3794 EINA_DEPRECATED EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
3797 * Gets the endmost widget of the scrolled entry. This object is owned
3798 * by the scrolled entry and should not be modified.
3800 * @param obj The scrolled entry object
3801 * @return the right widget inside the scroller
3803 * @deprecated Use elm_object_part_content_get(entry, "end") instead
3805 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
3808 * Unset the endmost widget of the scrolled entry, unparenting and
3811 * @param obj The scrolled entry object
3812 * @return the previously set icon sub-object of this entry, on
3815 * @deprecated Use elm_object_part_content_unset(entry, "end") instead
3816 * @see elm_entry_icon_set()
3818 EINA_DEPRECATED EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
3821 * Convert a pixel coordinate into a rotated pixel coordinate.
3823 * @param obj The map object.
3824 * @param x horizontal coordinate of the point to rotate.
3825 * @param y vertical coordinate of the point to rotate.
3826 * @param cx rotation's center horizontal position.
3827 * @param cy rotation's center vertical position.
3828 * @param degree amount of degrees from 0.0 to 360.0 to rotate around Z axis.
3829 * @param xx Pointer where to store rotated x.
3830 * @param yy Pointer where to store rotated y.
3833 * @deprecated Rotation is not needed to know. Use elm_map_canvas_to_geo_convert() instead
3835 EINA_DEPRECATED EAPI void elm_map_utils_rotate_coord(const Evas_Object *obj, const Evas_Coord x, const Evas_Coord y, const Evas_Coord cx, const Evas_Coord cy, const double degree, Evas_Coord *xx, Evas_Coord *yy);
3838 * Get the gengrid object's handle which contains a given gengrid item
3840 * @param it The item to fetch the container from
3841 * @return The gengrid (parent) object
3843 * This returns the gengrid object itself that an item belongs to.
3845 * @deprecated Use elm_object_item_widget_get() instead
3848 EINA_DEPRECATED EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Object_Item *it);
3851 * Return the data associated to a given gengrid item
3853 * @param it The gengrid item.
3854 * @return the data associated with this item.
3856 * This returns the @c data value passed on the
3857 * elm_gengrid_item_append() and related item addition calls.
3859 * @see elm_gengrid_item_append()
3860 * @see elm_gengrid_item_data_set()
3861 * @deprecated Use elm_object_item_data_get() instead
3864 EINA_DEPRECATED EAPI void *elm_gengrid_item_data_get(const Elm_Object_Item *it);
3867 * Set the data associated with a given gengrid item
3869 * @param it The gengrid item
3870 * @param data The data pointer to set on it
3872 * This @b overrides the @c data value passed on the
3873 * elm_gengrid_item_append() and related item addition calls. This
3874 * function @b won't call elm_gengrid_item_update() automatically,
3875 * so you'd issue it afterwards if you want to have the item
3876 * updated to reflect the new data.
3878 * @see elm_gengrid_item_data_get()
3879 * @see elm_gengrid_item_update()
3880 * @deprecated Use elm_object_item_data_set() instead
3884 EINA_DEPRECATED EAPI void elm_gengrid_item_data_set(Elm_Object_Item *it, const void *data);
3887 * Set whether a given gengrid item is disabled or not.
3889 * @param it The gengrid item
3890 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
3891 * to enable it back.
3893 * A disabled item cannot be selected or unselected. It will also
3894 * change its appearance, to signal the user it's disabled.
3896 * @see elm_gengrid_item_disabled_get()
3897 * @deprecated Use elm_object_item_disabled_set() instead
3901 EINA_DEPRECATED EAPI void elm_gengrid_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled);
3904 * Get whether a given gengrid item is disabled or not.
3906 * @param it The gengrid item
3907 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
3910 * @see elm_gengrid_item_disabled_set() for more details
3911 * @deprecated Use elm_object_item_disabled_get() instead
3915 EINA_DEPRECATED EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Object_Item *it);
3918 * Remove a gengrid item from its parent, deleting it.
3920 * @param it The item to be removed.
3921 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
3923 * @see elm_gengrid_clear(), to remove all items in a gengrid at
3925 * @deprecated use elm_object_item_del() instead
3929 EINA_DEPRECATED EAPI void elm_gengrid_item_del(Elm_Object_Item *it);
3932 * Get the real Evas object created to implement the view of a
3933 * given gengrid item
3935 * @param it The gengrid item.
3936 * @return the Evas object implementing this item's view.
3938 * This returns the actual Evas object used to implement the
3939 * specified gengrid item's view. This may be @c NULL, as it may
3940 * not have been created or may have been deleted, at any time, by
3941 * the gengrid. <b>Do not modify this object</b> (move, resize,
3942 * show, hide, etc.), as the gengrid is controlling it. This
3943 * function is for querying, emitting custom signals or hooking
3944 * lower level callbacks for events on that object. Do not delete
3945 * this object under any circumstances.
3947 * @see elm_object_item_data_get()
3951 EINA_DEPRECATED EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Object_Item *it);
3954 * Update the item class of a gengrid item.
3956 * This sets another class of the item, changing the way that it is
3957 * displayed. After changing the item class, elm_gengrid_item_update() is
3958 * called on the item @p it.
3960 * @param it The gengrid item
3961 * @param gic The gengrid item class describing the function pointers and the item style.
3963 * @deprecated Use elm_gengrid_item_item_class_update instead
3966 EINA_DEPRECATED EAPI void elm_gengrid_item_item_class_set(Elm_Object_Item *it, const Elm_Gengrid_Item_Class *gic);
3969 * Insert an item in a gengrid widget using a user-defined sort function.
3971 * @param obj The gengrid object.
3972 * @param gic The item class for the item.
3973 * @param data The item data.
3974 * @param comp User defined comparison function that defines the sort order
3975 * based on Elm_Gen_Item.
3976 * @param func Convenience function called when the item is selected.
3977 * @param func_data Data to be passed to @p func.
3978 * @return A handle to the item added or @c NULL, on errors.
3980 * This inserts an item in the gengrid based on user defined comparison function.
3982 * @see elm_gengrid_item_append()
3983 * @see elm_gengrid_item_prepend()
3984 * @see elm_gengrid_item_insert_after()
3985 * @see elm_object_item_del()
3986 * @see elm_gengrid_item_sorted_insert()
3988 * @deprecated Use elm_gengrid_item_sorted_insert() instead
3991 EINA_DEPRECATED EAPI Elm_Object_Item *elm_gengrid_item_direct_sorted_insert(Evas_Object *obj, const Elm_Gengrid_Item_Class *gic, const void *data, Eina_Compare_Cb comp, Evas_Smart_Cb func, const void *func_data);
3994 * Append a filter function for text inserted in the entry
3996 * Append the given callback to the list. This functions will be called
3997 * whenever any text is inserted into the entry, with the text to be inserted
3998 * as a parameter. The callback function is free to alter the text in any way
3999 * it wants, but it must remember to free the given pointer and update it.
4000 * If the new text is to be discarded, the function can free it and set its
4001 * text parameter to NULL. This will also prevent any following filters from
4004 * @param obj The entry object
4005 * @param func The function to use as text filter
4006 * @param data User data to pass to @p func
4007 * @deprecated use elm_entry_markup_filter_append() instead
4010 EINA_DEPRECATED EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data);
4013 * Prepend a filter function for text inserted in the entry
4015 * Prepend the given callback to the list. See elm_entry_text_filter_append()
4016 * for more information
4018 * @param obj The entry object
4019 * @param func The function to use as text filter
4020 * @param data User data to pass to @p func
4021 * @deprecated use elm_entry_markup_filter_prepend() instead
4024 EINA_DEPRECATED EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data);
4027 * Remove a filter from the list
4029 * Removes the given callback from the filter list. See
4030 * elm_entry_text_filter_append() for more information.
4032 * @param obj The entry object
4033 * @param func The filter function to remove
4034 * @param data The user data passed when adding the function
4035 * @deprecated use elm_entry_markup_filter_remove() instead
4038 EINA_DEPRECATED EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data);
4041 * @brief Set the front content of the flip widget.
4043 * @param obj The flip object
4044 * @param content The new front content object
4046 * Once the content object is set, a previously set one will be deleted.
4047 * If you want to keep that old content object, use the
4048 * elm_flip_content_front_unset() function.
4050 * @deprecated Use elm_object_part_content_set(flip, "front") instead
4052 EINA_DEPRECATED EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content);
4055 * @brief Set the back content of the flip widget.
4057 * @param obj The flip object
4058 * @param content The new back content object
4060 * Once the content object is set, a previously set one will be deleted.
4061 * If you want to keep that old content object, use the
4062 * elm_flip_content_back_unset() function.
4064 * @deprecated Use elm_object_part_content_set(flip, "back") instead
4066 EINA_DEPRECATED EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content);
4069 * @brief Get the front content used for the flip
4071 * @param obj The flip object
4072 * @return The front content object that is being used
4074 * Return the front content object which is set for this widget.
4076 * @deprecated Use elm_object_part_content_get(flip, "front") instead
4078 EINA_DEPRECATED EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj);
4081 * @brief Get the back content used for the flip
4083 * @param obj The flip object
4084 * @return The back content object that is being used
4086 * Return the back content object which is set for this widget.
4088 * @deprecated Use elm_object_part_content_get(flip, "back") instead
4090 EINA_DEPRECATED EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj);
4093 * @brief Unset the front content used for the flip
4095 * @param obj The flip object
4096 * @return The front content object that was being used
4098 * Unparent and return the front content object which was set for this widget.
4100 * @deprecated Use elm_object_part_content_unset(flip, "front") instead
4102 EINA_DEPRECATED EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj);
4105 * @brief Unset the back content used for the flip
4107 * @param obj The flip object
4108 * @return The back content object that was being used
4110 * Unparent and return the back content object which was set for this widget.
4112 * @deprecated Use elm_object_part_content_unset(flip, "back") instead
4114 EINA_DEPRECATED EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj);
4117 * @brief Get flip front visibility state
4119 * @param obj The flip object
4120 * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
4123 * @deprecated Use elm_flip_front_visible_get() instead
4125 EINA_DEPRECATED EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj);
4128 * Add a new pager to the parent
4130 * @param parent The parent object
4131 * @return The new object or NULL if it cannot be created
4134 * @deprecated Use naviframe instead
4136 EINA_DEPRECATED EAPI Evas_Object *elm_pager_add(Evas_Object *parent);
4139 * @brief Push an object to the top of the pager stack (and show it).
4141 * @param obj The pager object
4142 * @param content The object to push
4144 * The object pushed becomes a child of the pager, it will be controlled and
4145 * deleted when the pager is deleted.
4147 * @note If the content is already in the stack use
4148 * elm_pager_content_promote().
4149 * @warning Using this function on @p content already in the stack results in
4150 * undefined behavior.
4151 * @deprecated Use naviframe instead
4153 EINA_DEPRECATED EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content);
4156 * @brief Pop the object that is on top of the stack
4158 * @param obj The pager object
4160 * This pops the object that is on the top(visible) of the pager, makes it
4161 * disappear, then deletes the object. The object that was underneath it on
4162 * the stack will become visible.
4163 * @deprecated Use naviframe instead
4165 EINA_DEPRECATED EAPI void elm_pager_content_pop(Evas_Object *obj);
4168 * @brief Moves an object already in the pager stack to the top of the stack.
4170 * @param obj The pager object
4171 * @param content The object to promote
4173 * This will take the @p content and move it to the top of the stack as
4174 * if it had been pushed there.
4176 * @note If the content isn't already in the stack use
4177 * elm_pager_content_push().
4178 * @warning Using this function on @p content not already in the stack
4179 * results in undefined behavior.
4180 * @deprecated Use naviframe instead
4182 EINA_DEPRECATED EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content);
4185 * @brief Return the object at the bottom of the pager stack
4187 * @param obj The pager object
4188 * @return The bottom object or NULL if none
4189 * @deprecated Use naviframe instead
4191 EINA_DEPRECATED EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj);
4194 * @brief Return the object at the top of the pager stack
4196 * @param obj The pager object
4197 * @return The top object or NULL if none
4198 * @deprecated Use naviframe instead
4200 EINA_DEPRECATED EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj);
4203 * @brief Set the default item style.
4205 * Default item style will be used with items who's style is NULL
4207 * @param obj The pager object
4208 * @param style The style
4209 * @deprecated Use naviframe instead
4211 EINA_DEPRECATED EAPI void elm_pager_item_style_default_set(Evas_Object *obj, const char *style);
4214 * @brief Get the default item style
4216 * @param obj The pager object
4217 * @return the default item style
4219 * @see elm_pager_item_style_default_set()
4220 * @deprecated Use naviframe instead
4222 EINA_DEPRECATED EAPI const char *elm_pager_item_style_default_get(const Evas_Object *obj);
4225 * @brief Set the font size on the label object.
4227 * @param obj The label object
4228 * @param size font size
4230 * @warning NEVER use this. It is for hyper-special cases only. use styles
4231 * instead. e.g. "default", "marker", "slide_long" etc.
4232 * @deprecated Use tag instead
4234 EINA_DEPRECATED EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize);
4237 * @brief Set the text color on the label object
4239 * @param obj The label object
4240 * @param r Red property background color of The label object
4241 * @param g Green property background color of The label object
4242 * @param b Blue property background color of The label object
4243 * @param a Alpha property background color of The label object
4245 * @warning NEVER use this. It is for hyper-special cases only. use styles
4246 * instead. e.g. "default", "marker", "slide_long" etc.
4247 * @deprecated Use tag instead
4249 EINA_DEPRECATED EAPI void elm_label_text_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a);
4252 * @brief Set the text align on the label object
4254 * @param obj The label object
4255 * @param align align mode ("left", "center", "right")
4257 * @warning NEVER use this. It is for hyper-special cases only. use styles
4258 * instead. e.g. "default", "marker", "slide_long" etc.
4259 * @deprecated Use tag instead
4261 EINA_DEPRECATED EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode);
4264 * @brief Set background color of the label
4266 * @param obj The label object
4267 * @param r Red property background color of The label object
4268 * @param g Green property background color of The label object
4269 * @param b Blue property background color of The label object
4270 * @param a Alpha property background alpha of The label object
4272 * @warning NEVER use this. It is for hyper-special cases only. use styles
4273 * instead. e.g. "default", "marker", "slide_long" etc.
4274 * @deprecated Just make colored background by yourself.
4276 EINA_DEPRECATED EAPI void elm_label_background_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a);
4279 * @brief Flush all caches.
4281 * Frees all data that was in cache and is not currently being used to reduce
4282 * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
4283 * to calling all of the following functions:
4284 * @li edje_file_cache_flush()
4285 * @li edje_collection_cache_flush()
4286 * @li eet_clearcache()
4287 * @li evas_image_cache_flush()
4288 * @li evas_font_cache_flush()
4289 * @li evas_render_dump()
4290 * @note Evas caches are flushed for every canvas associated with a window.
4291 * @deprecated Use elm_cache_all_flush() instead.
4293 EINA_DEPRECATED EAPI void elm_all_flush(void);
4297 * @brief Define the uri that will be the video source.
4299 * @param video The video object to define the file for.
4300 * @param uri The uri to target.
4302 * This function will define an uri as a source for the video of the
4303 * Elm_Video object. URI could be remote source of video, like http:// or local
4304 * like for example WebCam who are most of the time v4l2:// (but that depend an
4305 * you should use Emotion API to request and list the available Webcam on your
4307 * @deprecated Use elm_video_file_set() instead.
4310 EINA_DEPRECATED EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
4313 * @brief Get the region of the image that is currently shown
4316 * @param x A pointer to the X-coordinate of region
4317 * @param y A pointer to the Y-coordinate of region
4318 * @param w A pointer to the width
4319 * @param h A pointer to the height
4321 * @deprecated Use elm_photocam_image_region_get() instead.
4323 EINA_DEPRECATED EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h);
4325 /* No documentation for these API before.
4327 * @deprecated Use elm_route_latitude_min_max_get()
4328 * elm_route_longitude_min_max_get()
4331 EINA_DEPRECATED EAPI double elm_route_lon_min_get(Evas_Object *obj);
4332 EINA_DEPRECATED EAPI double elm_route_lat_min_get(Evas_Object *obj);
4333 EINA_DEPRECATED EAPI double elm_route_lon_max_get(Evas_Object *obj);
4334 EINA_DEPRECATED EAPI double elm_route_lat_max_get(Evas_Object *obj);
4338 * Get the duration after which tooltip will be shown.
4340 * @return Duration after which tooltip will be shown.
4341 * @deprecated Use elm_config_tooltip_delay_get(void);
4343 EINA_DEPRECATED EAPI double elm_tooltip_delay_get(void);
4346 * Set the duration after which tooltip will be shown.
4348 * @return EINA_TRUE if value is set.
4349 * @deprecated Use elm_config_tooltip_delay_set(double delay);
4351 EINA_DEPRECATED EAPI Eina_Bool elm_tooltip_delay_set(double delay);
4354 * Set the corner of the bubble
4356 * @param obj The bubble object.
4357 * @param corner The given corner for the bubble.
4359 * @deprecated Use elm_bubble_pos_set()
4362 EINA_DEPRECATED EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner);
4365 * Get the corner of the bubble
4367 * @param obj The bubble object.
4368 * @return The given corner for the bubble.
4370 * @deprecated Use elm_bubble_pos_get()
4372 EINA_DEPRECATED EAPI const char *elm_bubble_corner_get(const Evas_Object *obj);
4375 * Enable or disable day selection
4377 * @param obj The calendar object.
4378 * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
4381 * @deprecated Use elm_calendar_day_selection_disabled_set()
4383 EINA_DEPRECATED EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled);
4386 * Get a value whether day selection is enabled or not.
4388 * @param obj The calendar object.
4389 * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
4390 * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
4392 * @deprecated elm_calendar_day_selection_disabled_get()
4394 EINA_DEPRECATED EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj);
4397 * @deprecated Use Elm_Calendar_Mark_Repeat_Type instead.
4399 typedef _Elm_Calendar_Mark_Repeat_Type Elm_Calendar_Mark_Repeat EINA_DEPRECATED;