efl/legacy/elementary/src/lib/elm_deprecated.h

1307 lines
49 KiB
C
Raw Normal View History

/**
* @image html img/widget/toggle/preview-00.png
* @image latex img/widget/toggle/preview-00.eps
*
* @brief A toggle is a slider which can be used to toggle between
* two values. It has two states: on and off.
*
* This widget is deprecated. Please use elm_check_add() instead using the
* toggle style like:
*
* @code
* obj = elm_check_add(parent);
* elm_object_style_set(obj, "toggle");
* elm_object_part_text_set(obj, "on", "ON");
* elm_object_part_text_set(obj, "off", "OFF");
* @endcode
*
* Signals that you can add callbacks for are:
* @li "changed" - Whenever the toggle value has been changed. Is not called
* until the toggle is released by the cursor (assuming it
* has been triggered by the cursor in the first place).
*
* Default content parts of the toggle widget that you can use for are:
* @li "icon" - An icon of the toggle
*
* Default text parts of the toggle widget that you can use for are:
* @li "elm.text" - Label of the toggle
*
* @ref tutorial_toggle show how to use a toggle.
* @{
*/
/**
* @brief Add a toggle to @p parent.
*
* @param parent The parent object
*
* @return The toggle object
*/
EINA_DEPRECATED EAPI Evas_Object *elm_toggle_add(Evas_Object *parent);
/**
* @brief Sets the label to be displayed with the toggle.
*
* @param obj The toggle object
* @param label The label to be displayed
*
* @deprecated use elm_object_text_set() instead.
*/
EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label);
/**
* @brief Gets the label of the toggle
*
* @param obj toggle object
* @return The label of the toggle
*
* @deprecated use elm_object_text_get() instead.
*/
EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj);
/**
* @brief Set the icon used for the toggle
*
* @param obj The toggle object
* @param icon The icon object for the button
*
* Once the icon object is set, a previously set one will be deleted
* If you want to keep that old content object, use the
* elm_toggle_icon_unset() function.
*
* @deprecated use elm_object_part_content_set() instead.
*/
EINA_DEPRECATED EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon);
/**
* @brief Get the icon used for the toggle
*
* @param obj The toggle object
* @return The icon object that is being used
*
* Return the icon object which is set for this widget.
*
* @deprecated use elm_object_part_content_get() instead.
*/
EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj);
/**
* @brief Unset the icon used for the toggle
*
* @param obj The toggle object
* @return The icon object that was being used
*
* Unparent and return the icon object which was set for this widget.
*
* @deprecated use elm_object_part_content_unset() instead.
*/
EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj);
/**
* @brief Sets the labels to be associated with the on and off states of the toggle.
*
* @param obj The toggle object
* @param onlabel The label displayed when the toggle is in the "on" state
* @param offlabel The label displayed when the toggle is in the "off" state
*
* @deprecated use elm_object_part_text_set() for "on" and "off" parts
* instead.
*/
EINA_DEPRECATED EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel);
/**
* @brief Gets the labels associated with the on and off states of the
* toggle.
*
* @param obj The toggle object
* @param onlabel A char** to place the onlabel of @p obj into
* @param offlabel A char** to place the offlabel of @p obj into
*
* @deprecated use elm_object_part_text_get() for "on" and "off" parts
* instead.
*/
EINA_DEPRECATED EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel);
/**
* @brief Sets the state of the toggle to @p state.
*
* @param obj The toggle object
* @param state The state of @p obj
*
* @deprecated use elm_check_state_set() instead.
*/
EINA_DEPRECATED EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state);
/**
* @brief Gets the state of the toggle to @p state.
*
* @param obj The toggle object
* @return The state of @p obj
*
* @deprecated use elm_check_state_get() instead.
*/
EINA_DEPRECATED EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj);
/**
* @brief Sets the state pointer of the toggle to @p statep.
*
* @param obj The toggle object
* @param statep The state pointer of @p obj
*
* @deprecated use elm_check_state_pointer_set() instead.
*/
EINA_DEPRECATED EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep);
/**
* @}
*/
EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent);
EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line);
EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj);
EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password);
EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj);
EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry);
EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj);
EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry);
EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj);
EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj);
EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry);
EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap);
EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable);
EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj);
EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj);
EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj);
EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj);
EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj);
EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj);
EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj);
EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj);
EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj);
EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj);
EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj);
EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj);
EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj);
EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj);
EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj);
EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj);
EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos);
EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj);
EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj);
EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj);
EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj);
EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj);
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);
EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled);
EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj);
EINA_DEPRECATED EAPI void elm_scrolled_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj);
EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj);
EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end);
EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj);
EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj);
EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
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);
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);
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);
EINA_DEPRECATED EAPI void elm_scrolled_entry_text_filter_append(Evas_Object *obj, void (*func)(void *data, Evas_Object *entry, char **text), void *data);
EINA_DEPRECATED EAPI void elm_scrolled_entry_text_filter_prepend(Evas_Object *obj, void (*func)(void *data, Evas_Object *entry, char **text), void *data);
EINA_DEPRECATED EAPI void elm_scrolled_entry_text_filter_remove(Evas_Object *obj, void (*func)(void *data, Evas_Object *entry, char **text), void *data);
EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format);
EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format);
EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj);
EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave);
EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj);
EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly);
EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj);
/**
2012-03-14 02:56:20 -07:00
* Get the real Evas object created to implement the view of a
* given genlist item
*
2012-03-14 02:56:20 -07:00
* @param it The genlist item.
* @return the Evas object implementing this item's view.
*
2012-03-14 02:56:20 -07:00
* This returns the actual Evas object used to implement the
* specified genlist item's view. This may be @c NULL, as it may
* not have been created or may have been deleted, at any time, by
* the genlist. <b>Do not modify this object</b> (move, resize,
* show, hide, etc.), as the genlist is controlling it. This
* function is for querying, emitting custom signals or hooking
* lower level callbacks for events on that object. Do not delete
* this object under any circumstances.
*
2012-03-14 02:56:20 -07:00
* @see elm_object_item_data_get()
* @deprecated No more support. If you need to emit signal to item's edje object, use elm_object_item_signal_emit().
*
*/
2012-03-14 02:56:20 -07:00
EINA_DEPRECATED EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Object_Item *it);
/**
2012-03-14 02:56:20 -07:00
* Set the function called when a list item is freed.
*
* @param it The item to set the callback on
* @param func The function called
*
2012-03-14 02:56:20 -07:00
* If there is a @p func, then it will be called prior item's memory release.
* That will be called with the following arguments:
* @li item's data;
* @li item's Evas object;
* @li item itself;
*
2012-03-14 02:56:20 -07:00
* This way, a data associated to a list item could be properly freed.
*
2012-03-14 02:56:20 -07:00
* @deprecated Please use elm_object_item_del_cb_set() instead.
*
*/
2012-03-14 02:56:20 -07:00
EINA_DEPRECATED EAPI void elm_list_item_del_cb_set(Elm_Object_Item *it, Evas_Smart_Cb func);
/**
2012-03-14 02:56:20 -07:00
* Get the data associated to the item.
*
2012-03-14 02:56:20 -07:00
* @param it The list item
* @return The data associated to @p item
*
2012-03-14 02:56:20 -07:00
* The return value is a pointer to data associated to @p item when it was
* created, with function elm_list_item_append() or similar. If no data
* was passed as argument, it will return @c NULL.
*
2012-03-14 02:56:20 -07:00
* @see elm_list_item_append()
*
* @deprecated Please use elm_object_item_data_get() instead.
*
*/
2012-03-14 02:56:20 -07:00
EINA_DEPRECATED EAPI void *elm_list_item_data_get(const Elm_Object_Item *it);
/**
2012-03-14 02:56:20 -07:00
* Get the left side icon associated to the item.
*
2012-03-14 02:56:20 -07:00
* @param it The list item
* @return The left side icon associated to @p item
*
2012-03-14 02:56:20 -07:00
* The return value is a pointer to the icon associated to @p item when
* it was
* created, with function elm_list_item_append() or similar, or later
* with function elm_list_item_icon_set(). If no icon
* was passed as argument, it will return @c NULL.
*
2012-03-14 02:56:20 -07:00
* @see elm_list_item_append()
* @see elm_list_item_icon_set()
*
2012-03-14 02:56:20 -07:00
* @deprecated Please use elm_object_item_part_content_get(item, NULL);
*/
2012-03-14 02:56:20 -07:00
EINA_DEPRECATED EAPI Evas_Object *elm_list_item_icon_get(const Elm_Object_Item *it);
/**
2012-03-14 02:56:20 -07:00
* Set the left side icon associated to the item.
*
2012-03-14 02:56:20 -07:00
* @param it The list item
* @param icon The left side icon object to associate with @p item
*
2012-03-14 02:56:20 -07:00
* The icon object to use at left side of the item. An
* icon can be any Evas object, but usually it is an icon created
* with elm_icon_add().
*
* Once the icon object is set, a previously set one will be deleted.
* @warning Setting the same icon for two items will cause the icon to
* disappear from the first item.
*
* If an icon was passed as argument on item creation, with function
* elm_list_item_append() or similar, it will be already
* associated to the item.
*
2012-03-14 02:56:20 -07:00
* @see elm_list_item_append()
* @see elm_list_item_icon_get()
*
2012-03-14 02:56:20 -07:00
* @deprecated Please use elm_object_item_part_content_set(item, NULL, icon);
*/
2012-03-14 02:56:20 -07:00
EINA_DEPRECATED EAPI void elm_list_item_icon_set(Elm_Object_Item *it, Evas_Object *icon);
/**
2012-03-14 02:56:20 -07:00
* Get the right side icon associated to the item.
*
2012-03-14 02:56:20 -07:00
* @param it The list item
* @return The right side icon associated to @p item
*
2012-03-14 02:56:20 -07:00
* The return value is a pointer to the icon associated to @p item when
* it was
* created, with function elm_list_item_append() or similar, or later
* with function elm_list_item_icon_set(). If no icon
* was passed as argument, it will return @c NULL.
*
2012-03-14 02:56:20 -07:00
* @see elm_list_item_append()
* @see elm_list_item_icon_set()
*
2012-03-14 02:56:20 -07:00
* @deprecated Please use elm_object_item_part_content_get(item, "end");
*/
2012-03-14 02:56:20 -07:00
EINA_DEPRECATED EAPI Evas_Object *elm_list_item_end_get(const Elm_Object_Item *it);
/**
2012-03-14 02:56:20 -07:00
* Set the right side icon associated to the item.
*
2012-03-14 02:56:20 -07:00
* @param it The list item
* @param end The right side icon object to associate with @p item
*
2012-03-14 02:56:20 -07:00
* The icon object to use at right side of the item. An
* icon can be any Evas object, but usually it is an icon created
* with elm_icon_add().
*
2012-03-14 02:56:20 -07:00
* Once the icon object is set, a previously set one will be deleted.
* @warning Setting the same icon for two items will cause the icon to
* disappear from the first item.
*
2012-03-14 02:56:20 -07:00
* If an icon was passed as argument on item creation, with function
* elm_list_item_append() or similar, it will be already
* associated to the item.
*
2012-03-14 02:56:20 -07:00
* @see elm_list_item_append()
* @see elm_list_item_end_get()
*
2012-03-14 02:56:20 -07:00
* @deprecated Please use elm_object_item_part_content_set(item, "end", end);
*/
2012-03-14 02:56:20 -07:00
EINA_DEPRECATED EAPI void elm_list_item_end_set(Elm_Object_Item *it, Evas_Object *end);
/**
2012-03-14 02:56:20 -07:00
* Get the label of item.
*
2012-03-14 02:56:20 -07:00
* @param it The item of list.
* @return The label of item.
*
* The return value is a pointer to the label associated to @p item when
* it was created, with function elm_list_item_append(), or later
* with function elm_list_item_label_set. If no label
* was passed as argument, it will return @c NULL.
*
2012-03-14 02:56:20 -07:00
* @see elm_list_item_label_set() for more details.
* @see elm_list_item_append()
*
2012-03-14 02:56:20 -07:00
* @deprecated Please use elm_object_item_text_get(item);
*/
2012-03-14 02:56:20 -07:00
EINA_DEPRECATED EAPI const char *elm_list_item_label_get(const Elm_Object_Item *it);
/**
2012-03-14 02:56:20 -07:00
* Set the label of item.
*
2012-03-14 02:56:20 -07:00
* @param it The item of list.
* @param text The label of item.
*
2012-03-14 02:56:20 -07:00
* The label to be displayed by the item.
* Label will be placed between left and right side icons (if set).
*
2012-03-14 02:56:20 -07:00
* If a label was passed as argument on item creation, with function
* elm_list_item_append() or similar, it will be already
* displayed by the item.
*
2012-03-14 02:56:20 -07:00
* @see elm_list_item_label_get()
* @see elm_list_item_append()
*
2012-03-14 02:56:20 -07:00
* @deprecated Please use elm_object_item_text_set(item, text);
*/
2012-03-14 02:56:20 -07:00
EINA_DEPRECATED EAPI void elm_list_item_label_set(Elm_Object_Item *it, const char *text);
/**
2012-03-14 02:56:20 -07:00
* Set the text to be shown in a given list item's tooltips.
*
2012-03-14 02:56:20 -07:00
* @param it Target item.
* @param text The text to set in the content.
*
2012-03-14 02:56:20 -07:00
* Setup the text as tooltip to object. The item can have only one tooltip,
* so any previous tooltip data - set with this function or
* elm_list_item_tooltip_content_cb_set() - is removed.
*
2012-03-14 02:56:20 -07:00
* @deprecated Use elm_object_item_tooltip_text_set() instead
* @see elm_object_tooltip_text_set() for more details.
*
*/
2012-03-14 02:56:20 -07:00
EINA_DEPRECATED EAPI void elm_list_item_tooltip_text_set(Elm_Object_Item *it, const char *text);
/**
2012-03-14 02:56:20 -07:00
* Set the content to be shown in the tooltip item.
*
2012-03-14 02:56:20 -07:00
* Setup the tooltip to item. The item can have only one tooltip,
* so any previous tooltip data is removed. @p func(with @p data) will
* be called every time that need show the tooltip and it should
* return a valid Evas_Object. This object is then managed fully by
* tooltip system and is deleted when the tooltip is gone.
*
2012-03-14 02:56:20 -07:00
* @param it the list item being attached a tooltip.
* @param func the function used to create the tooltip contents.
* @param data what to provide to @a func as callback data/context.
* @param del_cb called when data is not needed anymore, either when
* another callback replaces @a func, the tooltip is unset with
* elm_list_item_tooltip_unset() or the owner @a item
* dies. This callback receives as the first parameter the
* given @a data, and @c event_info is the item.
*
* @deprecated Use elm_object_item_tooltip_content_cb_set() instead
*
2012-03-14 02:56:20 -07:00
* @see elm_object_tooltip_content_cb_set() for more details.
*
*/
2012-03-14 02:56:20 -07:00
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);
/**
2012-03-14 02:56:20 -07:00
* Unset tooltip from item.
*
2012-03-14 02:56:20 -07:00
* @param it list item to remove previously set tooltip.
*
2012-03-14 02:56:20 -07:00
* Remove tooltip from item. The callback provided as del_cb to
* elm_list_item_tooltip_content_cb_set() will be called to notify
* it is not used anymore.
*
2012-03-14 02:56:20 -07:00
* @deprecated Use elm_object_item_tooltip_unset() instead
* @see elm_object_tooltip_unset() for more details.
* @see elm_list_item_tooltip_content_cb_set()
*
*/
2012-03-14 02:56:20 -07:00
EINA_DEPRECATED EAPI void elm_list_item_tooltip_unset(Elm_Object_Item *it);
/**
2012-03-14 02:56:20 -07:00
* Sets a different style for this item tooltip.
*
* @note before you set a style you should define a tooltip with
* elm_list_item_tooltip_content_cb_set() or
* elm_list_item_tooltip_text_set()
*
2012-03-14 02:56:20 -07:00
* @param it list item with tooltip already set.
* @param style the theme style to use (default, transparent, ...)
*
*
2012-03-14 02:56:20 -07:00
* @deprecated Use elm_object_item_tooltip_style_set() instead
* @see elm_object_tooltip_style_set() for more details.
*
*/
2012-03-14 02:56:20 -07:00
EINA_DEPRECATED EAPI void elm_list_item_tooltip_style_set(Elm_Object_Item *it, const char *style);
/**
2012-03-14 02:56:20 -07:00
* Get the style for this item tooltip.
*
2012-03-14 02:56:20 -07:00
* @param it list item with tooltip already set.
* @return style the theme style in use, defaults to "default". If the
* object does not have a tooltip set, then NULL is returned.
*
2012-03-14 02:56:20 -07:00
* @deprecated Use elm_object_item_tooltip_style_get() instead
*
2012-03-14 02:56:20 -07:00
* @see elm_object_tooltip_style_get() for more details.
* @see elm_list_item_tooltip_style_set()
*
*/
2012-03-14 02:56:20 -07:00
EINA_DEPRECATED EAPI const char *elm_list_item_tooltip_style_get(const Elm_Object_Item *it);
/**
2012-03-14 02:56:20 -07:00
* Set the type of mouse pointer/cursor decoration to be shown,
* when the mouse pointer is over the given list widget item
*
2012-03-14 02:56:20 -07:00
* @param it list item to customize cursor on
* @param cursor the cursor type's name
*
2012-03-14 02:56:20 -07:00
* This function works analogously as elm_object_cursor_set(), but
* here the cursor's changing area is restricted to the item's
* area, and not the whole widget's. Note that that item cursors
* have precedence over widget cursors, so that a mouse over an
* item with custom cursor set will always show @b that cursor.
*
2012-03-14 02:56:20 -07:00
* If this function is called twice for an object, a previously set
* cursor will be unset on the second call.
*
2012-03-14 02:56:20 -07:00
* @see elm_object_cursor_set()
* @see elm_list_item_cursor_get()
* @see elm_list_item_cursor_unset()
*
2012-03-14 02:56:20 -07:00
* @deprecated Please use elm_object_item_cursor_set() instead
*/
2012-03-14 02:56:20 -07:00
EINA_DEPRECATED EAPI void elm_list_item_cursor_set(Elm_Object_Item *it, const char *cursor);
/*
2012-03-14 02:56:20 -07:00
* Get the type of mouse pointer/cursor decoration set to be shown,
* when the mouse pointer is over the given list widget item
From: Bluezery <ohpowel@gmail.com> Subject: [E-devel] [Patch][elm_map] Change & Add map APIs I rename & add some APIs. As previously discussed, I categorized map APIs. (http://marc.info/?l=enlightenment-devel&m=132685497711772&w=2) 1) Zoom elm_map_zoom_set/get elm_map_zoom_mode_set/get elm_map_zoom_min_set/get elm_map_zoom_max_set/get 2) Region - Geographic coordinates (region) elm_map_region_get elm_map_region_show/bring_in elm_map_canvas_to_region_convert I will not use "_geo_" in map APIs. All map APIs are basically used by geographic coordinates. 3) Property elm_map_paused_set/get elm_map_rotate_set/get elm_map_wheel_disabled_set/get elm_map_user_agent_set/get 4) Overlay elm_map_overlay_add/del elm_map_overlay_xxx elm_map_overlay_class_xxx elm_map_overlay_bubble_xxx elm_map_overlay_route_xxx I will add line, rectangle, poi overlays ASAP. 5) Source - External Provider (Tile, Route, Name, ) elm_map_sources_get elm_map_source_set/get I will add more provider ASAP such as POI, etc. 6) Route elm_map_route_add/del elm_map_route_distance_get elm_map_route_node_get elm_map_route_waypoints_get 7) Name elm_map_name_add/del elm_map_route_address_get elm_map_route_region_get 6) Route and 7) Name do not return visible objects actually. Those just return data. I don't know "_add" suffix is correct for none visible objects. I cannot decide yet whether those should be removed from map widget. But current trends are that route, geocoding are tightly coupled with Map. If Apps want to use only data, just use elm_map_route_add(). If not, use elm_map_route_add() & elm_map_overlay_route_add(). Also name overlay could be added in the future. 8) Miscellaneous elm_map_tile_load_status_get 9) Signals Basic events : "clicked", "clicked,double", "press", "longpressed", Scroller events: "scroll", "scroll,xxx,xxx" Zoom events: "zoom,start/stop/change" Source (provider) events: "tile,load/loaded/loaded,fail" , "route,load/loaded/loaded,fail", "name,load/loaded/loaded,fail" There are some big patches. I think diff program do not make exact diff. :D. Anyway, it's better to maintain if this can be in before API fix (elementary 1.0). Because after these change, It is hard to maintain old APIs. PS) Documentations and some minor bugs are remained yet. SVN revision: 68915
2012-03-07 01:28:08 -08:00
*
2012-03-14 02:56:20 -07:00
* @param it list item with custom cursor set
* @return the cursor type's name or @c NULL, if no custom cursors
* were set to @p item (and on errors)
From: Bluezery <ohpowel@gmail.com> Subject: [E-devel] [Patch][elm_map] Change & Add map APIs I rename & add some APIs. As previously discussed, I categorized map APIs. (http://marc.info/?l=enlightenment-devel&m=132685497711772&w=2) 1) Zoom elm_map_zoom_set/get elm_map_zoom_mode_set/get elm_map_zoom_min_set/get elm_map_zoom_max_set/get 2) Region - Geographic coordinates (region) elm_map_region_get elm_map_region_show/bring_in elm_map_canvas_to_region_convert I will not use "_geo_" in map APIs. All map APIs are basically used by geographic coordinates. 3) Property elm_map_paused_set/get elm_map_rotate_set/get elm_map_wheel_disabled_set/get elm_map_user_agent_set/get 4) Overlay elm_map_overlay_add/del elm_map_overlay_xxx elm_map_overlay_class_xxx elm_map_overlay_bubble_xxx elm_map_overlay_route_xxx I will add line, rectangle, poi overlays ASAP. 5) Source - External Provider (Tile, Route, Name, ) elm_map_sources_get elm_map_source_set/get I will add more provider ASAP such as POI, etc. 6) Route elm_map_route_add/del elm_map_route_distance_get elm_map_route_node_get elm_map_route_waypoints_get 7) Name elm_map_name_add/del elm_map_route_address_get elm_map_route_region_get 6) Route and 7) Name do not return visible objects actually. Those just return data. I don't know "_add" suffix is correct for none visible objects. I cannot decide yet whether those should be removed from map widget. But current trends are that route, geocoding are tightly coupled with Map. If Apps want to use only data, just use elm_map_route_add(). If not, use elm_map_route_add() & elm_map_overlay_route_add(). Also name overlay could be added in the future. 8) Miscellaneous elm_map_tile_load_status_get 9) Signals Basic events : "clicked", "clicked,double", "press", "longpressed", Scroller events: "scroll", "scroll,xxx,xxx" Zoom events: "zoom,start/stop/change" Source (provider) events: "tile,load/loaded/loaded,fail" , "route,load/loaded/loaded,fail", "name,load/loaded/loaded,fail" There are some big patches. I think diff program do not make exact diff. :D. Anyway, it's better to maintain if this can be in before API fix (elementary 1.0). Because after these change, It is hard to maintain old APIs. PS) Documentations and some minor bugs are remained yet. SVN revision: 68915
2012-03-07 01:28:08 -08:00
*
2012-03-14 02:56:20 -07:00
* @see elm_object_cursor_get()
* @see elm_list_item_cursor_set()
* @see elm_list_item_cursor_unset()
From: Bluezery <ohpowel@gmail.com> Subject: [E-devel] [Patch][elm_map] Change & Add map APIs I rename & add some APIs. As previously discussed, I categorized map APIs. (http://marc.info/?l=enlightenment-devel&m=132685497711772&w=2) 1) Zoom elm_map_zoom_set/get elm_map_zoom_mode_set/get elm_map_zoom_min_set/get elm_map_zoom_max_set/get 2) Region - Geographic coordinates (region) elm_map_region_get elm_map_region_show/bring_in elm_map_canvas_to_region_convert I will not use "_geo_" in map APIs. All map APIs are basically used by geographic coordinates. 3) Property elm_map_paused_set/get elm_map_rotate_set/get elm_map_wheel_disabled_set/get elm_map_user_agent_set/get 4) Overlay elm_map_overlay_add/del elm_map_overlay_xxx elm_map_overlay_class_xxx elm_map_overlay_bubble_xxx elm_map_overlay_route_xxx I will add line, rectangle, poi overlays ASAP. 5) Source - External Provider (Tile, Route, Name, ) elm_map_sources_get elm_map_source_set/get I will add more provider ASAP such as POI, etc. 6) Route elm_map_route_add/del elm_map_route_distance_get elm_map_route_node_get elm_map_route_waypoints_get 7) Name elm_map_name_add/del elm_map_route_address_get elm_map_route_region_get 6) Route and 7) Name do not return visible objects actually. Those just return data. I don't know "_add" suffix is correct for none visible objects. I cannot decide yet whether those should be removed from map widget. But current trends are that route, geocoding are tightly coupled with Map. If Apps want to use only data, just use elm_map_route_add(). If not, use elm_map_route_add() & elm_map_overlay_route_add(). Also name overlay could be added in the future. 8) Miscellaneous elm_map_tile_load_status_get 9) Signals Basic events : "clicked", "clicked,double", "press", "longpressed", Scroller events: "scroll", "scroll,xxx,xxx" Zoom events: "zoom,start/stop/change" Source (provider) events: "tile,load/loaded/loaded,fail" , "route,load/loaded/loaded,fail", "name,load/loaded/loaded,fail" There are some big patches. I think diff program do not make exact diff. :D. Anyway, it's better to maintain if this can be in before API fix (elementary 1.0). Because after these change, It is hard to maintain old APIs. PS) Documentations and some minor bugs are remained yet. SVN revision: 68915
2012-03-07 01:28:08 -08:00
*
2012-03-14 02:56:20 -07:00
* @deprecated Please use elm_object_item_cursor_get() instead
*/
2012-03-14 02:56:20 -07:00
EINA_DEPRECATED EAPI const char *elm_list_item_cursor_get(const Elm_Object_Item *it);
/**
2012-03-14 02:56:20 -07:00
* Unset any custom mouse pointer/cursor decoration set to be
* shown, when the mouse pointer is over the given list widget
* item, thus making it show the @b default cursor again.
*
2012-03-14 02:56:20 -07:00
* @param it a list item
*
2012-03-14 02:56:20 -07:00
* Use this call to undo any custom settings on this item's cursor
* decoration, bringing it back to defaults (no custom style set).
*
2012-03-14 02:56:20 -07:00
* @see elm_object_cursor_unset()
* @see elm_list_item_cursor_set()
*
2012-03-14 02:56:20 -07:00
* @deprecated Please use elm_list_item_cursor_unset() instead
*/
2012-03-14 02:56:20 -07:00
EINA_DEPRECATED EAPI void elm_list_item_cursor_unset(Elm_Object_Item *it);
/**
2012-03-14 02:56:20 -07:00
* Set a different @b style for a given custom cursor set for a
* list item.
*
2012-03-14 02:56:20 -07:00
* @param it list item with custom cursor set
* @param style the <b>theme style</b> to use (e.g. @c "default",
* @c "transparent", etc)
*
2012-03-14 02:56:20 -07:00
* This function only makes sense when one is using custom mouse
* cursor decorations <b>defined in a theme file</b>, which can have,
* given a cursor name/type, <b>alternate styles</b> on it. It
* works analogously as elm_object_cursor_style_set(), but here
* applies only to list item objects.
*
2012-03-14 02:56:20 -07:00
* @warning Before you set a cursor style you should have defined a
* custom cursor previously on the item, with
* elm_list_item_cursor_set()
*
2012-03-14 02:56:20 -07:00
* @see elm_list_item_cursor_engine_only_set()
* @see elm_list_item_cursor_style_get()
*
2012-03-14 02:56:20 -07:00
* @deprecated Please use elm_list_item_cursor_style_set() instead
*/
2012-03-14 02:56:20 -07:00
EINA_DEPRECATED EAPI void elm_list_item_cursor_style_set(Elm_Object_Item *it, const char *style);
/**
2012-03-14 02:56:20 -07:00
* Get the current @b style set for a given list item's custom
* cursor
*
2012-03-14 02:56:20 -07:00
* @param it list item with custom cursor set.
* @return style the cursor style in use. If the object does not
* have a cursor set, then @c NULL is returned.
*
2012-03-14 02:56:20 -07:00
* @see elm_list_item_cursor_style_set() for more details
*
2012-03-14 02:56:20 -07:00
* @deprecated Please use elm_list_item_cursor_style_get() instead
*/
2012-03-14 02:56:20 -07:00
EINA_DEPRECATED EAPI const char *elm_list_item_cursor_style_get(const Elm_Object_Item *it);
/**
2012-03-14 02:56:20 -07:00
* Get if the (custom) cursor for a given list item is being
* searched in its theme, also, or is only relying on the rendering
* engine.
*
2012-03-14 02:56:20 -07:00
* @param it a list item
* @return @c EINA_TRUE, if cursors are being looked for only on
* those provided by the rendering engine, @c EINA_FALSE if they
* are being searched on the widget's theme, as well.
*
2012-03-14 02:56:20 -07:00
* @see elm_list_item_cursor_engine_only_set(), for more details
*
2012-03-14 02:56:20 -07:00
* @deprecated Please use elm_list_item_cursor_engine_only_get() instead
*/
2012-03-14 02:56:20 -07:00
EINA_DEPRECATED EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_Object_Item *it);
/**
2012-03-14 02:56:20 -07:00
* Delete the item from the list.
*
2012-03-14 02:56:20 -07:00
* @param it The item of list to be deleted.
*
2012-03-14 02:56:20 -07:00
* If deleting all list items is required, elm_list_clear()
* should be used instead of getting items list and deleting each one.
*
2012-03-14 02:56:20 -07:00
* @see elm_list_clear()
* @see elm_list_item_append()
* @see elm_widget_item_del_cb_set()
* @deprecated Use elm_object_item_del() instead
*
*/
2012-03-14 02:56:20 -07:00
EINA_DEPRECATED EAPI void elm_list_item_del(Elm_Object_Item *it);
/**
2012-03-14 02:56:20 -07:00
* Convert a pixel coordinate (x,y) into a geographic coordinate
* (longitude, latitude).
*
2012-03-14 02:56:20 -07:00
* @param obj The map object.
* @param x the coordinate.
* @param y the coordinate.
* @param size the size in pixels of the map.
* The map is a square and generally his size is : pow(2.0, zoom)*256.
* @param lon Pointer to store the longitude that correspond to x.
* @param lat Pointer to store the latitude that correspond to y.
*
2012-03-14 02:56:20 -07:00
* @note Origin pixel point is the top left corner of the viewport.
* Map zoom and size are taken on account.
*
2012-03-14 02:56:20 -07:00
* @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
*
2012-03-14 02:56:20 -07:00
* @deprecated Use elm_map_canvas_to_geo_convert() instead
*/
2012-03-14 02:56:20 -07:00
EINA_DEPRECATED EAPI void elm_map_utils_convert_coord_into_geo(const Evas_Object *obj, int x, int y, int size, double *lon, double *lat);
/**
2012-03-14 02:56:20 -07:00
* Convert a geographic coordinate (longitude, latitude) into a pixel
* coordinate (x, y).
*
2012-03-14 02:56:20 -07:00
* @param obj The map object.
* @param lon the longitude.
* @param lat the latitude.
* @param size the size in pixels of the map. The map is a square
* and generally his size is : pow(2.0, zoom)*256.
* @param x Pointer to store the horizontal pixel coordinate that
* correspond to the longitude.
* @param y Pointer to store the vertical pixel coordinate that
* correspond to the latitude.
*
2012-03-14 02:56:20 -07:00
* @note Origin pixel point is the top left corner of the viewport.
* Map zoom and size are taken on account.
*
2012-03-14 02:56:20 -07:00
* @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
*
2012-03-14 02:56:20 -07:00
* @deprecatedUse Use elm_map_canvas_to_geo_convert() instead
*/
2012-03-14 02:56:20 -07:00
EINA_DEPRECATED EAPI void elm_map_utils_convert_geo_into_coord(const Evas_Object *obj, double lon, double lat, int size, int *x, int *y);
/**
2012-03-14 02:56:20 -07:00
* Get the information of downloading status.
*
2012-03-14 02:56:20 -07:00
* @param obj The map object.
* @param try_num Pointer to store number of tiles being downloaded.
* @param finish_num Pointer to store number of tiles successfully
* downloaded.
*
2012-03-14 02:56:20 -07:00
* This gets the current downloading status for the map object, the number
* of tiles being downloaded and the number of tiles already downloaded.
*
2012-03-14 02:56:20 -07:00
* @deprecatedUse Use elm_map_tile_load_status_get() instead
*/
2012-03-14 02:56:20 -07:00
EINA_DEPRECATED EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num);
/**
2012-03-14 02:56:20 -07:00
* Convert a geographic coordinate (longitude, latitude) into a name
* (address).
*
* @param obj The map object.
* @param lon the longitude.
* @param lat the latitude.
* @return name A #Elm_Map_Name handle for this coordinate.
*
2012-03-14 02:56:20 -07:00
* To get the string for this address, elm_map_name_address_get()
* should be used.
*
2012-03-14 02:56:20 -07:00
* @see elm_map_utils_convert_name_into_coord() if you need the inverse.
* @deprecatedUse Use elm_map_name_add() instead
*
*/
2012-03-14 02:56:20 -07:00
EINA_DEPRECATED EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat);
/**
2012-03-14 02:56:20 -07:00
* Convert a name (address) into a geographic coordinate
* (longitude, latitude).
*
* @param obj The map object.
* @param address The address.
* @return name A #Elm_Map_Name handle for this address.
*
2012-03-14 02:56:20 -07:00
* To get the longitude and latitude, elm_map_name_region_get()
* should be used.
*
2012-03-14 02:56:20 -07:00
* @see elm_map_utils_convert_coord_into_name() if you need the inverse.
* @deprecatedUse Use elm_map_name_geo_request() instead
*
*/
2012-03-14 02:56:20 -07:00
EINA_DEPRECATED EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address);
/**
2012-03-14 02:56:20 -07:00
* Add a new marker to the map object.
*
2012-03-14 02:56:20 -07:00
* @param obj The map object.
* @param lon The longitude of the marker.
* @param lat The latitude of the marker.
* @param clas The class, to use when marker @b isn't grouped to others.
* @param clas_group The class group, to use when marker is grouped to others
* @param data The data passed to the callbacks.
*
* @return The created marker or @c NULL upon failure.
*
2012-03-14 02:56:20 -07:00
* A marker will be created and shown in a specific point of the map, defined
* by @p lon and @p lat.
*
2012-03-14 02:56:20 -07:00
* It will be displayed using style defined by @p class when this marker
* is displayed alone (not grouped). A new class can be created with
* elm_map_marker_class_new().
*
2012-03-14 02:56:20 -07:00
* If the marker is grouped to other markers, it will be displayed with
* style defined by @p class_group. Markers with the same group are grouped
* if they are close. A new group class can be created with
* elm_map_marker_group_class_new().
*
2012-03-14 02:56:20 -07:00
* Markers created with this method can be deleted with
* elm_map_marker_remove().
*
* A marker can have associated content to be displayed by a bubble,
* when a user click over it, as well as an icon. These objects will
* be fetch using class' callback functions.
*
2012-03-14 02:56:20 -07:00
* @see elm_map_marker_class_new()
* @see elm_map_marker_group_class_new()
* @see elm_map_marker_remove()
*
2012-03-14 02:56:20 -07:00
* @deprecated Use Elm_Map_Overlay instead
*/
2012-03-14 02:56:20 -07:00
EINA_DEPRECATED EAPI Elm_Map_Marker *elm_map_marker_add(Evas_Object *obj, double lon, double lat, Elm_Map_Marker_Class *clas, Elm_Map_Group_Class *clas_group, void *data);
/**
2012-03-14 02:56:20 -07:00
* Remove a marker from the map.
*
2012-03-14 02:56:20 -07:00
* @param marker The marker to remove.
*
2012-03-14 02:56:20 -07:00
* @see elm_map_marker_add()
*
2012-03-14 02:56:20 -07:00
* @deprecated Use Elm_Map_Overlay instead
*/
2012-03-14 02:56:20 -07:00
EINA_DEPRECATED EAPI void elm_map_marker_remove(Elm_Map_Marker *marker);
/**
2012-03-14 02:56:20 -07:00
* Get the current coordinates of the marker.
*
* @param marker marker.
* @param lat Pointer to store the marker's latitude.
* @param lon Pointer to store the marker's longitude.
*
2012-03-14 02:56:20 -07:00
* These values are set when adding markers, with function
* elm_map_marker_add().
*
2012-03-14 02:56:20 -07:00
* @see elm_map_marker_add()
*
2012-03-14 02:56:20 -07:00
* @deprecated Use Elm_Map_Overlay instead
*/
2012-03-14 02:56:20 -07:00
EINA_DEPRECATED EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat);
/**
2012-03-14 02:56:20 -07:00
* Animatedly bring in given marker to the center of the map.
*
2012-03-14 02:56:20 -07:00
* @param marker The marker to center at.
*
2012-03-14 02:56:20 -07:00
* This causes map to jump to the given @p marker's coordinates
* and show it (by scrolling) in the center of the viewport, if it is not
* already centered. This will use animation to do so and take a period
* of time to complete.
*
2012-03-14 02:56:20 -07:00
* @see elm_map_marker_show() for a function to avoid animation.
* @see elm_map_marker_region_get()
*
2012-03-14 02:56:20 -07:00
* @deprecated Use Elm_Map_Overlay instead
*/
2012-03-14 02:56:20 -07:00
EINA_DEPRECATED EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker);
/**
2012-03-14 02:56:20 -07:00
* Show the given marker at the center of the map, @b immediately.
*
2012-03-14 02:56:20 -07:00
* @param marker The marker to center at.
*
2012-03-14 02:56:20 -07:00
* This causes map to @b redraw its viewport's contents to the
* region containing the given @p marker's coordinates, that will be
* moved to the center of the map.
*
2012-03-14 02:56:20 -07:00
* @see elm_map_marker_bring_in() for a function to move with animation.
* @see elm_map_markers_list_show() if more than one marker need to be
* displayed.
* @see elm_map_marker_region_get()
*
2012-03-14 02:56:20 -07:00
* @deprecated Use Elm_Map_Overlay instead
*/
2012-03-14 02:56:20 -07:00
EINA_DEPRECATED EAPI void elm_map_marker_show(Elm_Map_Marker *marker);
/**
2012-03-14 02:56:20 -07:00
* Move and zoom the map to display a list of markers.
*
2012-03-14 02:56:20 -07:00
* @param markers A list of #Elm_Map_Marker handles.
*
2012-03-14 02:56:20 -07:00
* The map will be centered on the center point of the markers in the list.
* Then the map will be zoomed in order to fit the markers using the maximum
* zoom which allows display of all the markers.
*
2012-03-14 02:56:20 -07:00
* @warning All the markers should belong to the same map object.
*
2012-03-14 02:56:20 -07:00
* @see elm_map_marker_show() to show a single marker.
* @see elm_map_marker_bring_in()
*
2012-03-14 02:56:20 -07:00
* @deprecated Use Elm_Map_Overlay instead
*/
2012-03-14 02:56:20 -07:00
EINA_DEPRECATED EAPI void elm_map_markers_list_show(Eina_List *markers);
/**
2012-03-14 02:56:20 -07:00
* Get the Evas object returned by the Elm_Map_Marker_Get_Func callback
*
2012-03-14 02:56:20 -07:00
* @param marker The marker which content should be returned.
* @return Return the evas object if it exists, else @c NULL.
*
* To set callback function #Elm_Map_Marker_Get_Func for the marker class,
* elm_map_marker_class_get_cb_set() should be used.
*
* This content is what will be inside the bubble that will be displayed
* when an user clicks over the marker.
*
2012-03-14 02:56:20 -07:00
* This returns the actual Evas object used to be placed inside
* the bubble. This may be @c NULL, as it may
* not have been created or may have been deleted, at any time, by
* the map. <b>Do not modify this object</b> (move, resize,
* show, hide, etc.), as the map is controlling it. This
* function is for querying, emitting custom signals or hooking
* lower level callbacks for events on that object. Do not delete
* this object under any circumstances.
*
2012-03-14 02:56:20 -07:00
* @deprecated Use Elm_Map_Overlay instead
*/
2012-03-14 02:56:20 -07:00
EINA_DEPRECATED EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker);
/**
2012-03-14 02:56:20 -07:00
* Update the marker
*
2012-03-14 02:56:20 -07:00
* @param marker The marker to be updated.
*
2012-03-14 02:56:20 -07:00
* If a content is set to this marker, it will call function to delete it,
* #Elm_Map_Marker_Del_Func, and then will fetch the content again with
* #Elm_Map_Marker_Get_Func.
*
2012-03-14 02:56:20 -07:00
* These functions are set for the marker class with
* elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
*
2012-03-14 02:56:20 -07:00
* @deprecated Use Elm_Map_Overlay instead
*/
2012-03-14 02:56:20 -07:00
EINA_DEPRECATED EAPI void elm_map_marker_update(Elm_Map_Marker *marker);
/**
2012-03-14 02:56:20 -07:00
* Create a new group class.
*
2012-03-14 02:56:20 -07:00
* @param obj The map object.
* @return Returns the new group class.
*
2012-03-14 02:56:20 -07:00
* Each marker must be associated to a group class. Markers in the same
* group are grouped if they are close.
*
2012-03-14 02:56:20 -07:00
* The group class defines the style of the marker when a marker is grouped
* to others markers. When it is alone, another class will be used.
*
2012-03-14 02:56:20 -07:00
* A group class will need to be provided when creating a marker with
* elm_map_marker_add().
*
2012-03-14 02:56:20 -07:00
* Some properties and functions can be set by class, as:
* - style, with elm_map_group_class_style_set()
* - data - to be associated to the group class. It can be set using
* elm_map_group_class_data_set().
* - min zoom to display markers, set with
* elm_map_group_class_zoom_displayed_set().
* - max zoom to group markers, set using
* elm_map_group_class_zoom_grouped_set().
* - visibility - set if markers will be visible or not, set with
* elm_map_group_class_hide_set().
* - #Elm_Map_Group_Icon_Get_Func - used to fetch icon for markers group classes.
* It can be set using elm_map_group_class_icon_cb_set().
*
2012-03-14 02:56:20 -07:00
* @see elm_map_marker_add()
* @see elm_map_group_class_style_set()
* @see elm_map_group_class_data_set()
* @see elm_map_group_class_zoom_displayed_set()
* @see elm_map_group_class_zoom_grouped_set()
* @see elm_map_group_class_hide_set()
* @see elm_map_group_class_icon_cb_set()
*
2012-03-14 02:56:20 -07:00
* @deprecated Use Elm_Map_Overlay instead
*/
2012-03-14 02:56:20 -07:00
EINA_DEPRECATED EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj);
/**
2012-03-14 02:56:20 -07:00
* Create a new marker class.
*
2012-03-14 02:56:20 -07:00
* @param obj The map object.
* @return Returns the new group class.
*
2012-03-14 02:56:20 -07:00
* Each marker must be associated to a class.
*
2012-03-14 02:56:20 -07:00
* The marker class defines the style of the marker when a marker is
* displayed alone, i.e., not grouped to to others markers. When grouped
* it will use group class style.
*
2012-03-14 02:56:20 -07:00
* A marker class will need to be provided when creating a marker with
* elm_map_marker_add().
*
2012-03-14 02:56:20 -07:00
* Some properties and functions can be set by class, as:
* - style, with elm_map_marker_class_style_set()
* - #Elm_Map_Marker_Icon_Get_Func - used to fetch icon for markers classes.
* It can be set using elm_map_marker_class_icon_cb_set().
* - #Elm_Map_Marker_Get_Func - used to fetch bubble content for marker classes.
* Set using elm_map_marker_class_get_cb_set().
* - #Elm_Map_Marker_Del_Func - used to delete bubble content for marker classes.
* Set using elm_map_marker_class_del_cb_set().
*
2012-03-14 02:56:20 -07:00
* @see elm_map_marker_add()
* @see elm_map_marker_class_style_set()
* @see elm_map_marker_class_icon_cb_set()
* @see elm_map_marker_class_get_cb_set()
* @see elm_map_marker_class_del_cb_set()
*
2012-03-14 02:56:20 -07:00
* @deprecated Use Elm_Map_Overlay instead
*/
2012-03-14 02:56:20 -07:00
EINA_DEPRECATED EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj);
/**
2012-03-14 02:56:20 -07:00
* Remove a route from the map.
*
2012-03-14 02:56:20 -07:00
* @param route The route to remove.
*
2012-03-14 02:56:20 -07:00
* @see elm_map_route_add()
* @deprecated Use elm_map_route_del() instead
*
*/
2012-03-14 02:56:20 -07:00
EINA_DEPRECATED EAPI void elm_map_route_remove(Elm_Map_Route *route);
2012-03-14 02:56:20 -07:00
/*
* Add a new pager to the parent
*
2012-03-14 02:56:20 -07:00
* @param parent The parent object
* @return The new object or NULL if it cannot be created
*
2012-03-14 02:56:20 -07:00
* @deprecated Use naviframe instead
*/
2012-03-14 02:56:20 -07:00
EINA_DEPRECATED EAPI Evas_Object *elm_pager_add(Evas_Object *parent);
/**
2012-03-14 02:56:20 -07:00
* @brief Push an object to the top of the pager stack (and show it).
*
2012-03-14 02:56:20 -07:00
* @param obj The pager object
* @param content The object to push
*
2012-03-14 02:56:20 -07:00
* The object pushed becomes a child of the pager, it will be controlled and
* deleted when the pager is deleted.
*
2012-03-14 02:56:20 -07:00
* @note If the content is already in the stack use
* elm_pager_content_promote().
* @warning Using this function on @p content already in the stack results in
* undefined behavior.
* @deprecated Use naviframe instead
*/
2012-03-14 02:56:20 -07:00
EINA_DEPRECATED EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content);
/**
2012-03-14 02:56:20 -07:00
* @brief Pop the object that is on top of the stack
*
2012-03-14 02:56:20 -07:00
* @param obj The pager object
*
2012-03-14 02:56:20 -07:00
* This pops the object that is on the top(visible) of the pager, makes it
* disappear, then deletes the object. The object that was underneath it on
* the stack will become visible.
* @deprecated Use naviframe instead
*/
2012-03-14 02:56:20 -07:00
EINA_DEPRECATED EAPI void elm_pager_content_pop(Evas_Object *obj);
/**
2012-03-14 02:56:20 -07:00
* @brief Moves an object already in the pager stack to the top of the stack.
*
* @param obj The pager object
* @param content The object to promote
*
* This will take the @p content and move it to the top of the stack as
* if it had been pushed there.
*
2012-03-14 02:56:20 -07:00
* @note If the content isn't already in the stack use
* elm_pager_content_push().
* @warning Using this function on @p content not already in the stack
* results in undefined behavior.
* @deprecated Use naviframe instead
*/
2012-03-14 02:56:20 -07:00
EINA_DEPRECATED EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content);
/**
2012-03-14 02:56:20 -07:00
* @brief Return the object at the bottom of the pager stack
*
2012-03-14 02:56:20 -07:00
* @param obj The pager object
* @return The bottom object or NULL if none
* @deprecated Use naviframe instead
*/
2012-03-14 02:56:20 -07:00
EINA_DEPRECATED EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj);
/**
2012-03-14 02:56:20 -07:00
* @brief Return the object at the top of the pager stack
*
2012-03-14 02:56:20 -07:00
* @param obj The pager object
* @return The top object or NULL if none
* @deprecated Use naviframe instead
*/
2012-03-14 02:56:20 -07:00
EINA_DEPRECATED EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj);
/**
2012-03-14 02:56:20 -07:00
* @brief Set the default item style.
*
2012-03-14 02:56:20 -07:00
* Default item style will be used with items who's style is NULL
*
2012-03-14 02:56:20 -07:00
* @param obj The pager object
* @param style The style
* @deprecated Use naviframe instead
*/
2012-03-14 02:56:20 -07:00
EINA_DEPRECATED EAPI void elm_pager_item_style_default_set(Evas_Object *obj, const char *style);
/**
2012-03-14 02:56:20 -07:00
* @brief Get the default item style
*
2012-03-14 02:56:20 -07:00
* @param obj The pager object
* @return the default item style
*
2012-03-14 02:56:20 -07:00
* @see elm_pager_item_style_default_set()
* @deprecated Use naviframe instead
*/
2012-03-14 02:56:20 -07:00
EINA_DEPRECATED EAPI const char *elm_pager_item_style_default_get(const Evas_Object *obj);
/**
* Set the always select mode.
*
* @param obj The genlist object
* @param always_select The always select mode (@c EINA_TRUE = on, @c
* EINA_FALSE = off). Default is @c EINA_FALSE.
*
* Items will only call their selection func and callback when first
* becoming selected. Any further clicks will do nothing, unless you
* enable always select with elm_genlist_always_select_mode_set().
* This means that, even if selected, every click will make the selected
* callbacks be called.
*
* @deprecated use elm_genlist_select_mode_set(obj, ELM_OBJECT_SELECT_MODE_ALWAYS); instead. use elm_genlist_select_mode_set(obj, ELM_OBJECT_SELECT_MODE_DEFAULT); for normal mode.
*
*/
EINA_DEPRECATED EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select);
/**
* Get the always select mode.
*
* @param obj The genlist object
* @return The always select mode
* (@c EINA_TRUE = on, @c EINA_FALSE = off)
*
* @deprecated use elm_genlist_select_mode_get instead.
*
*/
EINA_DEPRECATED EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj);
/**
* Enable/disable the no select mode.
*
* @param obj The genlist object
* @param no_select The no select mode
* (EINA_TRUE = on, EINA_FALSE = off)
*
* This will turn off the ability to select items entirely and they
* will neither appear selected nor call selected callback functions.
*
* @deprecated use elm_genlist_select_mode_set(obj, ELM_OBJECT_SELECT_MODE_NONE); instead. use elm_genlist_select_mode_set(obj, ELM_OBJECT_SELECT_MODE_DEFAULT); for normal mode.
*
*/
EINA_DEPRECATED EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select);
/**
* Gets whether the no select mode is enabled.
*
* @param obj The genlist object
* @return The no select mode
* (@c EINA_TRUE = on, @c EINA_FALSE = off)
*
* @deprecated use elm_genlist_select_mode_get instead.
*
*/
EINA_DEPRECATED EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj);
/*
* Enable/disable compress mode.
*
* @param obj The genlist object
* @param compress The compress mode
* (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
*
* This will enable the compress mode where items are "compressed"
* horizontally to fit the genlist scrollable viewport width. This is
* special for genlist. Do not rely on
* elm_genlist_mode_set() being set to @c ELM_LIST_COMPRESS to
* work as genlist needs to handle it specially.
*
* @deprecated elm_genlist_mode_set(obj, ELM_LIST_COMPRESS)
*/
EINA_DEPRECATED EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress);
/**
* Sets the display only state of an item.
*
* @param it The item
* @param display_only @c EINA_TRUE if the item is display only, @c
* EINA_FALSE otherwise.
*
* A display only item cannot be selected or unselected. It is for
* display only and not selecting or otherwise clicking, dragging
* etc. by the user, thus finger size rules will not be applied to
* this item.
*
* It's good to set group index items to display only state.
*
* @see elm_genlist_item_display_only_get()
*
* @deprecated elm_genlist_item_display_only_set()
*/
EINA_DEPRECATED EAPI void elm_genlist_item_display_only_set(Elm_Object_Item *it, Eina_Bool display_only);
/**
* Get the display only state of an item
*
* @param it The item
* @return @c EINA_TRUE if the item is display only, @c
* EINA_FALSE otherwise.
*
* @see elm_genlist_item_display_only_set()
*
* @deprecated elm_genlist_item_display_only_get()
*/
EINA_DEPRECATED EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Object_Item *it);
/**
* Get whether the compress mode is enabled.
*
* @param obj The genlist object
* @return The compress mode
* (@c EINA_TRUE = on, @c EINA_FALSE = off)
*
* @deprecated elm_genlsit_mode_get()
*/
EINA_DEPRECATED EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj);
/**
* Enable/disable height-for-width mode.
*
* @param obj The genlist object
* @param height_for_width The height-for-width mode (@c EINA_TRUE = on,
* @c EINA_FALSE = off). Default is @c EINA_FALSE.
*
* With height-for-width mode the item width will be fixed (restricted
* to a minimum of) to the list width when calculating its size in
* order to allow the height to be calculated based on it. This allows,
* for instance, text block to wrap lines if the Edje part is
* configured with "text.min: 0 1".
*
* @note This mode will make list resize slower as it will have to
* recalculate every item height again whenever the list width
* changes!
*
* @note When height-for-width mode is enabled, it also enables
* compress mode (see elm_genlist_compress_mode_set()) and
* disables homogeneous (see elm_genlist_homogeneous_set()).
*
* @deprecated elm_genlist_mode_set(obj, ELM_LIST_COMPRESS)
*/
EINA_DEPRECATED EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width);
/**
* Get whether the height-for-width mode is enabled.
*
* @param obj The genlist object
* @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
* off)
*
* @deprecated elm_genlist_mode_set(obj, ELM_LIST_COMPRESS)
*/
EINA_DEPRECATED EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj);
/**
* Activate a genlist mode on an item
*
* @param it The genlist item
* @param mode_type Mode name
* @param mode_set Boolean to define set or unset mode.
*
* A genlist mode is a different way of selecting an item. Once a mode is
* activated on an item, any other selected item is immediately unselected.
* This feature provides an easy way of implementing a new kind of animation
* for selecting an item, without having to entirely rewrite the item style
* theme. However, the elm_genlist_selected_* API can't be used to get what
* item is activate for a mode.
*
* The current item style will still be used, but applying a genlist mode to
* an item will select it using a different kind of animation.
*
* The current active item for a mode can be found by
* elm_genlist_decorated_item_get().
*
* The characteristics of genlist mode are:
* - Only one mode can be active at any time, and for only one item.
* - Genlist handles deactivating other items when one item is activated.
* - A mode is defined in the genlist theme (edc), and more modes can easily
* be added.
* - A mode style and the genlist item style are different things. They
* can be combined to provide a default style to the item, with some kind
* of animation for that item when the mode is activated.
*
* When a mode is activated on an item, a new view for that item is created.
* The theme of this mode defines the animation that will be used to transit
* the item from the old view to the new view. This second (new) view will be
* active for that item while the mode is active on the item, and will be
* destroyed after the mode is totally deactivated from that item.
*
* @deprecated elm_genlist_item_decorate_mode_set()
*/
EINA_DEPRECATED EAPI void elm_genlist_item_mode_set(Elm_Object_Item *it, const char *mode_type, Eina_Bool mode_set);
/**
* Get the last (or current) genlist mode used.
*
* @param obj The genlist object
*
* This function just returns the name of the last used genlist mode. It will
* be the current mode if it's still active.
*
* @deprecated elm_genlist_item_decorate_mode_get()
*/
EINA_DEPRECATED EAPI const char *elm_genlist_mode_type_get(const Evas_Object *obj);
/**
* Get active genlist mode item
*
* @param obj The genlist object
* @return The active item for that current mode. Or @c NULL if no item is
* activated with any mode.
*
* This function returns the item that was activated with a mode, by the
* function elm_genlist_item_decorate_mode_set().
*
* @deprecated elm_genlist_decorated_item_get()
*/
EINA_DEPRECATED EAPI const Elm_Object_Item *elm_genlist_mode_item_get(const Evas_Object *obj);
/**
* Set Genlist edit mode
*
* This sets Genlist edit mode.
*
* @param obj The Genlist object
* @param The edit mode status
* (EINA_TRUE = edit mode, EINA_FALSE = normal mode
*
* @deprecated elm_genlist_decorate_mode_set
*/
EINA_DEPRECATED EAPI void elm_genlist_edit_mode_set(Evas_Object *obj, Eina_Bool edit_mode);
/**
* Get Genlist edit mode
*
* @param obj The genlist object
* @return The edit mode status
* (EINA_TRUE = edit mode, EINA_FALSE = normal mode
*
* @deprecated elm_genlist_decorate_mode_get()
*/
EINA_DEPRECATED EAPI Eina_Bool elm_genlist_edit_mode_get(const Evas_Object *obj);
/**
* @}
*/