* @return New object or @c NULL, if it cannot be created
*
* @ingroup Ctxpopup
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent);
/**
+ * @internal
+ *
* Add a new file selector button widget to the given parent
* Elementary (container) object
*
/**
+ * @internal
+ *
* Add a new file selector entry widget to the given parent
* Elementary (container) object
*
#include "elm_interface_fileselector.eo.legacy.h"
/**
+ * @internal
+ *
* Add a new file selector widget to the given parent Elementary
* (container) object
*
EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent);
/**
+ * @internal
+ *
* Enable/disable the file name entry box where the user can type
* in a name for a file, in a given file selector widget
*
EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save);
/**
+ * @internal
+ *
* Get whether the given file selector is in "saving dialog" mode
*
* @param obj The file selector object
EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj);
/**
+ * @internal
+ *
* Enable/disable folder-only view for a given file selector widget
*
* @param obj The file selector object
EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only);
/**
+ * @internal
+ *
* Get whether folder-only view is set for a given file selector
* widget
*
EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj);
/**
+ * @internal
+ *
* Enable/disable a tree view in the given file selector widget,
* <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
*
EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand);
/**
+ * @internal
+ *
* Get whether tree view is enabled for the given file selector
* widget
*
EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj);
/**
+ * @internal
+ *
* Set, programmatically, the @b directory that a given file
* selector widget will display contents from
*
EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path);
/**
+ * @internal
+ *
* Get the parent directory's path that a given file selector
* widget is displaying
*
EAPI const char *elm_fileselector_path_get(const Evas_Object *obj);
/**
+ * @internal
+ *
* Set the mode in which a given file selector widget will display
* (layout) file system entries in its view
*
EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode);
/**
+ * @internal
+ *
* Get the mode in which a given file selector widget is displaying
* (layouting) file system entries in its view
*
EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj);
/**
+ * @internal
+ *
* Enable or disable multi-selection in the file selector widget.
*
* @param obj The file selector object
EAPI void elm_fileselector_multi_select_set(Evas_Object *obj, Eina_Bool multi);
/**
+ * @internal
+ *
* Get if multi-selection in the file selector is enabled or disabled.
*
* @param obj The file selector object
EAPI Eina_Bool elm_fileselector_multi_select_get(const Evas_Object *obj);
/**
+ * @internal
+ *
* Set, programmatically, the currently selected file/directory in
* the given file selector widget
*
EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path);
/**
+ * @internal
+ *
* Get the currently selected item's (full) path, in the given file
* selector widget
*
EAPI const char *elm_fileselector_current_name_get(const Evas_Object *obj);
/**
+ * @internal
+ *
* Get a list of selected paths in the file selector.
*
* @param obj The file selector object
EAPI const Eina_List *elm_fileselector_selected_paths_get(const Evas_Object *obj);
/**
+ * @internal
+ *
* Append mime types filter into filter list
*
* @param obj The file selector object
EAPI Eina_Bool elm_fileselector_mime_types_filter_append(Evas_Object *obj, const char *mime_types, const char *filter_name);
/**
+ * @internal
+ *
* Append custom filter into filter list
*
* @param obj The file selector object
EAPI Eina_Bool elm_fileselector_custom_filter_append(Evas_Object *obj, Elm_Fileselector_Filter_Func func, void *data, const char *filter_name);
/**
+ * @internal
+ *
* Clear all filters registered
*
* @param obj The file selector object
EAPI void elm_fileselector_filters_clear(Evas_Object *obj);
/**
+ * @internal
+ *
* Enable or disable visibility of hidden files/directories
* in the file selector widget.
*
EAPI void elm_fileselector_hidden_visible_set(Evas_Object *obj, Eina_Bool visible);
/**
+ * @internal
+ *
* Get if hiden files/directories in the file selector widget are visible or not.
*
* @param obj The file selector object
EAPI Eina_Bool elm_fileselector_hidden_visible_get(const Evas_Object *obj);
/**
+ * @internal
+ *
* Set the size for the thumbnail of the file selector widget's view.
*
* @param obj The file selector object
EAPI void elm_fileselector_thumbnail_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h);
/**
+ * @internal
+ *
* Get the size for the thumbnail of a given file selector widget
*
* @param obj The file selector object.
EAPI void elm_fileselector_thumbnail_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h);
/**
+ * @internal
+ *
* Get the sort method of the file selector widget.
*
* @param obj The file selector object
EAPI Elm_Fileselector_Sort elm_fileselector_sort_method_get(const Evas_Object *obj);
/**
+ * @internal
+ *
* Set the sort method of the file selector widget.
*
* @param obj The file selector object
/**
+ * @MOBILE_ONLY
+ *
* @brief Add a new Hoversel object
*
* @param parent The parent object
* @return The new object or NULL if it cannot be created
*
* @ingroup Hoversel
+ *
+ * @if MOBILE @since_tizen 2.4
+ * @endif
*/
EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent);
/**
+ * @MOBILE_ONLY
+ *
* @brief Add a new multibuttonentry to the parent
*
* @param parent The parent object
*
*
* @ingroup Multibuttonentry
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @endif
*/
EAPI Evas_Object *elm_multibuttonentry_add(Evas_Object *parent);
* @return New object or @c NULL, if it cannot be created
*
* @ingroup Naviframe
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent);
* @return The new object or NULL if it cannot be created
*
* @ingroup Popup
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Evas_Object *elm_popup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
/**
+ * @internal
+ *
* @brief Register evas object as an accessible object.
* @since 1.8
*
EAPI Evas_Object *elm_access_object_register(Evas_Object *obj, Evas_Object *parent);
/**
+ * @internal
+ *
* @brief Unregister accessible object.
* @since 1.8
*
EAPI void elm_access_object_unregister(Evas_Object *obj);
/**
+ * @internal
+ *
* @brief Get an accessible object of the evas object.
* @since 1.8
*
EAPI Evas_Object *elm_access_object_get(const Evas_Object *obj);
/**
+ * @internal
+ *
* @brief Set text to give information for specific type.
* @since 1.8
*
EAPI void elm_access_info_set(Evas_Object *obj, int type, const char *text);
/**
+ * @internal
+ *
* @brief Set text to give information for specific type.
* @since 1.8
*
EAPI char *elm_access_info_get(const Evas_Object *obj, int type);
/**
+ * @internal
+ *
* @brief Set content callback to give information for specific type.
* @since 1.8
*
EAPI void elm_access_info_cb_set(Evas_Object *obj, int type, Elm_Access_Info_Cb func, const void *data);
/**
+ * @internal
+ *
* @brief Set activate callback to activate highlight object.
* @since 1.8
*
EAPI void elm_access_activate_cb_set(Evas_Object *obj, Elm_Access_Activate_Cb func, void *data);
/**
+ * @internal
+ *
* @brief Read out text information directly.
* @since 1.8
*
EAPI void elm_access_say(const char *text);
/**
+ * @internal
+ *
* @brief Give the highlight to the object directly.
* @since 1.8
*
EAPI void elm_access_highlight_set(Evas_Object* obj);
/**
+ * @internal
+ *
* @brief Do the accessibility action base on given object.
* @since 1.8
*
EAPI Eina_Bool elm_access_action(Evas_Object *obj, const Elm_Access_Action_Type type, Elm_Access_Action_Info *action_info);
/**
+ * @internal
+ *
* @brief Set a callback function to a given accessibility action type
* @since 1.8
*
EAPI void elm_access_action_cb_set(Evas_Object *obj, const Elm_Access_Action_Type type, const Elm_Access_Action_Cb cb, const void *data);
/**
+ * @internal
+ *
* @brief Set the next access object for highlight.
* @since 1.8
*
eo_prefix: elm_obj_actionslider;
methods {
@property indicator_pos {
- set {
+ set @internal {
[[Set actionslider indicator position.]]
}
- get {
+ get @internal {
[[Get actionslider indicator position.]]
}
values {
}
}
@property magnet_pos {
- set {
+ set @internal {
[[Set actionslider magnet position.
To make multiple positions magnets OR them together (e.g.
ELM_ACTIONSLIDER_LEFT | #ELM_ACTIONSLIDER_RIGHT)
]]
}
- get {
+ get @internal {
[[Get actionslider magnet position.]]
}
values {
}
}
@property enabled_pos {
- set {
+ set @internal {
[[Set actionslider enabled position. To set multiple positions as
enabled OR them together(e.g.
#ELM_ACTIONSLIDER_LEFT | #ELM_ACTIONSLIDER_RIGHT).
Note: All the positions are enabled by default.
]]
}
- get {
+ get @internal {
[[Get actionslider enabled position.]]
}
values {
}
}
@property selected_label {
- get {
+ get @internal {
[[Get actionslider selected label.]]
return: const(char)*;
}
/**
+ * @internal
+ *
* Add a new actionslider to the parent.
*
* @param parent The parent object
* @see elm_app_locale_dir_get()
*
* @ingroup App
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
*
* @ingroup App
* @since 1.8
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_app_name_set(const char *name);
/**
+ * @internal
+ *
* Set the path to the '.desktop' file to be associated
* with the elm application.
*
* elm_app_info_set().
*
* @ingroup App
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_app_compile_bin_dir_set(const char *dir);
* elm_app_info_set().
*
* @ingroup App
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_app_compile_lib_dir_set(const char *dir);
* elm_app_info_set().
*
* @ingroup App
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_app_compile_data_dir_set(const char *dir);
* elm_app_info_set().
*
* @ingroup App
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_app_compile_locale_set(const char *dir);
*
* @ingroup App
* @since 1.8
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI const char *elm_app_name_get(void);
/**
+ * @internal
+ *
* Get the path to the '.desktop' file, as set by
* elm_app_desktop_entry_set().
*
* @return The directory prefix the application is actually using.
*
* @ingroup App
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI const char *elm_app_prefix_dir_get(void);
* using.
*
* @ingroup App
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI const char *elm_app_bin_dir_get(void);
* using.
*
* @ingroup App
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI const char *elm_app_lib_dir_get(void);
* using.
*
* @ingroup App
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI const char *elm_app_data_dir_get(void);
* using.
*
* @ingroup App
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI const char *elm_app_locale_dir_get(void);
*
* @ingroup App
* @since 1.12
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_app_base_scale_set(double base_scale);
*
* @ingroup App
* @since 1.12
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI double elm_app_base_scale_get(void);
methods {
@property connected {
get {
- [[Indicate if connection with AT-SPI2 bus has been established.]]
+ [[Indicate if connection with AT-SPI2 bus has been established.
+
+ \@if MOBILE \@since_tizen 3.0
+ \@elseif WEARABLE \@since_tizen 3.0
+ \@endif
+ ]]
values {
ret: bool;
}
centered or stretched. @Elm.Bg.Option.scale by default.
See also @.option.get.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
See also @.option.set for more details
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
of the pixmap may differ depending on the type of image being
loaded, being bigger than requested.
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
* @return The new object or @c NULL if it cannot be created
*
* @ingroup Bg
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Evas_Object *elm_bg_add(Evas_Object *parent);
* @see elm_bg_color_get()
*
* @ingroup Bg
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b);
* @see elm_bg_color_get() for more details
*
* @ingroup Bg
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b);
*
* @param[in] file The file path
* @param[in] group Optional key (group in Edje) within the file
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Eina_Bool elm_bg_file_set(Eo *obj, const char *file, const char *group);
*
* @param[out] file The file path
* @param[out] group Optional key (group in Edje) within the file
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_bg_file_get(const Eo *obj, const char **file, const char **group);
Note: This flag is ignored if a custom layout function is set.
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
[[Get whether the box is using homogeneous mode or not ($true if
- it's homogeneous, $false otherwise)]]
+ it's homogeneous, $false otherwise)
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
homogeneous: bool; [[The homogeneous flag]]
their sizes and position has been calculated, will be aligned within
the space given for the whole box widget.
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
See also @.align.set.
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
Note: This flag is ignored if a custom layout function is set.
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
[[Get the horizontal orientation ($true if the box is set to
- horizontal mode, $false otherwise)]]
+ horizontal mode, $false otherwise)
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
horizontal: bool; [[The horizontal flag]]
is set for all elements in the box, besides any possible padding that
individual elements may have through their size hints.
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
See also @.padding.set.
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
See also \@ref elm_box_layout_transition.
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
You must free this list with eina_list_free() once you are done with it.
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
return: free(own(list<Evas.Object*>*), eina_list_free) @warn_unused;
}
@.unpack,
@.unpack_all,
@.clear.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
params {
See also @.clear,
@.unpack.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
unpack {
See also @.unpack_all,
@.clear.
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
params {
@.unpack_all,
@.clear.
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
params {
@.unpack_all,
@.clear.
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
params {
recalculation, whenever you need to get the position of a just
added item you must force recalculate before doing so.
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
@.unpack_all,
@.clear.
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
params {
See also @.unpack,
@.unpack_all.
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
* @see elm_box_transition_new
* @see elm_box_transition_free
* @see elm_box_layout_set
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
*
* @see elm_box_transition_new
* @see elm_box_layout_transition
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Elm_Box_Transition *elm_box_transition_new(const double duration, Evas_Object_Box_Layout start_layout, void *start_layout_data, Ecore_Cb start_layout_free_data, Evas_Object_Box_Layout end_layout, void *end_layout_data, Ecore_Cb end_layout_free_data, Ecore_Cb transition_end_cb, void *transition_end_data);
*
* @see elm_box_transition_new
* @see elm_box_layout_transition
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_box_transition_free(void *data);
* @return The new object or NULL if it cannot be created
*
* @ingroup Box
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Evas_Object *elm_box_add(Evas_Object *parent);
eo_prefix: elm_obj_bubble;
methods {
@property pos {
- set {
+ set @internal {
[[Set the corner of the bubble
This function sets the corner of the bubble. The corner will be used to
]]
}
- get {
+ get @internal {
[[Get the corner of the bubble
This function gets the selected corner of the bubble.
/**
+ * @internal
+ *
* Add a new bubble to the parent
*
* @param parent The parent object
See also @.autorepeat.set,
@.autorepeat_gap_timeout.set.
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
See also @.autorepeat_initial_timeout.set.
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
See also @.autorepeat_initial_timeout.set.
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
- [[Get the interval between each generated autorepeat event]]
+ [[Get the interval between each generated autorepeat event
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
t: double; [[Interval in seconds]]
@.autorepeat_initial_timeout.set, and the time between each
new emission by @.autorepeat_gap_timeout.set.
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
See also @.autorepeat.set.
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
* @return The new object or NULL if it cannot be created
*
* @ingroup Button
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Evas_Object *elm_button_add(Evas_Object *parent);
* @note Evas caches are flushed for every canvas associated with a window.
*
* @ingroup Caches
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_cache_all_flush(void);
methods {
@property first_day_of_week {
set {
- [[Set the first day of week to use on calendar widgets'.]]
+ [[\@MOBILE_ONLY
+
+ Set the first day of week to use on calendar widgets'.
+
+ \@if MOBILE \@since_tizen 2.4
+ \@endif
+ ]]
}
get {
- [[Get the first day of week, who are used on calendar widgets'.
+ [[\@MOBILE_ONLY
+
+ Get the first day of week, who are used on calendar widgets'.
See also @.first_day_of_week.set for more details.
+ \@if MOBILE \@since_tizen 2.4
+ \@endif
]]
}
values {
}
@property selectable {
set {
- [[Define which fields of a tm struct will be taken into account, when
+ [[\@MOBILE_ONLY
+
+ Define which fields of a tm struct will be taken into account, when
Elm.Calendar.selected_time.set is invoked.
By Default the bitmask is set to use all fields of a tm struct (year,
See also @.selected_time_set.
+ \@if MOBILE \@since_tizen 2.4
+ \@endif
+
@since 1.8
]]
}
get {
- [[Get how elm_calendar_selected_time_set manage a date
+ [[\@MOBILE_ONLY
+
+ Get how elm_calendar_selected_time_set manage a date
See also @.selectable.set,
@.selected_time_set.
+ \@if MOBILE \@since_tizen 2.4
+ \@endif
+
@since 1.8
]]
}
}
@property interval {
set {
- [[Set the interval on time updates for an user mouse button hold
+ [[\@MOBILE_ONLY
+
+ Set the interval on time updates for an user mouse button hold
on calendar widgets' month/year selection.
This interval value is decreased while the user holds the
0.85 seconds.
See also @.interval.get.
+
+ \@if MOBILE \@since_tizen 2.4
+ \@endif
]]
}
get {
- [[Get the interval on time updates for an user mouse button hold
+ [[\@MOBILE_ONLY
+
+ Get the interval on time updates for an user mouse button hold
on calendar widgets' month/year selection.
See also @.interval.set for more details.
+
+ \@if MOBILE \@since_tizen 2.4
+ \@endif
]]
}
values {
}
@property weekdays_names {
set {
- [[Set weekdays names to be displayed by the calendar.
+ [[\@MOBILE_ONLY
+
+ Set weekdays names to be displayed by the calendar.
By default, weekdays abbreviations get from system are displayed:
E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
See also @.weekdays_names.get.
\@ref calendar_example_02.
+
+ \@if MOBILE \@since_tizen 2.4
+ \@endif
]]
/* FIXME-doc
*
*/
}
get {
- [[Get weekdays names displayed by the calendar.
+ [[\@MOBILE_ONLY
+
+ Get weekdays names displayed by the calendar.
By default, weekdays abbreviations get from system are displayed:
E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
See also @.weekdays_names.set.
\@ref calendar_example_05.
+
+ \@if MOBILE \@since_tizen 2.4
+ \@endif
]]
}
values {
}
@property select_mode {
set {
- [[Set select day mode to use.
+ [[\@MOBILE_ONLY
+
+ Set select day mode to use.
Set the day selection mode used.
+
+ \@if MOBILE \@since_tizen 2.4
+ \@endif
]]
}
get {
- [[Get the select day mode used.
+ [[\@MOBILE_ONLY
+
+ Get the select day mode used.
Get the day selection mode used.
See also @.select_mode.set for more details.
+ \@if MOBILE \@since_tizen 2.4
+ \@endif
]]
}
values {
}
@property min_max_year {
set {
- [[Set the minimum and maximum values for the year
+ [[\@MOBILE_ONLY
+
+ Set the minimum and maximum values for the year
Maximum must be greater than minimum, except if you don't want to set
maximum year.
See also @.min_max_year.get.
\@ref calendar_example_03.
+
+ \@if MOBILE \@since_tizen 2.4
+ \@endif
]]
}
get {
- [[Get the minimum and maximum values for the year
+ [[\@MOBILE_ONLY
+
+ Get the minimum and maximum values for the year
Default values are 1902 and -1.
See also @.min_max_year.set for more details.
\@ref calendar_example_05.
+
+ \@if MOBILE \@since_tizen 2.4
+ \@endif
]]
}
values {
}
@property format_function {
set {
- [[Set a function to format the string that will be used to display
+ [[\@MOBILE_ONLY
+
+ Set a function to format the string that will be used to display
month and year;
By default it uses strftime with "%B %Y" format string.
A pointer to the string and a pointer to the time struct will be provided.
\@ref calendar_example_02.
+
+ \@if MOBILE \@since_tizen 2.4
+ \@endif
]]
/* FIXME-doc
* Example:
}
@property marks {
get {
- [[Get a list of all the calendar marks.
+ [[\@MOBILE_ONLY
+
+ Get a list of all the calendar marks.
See also @.mark_add,
\@ref elm_calendar_mark_del(),
@.marks_clear.
+ \@if MOBILE \@since_tizen 2.4
+ \@endif
]]
return: const(list<Elm.Calendar.Mark*>)*;
}
}
selected_time_set {
- [[Set selected date to be highlighted on calendar.
+ [[\@MOBILE_ONLY
+
+ Set selected date to be highlighted on calendar.
Set the selected date, changing the displayed month if needed.
Selected date changes when the user goes to next/previous month or
See also @.selected_time_get.
\@ref calendar_example_04
+
+ \@if MOBILE \@since_tizen 2.4
+ \@endif
]]
params {
@in selected_time: Elm_Calendar_Time *; [[A tm struct to represent the selected date.]]
}
}
selected_time_get @const {
- [[Get selected date.
+ [[\@MOBILE_ONLY
+
+ Get selected date.
Get date selected by the user or set by function
@.selected_time_set().
See also @.selected_time_get.
\@ref calendar_example_05.
+
+ \@if MOBILE \@since_tizen 2.4
+ \@endif
]]
return: bool;
params {
}
}
mark_add {
- [[Add a new mark to the calendar
+ [[\@MOBILE_ONLY
+
+ Add a new mark to the calendar
Add a mark that will be drawn in the calendar respecting the insertion
time and periodicity. It will emit the type as signal to the widget theme.
\@ref elm_calendar_mark_del().
\@ref calendar_example_06
+
+ \@if MOBILE \@since_tizen 2.4
+ \@endif
]]
/* FIXME-doc
* Example
}
}
marks_clear {
- [[Remove all calendar's marks
+ [[\@MOBILE_ONLY
+
+ Remove all calendar's marks
See also @.mark_add,
\@ref elm_calendar_mark_del().
+ \@if MOBILE \@since_tizen 2.4
+ \@endif
]]
}
marks_draw {
- [[Draw calendar marks.
+ [[\@MOBILE_ONLY
+
+ Draw calendar marks.
Should be used after adding, removing or clearing marks.
It will go through the entire marks list updating the calendar.
@.marks_clear.
\@ref calendar_example_06
+
+ \@if MOBILE \@since_tizen 2.4
+ \@endif
]]
}
displayed_time_get @const {
- [[Get the current time displayed in the widget
+ [[\@MOBILE_ONLY
+
+ Get the current time displayed in the widget
+
+ \@if MOBILE \@since_tizen 2.4
+ \@endif
@since 1.8
]]
typedef char * (*Elm_Calendar_Format_Cb)(struct tm *stime);
/**
+ * @MOBILE_ONLY
+ *
* Delete mark from the calendar.
*
* @param mark The mark to be deleted.
* @see elm_calendar_mark_add()
*
* @ref calendar_example_06
+ *
+ * @if MOBILE @since_tizen 2.4
+ * @endif
*/
EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark);
/**
+ * @MOBILE_ONLY
+ *
* Add a new calendar widget to the given parent Elementary
* (container) object.
*
* @ref calendar_example_01
*
* @ingroup Calendar
+ *
+ * @if MOBILE @since_tizen 2.4
+ * @endif
*/
EAPI Evas_Object *elm_calendar_add(Evas_Object *parent);
@.state_pointer.set, the state of that variable is also
changed. Calling this doesn't cause the "changed" signal to
be emitted.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
- [[Get the state of the check object]]
+ [[Get the state of the check object
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
state: bool; [[The state to use (1 == on, 0 == off)]]
If "statep" is not null, then when this is called, the check
objects state will also be modified to reflect the value of the
boolean "statep" points to, just like calling @.state.set.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
* @return The new object or NULL if it cannot be created
*
* @ingroup Check
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Evas_Object * elm_check_add(Evas_Object *parent);
eo_prefix: elm_obj_clock;
methods {
@property show_am_pm {
- set {
+ set @internal {
[[Set if the given clock widget must show hours in military or
am/pm mode
See also @.show_am_pm.get.
]]
}
- get {
+ get @internal {
[[Get if the given clock widget shows hours in military or am/pm
mode
}
}
@property first_interval {
- set {
+ set @internal {
[[Set the first interval on time updates for a user mouse button hold
on clock widgets' time edition.
See also @.first_interval.get.
]]
}
- get {
+ get @internal {
[[Get the first interval on time updates for a user mouse button hold
on clock widgets' time edition.
}
}
@property show_seconds {
- set {
+ set @internal {
[[Set if the given clock widget must show time with seconds or not
This function sets if the given clock must show or not elapsed
See also @.show_seconds.get.
]]
}
- get {
+ get @internal {
[[Get whether the given clock widget is showing time with seconds
or not
}
}
@property edit {
- set {
+ set @internal {
[[Set whether a given clock widget is under edition mode or
under (default) displaying-only mode.
See also @.edit.get.
]]
}
- get {
+ get @internal {
[[Get whether a given clock widget is under editing mode
or under (default) displaying-only mode.
}
}
@property pause {
- set {
+ set @internal {
[[Set whether the given clock widget should be paused or not.
This function pauses or starts the clock widget.
@since 1.9
]]
}
- get {
+ get @internal {
[[Get whether the given clock widget is paused.
This function gets whether the clock is paused or not.
}
}
@property time {
- set {
+ set @internal {
[[Set a clock widget's time, programmatically
This function updates the time that is showed by the clock
undefined.
]]
}
- get {
+ get @internal {
[[Get a clock widget's time values
This function gets the time set for $obj, returning
}
}
@property edit_mode {
- set {
+ set @internal {
[[Set what digits of the given clock widget should be editable
when in edition mode.
See also @.edit_mode.get.
]]
}
- get {
+ get @internal {
[[Get what digits of the given clock widget should be
editable when in edition mode.
/**
+ * @internal
+ *
* Add a new clock widget to the given parent Elementary
* (container) object
*
*
* @ingroup CopyPaste
*
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Eina_Bool elm_cnp_selection_set(Evas_Object *obj, Elm_Sel_Type selection,
Elm_Sel_Format format,
* @return If @c EINA_TRUE, getting selection data was successful.
*
* @ingroup CopyPaste
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Eina_Bool elm_cnp_selection_get(const Evas_Object *obj, Elm_Sel_Type selection,
Elm_Sel_Format format,
*
* @ingroup CopyPaste
*
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Eina_Bool elm_object_cnp_selection_clear(Evas_Object *obj,
Elm_Sel_Type selection);
* @ingroup CopyPaste
*
* @since 1.7
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_cnp_selection_loss_callback_set(Evas_Object *obj, Elm_Sel_Type selection, Elm_Selection_Loss_Cb func, const void *data);
* @ingroup CopyPaste
*
* @since 1.8
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Eina_Bool elm_drop_target_add(Evas_Object *obj, Elm_Sel_Format format,
Elm_Drag_State entercb, void *enterdata,
* @ingroup CopyPaste
*
* @since 1.8
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Eina_Bool elm_drop_target_del(Evas_Object *obj, Elm_Sel_Format format,
Elm_Drag_State entercb, void *enterdata,
* @ingroup CopyPaste
*
* @since 1.8
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Eina_Bool elm_drag_start(Evas_Object *obj, Elm_Sel_Format format,
const char *data, Elm_Xdnd_Action action,
* @ingroup CopyPaste
*
* @since 1.9
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Eina_Bool elm_drag_cancel(Evas_Object *obj);
* @ingroup CopyPaste
*
* @since 1.8
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Eina_Bool elm_drag_action_set(Evas_Object *obj, Elm_Xdnd_Action action);
* @ingroup CopyPaste
*
* @since 1.8
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Eina_Bool elm_drag_item_container_add(Evas_Object *obj, double tm_to_anim, double tm_to_drag, Elm_Xy_Item_Get_Cb itemgetcb, Elm_Item_Container_Data_Get_Cb data_get);
* @ingroup CopyPaste
*
* @since 1.8
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Eina_Bool elm_drag_item_container_del(Evas_Object *obj);
* @ingroup CopyPaste
*
* @since 1.8
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Eina_Bool elm_drop_item_container_add(Evas_Object *obj,
Elm_Sel_Format format,
* @ingroup CopyPaste
*
* @since 1.8
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Eina_Bool elm_drop_item_container_del(Evas_Object *obj);
typedef Eina_List *(*Elm_Color_Class_List_Cb)(void);
/**
+ * @internal
+ *
* @brief Create a new color class editor
* @param obj The parent object
*
EAPI Evas_Object *elm_color_class_editor_add(Evas_Object *obj);
/**
+ * @internal
+ *
* @brief Set a callback to provide translations for color class descriptions
* @param cb The callback to use
*
EAPI void elm_color_class_translate_cb_set(Elm_Color_Class_Name_Cb cb);
/**
+ * @internal
+ *
* @brief Set a callback to provide a list of supplementary color classes
* @param cb The callback to use
*
EAPI void elm_color_class_list_cb_set(Elm_Color_Class_List_Cb cb);
/**
+ * @internal
+ *
* @brief Create an allocated list of allocated Edje_Color_Class structs from an open edje file
* @param f The file to list color classes from
* @return The list of color classes present in the file
eo_prefix: elm_obj_color_item;
methods {
@property color {
- get {
+ get @internal {
[[Get Palette item's color.]]
}
- set {
+ set @internal {
[[Set Palette item's color.]]
}
values {
}
}
@property selected {
- get {
+ get @internal {
[[Get the selected state of color palette item
@since 1.9
]]
}
- set {
+ set @internal {
[[Set the selected state of color palette item
@since 1.9
methods {
@property color {
set {
- [[Set color to colorselector.]]
+ [[\@MOBILE_ONLY
+
+ Set color to colorselector.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
}
get {
- [[Get current color from colorselector.]]
+ [[\@MOBILE_ONLY
+
+ Get current color from colorselector.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
}
values {
r: int; [[r-value of color]]
}
@property palette_name {
set {
- [[Set current palette's name
+ [[\@MOBILE_ONLY
+
+ Set current palette's name
When colorpalette name is set, colors will be loaded from and saved to config
using the set name. If no name is set then colors will be loaded from or
saved to "default" config.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
]]
}
get {
- [[Get current palette's name
+ [[\@MOBILE_ONLY
+
+ Get current palette's name
Returns the currently set palette name using which colors will be
saved/loaded in to config.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
]]
}
values {
}
@property mode {
set {
- [[Set Colorselector's mode.
+ [[\@MOBILE_ONLY
+
+ Set Colorselector's mode.
Colorselector supports three modes palette only, selector only and both.
Only palette mode is supported in Tizen 3.0.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
]]
}
get {
- [[Get Colorselector's mode.]]
+ [[\@MOBILE_ONLY
+
+ Get Colorselector's mode.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
}
values {
mode: Elm.Colorselector.Mode; [[Elm_Colorselector_Mode]]
}
@property palette_items {
get {
- [[Get list of palette items.
+ [[\@MOBILE_ONLY
+
+ Get list of palette items.
Note That palette item list is internally managed by colorselector widget and
it should not be freed/modified by application.
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+
@since 1.9
]]
return: const(list<Elm.Object.Item*>)*;[[The list of color palette items.]]
}
}
@property palette_selected_item {
- get {
+ get @internal {
[[Get the selected item in colorselector palette.
@since 1.9]]
}
}
palette_color_add {
- [[Add a new color item to palette.]]
+ [[\@MOBILE_ONLY
+
+ Add a new color item to palette.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
return: Elm.Widget_Item *;[[A new color palette Item.]]
params {
}
}
palette_clear {
- [[Clear the palette items.]]
+ [[\@MOBILE_ONLY
+
+ Clear the palette items.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
}
}
implements {
/**
+ * @MOBILE_ONLY
+ *
* @brief Add a new colorselector to the parent
*
* @param parent The parent object
* @return The new object or NULL if it cannot be created
*
* @ingroup Colorselector
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @endif
*/
EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent);
*/
/**
+ * @internal
+ *
* Save back Elementary's configuration, so that it will persist on
* future sessions.
*
* a profile. If one removes user custom configuration directories,
* for example, it will force a reload with system values instead.
*
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_config_reload(void);
* using elementary on the current display.
*
* @ingroup Config
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_config_all_flush(void);
*
* @return The profile's name
* @ingroup Profile
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI const char *elm_config_profile_get(void);
* @ingroup Profile
*
* @note You must free it with elm_config_profile_dir_free().
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI const char *elm_config_profile_dir_get(const char *profile, Eina_Bool is_user);
* @param p_dir The profile's path
* @ingroup Profile
*
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_config_profile_dir_free(const char *p_dir);
*
* @note One must free this list, after usage, with the function
* elm_config_profile_list_free().
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Eina_List *elm_config_profile_list_get(void);
* @param l The profiles list, as returned by elm_config_profile_list_get().
* @ingroup Profile
*
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_config_profile_list_free(Eina_List *l);
* @param profile The profile's name
* @ingroup Profile
*
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_config_profile_set(const char *profile);
*
* This is the default behavior for touch screens, in general.
* @ingroup Scrolling
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Eina_Bool elm_config_scroll_bounce_enabled_get(void);
*
* @see elm_config_scroll_bounce_enabled_get()
* @ingroup Scrolling
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_config_scroll_bounce_enabled_set(Eina_Bool enabled);
* @return the thumb scroll bounce friction
*
* @ingroup Scrolling
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI double elm_config_scroll_bounce_friction_get(void);
*
* @see elm_config_scroll_bounce_friction_get()
* @ingroup Scrolling
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_config_scroll_bounce_friction_set(double friction);
* @return the page scroll friction
*
* @ingroup Scrolling
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI double elm_config_scroll_page_scroll_friction_get(void);
*
* @see elm_config_scroll_page_scroll_friction_get()
* @ingroup Scrolling
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_config_scroll_page_scroll_friction_set(double friction);
* @return the bring in scroll friction
*
* @ingroup Scrolling
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI double elm_config_scroll_bring_in_scroll_friction_get(void);
*
* @see elm_config_scroll_bring_in_scroll_friction_get()
* @ingroup Scrolling
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_config_scroll_bring_in_scroll_friction_set(double friction);
* @return the zoom friction
*
* @ingroup Scrolling
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI double elm_config_scroll_zoom_friction_get(void);
*
* @see elm_config_scroll_zoom_friction_get()
* @ingroup Scrolling
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_config_scroll_zoom_friction_set(double friction);
* have effect if this mode is enabled.
*
* @ingroup Scrolling
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Eina_Bool elm_config_scroll_thumbscroll_enabled_get(void);
*
* @see elm_config_scroll_thumbscroll_enabled_get()
* @ingroup Scrolling
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_config_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
* One would use higher values for touch screens, in general, because
* of their inherent imprecision.
* @ingroup Scrolling
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI unsigned int elm_config_scroll_thumbscroll_threshold_get(void);
*
* @see elm_config_thumbscroll_threshold_get()
* @ingroup Scrolling
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_config_scroll_thumbscroll_threshold_set(unsigned int threshold);
* @return the thumb scroll hold threshold
*
* @ingroup Scrolling
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI unsigned int elm_config_scroll_thumbscroll_hold_threshold_get(void);
*
* @see elm_config_thumbscroll_hold_threshold_get()
* @ingroup Scrolling
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_config_scroll_thumbscroll_hold_threshold_set(unsigned int threshold);
* @return the thumb scroll momentum threshold
*
* @ingroup Scrolling
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI double elm_config_scroll_thumbscroll_momentum_threshold_get(void);
*
* @see elm_config_thumbscroll_momentum_threshold_get()
* @ingroup Scrolling
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_config_scroll_thumbscroll_momentum_threshold_set(double threshold);
* @return the thumb scroll maximum flick distance
*
* @ingroup Scrolling
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI unsigned int elm_config_scroll_thumbscroll_flick_distance_tolerance_get(void);
*
* @see elm_config_thumbscroll_flick_distance_tolerance_get()
* @ingroup Scrolling
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_config_scroll_thumbscroll_flick_distance_tolerance_set(unsigned int distance);
* @return the thumb scroll friction
*
* @ingroup Scrolling
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI double elm_config_scroll_thumbscroll_friction_get(void);
*
* @see elm_config_thumbscroll_friction_get()
* @ingroup Scrolling
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_config_scroll_thumbscroll_friction_set(double friction);
* @return the thumb scroll min friction
*
* @ingroup Scrolling
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI double elm_config_scroll_thumbscroll_min_friction_get(void);
*
* @see elm_config_thumbscroll_min_friction_get()
* @ingroup Scrolling
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_config_scroll_thumbscroll_min_friction_set(double friction);
* @return the thumb scroll friction
*
* @ingroup Scrolling
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI double elm_config_scroll_thumbscroll_friction_standard_get(void);
*
* @see elm_config_thumbscroll_friction_standard_get()
* @ingroup Scrolling
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_config_scroll_thumbscroll_friction_standard_set(double standard);
* @return the thumb scroll border friction
*
* @ingroup Scrolling
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI double elm_config_scroll_thumbscroll_border_friction_get(void);
* @note parameter value will get bound to 0.0 - 1.0 interval, always
*
* @ingroup Scrolling
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_config_scroll_thumbscroll_border_friction_set(double friction);
* @return the thumb scroll sensitivity friction
*
* @ingroup Scrolling
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI double elm_config_scroll_thumbscroll_sensitivity_friction_get(void);
* @note parameter value will get bound to 0.1 - 1.0 interval, always
*
* @ingroup Scrolling
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_config_scroll_thumbscroll_sensitivity_friction_set(double friction);
*
* @since 1.16
* @ingroup Scrolling
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI Eina_Bool elm_config_scroll_thumbscroll_smooth_start_get(void);
*
* @since 1.16
* @ingroup Scrolling
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI void elm_config_scroll_thumbscroll_smooth_start_set(Eina_Bool enable);
*
* @since 1.16
* @ingroup Scrolling
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI double elm_config_scroll_thumbscroll_smooth_amount_get(void);
*
* @since 1.16
* @ingroup Scrolling
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI void elm_config_scroll_thumbscroll_smooth_amount_set(double amount);
*
* @since 1.16
* @ingroup Scrolling
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI double elm_config_scroll_thumbscroll_smooth_time_window_get(void);
*
* @since 1.16
* @ingroup Scrolling
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI void elm_config_scroll_thumbscroll_smooth_time_window_set(double amount);
* @return the thumb scroll acceleration threshold
*
* @ingroup Scrolling
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI double elm_config_scroll_thumbscroll_acceleration_threshold_get(void);
*
* @see elm_config_thumbscroll_acceleration_threshold_get()
* @ingroup Scrolling
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_config_scroll_thumbscroll_acceleration_threshold_set(double threshold);
* @return the thumb scroll acceleration time limit
*
* @ingroup Scrolling
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI double elm_config_scroll_thumbscroll_acceleration_time_limit_get(void);
*
* @see elm_config_thumbscroll_acceleration_time_limit_get()
* @ingroup Scrolling
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_config_scroll_thumbscroll_acceleration_time_limit_set(double time_limit);
* @return the thumb scroll acceleration weight
*
* @ingroup Scrolling
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI double elm_config_scroll_thumbscroll_acceleration_weight_get(void);
*
* @see elm_config_thumbscroll_acceleration_weight_get()
* @ingroup Scrolling
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_config_scroll_thumbscroll_acceleration_weight_set(double weight);
* @param[in] enable The scroll item align state
*
* @see elm_config_scroll_item_align_enabled_get()
+ *
+ * @if MOBILE @since_tizen 2.4
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_config_scroll_item_align_enabled_set(Eina_Bool enable);
* @return The scroll item align state.
*
* @see elm_config_scroll_item_align_enabled_set()
+ *
+ * @if MOBILE @since_tizen 2.4
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Eina_Bool elm_config_scroll_item_align_enabled_get(void);
* @param[in] scroll_item_valign The position name.
*
* @see elm_config_scroll_item_valign_get()
+ *
+ * @if MOBILE @since_tizen 2.4
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_config_scroll_item_valign_set(const char *scroll_item_valign);
* @return The scroll item vertical align name.
*
* @see elm_config_scroll_item_valign_set()
+ *
+ * @if MOBILE @since_tizen 2.4
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI const char *elm_config_scroll_item_valign_get(void);
//
* @see elm_config_focus_autoscroll_mode_set()
* @ingroup Focus
* @since 1.10
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI Elm_Focus_Autoscroll_Mode elm_config_focus_autoscroll_mode_get(void);
* @see elm_config_focus_autoscroll_mode_get()
* @ingroup Focus
* @since 1.10
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI void elm_config_focus_autoscroll_mode_set(Elm_Focus_Autoscroll_Mode mode);
*
* @ingroup Slider
* @since 1.13
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI void elm_config_slider_indicator_visible_mode_set(Elm_Slider_Indicator_Visible_Mode mode);
*
* @ingroup Slider
* @since 1.13
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI Elm_Slider_Indicator_Visible_Mode elm_config_slider_indicator_visible_mode_get(void);
*
* @return Timeout for long press event
* @ingroup Longpress
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI double elm_config_longpress_timeout_get(void);
*
* @param lonpress_timeout Timeout for long press event
* @ingroup Longpress
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_config_longpress_timeout_set(double longpress_timeout);
*
* @see elm_config_softcursor_mode_get()
* @since 1.7
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_config_softcursor_mode_set(Elm_Softcursor_Mode mode);
*
* @see elm_config_softcursor_mode_set()
* @since 1.7
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Elm_Softcursor_Mode elm_config_softcursor_mode_get(void);
/**
+ * @MOBILE_ONLY
+ *
* Get the duration after which tooltip will be shown.
*
* @return Duration after which tooltip will be shown.
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @endif
*/
EAPI double elm_config_tooltip_delay_get(void);
/**
+ * @MOBILE_ONLY
+ *
* Set the duration after which tooltip will be shown.
*
* @return @c EINA_TRUE if value is set.
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @endif
*/
EAPI void elm_config_tooltip_delay_set(double delay);
*
* @return 1 if only engine cursors should be used
* @ingroup Cursors
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Eina_Bool elm_config_cursor_engine_only_get(void);
* @param engine_only If 1 only engine cursors will be enabled, if 0 will
* look for them on theme before.
* @ingroup Cursors
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_config_cursor_engine_only_set(Eina_Bool engine_only);
*
* @return The scaling factor
* @ingroup Scaling
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI double elm_config_scale_get(void);
*
* @param scale The scaling factor to set
* @ingroup Scaling
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_config_scale_set(double scale);
* @c EINA_FALSE if it's disabled.
*
* @ingroup Password_last_show
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Eina_Bool elm_config_password_show_last_get(void);
* @param password_show_last If @c EINA_TRUE, enables "show last" in password mode.
* @see elm_config_password_show_last_timeout_set()
* @ingroup Password_last_show
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_config_password_show_last_set(Eina_Bool password_show_last);
*
* @return The timeout value of "show last" password mode.
* @ingroup Password_last_show
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI double elm_config_password_show_last_timeout_get(void);
* @param password_show_last_timeout The timeout value.
* @see elm_config_password_show_last_set()
* @ingroup Password_last_show
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_config_password_show_last_timeout_set(double password_show_last_timeout);
* applications.
*
* @see elm_config_engine_set()
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EINA_DEPRECATED EAPI const char *elm_config_engine_get(void);
* this is called.
*
* @see elm_win_add()
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EINA_DEPRECATED EAPI void elm_config_engine_set(const char *engine);
* elm_config_accel_preference_set() normally.
*
* @see elm_config_preferred_engine_set()
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI const char *elm_config_preferred_engine_get(void);
* @see elm_win_add()
* @see elm_config_accel_preference_set()
* @see elm_config_engine_set()
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_config_preferred_engine_set(const char *engine);
*
* @see elm_config_accel_preference_set()
* @since 1.10
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI const char *elm_config_accel_preference_get(void);
* @see elm_config_accel_preference_override_set()
*
* @since 1.10
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_config_accel_preference_set(const char *pref);
* @ingroup Fonts
*
* Release the list with elm_text_classes_list_free().
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Eina_List *elm_config_text_classes_list_get(void);
* @ingroup Fonts
*
* @see elm_config_text_classes_list_get().
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_config_text_classes_list_free(Eina_List *list);
* the theme in use. There is no need to free this list.
*
* @see elm_config_font_overlay_set() and elm_config_font_overlay_unset().
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI const Eina_List *elm_config_font_overlay_list_get(void);
* @see elm_config_font_overlay_list_get()
* @see elm_config_font_overlay_unset()
* @see edje_object_text_class_set()
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_config_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
/**
+ * @internal
+ *
* Get access mode
*
* @return the access mode bouncing state
EAPI Eina_Bool elm_config_access_get(void);
/**
+ * @internal
+ *
* Set access mode
*
* @param is_access If @c EINA_TRUE, enables access mode
* @ingroup Selection
*
* @see elm_config_selection_unfocused_clear_set()
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Eina_Bool elm_config_selection_unfocused_clear_get(void);
* @ingroup Selection
*
* @see elm_config_selection_unfocused_clear_get()
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_config_selection_unfocused_clear_set(Eina_Bool enabled);
*
* This will bring back text elements belonging to text class
* @p text_class back to their default font settings.
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_config_font_overlay_unset(const char *text_class);
* @ingroup Fonts
*
* This applies all font overlays set to all objects in the UI.
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_config_font_overlay_apply(void);
* This applies font hint changes to all windows of the current application.
*
* @since 1.13
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI void elm_config_font_hint_type_set(int type);
* This gets the globally configured finger size, <b>in pixels</b>
*
* @ingroup Fingers
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Evas_Coord elm_config_finger_size_get(void);
*
* @param size The finger size
* @ingroup Fingers
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_config_finger_size_set(Evas_Coord size);
* @ingroup Caches
*
* @see elm_cache_all_flush()
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI int elm_config_cache_flush_interval_get(void);
* @ingroup Caches
*
* @see elm_cache_all_flush()
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_config_cache_flush_interval_set(int size);
* @ingroup Caches
*
* @see elm_cache_all_flush()
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Eina_Bool elm_config_cache_flush_enabled_get(void);
* @ingroup Caches
*
* @see elm_cache_all_flush()
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_config_cache_flush_enabled_set(Eina_Bool enabled);
*
* @return The font cache size
* @ingroup Caches
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI int elm_config_cache_font_cache_size_get(void);
*
* @param size The font cache size
* @ingroup Caches
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_config_cache_font_cache_size_set(int size);
*
* @return The image cache size
* @ingroup Caches
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI int elm_config_cache_image_cache_size_get(void);
*
* @param size The image cache size
* @ingroup Caches
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_config_cache_image_cache_size_set(int size);
*
* @return The edje file cache size
* @ingroup Caches
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI int elm_config_cache_edje_file_cache_size_get(void);
*
* @param size The edje file cache size
* @ingroup Caches
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_config_cache_edje_file_cache_size_set(int size);
*
* @return The edje collections cache size
* @ingroup Caches
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI int elm_config_cache_edje_collection_cache_size_get(void);
*
* @param size The edje collections cache size
* @ingroup Caches
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_config_cache_edje_collection_cache_size_set(int size);
* @return If vsync is enabled
*
* @since 1.11
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI Eina_Bool elm_config_vsync_get(void);
* not.
*
* @since 1.11
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI void elm_config_vsync_set(Eina_Bool enabled);
* @return If acceleration override is enabled
*
* @since 1.11
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Eina_Bool elm_config_accel_preference_override_get(void);
* @see elm_config_accel_preference_set()
*
* @since 1.11
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_config_accel_preference_override_set(Eina_Bool enabled);
*
* @see elm_config_focus_highlight_enabled_set()
* @ingroup Focus
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Eina_Bool elm_config_focus_highlight_enabled_get(void);
*
* @see elm_config_focus_highlight_enabled_get()
* @ingroup Focus
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_config_focus_highlight_enabled_set(Eina_Bool enable);
*
* @see elm_config_focus_highlight_animate_set()
* @ingroup Focus
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Eina_Bool elm_config_focus_highlight_animate_get(void);
*
* @see elm_config_focus_highlight_animate_get()
* @ingroup Focus
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_config_focus_highlight_animate_set(Eina_Bool animate);
* @see elm_config_focus_highlight_clip_disabled_set()
* @since 1.10
* @ingroup Focus
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI Eina_Bool elm_config_focus_highlight_clip_disabled_get(void);
* @see elm_config_focus_highlight_clip_disabled_get()
* @since 1.10
* @ingroup Focus
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI void elm_config_focus_highlight_clip_disabled_set(Eina_Bool disable);
* @see elm_config_focus_move_policy_set()
* @since 1.10
* @ingroup Focus
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI Elm_Focus_Move_Policy elm_config_focus_move_policy_get(void);
* @see elm_config_focus_move_policy_get()
* @since 1.10
* @ingroup Focus
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI void elm_config_focus_move_policy_set(Elm_Focus_Move_Policy policy);
* @see elm_config_item_select_on_focus_disabled_set
* @since 1.10
* @ingroup Focus
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI Eina_Bool elm_config_item_select_on_focus_disabled_get(void);
* @see elm_config_item_select_on_focus_disabled_get
* @since 1.10
* @ingroup Focus
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI void elm_config_item_select_on_focus_disabled_set(Eina_Bool disabled);
* @see elm_config_first_item_focus_on_first_focusin_set
* @since 1.11
* @ingroup Focus
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI Eina_Bool elm_config_first_item_focus_on_first_focusin_get(void);
* @see elm_config_first_item_focus_on_first_focusin_get
* @since 1.11
* @ingroup Focus
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI void elm_config_first_item_focus_on_first_focusin_set(Eina_Bool enabled);
* of widgets.
*
* @return @c EINA_TRUE if mirrored is set, @c EINA_FALSE otherwise
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Eina_Bool elm_config_mirrored_get(void);
* of widgets.
*
* @param mirrored @c EINA_TRUE to set mirrored mode, @c EINA_FALSE to unset it.
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_config_mirrored_set(Eina_Bool mirrored);
/**
+ * @internal
+ *
* Get the clouseau state. @c EINA_TRUE if clouseau was tried to be run.
*
* @since 1.8
EAPI Eina_Bool elm_config_clouseau_enabled_get(void);
/**
+ * @internal
+ *
* Get the clouseau state. @c EINA_TRUE if clouseau should be attempted to be run.
*
* @since 1.8
* @c "elm_indicator_landscape".
*
* @note Do not free the return string.
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI const char *elm_config_indicator_service_get(int rotation);
* @return Timeout for long tap event of gesture layer.
* @ingroup Elm_Gesture_Layer
* @since 1.8
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI double elm_config_glayer_long_tap_start_timeout_get(void);
* @param long_tap_timeout Timeout for long tap event of gesture layer.
* @ingroup Elm_Gesture_Layer
* @since 1.8
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_config_glayer_long_tap_start_timeout_set(double long_tap_timeout);
* @return Timeout for double tap event of gesture layer.
* @ingroup Elm_Gesture_Layer
* @since 1.8
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI double elm_config_glayer_double_tap_timeout_get(void);
* @param double_tap_timeout Timeout for double tap event of gesture layer.
* @ingroup Elm_Gesture_Layer
* @since 1.8
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_config_glayer_double_tap_timeout_set(double double_tap_timeout);
* @since 1.10
*
* Release the list with elm_color_classes_list_free().
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Eina_List *elm_config_color_classes_list_get(void);
* @since 1.10
*
* @see elm_config_color_classes_list_get().
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_config_color_classes_list_free(Eina_List *list);
*
* @see elm_config_color_overlay_set()
* @see elm_config_color_overlay_unset().
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI const Eina_List *elm_config_color_overlay_list_get(void);
* @note unlike Evas, Edje colors are @b not pre-multiplied. That is,
* half-transparent white is 255 255 255 128.
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_config_color_overlay_set(const char *color_class,
int r, int g, int b, int a,
*
* This will bring back color elements belonging to color class
* @p color_class back to their default color settings.
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_config_color_overlay_unset(const char *color_class);
* @since 1.10
*
* This applies all color overlays set to all objects in the UI.
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_config_color_overlay_apply(void);
/**
+ * @internal
+ *
* Get the magnifier enabled state for entries
*
* @return The enabled state for magnifier
EAPI Eina_Bool elm_config_magnifier_enable_get(void);
/**
+ * @internal
+ *
* Set the magnifier enabled state for entires
*
* @param enable The magnifier config state
EAPI void elm_config_magnifier_enable_set(Eina_Bool enable);
/**
+ * @internal
+ *
* Get the amount of scaling the magnifer does
*
* @return The scaling amount (1.0 is none, 2.0 is twice as big etc.)
EAPI double elm_config_magnifier_scale_get(void);
/**
+ * @internal
+ *
* Set the amount of scaling the magnifier does
*
* @param scale The scaling amount for magnifiers
EAPI void elm_config_magnifier_scale_set(double scale);
/**
+ * @internal
+ *
* Get the mute state of an audio channel for effects
*
* @param channel The channel to get the mute state of
EAPI Eina_Bool elm_config_audio_mute_get(Edje_Channel channel);
/**
+ * @internal
+ *
* Set the mute state of the specified channel
*
* @param channel The channel to set the mute state of
*
* @return The enabled state for auto focus display
* @since 1.14
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI Eina_Bool elm_config_window_auto_focus_enable_get(void);
*
* @param enable the auto focus display enabled state
* @since 1.14
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI void elm_config_window_auto_focus_enable_set(Eina_Bool enable);
*
* @return The enabled state for auto focus animation
* @since 1.14
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI Eina_Bool elm_config_window_auto_focus_animate_get(void);
*
* @param enable the auto focus animation state
* @since 1.14
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI void elm_config_window_auto_focus_animate_set(Eina_Bool enable);
* @ingroup ATSPI
*
* @see elm_config_atspi_mode_set()
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI Eina_Bool elm_config_atspi_mode_get(void);
* @ingroup ATSPI
*
* @see elm_config_atspi_mode_get()
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI void elm_config_atspi_mode_set(Eina_Bool is_atspi);
* @since 1.15
*
* @see edje_transition_duration_set() for more details
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI void elm_config_transition_duration_factor_set(double factor);
* @return The duration factor of transition in edje
*
* @since 1.15
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI double elm_config_transition_duration_factor_get(void);
* This function inserts a new conformant widget on the canvas.
*
* @ingroup Conformant
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Evas_Object *elm_conformant_add(Evas_Object *parent);
methods {
@property horizontal {
set {
- [[Change the ctxpopup's orientation to horizontal or vertical.]]
+ [[Change the ctxpopup's orientation to horizontal or vertical.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
[[Get the value of current ctxpopup object's orientation.
See also @.horizontal.set.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
See also @.auto_hide_disabled.get.
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+
@since 1.9
]]
}
- get {
+ get @internal {
[[Get ctxpopup auto hide mode triggered by ctxpopup policy.
See also @.auto_hide_disabled.set for more information.
See also \@ref elm_ctxpopup_add,
\@ref elm_hover_parent_set.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
[[Get the Ctxpopup's parent
See also @.hover_parent.set for more information
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
requested direction.
See also @.Direction.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
[[Get the direction priority of a ctxpopup.
See also @.direction_priority.set for more information.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
Warning: Once the ctxpopup showed up, the direction would be determined
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
return: Elm.Ctxpopup.Direction(Elm.Ctxpopup.Direction.unknown);
}
}
@property items {
- get {
+ get @internal {
[[Get the internal list of items in a given ctxpopup widget.
This list is not to be modified in any way and must not be
}
}
@property first_item {
- get {
+ get @internal {
[[Get the first item in the given ctxpopup widget's list of
items.
}
}
@property last_item {
- get {
+ get @internal {
[[Get the last item in the given ctxpopup widget's list of
items.
Use this function to simulate clicking outside of the ctxpopup to dismiss it.
In this way, the ctxpopup will be hidden and the "clicked" signal will be
- emitted.]]
+ emitted.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
clear {
- [[Clear all items in the given ctxpopup object.]]
+ [[Clear all items in the given ctxpopup object.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
item_append {
[[Add a new item to a ctxpopup object.
time. When an item is added, any previous content will be removed.
See also \@ref elm_object_content_set.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
return: Elm.Widget_Item *; [[A handle to the item added or $null, on errors.]]
@in data: const(void)* @optional; [[Data passed to $func]]
}
}
- item_prepend {
+ item_prepend @internal {
[[Prepend a new item to a ctxpopup object.
Warning: Ctxpopup can't hold both an item list and a content at the same
eo_prefix: elm_obj_ctxpopup_item;
methods {
@property prev {
- get {
+ get @internal {
[[Get the item before $ it in a ctxpopup widget's internal list of
items.
}
}
@property next {
- get {
+ get @internal {
[[Get the item after $ it in a ctxpopup widget's
internal list of items.
item: Elm.Widget_Item *; [[The item after the object in its parent's list. If there is no previous item for $ it or there's an error, $null is returned.]]
}
}
- init {
+ init @internal {
params {
func: Evas_Smart_Cb @nullable;
data: const(void) * @optional;
* @param cursor the cursor name to be used.
*
* @ingroup Cursors
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor);
* @return the cursor name.
*
* @ingroup Cursors
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI const char *elm_object_cursor_get(const Evas_Object *obj);
* @see elm_object_cursor_set()
*
* @ingroup Cursors
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_object_cursor_unset(Evas_Object *obj);
* @param style the theme style to use (default, transparent, ...)
*
* @ingroup Cursors
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style);
* object does not have a cursor set, then NULL is returned.
*
* @ingroup Cursors
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj);
* on widget's theme.
*
* @ingroup Cursors
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_object_cursor_theme_search_enabled_set(Evas_Object *obj, Eina_Bool theme_search);
* @c EINA_FALSE otherwise.
*
* @ingroup Cursors
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Eina_Bool elm_object_cursor_theme_search_enabled_get(const Evas_Object *obj);
will display the fields accordingly.
Default format is taken as per the system locale settings.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
/* FIXME-doc
Following are the allowed set of format specifiers for each datetime field.
*/
}
get {
- [[Get the datetime format.]]
+ [[Get the datetime format.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
fmt: const(char)* @nullable; [[The datetime format.]]
field limits always works under the limitations of mintime/maxtime.
There is no provision to set the limits of AM/PM field.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
params {
@in fieldtype: Elm.Datetime.Field_Type; [[Type of the field. #ELM_DATETIME_YEAR etc.]]
field limits always works under the limitations of mintime/maxtime.
There is no provision to set the limits of AM/PM field.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
params {
@in fieldtype: Elm.Datetime.Field_Type; [[Type of the field. #ELM_DATETIME_YEAR etc.]]
Hour: default value will be in terms of 24 hr format (0~23)
Minute: default value range is from 0 to 59.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
return: bool; [[$true if minimum value is accepted.]]
Hour: default value will be in terms of 24 hr format (0~23)
Minute: default value range is from 0 to 59.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
return: bool; [[$true if minimum value is successfully returned.]]
params {
Hour: default value will be in terms of 24 hr format (0~23)
Minute: default value range is from 0 to 59.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
return: bool; [[$true if current time is set successfully.]]
params {
Hour: default value will be in terms of 24 hr format (0~23)
Minute: default value range is from 0 to 59.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
return: bool; [[$true if current time is returned successfully.]]
params {
in Datetime format, the field is visible.
By default the field visibility is set to $true.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
params {
@in fieldtype: Elm.Datetime.Field_Type; [[Type of the field. #ELM_DATETIME_YEAR etc.]]
}
}
field_visible_get @const {
- [[ Get whether a field can be visible/not.]]
+ [[ Get whether a field can be visible/not.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
return: bool; [[$true, if field can be visible. $false otherwise.]]
params {
@in fieldtype: Elm.Datetime.Field_Type; [[Type of the field. #ELM_DATETIME_YEAR etc.]]
Hour: default value will be in terms of 24 hr format (0~23)
Minute: default value range is from 0 to 59.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
return: bool; [[$true if maximum value is accepted.]]
params {
Hour: default value will be in terms of 24 hr format (0~23)
Minute: default value range is from 0 to 59.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
return: bool; [[$true if maximum value is returned successfully.]]
params {
* This function inserts a new datetime widget on the canvas.
*
* @ingroup Datetime
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Evas_Object *elm_datetime_add(Evas_Object *parent);
eo_prefix: elm_obj_dayselector;
methods {
@property week_start {
- set {
+ set @internal {
[[Set the starting day of Dayselector.
See also @Elm.Dayselector.Day,
@.week_start.get.
]]
}
- get {
+ get @internal {
[[Get the starting day of Dayselector.
See also @Elm.Dayselector.Day,
}
}
@property weekend_length {
- set {
+ set @internal {
[[Set the weekend length of Dayselector.
See also @.weekend_length.get.
]]
}
- get {
+ get @internal {
[[Get the weekend length of Dayselector.
See also @Elm.Dayselector.Day,
}
}
@property weekend_start {
- set {
+ set @internal {
[[Set the weekend starting day of Dayselector.
See also @Elm.Dayselector.Day,
@.weekend_start.get.
]]
}
- get {
+ get @internal {
[[Get the weekend starting day of Dayselector.
See also @Elm.Dayselector.Day,
day: Elm.Dayselector.Day; [[Dayselector_Day the first day from where weekend starts.]]
}
}
- weekdays_names_set {
+ weekdays_names_set @internal {
[[Set weekdays names to be displayed by the Dayselector.
By default or if weekdays is $null, weekdays abbreviations get from system are displayed:
]]
return: own(list<own(Eina_Stringshare *)> *) @warn_unused; [[A list of seven strings to be used as weekday names.]]
}
- day_selected_set {
+ day_selected_set @internal {
[[Set the state of given Dayselector_Day.
See also @Elm.Dayselector.Day,
/**
+ * @internal
+ *
* Add the dayselector.
*
* @param parent Parent object
*
* @param top The root object
* @ingroup Debug
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_object_tree_dump(const Evas_Object *top);
* @param top The root object
* @param file The path of output file
* @ingroup Debug
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
* @ingroup Win
*
* @deprecated Deprecated since Tizen 2.4
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EINA_DEPRECATED EAPI void elm_win_profiles_set(Evas_Object *obj, const char **profiles, unsigned int num_profiles);
EINA_DEPRECATED EAPI void elm_map_route_remove(Elm_Map_Route *route);
/**
+ * @MOBILE_ONLY
+ *
* @deprecated Use elm_object_item_data_get instead.
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @endif
*/
EINA_DEPRECATED EAPI void * elm_multibuttonentry_item_data_get(const Elm_Object_Item *it);
/**
+ * @MOBILE_ONLY
+ *
* @deprecated Use elm_object_item_data_set instead.
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @endif
*/
EINA_DEPRECATED EAPI void elm_multibuttonentry_item_data_set(Elm_Object_Item *it, void *data);
/**
+ * @MOBILE_ONLY
+ *
* @deprecated Use elm_calendar_select_mode_set instead.
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @endif
*/
EINA_DEPRECATED EAPI void elm_calendar_day_selection_disabled_set(Evas_Object *obj, Eina_Bool disabled);
/**
+ * @MOBILE_ONLY
+ *
* @deprecated Use elm_calendar_select_mode_get instead.
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @endif
*/
EINA_DEPRECATED EAPI Eina_Bool elm_calendar_day_selection_disabled_get(const Evas_Object *obj);
/**
+ * @internal
+ *
* @deprecated Use elm_notify_align_set instead.
*/
EINA_DEPRECATED EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient);
/**
+ * @internal
+ *
* @deprecated Use elm_notify_align_get instead.
*/
EINA_DEPRECATED EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj);
/**
+ * @internal
+ *
* @brief Set slide effect of label widget.
*
* @param obj The label object
EINA_DEPRECATED EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide);
/**
+ * @internal
+ *
* @brief Get whether slide effect is shown or not.
*
* @param obj The label object
EINA_DEPRECATED EAPI Eina_Bool elm_label_slide_get(const Evas_Object *obj);
/**
+ * @internal
+ *
* Set the text for an object's part, marking it as translatable.
*
* The string to set as @p text must be the original one. Do not pass the
EINA_DEPRECATED EAPI void elm_object_domain_translatable_text_part_set(Evas_Object *obj, const char *part, const char *domain, const char *text);
/**
+ * @internal
+ *
* Get the original string set as translatable for an object
*
* When setting translated strings, the function elm_object_part_text_get()
EINA_DEPRECATED EAPI const char *elm_object_translatable_text_part_get(const Evas_Object *obj, const char *part);
/**
+ * @internal
+ *
* @brief Show/Hide the title area
*
* @param it The naviframe item
EINA_DEPRECATED EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible);
/**
+ * @internal
+ *
* @brief Get a value whether title area is visible or not.
*
* @param it The naviframe item
EINA_DEPRECATED EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it);
/**
+ * @internal
+ *
* Enable/disable horizontal and vertical bouncing effect.
*
* @param obj The genlist object
EINA_DEPRECATED EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
/**
+ * @internal
+ *
* Get whether the horizontal and vertical bouncing effect is enabled.
*
* @param obj The genlist object
EINA_DEPRECATED EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
/**
+ * @internal
+ *
* Set the scrollbar policy
*
* @param obj The genlist object
EINA_DEPRECATED EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v);
/**
+ * @internal
+ *
* Get the scrollbar policy
*
* @param obj The genlist object
EINA_DEPRECATED EAPI void elm_genlist_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v);
/**
+ * @internal
+ *
* This sets the entry's scrollbar policy (i.e. enabling/disabling
* them).
*
EINA_DEPRECATED EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
/**
+ * @internal
+ *
* This enables/disables bouncing within the entry.
*
* This function sets whether the entry will bounce when scrolling reaches
EINA_DEPRECATED EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
/**
+ * @internal
+ *
* Get the bounce mode
*
* @param obj The Entry object
EINA_DEPRECATED EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
/**
+ * @internal
+ *
* @brief Set the photocam scrolling bouncing.
*
* @param obj The photocam object
EINA_DEPRECATED EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
/**
+ * @internal
+ *
* @brief Get the photocam scrolling bouncing.
*
* @param obj The photocam object
EINA_DEPRECATED EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
/**
+ * @internal
+ *
* Set bouncing behaviour when the scrolled content reaches an edge.
*
* Tell the internal scroller object whether it should bounce or not
EINA_DEPRECATED EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
/**
+ * @internal
+ *
* Get the bouncing behaviour of the internal scroller.
*
* Get whether the internal scroller should bounce when the edge of each
EINA_DEPRECATED EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
/**
+ * @internal
+ *
* Set the scrollbar policy.
*
* @param obj The list object
EINA_DEPRECATED EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v);
/**
+ * @internal
+ *
* Get the scrollbar policy.
*
* @see elm_list_scroller_policy_get() for details.
EINA_DEPRECATED EAPI void elm_list_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v);
/**
+ * @internal
+ *
* @brief Set custom theme elements for the scroller
*
* @param obj The scroller object
EINA_DEPRECATED EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base);
/**
+ * @internal
+ *
* Set bouncing behaviour when the scrolled content reaches an edge.
*
* Tell the internal scroller object whether it should bounce or not
EINA_DEPRECATED EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
/**
+ * @internal
+ *
* Get the bouncing behaviour of the internal scroller.
*
* Get whether the internal scroller should bounce when the edge of each
EINA_DEPRECATED EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
/**
+ * @internal
+ *
* Get the scrollbar policy.
*
* @see elm_diskselector_scroller_policy_get() for details.
EINA_DEPRECATED EAPI void elm_diskselector_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v);
/**
+ * @internal
+ *
* Set the scrollbar policy.
*
* @param obj The diskselector object.
EINA_DEPRECATED EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v);
/**
+ * @internal
+ *
* Set the file that will be used as icon.
*
* @param obj The icon object
EINA_DEPRECATED EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group);
/**
+ * @internal
+ *
* Set a location in memory to be used as an icon
*
* @param obj The icon object
EINA_DEPRECATED EAPI Eina_Bool elm_icon_memfile_set(Evas_Object *obj, const void *img, size_t size, const char *format, const char *key);
/**
+ * @internal
+ *
* Get the file that will be used as icon.
*
* @param obj The icon object
EINA_DEPRECATED EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group);
/**
+ * @internal
+ *
* Set the smooth scaling for an icon object.
*
* @param obj The icon object
EINA_DEPRECATED EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth);
/**
+ * @internal
+ *
* Get whether smooth scaling is enabled for an icon object.
*
* @param obj The icon object
EINA_DEPRECATED EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj);
/**
+ * @internal
+ *
* Disable scaling of this object.
*
* @param obj The icon object.
EINA_DEPRECATED EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale);
/**
+ * @internal
+ *
* Get whether scaling is disabled on the object.
*
* @param obj The icon object
EINA_DEPRECATED EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj);
/**
+ * @internal
+ *
* Set if the object is (up/down) resizable.
*
* @param obj The icon object
EINA_DEPRECATED EAPI void elm_icon_resizable_set(Evas_Object *obj, Eina_Bool size_up, Eina_Bool size_down);
/**
+ * @internal
+ *
* Get if the object is (up/down) resizable.
*
* @param obj The icon object
EINA_DEPRECATED EAPI void elm_icon_resizable_get(const Evas_Object *obj, Eina_Bool *size_up, Eina_Bool *size_down);
/**
+ * @internal
+ *
* Get the object's image size
*
* @param obj The icon object
EINA_DEPRECATED EAPI void elm_icon_size_get(const Evas_Object *obj, int *w, int *h);
/**
+ * @internal
+ *
* Set if the icon fill the entire object area.
*
* @param obj The icon object
EINA_DEPRECATED EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside);
/**
+ * @internal
+ *
* Get if the object is filled outside.
*
* @param obj The icon object
EINA_DEPRECATED EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj);
/**
+ * @internal
+ *
* Set the prescale size for the icon.
*
* @param obj The icon object
EINA_DEPRECATED EAPI void elm_icon_prescale_set(Evas_Object *obj, int size);
/**
+ * @internal
+ *
* Get the prescale size for the icon.
*
* @param obj The icon object
EINA_DEPRECATED EAPI int elm_icon_prescale_get(const Evas_Object *obj);
/**
+ * @internal
+ *
* Get the image object of the icon. DO NOT MODIFY THIS.
*
* @param obj The icon object
EINA_DEPRECATED EAPI Evas_Object *elm_icon_object_get(Evas_Object *obj);
/**
+ * @internal
+ *
* Enable or disable preloading of the icon
*
* @param obj The icon object
EINA_DEPRECATED EAPI void elm_icon_preload_disabled_set(Evas_Object *obj, Eina_Bool disabled);
/**
+ * @internal
+ *
* Get if the icon supports animation or not.
*
* @param obj The icon object
EINA_DEPRECATED EAPI Eina_Bool elm_icon_animated_available_get(const Evas_Object *obj);
/**
+ * @internal
+ *
* Set animation mode of the icon.
*
* @param obj The icon object
EINA_DEPRECATED EAPI void elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated);
/**
+ * @internal
+ *
* Get animation mode of the icon.
*
* @param obj The icon object
EINA_DEPRECATED EAPI Eina_Bool elm_icon_animated_get(const Evas_Object *obj);
/**
+ * @internal
+ *
* Set animation play mode of the icon.
*
* @param obj The icon object
EINA_DEPRECATED EAPI void elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play);
/**
+ * @internal
+ *
* Get animation play mode of the icon.
*
* @param obj The icon object
EINA_DEPRECATED EAPI Eina_Bool elm_icon_animated_play_get(const Evas_Object *obj);
/**
+ * @internal
+ *
* Set whether the original aspect ratio of the icon should be kept on resize.
*
* @param obj The icon object.
EINA_DEPRECATED EAPI void elm_icon_aspect_fixed_set(Evas_Object *obj, Eina_Bool fixed);
/**
+ * @internal
+ *
* Get if the object retains the original aspect ratio.
*
* @param obj The icon object.
EINA_DEPRECATED EAPI Eina_Bool elm_icon_aspect_fixed_get(const Evas_Object *obj);
/**
+ * @internal
+ *
* Set the initial file system path for a given file selector
* button widget
*
EINA_DEPRECATED EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path);
/**
+ * @internal
+ *
* Get the initial file system path set for a given file selector
* button widget
*
EINA_DEPRECATED EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj);
/**
+ * @internal
+ *
* Enable/disable a tree view in the given file selector button
* widget's internal file selector
*
EINA_DEPRECATED EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value);
/**
+ * @internal
+ *
* Get whether tree view is enabled for the given file selector
* button widget's internal file selector
*
EINA_DEPRECATED EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj);
/**
+ * @internal
+ *
* Set whether a given file selector button widget's internal file
* selector is to display folders only or the directory contents,
* as well.
EINA_DEPRECATED EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value);
/**
+ * @internal
+ *
* Get whether a given file selector button widget's internal file
* selector is displaying folders only or the directory contents,
* as well.
EINA_DEPRECATED EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj);
/**
+ * @internal
+ *
* Enable/disable the file name entry box where the user can type
* in a name for a file, in a given file selector button widget's
* internal file selector.
EINA_DEPRECATED EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value);
/**
+ * @internal
+ *
* Get whether the given file selector button widget's internal
* file selector is in "saving dialog" mode
*
EINA_DEPRECATED EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj);
/**
+ * @internal
+ *
* Set the initial file system path and the entry's path string for
* a given file selector entry widget
*
EINA_DEPRECATED EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path);
/**
+ * @internal
+ *
* Get the entry's path string for a given file selector entry
* widget
*
EINA_DEPRECATED EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj);
/**
+ * @internal
+ *
* Enable/disable a tree view in the given file selector entry
* widget's internal file selector
*
EINA_DEPRECATED EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value);
/**
+ * @internal
+ *
* Get whether tree view is enabled for the given file selector
* entry widget's internal file selector
*
EINA_DEPRECATED EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj);
/**
+ * @internal
+ *
* Set whether a given file selector entry widget's internal file
* selector is to display folders only or the directory contents,
* as well.
EINA_DEPRECATED EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value);
/**
+ * @internal
+ *
* Get whether a given file selector entry widget's internal file
* selector is displaying folders only or the directory contents,
* as well.
EINA_DEPRECATED EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj);
/**
+ * @internal
+ *
* Enable/disable the file name entry box where the user can type
* in a name for a file, in a given file selector entry widget's
* internal file selector.
EINA_DEPRECATED EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value);
/**
+ * @internal
+ *
* Get whether the given file selector entry widget's internal
* file selector is in "saving dialog" mode
*
EINA_DEPRECATED EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj);
/**
+ * @internal
+ *
* Set the initial file system path for a given file selector entry
* widget
*
EINA_DEPRECATED EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path);
/**
+ * @internal
+ *
* Get the parent directory's path to the latest file selection on
* a given filer selector entry widget
*
/**
* @deprecated Deprecated since 2.4.
* @ingroup Ctxpopup
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EINA_DEPRECATED EAPI Eina_Bool elm_ctxpopup_direction_available_get(Evas_Object *obj, Elm_Ctxpopup_Direction direction);
eo_prefix: elm_obj_diskselector;
methods {
@property side_text_max_length {
- set {
+ set @internal {
[[Set the side labels max length.
Length is the number of characters of items' label that will be
later this function call.
]]
}
- get {
+ get @internal {
[[Get the side labels max length.
See also @.side_text_max_length.set for details.
}
}
@property round_enabled {
- set {
+ set @internal {
[[Enable or disable round mode.
Disabled by default. If round mode is enabled the items list will
See also @.round_enabled.get.
]]
}
- get {
+ get @internal {
[[Get a value whether round mode is enabled or not.
See also @.round_enabled.set for details.
}
}
@property display_item_num {
- set {
+ set @internal {
[[Set the number of items to be displayed.
Default value is 3, and also it's the minimum. If $num is less
* }
*/
}
- get {
+ get @internal {
[[Get the number of items in the diskselector object.]]
}
values {
}
}
@property first_item {
- get {
+ get @internal {
[[Get the first item of the diskselector.
The list of items follows append order. So it will return the first
}
}
@property items {
- get {
+ get @internal {
[[Get a list of all the diskselector items.
See also @.item_append,
}
}
@property last_item {
- get {
+ get @internal {
[[Get the last item of the diskselector.
The list of items follows append order. So it will return last first
}
}
@property selected_item {
- get {
+ get @internal {
[[Get the selected item.
return: Elm.Widget_Item *; [[The selected diskselector item.]]
}
}
- item_append {
+ item_append @internal {
[[Appends a new item to the diskselector object.
A new item will be created and appended to the diskselector, i.e., will
@in data: const(void)* @optional; [[The data to associate with the item for related callbacks.]]
}
}
- clear {
+ clear @internal {
[[Remove all diskselector's items.
See also \@ref elm_object_item_del,
eo_prefix: elm_obj_diskselector_item;
methods {
@property prev {
- get {
+ get @internal {
[[Get the item before $item in diskselector.
The list of items follows append order. So it will return item appended
}
}
@property next {
- get {
+ get @internal {
[[Get the item after $item in diskselector.
The list of items follows append order. So it will return item appended
}
}
@property selected {
- get {
+ get @internal {
[[Get whether the $item is selected or not.
See also \@ref elm_diskselector_selected_item_set for details,
\@ref elm_diskselector_item_selected_get.
]]
}
- set {
+ set @internal {
[[Set the selected state of an item.
This sets the selected state of the given $item as $true,
/**
+ * @internal
+ *
* Add a new diskselector widget to the given parent Elementary
* (container) object.
*
[[Enable or disable scrolling in entry
Normally the entry is not scrollable unless you enable it with this call.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
Normally the entry is not scrollable. This gets the scrollable state
of the entry.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
[[Set the attribute to show the input panel in case of only an user's explicit Mouse Up event.
It doesn't request to show the input panel even though it has focus.
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+
@since 1.9
]]
}
get {
[[Get the attribute to show the input panel in case of only an user's explicit Mouse Up event.
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+
@since 1.9
]]
}
}
@property context_menu_disabled {
set {
- [[This disables the entry's contextual (longpress) menu.]]
+ [[This disables the entry's contextual (longpress) menu.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
[[This returns whether the entry's contextual (longpress) menu is
disabled.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
By setting cnp_mode to be #ELM_CNP_MODE_PLAINTEXT, this remove all tags in text .
Note: This only changes the behaviour of text.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
Normally the entry allows both text and images to be pasted.
This gets the copy & paste mode of the entry.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
]]
set {
- [[Use it before calling @Efl.File.file.set or @.file_save.]]
+ [[Use it before calling @Efl.File.file.set or @.file_save.
+
+ \@if MOBILE \@since_tizen 3.0
+ \@elseif WEARABLE \@since_tizen 3.0
+ \@endif
+ ]]
}
values {
format: Elm.Text_Format(Elm.Text_Format.plain_utf8); [[ The file format ]]
[[Set the language mode of the input panel.
This API can be used if you want to show the alphabet keyboard mode.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
- [[Get the language mode of the input panel.]]
+ [[Get the language mode of the input panel.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
lang: Elm.Input.Panel.Lang; [[language to be set to the input panel.]]
}
@property selection_handler_disabled {
set {
- [[This disabled the entry's selection handlers.]]
+ [[This disabled the entry's selection handlers.
+
+ \@if MOBILE \@since_tizen 3.0
+ \@elseif WEARABLE \@since_tizen 3.0
+ \@endif
+ ]]
}
get {
[[This returns whether the entry's selection handlers are disabled.]]
set {
[[Set the input panel layout variation of the entry
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+
@since 1.8
]]
}
get {
[[Get the input panel layout variation of the entry
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+
@since 1.8
]]
}
}
@property autocapital_type {
set {
- [[Set the autocapitalization type on the immodule.]]
+ [[Set the autocapitalization type on the immodule.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
- [[Get the autocapitalization type on the immodule.]]
+ [[Get the autocapitalization type on the immodule.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
autocapital_type: Elm.Autocapital.Type; [[The type of autocapitalization.]]
The only way to change the text of a non-editable entry is to use
\@ref elm_object_text_set, \@ref elm_entry_entry_insert and other related
functions.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
- [[Get whether the entry is editable or not.]]
+ [[Get whether the entry is editable or not.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
editable: bool; [[If $true, user input will be inserted in the entry,
themed according to $style.
Setting style no $null means disabling automatic hover.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
- [[Get the style that the hover should use.]]
+ [[Get the style that the hover should use.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
style: const(char)* @nullable; [[The style to use for the underlying hover.]]
When $single_line is $false, line wrapping takes effect again
and pressing enter will break the text into a different line
without generating any events.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
- [[Get whether the entry is set to be single line.]]
+ [[Get whether the entry is set to be single line.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
single_line: bool; [[If true, the text in the entry
In password mode, entries are implicitly single line and the display of
any text in them is replaced with asterisks (*).
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
- [[Get whether the entry is set to password mode.]]
+ [[Get whether the entry is set to password mode.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
password: bool; [[If true, password mode is enabled.]]
}
@property input_panel_return_key_disabled {
set {
- [[Set the return key on the input panel to be disabled.]]
+ [[Set the return key on the input panel to be disabled.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
- [[Get whether the return key on the input panel should be disabled or not.]]
+ [[Get whether the return key on the input panel should be disabled or not.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
disabled: bool; [[The state to put in in: $true for
}
@property autosave {
set {
- [[This sets the entry object to 'autosave' the loaded text file or not.]]
+ [[This sets the entry object to 'autosave' the loaded text file or not.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
- [[This gets the entry object's 'autosave' status.]]
+ [[This gets the entry object's 'autosave' status.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
auto_save: bool; [[Autosave the loaded file or not.]]
Sets the parent object to use by the hover created by the entry
when an anchor is clicked.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
Get the object used as parent for the hover created by the entry
widget. If no parent is set, the same entry object will be used.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
}
@property prediction_allow {
set {
- [[Set whether the entry should allow to use the text prediction.]]
+ [[Set whether the entry should allow to use the text prediction.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
- [[Get whether the entry should allow to use the text prediction.]]
+ [[Get whether the entry should allow to use the text prediction.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
prediction: bool; [[Whether the entry should allow to use the text prediction.]]
}
@property input_hint {
set {
- [[Sets the input hint which allows input methods to fine-tune their behavior.]]
+ [[Sets the input hint which allows input methods to fine-tune their behavior.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
- [[Gets the value of input hint.]]
+ [[Gets the value of input hint.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
hints: Elm.Input.Hints; [[Input hint.]]
}
@property input_panel_layout {
set {
- [[Set the input panel layout of the entry.]]
+ [[Set the input panel layout of the entry.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
- [[Get the input panel layout of the entry.]]
+ [[Get the input panel layout of the entry.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
layout: Elm.Input.Panel.Layout(Elm.Input.Panel.Layout.invalid); [[layout type.]]
An input panel displays the string or icon associated with this type.
Regardless of return key type, "activated" event will be generated when pressing return key in single line entry.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
- [[Get the "return" key type.]]
+ [[Get the "return" key type.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
return_key_type: Elm.Input.Panel.Return_Key.Type; [[The type of "return" key on the input panel.]]
}
@property input_panel_enabled {
set {
- [[Sets the attribute to show the input panel automatically.]]
+ [[Sets the attribute to show the input panel automatically.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
- [[Get the attribute to show the input panel automatically.]]
+ [[Get the attribute to show the input panel automatically.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
enabled: bool; [[If true, the input panel is appeared when entry is clicked or has a focus.]]
Note that this only makes sense for multi-line entries. A widget set
to be single line will never wrap.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
- [[Get the wrap mode the entry was set to use.]]
+ [[Get the wrap mode the entry was set to use.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
wrap: Elm.Wrap.Type; [[The wrap mode to use. See Elm_Wrap_Type for details on them.]]
The value in $pos is the index of the character position within the
contents of the string as returned by @.cursor_pos.get.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
- [[Get the current position of the cursor in the entry.]]
+ [[Get the current position of the cursor in the entry.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
pos: int; [[The position of the cursor.]]
@property icon_visible {
set {
[[Sets the visibility of the left-side widget of the entry,
- set by \@ref elm_object_part_content_set.]]
+ set by \@ref elm_object_part_content_set.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
setting: bool; [[$true if the object should be displayed,
}
@property cursor_line_end {
set {
- [[This moves the cursor to the end of the current line.]]
+ [[This moves the cursor to the end of the current line.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
}
@property select_region {
set {
[[This selects a region of text within the entry.
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+
@since 1.9
]]
}
If $enabled is $true, The return key on input panel is disabled when the entry has no text.
The return key on the input panel is automatically enabled when the entry has text.
The default value is $false.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
}
}
@property end_visible {
- set {
+ set @internal {
[[Sets the visibility of the end widget of the entry, set by
\@ref elm_object_part_content_set(ent, "end", content).]]
}
}
@property cursor_begin {
set {
- [[This moves the cursor to the beginning of the entry.]]
+ [[This moves the cursor to the beginning of the entry.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
}
@property cursor_line_begin {
set {
- [[This moves the cursor to the beginning of the current line.]]
+ [[This moves the cursor to the beginning of the current line.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
}
@property cursor_end {
set {
- [[This moves the cursor to the end of the entry.]]
+ [[This moves the cursor to the end of the entry.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
}
@property textblock {
not to mix calls on this object with regular elm_entry calls (which may
change the internal textblock object). This applies to all cursors
returned from textblock calls, and all the other derivative values.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
return: Evas.Object *;
}
It's useful if you want to draw something on the cursor (or where it is),
or for example in the case of scrolled entry where you want to show the
cursor.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
return: bool;
}
IMPORTANT: Many functions may change (i.e delete and create a new one)
the internal input method context. Do NOT cache the returned object.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
return: void *;
}
or an invisible one, such as bold begin or end tag.
This function returns whether any format node exists at the current
cursor position.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
return: bool;
}
current cursor position.
Only the text is returned, any format that may exist will not be part
of the return value. You must free the string when done with \@ref free.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
return: own(char *) @warn_unused;
}
The returned value points to an internal string and should not be freed
or modified in any way. If the $entry object is deleted or its
contents are changed, the returned pointer should be considered invalid.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
return: const(char)*;
}
}
@property cursor_is_visible_format {
get {
- [[Get if the current cursor position holds a visible format node.]]
+ [[Get if the current cursor position holds a visible format node.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
return: bool;
}
}
}
}
cursor_prev {
- [[This moves the cursor one place to the left within the entry.]]
+ [[This moves the cursor one place to the left within the entry.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
return: bool;
}
text_style_user_pop {
[[Remove the style in the top of user style stack.
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+
@since 1.7
]]
}
item_provider_prepend {
[[This prepends a custom item provider to the list for that entry
- This prepends the given callback.]]
+ This prepends the given callback.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
params {
@in func: Elm_Entry_Item_Provider_Cb; [[The function called to provide the item object.]]
@in data: void * @optional; [[The data passed to $func.]]
Note that input panel is shown or hidden automatically according to the focus state of entry widget.
This API can be used in the case of manually controlling by using @.input_panel_enabled.set(en, $false).
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
imf_context_reset {
This can be necessary in the case where modifying the buffer would confuse on-going input method behavior.
This will typically cause the Input Method Context to clear the preedit state.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
calc_force {
This should be used after modifying the textblock object directly. See
@.textblock.get for more information.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
anchor_hover_end {
When an anchor is clicked, the entry widget will create a hover
object to use as a popup with user provided content. This function
terminates this popup, returning the entry to its normal state.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
cursor_selection_begin {
[[This begins a selection within the entry as though
- the user were holding down the mouse button to make a selection.]]
+ the user were holding down the mouse button to make a selection.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
cursor_down {
- [[This moves the cursor one line down within the entry.]]
+ [[This moves the cursor one line down within the entry.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
return: bool;
}
file_save {
[[This function writes any changes made to the file set with
- \@ref elm_entry_file_set.]]
+ \@ref elm_entry_file_set.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
selection_copy {
- [[This executes a "copy" action on the selected text in the entry.]]
+ [[This executes a "copy" action on the selected text in the entry.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
text_style_user_push {
[[Push the style to the top of user style stack.
of user style stack will replace the properties in current theme.
The input style is specified in format tag='property=value' (i.e. DEFAULT='font=Sans font_size=60'hilight=' + font_weight=Bold').
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+
@since 1.7
]]
params {
This removes the given callback. See @.item_provider_append for
more information
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
params {
@in func: Elm_Entry_Item_Provider_Cb; [[The function called to provide the item object.]]
See also @.text_style_user_push.
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+
@since 1.7
]]
return: const(char)*;
menu.
See also @.context_menu_item_add.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
cursor_up {
- [[This moves the cursor one line up within the entry.]]
+ [[This moves the cursor one line up within the entry.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
return: bool;
}
entry_insert {
The inserted text is subject to any filters set for the widget.
See also @.markup_filter_append.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
params {
@in entry: const(char)*; [[The text to insert.]]
This API is used by applications to deliver specific data to the input panel.
The data format MUST be negotiated by both application and the input panel.
The size and format of data are defined by the input panel.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
params {
@in data: const(void)*; [[The specific data to be set to the input panel.]]
}
}
input_panel_imdata_get @const {
- [[Get the specific data of the current input panel.]]
+ [[Get the specific data of the current input panel.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
params {
@out data: void; [[The specific data to be got from the input panel.]]
@out len: int; [[The length of data.]]
}
}
selection_paste {
- [[This executes a "paste" action in the entry.]]
+ [[This executes a "paste" action in the entry.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
cursor_next {
- [[This moves the cursor one place to the right within the entry.]]
+ [[This moves the cursor one place to the right within the entry.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
return: bool;
}
select_none {
- [[This drops any existing text selection within the entry.]]
+ [[This drops any existing text selection within the entry.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
input_panel_hide {
[[Hide the input panel (virtual keyboard).
Note that input panel is shown or hidden automatically according to the focus state of entry widget.
This API can be used in the case of manually controlling by using @.input_panel_enabled.set(en, $false)
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
select_all {
- [[This selects all text within the entry.]]
+ [[This selects all text within the entry.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
cursor_selection_end {
[[This ends a selection within the entry as though
- the user had just released the mouse button while making a selection.]]
+ the user had just released the mouse button while making a selection.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
selection_cut {
- [[This executes a "cut" action on the selected text in the entry.]]
+ [[This executes a "cut" action on the selected text in the entry.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
is_empty @const {
[[Get whether the entry is empty.
Empty means no text at all. If there are any markup tags, like an item
tag for which no provider finds anything, and no text is displayed, this
function still returns $false.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
return: bool(true);
}
Removes the given callback from the filter list. See
@.markup_filter_append for more information.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
params {
@in func: Elm_Entry_Filter_Cb; [[The filter function to remove.]]
default provider in entry does.
See also \@ref entry-items.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
params {
@in func: Elm_Entry_Item_Provider_Cb; [[The function called to provide the item object.]]
If the new text is to be discarded, the function can free it and set its
text parameter to $null. This will also prevent any following filters from
being called.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
params {
@in func: Elm_Entry_Filter_Cb; [[The function to use as text filter.]]
The appended text is subject to any filters set for the widget.
See also @.markup_filter_append.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
params {
@in str: const(char)*; [[The text to be appended.]]
With this function, developers can add other options to this menu to
perform any action they deem necessary.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
params {
@in label: const(char)* @optional; [[The item's text label.]]
markup_filter_prepend {
[[Prepend a markup filter function for text inserted in the entry
- Prepend the given callback to the list.]]
+ Prepend the given callback to the list.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
params {
@in func: Elm_Entry_Filter_Cb; [[The function to use as text filter.]]
@in data: void * @optional; [[User data to pass to $func.]]
*
* @param s The string (in markup) to be converted
* @return The converted string (in UTF-8). It should be freed.
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI char *elm_entry_markup_to_utf8(const char *s);
* "<align=center>hello</align> &gt;". This is useful when you
* want to display "&" in label, entry, and some widgets which use textblock
* internally.
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI char *elm_entry_utf8_to_markup(const char *s);
*
* This filter, like any others, does not apply when setting the entry text
* directly with elm_object_text_set().
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text);
*
* This filter, like any others, does not apply when setting the entry text
* directly with elm_object_text_set()
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text);
*
* @see elm_entry_context_menu_item_add()
* @since 1.8
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI const char *elm_entry_context_menu_item_label_get(const Elm_Entry_Context_Menu_Item *item);
*
* @see elm_entry_context_menu_item_add()
* @since 1.8
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI void elm_entry_context_menu_item_icon_get(const Elm_Entry_Context_Menu_Item *item, const char **icon_file, const char **icon_group, Elm_Icon_Type *icon_type);
* @return The new object or NULL if it cannot be created
*
* @ingroup Entry
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Evas_Object *elm_entry_add(Evas_Object *parent);
* @note Using this function bypasses text filters
*
* @ingroup Entry
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry);
* @return The currently displayed text or NULL on failure
*
* @ingroup Entry
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI const char *elm_entry_entry_get(const Evas_Object *obj);
*
* @param[in] file The path to the file to load and save
* @param[in] format The file format
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Eina_Bool elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format);
*
* @param[out] file The path to the file to load and save
* @param[out] format The file format
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format);
eo_prefix: elm_obj_fileselector;
methods {
@property buttons_ok_cancel {
- set {
+ set @internal {
[[Enable/disable the "ok" and "cancel" buttons on a given file
selector widget
See also @.buttons_ok_cancel.get.
]]
}
- get {
+ get @internal {
[[Get whether the "ok" and "cancel" buttons on a given file
selector widget are being shown.
eo_prefix: elm_obj_fileselector_button;
methods {
@property inwin_mode {
- set {
+ set @internal {
[[Set whether a given file selector button widget's internal file
selector will raise an Elementary "inner window", instead of a
dedicated Elementary window. By default, it depends on the
See also @.inwin_mode.get.
]]
}
- get {
+ get @internal {
[[Get whether a given file selector button widget's internal file
selector will raise an Elementary "inner window", instead of a
dedicated Elementary window.
}
}
@property window_size {
- set {
+ set @internal {
[[Set the size of a given file selector button widget's window,
holding the file selector itself.
See also @.window_size.get.
]]
}
- get {
+ get @internal {
[[Get the size of a given file selector button widget's window,
holding the file selector itself.
}
}
@property window_title {
- set {
+ set @internal {
[[Set the title for a given file selector button widget's window
This will change the popup window's title, when the file selector
See also @.window_title.get.
]]
}
- get {
+ get @internal {
[[Get the title for a given file selector button widget's
window
eo_prefix: elm_obj_fileselector_entry;
methods {
@property inwin_mode {
- set {
+ set @internal {
[[Set whether a given file selector entry widget's internal file
selector will raise an Elementary "inner window", instead of a
dedicated Elementary window. By default, it depends on the current
@.inwin_mode.get.
]]
}
- get {
+ get @internal {
[[Get whether a given file selector entry widget's internal file
selector will raise an Elementary "inner window", instead of a
dedicated Elementary window.
}
}
@property window_size {
- set {
+ set @internal {
[[Set the size of a given file selector entry widget's window,
holding the file selector itself.
See also @.window_size.get.
]]
}
- get {
+ get @internal {
[[Get the size of a given file selector entry widget's window,
holding the file selector itself.
}
}
@property window_title {
- set {
+ set @internal {
[[Set the title for a given file selector entry widget's window
This will change the window's title, when the file selector pops
See also @.window_title.get.
]]
}
- get {
+ get @internal {
[[Get the title set for a given file selector entry widget's
window.
* be calling, most of the time.
*
* @ingroup Fingers
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
methods {
@property interaction {
set {
- [[Set the interactive flip mode.
+ [[\@MOBILE_ONLY
+
+ Set the interactive flip mode.
This sets if the flip should be interactive (allow user to
click and drag a side of the flip to reveal the back page
Note: #ELM_FLIP_INTERACTION_ROTATE won't cause
#ELM_FLIP_ROTATE_XZ_CENTER_AXIS or #ELM_FLIP_ROTATE_YZ_CENTER_AXIS
to happen, those can only be achieved with @.go.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
]]
}
get {
- [[Get the interactive flip mode.]]
+ [[\@MOBILE_ONLY
+
+ Get the interactive flip mode.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
}
values {
mode: Elm.Flip.Interaction; [[The interactive flip mode to use.]]
}
@property front_visible {
get {
- [[Get flip front visibility state.]]
+ [[\@MOBILE_ONLY
+
+ Get flip front visibility state.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
return: bool; [[$true if front front is showing, $false if
the back is showing.]]
}
}
interaction_direction_hitsize_set {
- [[Set the amount of the flip that is sensitive to interactive flip.
+ [[\@MOBILE_ONLY
+
+ Set the amount of the flip that is sensitive to interactive flip.
Set the amount of the flip that is sensitive to interactive flip,
with 0 representing no area in the flip and 1 representing the
Negative values of $hitsize will disable this hit area.
See also @.interaction.set.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
]]
params {
@in dir: Elm.Flip.Direction; [[The hit area to set.]]
}
}
interaction_direction_hitsize_get {
- [[Get the amount of the flip that is sensitive to interactive flip.]]
+ [[\@MOBILE_ONLY
+
+ Get the amount of the flip that is sensitive to interactive flip.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
return: double; [[The size set for that direction.]]
params {
@in dir: Elm.Flip.Direction; [[The direction to check.]]
}
}
interaction_direction_enabled_set {
- [[Set which directions of the flip respond to interactive flip
+ [[\@MOBILE_ONLY
+
+ Set which directions of the flip respond to interactive flip
By default all directions are disabled, so you may want to
enable the desired directions for flipping if you need
You can also set the appropriate hit area size by calling
@.interaction_direction_hitsize_set. By default, a minimum
hit area will be created on the opposite edge of the flip.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
]]
params {
@in dir: Elm.Flip.Direction; [[The direction to change.]]
}
}
interaction_direction_enabled_get {
- [[Get the enabled state of that flip direction.]]
+ [[\@MOBILE_ONLY
+
+ Get the enabled state of that flip direction.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
return: bool; [[If that direction is enabled or not.]]
params {
@in dir: Elm.Flip.Direction; [[The direction to check.]]
}
}
go {
- [[Runs the flip animation.
+ [[\@MOBILE_ONLY
+
+ Runs the flip animation.
Flips the front and back contents using the $mode animation.
This effectively hides the currently visible content and shows
as the page below that) and #ELM_FLIP_PAGE_DOWN (move the
currently visible content down as if the flip was a book, the
other content is shown as the page below that).
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
]]
/* FIXME-doc
* @image html elm_flip.png
}
}
go_to {
- [[Runs the flip animation to front or back.
+ [[\@MOBILE_ONLY
+
+ Runs the flip animation to front or back.
Flips the front and back contents using the $mode animation.
This effectively hides the currently visible content and shows
as the page below that) and #ELM_FLIP_PAGE_DOWN (move the
currently visible content down as if the flip was a book, the
other content is shown as the page below that).
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
]]
/* FIXME-doc
* @image html elm_flip.png
/**
+ * @MOBILE_ONLY
+ *
* @brief Add a new flip to the parent
*
* @param parent The parent object
* @return The new object or NULL if it cannot be created
*
* @ingroup Flip
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @endif
*/
EAPI Evas_Object *elm_flip_add(Evas_Object *parent);
/**
+ * @MOBILE_ONLY
+ *
* @brief Set flip perspective
*
* @param obj The flip object
* @warning This function currently does nothing.
*
* @ingroup Flip
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @endif
*/
EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y);
methods {
@property first_interval {
set {
- [[Set the interval on time updates for a user mouse button hold
+ [[\@MOBILE_ONLY
+
+ Set the interval on time updates for a user mouse button hold
on a flip selector widget.
This interval value is decreased while the user holds the
0.85 seconds.
See also @.first_interval.get.
+
+ \@if MOBILE \@since_tizen 2.4
+ \@endif
]]
}
get {
- [[Get the interval on time updates for an user mouse button hold
+ [[\@MOBILE_ONLY
+
+ Get the interval on time updates for an user mouse button hold
on a flip selector widget.
See also @.first_interval.set for more details.
+
+ \@if MOBILE \@since_tizen 2.4
+ \@endif
]]
}
values {
}
@property items {
get {
- [[Get the internal list of items in a given flip selector widget.
+ [[\@MOBILE_ONLY
+
+ Get the internal list of items in a given flip selector widget.
This list is not to be modified in any way and must not be
freed. Use the list members with functions like
Warning: This list is only valid until $obj object's internal
items list is changed. It should be fetched again with another
call to this function when changes happen.
+
+ \@if MOBILE \@since_tizen 2.4
+ \@endif
]]
return: const(list<Elm.Object.Item*>)*;
}
}
@property first_item {
get {
- [[Get the first item in the given flip selector widget's list of
+ [[\@MOBILE_ONLY
+
+ Get the first item in the given flip selector widget's list of
items.
See also @.item_append,
@.last_item.get.
+
+ \@if MOBILE \@since_tizen 2.4
+ \@endif
]]
return: Elm.Widget_Item *; [[The first item or $null, if it has no items (and on
errors).]]
}
@property last_item {
get {
- [[Get the last item in the given flip selector widget's list of
+ [[\@MOBILE_ONLY
+
+ Get the last item in the given flip selector widget's list of
items.
See also @.item_prepend,
@.first_item.get.
+
+ \@if MOBILE \@since_tizen 2.4
+ \@endif
]]
return: Elm.Widget_Item *; [[The last item or $null, if it has no items (and on
errors).]]
}
@property selected_item {
get {
- [[Get the currently selected item in a flip selector widget.]]
+ [[\@MOBILE_ONLY
+
+ Get the currently selected item in a flip selector widget.
+
+ \@if MOBILE \@since_tizen 2.4
+ \@endif
+ ]]
return: Elm.Widget_Item *; [[The selected item or $null, if the widget has no items
(and on errors).]]
}
}
item_prepend {
- [[Prepend a (text) item to a flip selector widget
+ [[\@MOBILE_ONLY
+
+ Prepend a (text) item to a flip selector widget
The widget's list of labels to show will be prepended with the
given value. If the user wishes so, a callback function pointer
Note: The maximum length of the text label is going to be
determined by the widget's theme. Strings larger than
that value are going to be truncated.
+
+ \@if MOBILE \@since_tizen 2.4
+ \@endif
]]
return: Elm.Widget_Item *;
params {
}
}
flip_next {
- [[Programmatically select the next item of a flip selector widget
+ [[\@MOBILE_ONLY
+
+ Programmatically select the next item of a flip selector widget
Note: The selection will be animated. Also, if it reaches the
end of its list of member items, it will continue with the first
one onwards.
+
+ \@if MOBILE \@since_tizen 2.4
+ \@endif
]]
}
item_append {
- [[Append a (text) item to a flip selector widget
+ [[\@MOBILE_ONLY
+
+ Append a (text) item to a flip selector widget
The widget's list of labels to show will be appended with the
given value. If the user wishes so, a callback function pointer
Note: The maximum length of the text label is going to be
determined by the widget's theme. Strings larger than
that value are going to be truncated.
+
+ \@if MOBILE \@since_tizen 2.4
+ \@endif
]]
return: Elm.Widget_Item *;
params {
}
}
flip_prev {
- [[Programmatically select the previous item of a flip selector
+ [[\@MOBILE_ONLY
+
+ Programmatically select the previous item of a flip selector
widget
Note: The selection will be animated. Also, if it reaches the
beginning of its list of member items, it will continue with the
last one backwards.
+
+ \@if MOBILE \@since_tizen 2.4
+ \@endif
]]
}
}
methods {
@property selected {
get {
- [[Get whether a given flip selector widget's item is the currently
+ [[\@MOBILE_ONLY
+
+ Get whether a given flip selector widget's item is the currently
selected one.
See also @.selected.set.
+
+ \@if MOBILE \@since_tizen 2.4
+ \@endif
]]
}
set {
- [[Set whether a given flip selector widget's item should be the
+ [[\@MOBILE_ONLY
+
+ Set whether a given flip selector widget's item should be the
currently selected one.
This sets whether $item is or not the selected (thus, under
internal members list will be the new selected one.
See also @.selected.get.
+
+ \@if MOBILE \@since_tizen 2.4
+ \@endif
]]
}
values {
}
}
prev_get @const {
- [[Get the item before $item in a flip selector widget's internal list of
+ [[\@MOBILE_ONLY
+
+ Get the item before $item in a flip selector widget's internal list of
items.
See also @.next_get.
+
+ \@if MOBILE \@since_tizen 2.4
+ \@endif
]]
return: Elm.Widget_Item *; [[The item before the $item, in its parent's list. If there is no previous item for $item or there's an error, $null is returned.]]
}
next_get @const {
- [[Get the item after $item in a flip selector widget's
+ [[\@MOBILE_ONLY
+
+ Get the item after $item in a flip selector widget's
internal list of items.
See also @.prev_get.
+
+ \@if MOBILE \@since_tizen 2.4
+ \@endif
]]
return: Elm.Widget_Item *; [[The item after the $item, in its parent's list. If there is no next item for $item or there's an error, $null is returned.]]
}
/**
+ * @MOBILE_ONLY
+ *
* Add a new flip selector widget to the given parent Elementary
* (container) widget
*
* This function inserts a new flip selector widget on the canvas.
*
* @ingroup Flipselector
+ *
+ * @if MOBILE @since_tizen 2.4
+ * @endif
*/
EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent);
* @see elm_object_focus_set()
*
* @ingroup Focus
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj);
* @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
*
* @ingroup Focus
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_object_focus_set(Evas_Object *obj, Eina_Bool focus);
* was previously.
*
* @ingroup Focus
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable);
* others are not.
*
* @ingroup Focus
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Eina_Bool elm_object_focus_allow_get(const Evas_Object *obj);
* @param obj The container object
* @param objs Chain of objects to pass focus
* @ingroup Focus
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs);
* is removed entirely after this call.
*
* @ingroup Focus
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj);
*
* @param obj The container object
* @ingroup Focus
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj);
* @param child The child to be added in custom chain
* @param relative_child The relative object to position the child
* @ingroup Focus
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child);
* @param child The child to be added in custom chain
* @param relative_child The relative object to position the child
* @ingroup Focus
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child);
* @see elm_object_focus_next_object_get(), elm_object_focus_next_object_set()
*
* @ingroup Focus
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_object_focus_next(Evas_Object *obj, Elm_Focus_Direction dir);
* @since 1.8
*
* @ingroup Focus
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Evas_Object * elm_object_focus_next_object_get(const Evas_Object *obj, Elm_Focus_Direction dir);
* @since 1.8
*
* @ingroup Focus
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_object_focus_next_object_set(Evas_Object *obj, Evas_Object *next, Elm_Focus_Direction dir);
* @since 1.8
*
* @ingroup Focus
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Evas_Object *elm_object_focused_object_get(const Evas_Object *obj);
*
* @ingroup Focus
*
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_object_tree_focus_allow_set(Evas_Object *obj, Eina_Bool focusable);
* @see elm_object_tree_focus_allow_set()
*
* @ingroup Focus
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Eina_Bool elm_object_tree_focus_allow_get(const Evas_Object *obj);
* @since 1.9
*
* @ingroup Focus
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI Eina_Bool elm_object_focus_highlight_style_set(Evas_Object *obj, const char *style);
* @since 1.9
*
* @ingroup Focus
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI const char *elm_object_focus_highlight_style_get(const Evas_Object *obj);
* @since 1.15
*
* @ingroup Focus
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI void elm_object_focus_move_policy_set(Evas_Object *obj, Elm_Focus_Move_Policy policy);
* @since 1.15
*
* @ingroup Focus
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI Elm_Focus_Move_Policy elm_object_focus_move_policy_get(const Evas_Object *obj);
* @since 1.16
*
* @ingroup Focus
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI void elm_object_focus_region_show_mode_set(Evas_Object *obj, Elm_Focus_Region_Show_Mode mode);
* @since 1.16
*
* @ingroup Focus
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI Elm_Focus_Region_Show_Mode elm_object_focus_region_show_mode_get(const Evas_Object *obj);
*
* @ingroup Focus
* @since 1.10
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI Elm_Object_Item *elm_object_focused_item_get(const Evas_Object *obj);
* @since 1.16
*
* @ingroup Focus
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI Elm_Object_Item * elm_object_focus_next_item_get(const Evas_Object *obj, Elm_Focus_Direction dir);
* @since 1.16
*
* @ingroup Focus
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI void elm_object_focus_next_item_set(Evas_Object *obj, Elm_Object_Item *next_item, Elm_Focus_Direction dir);
* @note The reverse translation can be achieved with
* elm_font_fontconfig_name_get(), for one style only (single font
* instance, not family).
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Elm_Font_Properties *elm_font_properties_get(const char *font);
* @param efp the font properties struct
*
* @ingroup Fonts
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_font_properties_free(Elm_Font_Properties *efp);
* @note The reverse translation can be achieved with
* elm_font_properties_get(), for one style only (single font
* instance, not family).
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI char *elm_font_fontconfig_name_get(const char *name, const char *style);
* @param name the font properties struct
*
* @ingroup Fonts
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_font_fontconfig_name_free(char *name);
* @note The user is supposed to get it populated at least with 3
* default font families (Sans, Serif, Monospace), which should be
* present on most systems.
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Eina_Hash *elm_font_available_hash_add(Eina_List *list);
* @param hash the hash to be freed.
*
* @ingroup Fonts
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_font_available_hash_del(Eina_Hash *hash);
set {
[[Manually collapse a frame without animations
Use this to toggle the collapsed state of a frame, bypassing animations.
+
+ \@if MOBILE \@since_tizen 3.0
+ \@elseif WEARABLE \@since_tizen 3.0
+ \@endif
]]
}
get {
[[Determine the collapse state of a frame
Use this to determine the collapse state of a frame.
+
+ \@if MOBILE \@since_tizen 3.0
+ \@elseif WEARABLE \@since_tizen 3.0
+ \@endif
]]
}
values {
When $enable is $true, clicking a frame's label will collapse the frame
vertically, shrinking it to the height of the label.
By default, this is DISABLED.
+
+ \@if MOBILE \@since_tizen 3.0
+ \@elseif WEARABLE \@since_tizen 3.0
+ \@endif
]]
}
get {
When this returns $true, clicking a frame's label will collapse the frame
vertically, shrinking it to the height of the label.
By default, this is DISABLED.
+
+ \@if MOBILE \@since_tizen 3.0
+ \@elseif WEARABLE \@since_tizen 3.0
+ \@endif
]]
}
values {
collapse_go {
[[Manually collapse a frame with animations
Use this to toggle the collapsed state of a frame, triggering animations.
+
+ \@if MOBILE \@since_tizen 3.0
+ \@elseif WEARABLE \@since_tizen 3.0
+ \@endif
]]
params {
@in collapse: bool; [[$true to collapse, $false to expand.]]
* @return The new object or NULL if it cannot be created
*
* @ingroup Frame
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI Evas_Object *elm_frame_add(Evas_Object *parent);
/**
* Emitted when the application has reconfigured elementary settings due
* to an external configuration tool asking it to.
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI extern int ELM_EVENT_CONFIG_ALL_CHANGED;
/**
* Emitted when any Elementary's policy value is changed.
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI extern int ELM_EVENT_POLICY_CHANGED;
* Emitted when nothing is visible and the process as a whole should go into
* a background state.
* @since 1.12
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI extern int ELM_EVENT_PROCESS_BACKGROUND;
* Emitted when going from nothing being visible to at least one window
* being visible.
* @since 1.12
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI extern int ELM_EVENT_PROCESS_FOREGROUND;
*
* @see elm_shutdown().
* @ingroup General
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI int elm_init(int argc, char **argv);
* job, and etc.) in elm_shutdown()
*
* @ingroup General
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI int elm_shutdown(void);
* @see elm_init() for an example
*
* @ingroup General
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_run(void);
* applications, you'll be able to get this function called automatically for you.
*
* @ingroup General
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_exit(void);
/**
* @deprecated Deprecated since 2.4.
* Exposed symbol used only by macros and should not be used by apps
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_quicklaunch_mode_set(Eina_Bool ql_on);
/**
* @deprecated Deprecated since 2.4.
* Exposed symbol used only by macros and should not be used by apps
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EINA_DEPRECATED EAPI Eina_Bool elm_quicklaunch_mode_get(void);
/**
* @deprecated Deprecated since 2.4.
* Exposed symbol used only by macros and should not be used by apps
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EINA_DEPRECATED EAPI int elm_quicklaunch_init(int argc, char **argv);
/**
* @deprecated Deprecated since 2.4.
* Exposed symbol used only by macros and should not be used by apps
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EINA_DEPRECATED EAPI int elm_quicklaunch_sub_init(int argc, char **argv);
/**
* @deprecated Deprecated since 2.4.
* Exposed symbol used only by macros and should not be used by apps
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EINA_DEPRECATED EAPI int elm_quicklaunch_sub_shutdown(void);
/**
* @deprecated Deprecated since 2.4.
* Exposed symbol used only by macros and should not be used by apps
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EINA_DEPRECATED EAPI int elm_quicklaunch_shutdown(void);
/**
* @deprecated Deprecated since 2.4.
* Exposed symbol used only by macros and should not be used by apps
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EINA_DEPRECATED EAPI void elm_quicklaunch_seed(void);
/**
* @deprecated Deprecated since 2.4.
* Exposed symbol used only by macros and should not be used by apps
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EINA_DEPRECATED EAPI Eina_Bool elm_quicklaunch_prepare(int argc, char **argv, const char *cwd);
/**
* @deprecated Deprecated since 2.4.
* Exposed symbol used only by macros and should not be used by apps
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EINA_DEPRECATED EAPI Eina_Bool elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (*postfork_func) (void *data), void *postfork_data);
/**
* @deprecated Deprecated since 2.4.
* Exposed symbol used only by macros and should not be used by apps
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EINA_DEPRECATED EAPI void elm_quicklaunch_cleanup(void);
/**
* @deprecated Deprecated since 2.4.
* Exposed symbol used only by macros and should not be used by apps
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EINA_DEPRECATED EAPI int elm_quicklaunch_fallback(int argc, char **argv);
/**
* @deprecated Deprecated since 2.4.
* Exposed symbol used only by macros and should not be used by apps
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EINA_DEPRECATED EAPI char *elm_quicklaunch_exe_path_get(const char *exe, const char *cwd);
* (#ELM_POLICY_QUIT), which has two possible values.
*
* @ingroup General
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Eina_Bool elm_policy_set(unsigned int policy, int value);
* identifier. Will be @c 0 if @p policy passed is invalid.
*
* @ingroup General
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI int elm_policy_get(unsigned int policy);
* @param lang Language to set, must be the full name of the locale
*
* @ingroup General
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_language_set(const char *lang);
} Elm_Process_State; /** The state of the process as a whole. @since 1.12 */
/**
+ * @internal
+ *
* Get the process state as a while
*
* @return The current process state
methods {
@property align {
set {
- [[Set the items grid's alignment within a given gengrid widget.
+ [[\@MOBILE_ONLY
+
+ Set the items grid's alignment within a given gengrid widget.
This sets the alignment of the whole grid of items of a gengrid
within its given viewport. By default, those values are both
Note: If given alignment values are out of the cited ranges,
they'll be changed to the nearest boundary values on the valid
ranges.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
]]
}
get {
- [[Get the items grid's alignment values within a given gengrid
+ [[\@MOBILE_ONLY
+
+ Get the items grid's alignment values within a given gengrid
widget.
Note: Use $null pointers on the alignment values you're not
interested in: they'll be ignored by the function.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
]]
}
values {
}
@property filled {
set {
- [[Set how the items grid's filled within a given gengrid widget
+ [[\@MOBILE_ONLY
+
+ Set how the items grid's filled within a given gengrid widget
This sets the fill state of the whole grid of items of a
gengrid within its given viewport. By default, this value
is false, meaning that if the first line of items grid's
isn't filled, the items are centered with the alignment.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
]]
}
get {
- [[Get how the items grid's filled within a given gengrid widget
+ [[\@MOBILE_ONLY
+
+ Get how the items grid's filled within a given gengrid widget
Note: Use $null pointers on the alignment values you're not
interested in: they'll be ignored by the function.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
]]
}
values {
[[Control a given gengrid widget's scrolling page size, relative
to its viewport size.
]]
- set {}
- get {}
+ set @internal {
+ }
+ get @internal {
+ }
values {
h_pagerel: double;
v_pagerel: double;
}
@property multi_select {
set {
- [[Enable or disable multi-selection in a given gengrid widget.
+ [[\@MOBILE_ONLY
+
+ Enable or disable multi-selection in a given gengrid widget.
Multi-selection is the ability to have more than one item
selected, on a given gengrid, simultaneously. When it is
"Shift" key.
Note: By default, multi-selection is disabled on gengrids.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
]]
}
get {
- [[Get whether multi-selection is enabled or disabled for a given
+ [[\@MOBILE_ONLY
+
+ Get whether multi-selection is enabled or disabled for a given
gengrid widget.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
]]
}
values {
}
@property group_item_size {
set {
- [[Set the size for the group items of a given gengrid widget.
+ [[\@MOBILE_ONLY
+
+ Set the size for the group items of a given gengrid widget.
A gengrid, after creation, has still no information on the size
to give to each of its cells. So, you most probably will end up
with squares one \@ref Fingers "finger" wide, the default
size. Use this function to force a custom size for you group
items, making them as big as you wish.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
]]
}
get {
- [[Get the size set for the group items of a given gengrid widget.
+ [[\@MOBILE_ONLY
+
+ Get the size set for the group items of a given gengrid widget.
Note: Use $null pointers on the size values you're not
interested in: they'll be ignored by the function.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
]]
}
values {
}
@property select_mode {
set {
- [[Set the gengrid select mode.
+ [[\@MOBILE_ONLY
+
+ Set the gengrid select mode.
This changes item select mode in the gengrid widget.
#ELM_OBJECT_SELECT_MODE_DEFAULT means that items will only
be called. #ELM_OBJECT_SELECT_MODE_NONE will turn off the
ability to select items entirely and they will neither appear
selected nor call selected callback functions.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
]]
}
get {
- [[Get the gengrid select mode.]]
+ [[\@MOBILE_ONLY
+
+ Get the gengrid select mode.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
}
values {
mode: Elm.Object.Select_Mode(Elm.Object.Select_Mode.max); [[The select mode.]]
}
@property reorder_mode {
set {
- [[Set whether a given gengrid widget is or not able have items
+ [[\@MOBILE_ONLY
+
+ Set whether a given gengrid widget is or not able have items
reordered.
If a gengrid is set to allow reordering, a click held for more
The replacements will be animated and, whenever the user
releases the mouse button, the item being replaced gets a new
definitive place in the grid.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
]]
}
get {
- [[Get whether a given gengrid widget is or not able have items
+ [[\@MOBILE_ONLY
+
+ Get whether a given gengrid widget is or not able have items
reordered.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
]]
}
values {
[[Control whether the gengrid items' should be highlighted when
item selected.
]]
- set {}
- get {}
+ set {
+ [[\@MOBILE_ONLY
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
+ }
+ get {
+ [[\@MOBILE_ONLY
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
+ }
values {
highlight: bool;
}
}
@property reorder_type {
- set {
+ set @internal {
[[ Set the Gengrid reorder type
@since 1.11
]]
}
@property item_size {
set {
- [[Set the size for the items of a given gengrid widget.
+ [[\@MOBILE_ONLY
+
+ Set the size for the items of a given gengrid widget.
A gengrid, after creation, has still no information on the size
to give to each of its cells. So, you most probably will end up
with squares one \@ref Fingers "finger" wide, the default
size. Use this function to force a custom size for you items,
making them as big as you wish.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
]]
}
get {
- [[Get the size set for the items of a given gengrid widget.
+ [[\@MOBILE_ONLY
+
+ Get the size set for the items of a given gengrid widget.
Note: Use $null pointers on the size values you're not
interested in: they'll be ignored by the function.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
]]
}
values {
}
}
@property multi_select_mode {
- set {
+ set @internal {
[[Set the gengrid multi select mode.
#ELM_OBJECT_MULTI_SELECT_MODE_DEFAULT means that
@since 1.8
]]
}
- get {
+ get @internal {
[[Get the gengrid multi select mode.
If getting mode fails, it returns
}
@property horizontal {
set {
- [[Set the direction in which a given gengrid widget will
+ [[\@MOBILE_ONLY
+
+ Set the direction in which a given gengrid widget will
expand while placing its items.
When in "horizontal mode" ($true), items will be placed in
started below, thus expanding the grid vertically.
Note: By default, gengrid is in vertical mode, $false.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
]]
}
get {
- [[Get for what direction a given gengrid widget will expand while
+ [[\@MOBILE_ONLY
+
+ Get for what direction a given gengrid widget will expand while
placing its items.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
]]
}
values {
}
}
@property page_size {
- set {
+ set @internal {
[[Set a given gengrid widget's scrolling page size.]]
}
values {
}
@property selected_item {
get {
- [[Get the selected item in a given gengrid widget.
+ [[\@MOBILE_ONLY
+
+ Get the selected item in a given gengrid widget.
This returns the selected item in $obj. If multi selection is
enabled on $obj (See @.multi_select.set), only the first item
in the list is selected, which might not be very useful. For
that case, see @.selected_items.get.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
]]
return: Elm.Widget_Item *; [[The selected item's handle or $null
if none is selected at the moment
}
@property realized_items {
get {
- [[Get a list of realized items in gengrid.
+ [[\@MOBILE_ONLY
+
+ Get a list of realized items in gengrid.
This returns a list of the realized items in the gengrid. The
list contains gengrid item pointers. The list must be freed by
the caller when done with eina_list_free(). The item pointers
in the list are only valid so long as those items are not
deleted or the gengrid is not deleted.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
]]
return: free(own(list<Elm_Gen_Item *> *), eina_list_free) @warn_unused; [[
The list of realized items or $null if none are realized.
}
@property first_item {
get {
- [[Get the first item in a given gengrid widget.
+ [[\@MOBILE_ONLY
+
+ Get the first item in a given gengrid widget.
This returns the first item in the $obj's internal list of
items.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
]]
return: Elm.Widget_Item *; [[
The first item's handle or $null, if there are no
}
@property selected_items {
get {
- [[Get a list of selected items in a given gengrid.
+ [[\@MOBILE_ONLY
+
+ Get a list of selected items in a given gengrid.
This returns a list of the selected items, in the order that
they appear in the grid. This list is only valid as long as no
more items are selected or unselected (or unselected implicitly
by deletion). The list contains Gengrid item pointers as
data, naturally.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
]]
return: const(list<Elm.Widget_Item *>)*; [[
The list of selected items or $null, if none is
}
@property last_item {
get {
- [[Get the last item in a given gengrid widget.
+ [[\@MOBILE_ONLY
+
+ Get the last item in a given gengrid widget.
This returns the last item in the $obj's internal list of
items.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
]]
return: Elm.Widget_Item *; [[The last item's handle or $null
if there are no items in $obj
}
}
@property wheel_disabled {
- set {
+ set @internal {
[[Enable or disable mouse wheel to be used to scroll the gengrid.
Mouse wheel can be used for the user to scroll up and down
Wheel is enabled by default.
]]
}
- get {
+ get @internal {
[[Get a value whether mouse wheel is enabled or not.
Mouse wheel can be used for the user to scroll up and down
}
}
item_insert_before {
- [[Insert an item before another in a gengrid widget.
+ [[\@MOBILE_ONLY
+
+ Insert an item before another in a gengrid widget.
This inserts an item before another in the gengrid.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
]]
return: Elm.Widget_Item *; [[A handle to the item added or $null on errors.]]
params {
}
}
realized_items_update {
- [[Update the contents of all realized items.
+ [[\@MOBILE_ONLY
+
+ Update the contents of all realized items.
This updates all realized items by calling all the item class
functions again to get the contents, texts and states. Use this
desired to be reflected.
To update just one item, use \@ref elm_gengrid_item_update.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
]]
}
item_insert_after {
- [[Insert an item after another in a gengrid widget.
+ [[\@MOBILE_ONLY
+
+ Insert an item after another in a gengrid widget.
This inserts an item after another in the gengrid.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
]]
return: Elm.Widget_Item *; [[A handle to the item added or $null on error.]]
params {
}
}
items_count @const {
- [[Return how many items are currently in a list
+ [[\@MOBILE_ONLY
+
+ Return how many items are currently in a list
This behavior is O(1) and includes items which may or may not
be realized.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
]]
return: uint;
}
at_xy_item_get @const {
- [[Get the item that is at the x, y canvas coords.
+ [[\@MOBILE_ONLY
+
+ Get the item that is at the x, y canvas coords.
This returns the item at the given coordinates (which are canvas
relative, not object-relative). If an item is at that coordinate,
lower part (1). If NULL is returned as an item (no item found
there), then posret may indicate -1 or 1 based if the coordinate
is above or below all items respectively in the gengrid.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
]]
return: Elm.Widget_Item *; [[The item at the coordinates or $null if none.]]
params {
}
}
item_append {
- [[Append a new item in a given gengrid widget.
+ [[\@MOBILE_ONLY
+
+ Append a new item in a given gengrid widget.
This adds an item to the beginning of the gengrid.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
]]
return: Elm.Widget_Item *; [[A handle to the item added or $null on errors.]]
params {
}
}
item_prepend {
- [[Prepend a new item in a given gengrid widget.
+ [[\@MOBILE_ONLY
+
+ Prepend a new item in a given gengrid widget.
This adds an item to the end of the gengrid.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
]]
return: Elm.Widget_Item *; [[A handle to the item added or $null on errors.]]
params {
}
}
clear {
- [[Remove all items from a given gengrid widget.
+ [[\@MOBILE_ONLY
+
+ Remove all items from a given gengrid widget.
This removes (and deletes) all items in $obj, leaving it empty.
See \@ref elm_gengrid_item_del to remove just one item.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
]]
}
item_sorted_insert {
- [[Insert an item in a gengrid widget using a user-defined sort
+ [[\@MOBILE_ONLY
+
+ Insert an item in a gengrid widget using a user-defined sort
function.
This inserts an item in the gengrid based on user defined
comparison function. The two arguments passed to the function
$func are gengrid item handles to compare.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
]]
return: Elm.Widget_Item *; [[A handle to the item added or $null on errors.]]
params {
@in func_data: const(void)* @optional; [[Data to be passed to $func.]]
}
}
- search_by_text_item_get {
+ search_by_text_item_get @internal {
[[Get gengrid item by given string.
It takes pointer to the gengrid item that will be used to start
@in flags: Elm_Glob_Match_Flags; [[Search flags.]]
}
}
- reorder_mode_start {
+ reorder_mode_start @internal {
[[
Starts the reorder mode of Gengrid
@since 1.10
@in tween_mode: Ecore_Pos_Map; [[ Position mappings for animation ]]
}
}
- reorder_mode_stop {
+ reorder_mode_stop @internal {
[[
Stops the reorder mode of Gengrid
@since 1.10
typedef Elm_Gen_Item_Del_Cb Elm_Gengrid_Item_Del_Cb;
/**
+ * @MOBILE_ONLY
+ *
* Add a new gengrid item class in a given gengrid widget.
*
* @return New allocated a gengrid item class.
* @see elm_gengrid_item_append()
*
* @ingroup Gengrid
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @endif
*/
EAPI Elm_Gengrid_Item_Class *elm_gengrid_item_class_new(void);
/**
+ * @MOBILE_ONLY
+ *
* Remove an item class in a given gengrid widget.
*
* @param itc The itc to be removed.
* @see elm_gengrid_item_class_unref()
*
* @ingroup Gengrid
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @endif
*/
EAPI void elm_gengrid_item_class_free(Elm_Gengrid_Item_Class *itc);
/**
+ * @MOBILE_ONLY
+ *
* Increments object reference count for the item class.
*
* @param itc The given item class object to reference
* @see elm_gengrid_item_class_unref()
*
* @ingroup Gengrid
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @endif
*/
EAPI void elm_gengrid_item_class_ref(Elm_Gengrid_Item_Class *itc);
/**
+ * @MOBILE_ONLY
+ *
* Decrements object reference count for the item class.
*
* @param itc The given item class object to reference
* @see elm_gengrid_item_class_free()
*
* @ingroup Gengrid
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @endif
*/
EAPI void elm_gengrid_item_class_unref(Elm_Gengrid_Item_Class *itc);
/**
+ * @MOBILE_ONLY
+ *
* Set the text to be shown in a given gengrid item's tooltips.
*
* @param it The gengrid item
* elm_gengrid_item_tooltip_content_cb_set().
*
* @ingroup Gengrid
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @endif
*/
EAPI void elm_gengrid_item_tooltip_text_set(Elm_Object_Item *it, const char *text);
/**
+ * @MOBILE_ONLY
+ *
* Set the content to be shown in a given gengrid item's tooltip
*
* @param it The gengrid item.
* elm_gengrid_item_tooltip_text_set().
*
* @ingroup Gengrid
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @endif
*/
EAPI void elm_gengrid_item_tooltip_content_cb_set(Elm_Object_Item *it, Elm_Tooltip_Item_Content_Cb func, const void *data, Evas_Smart_Cb del_cb);
/**
+ * @MOBILE_ONLY
+ *
* Unset a tooltip from a given gengrid item
*
* @param it gengrid item to remove a previously set tooltip from.
* @see elm_gengrid_item_tooltip_content_cb_set()
*
* @ingroup Gengrid
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @endif
*/
EAPI void elm_gengrid_item_tooltip_unset(Elm_Object_Item *it);
/**
+ * @MOBILE_ONLY
+ *
* Set a different @b style for a given gengrid item's tooltip.
*
* @param it gengrid item with tooltip set
* @see elm_gengrid_item_tooltip_style_get()
*
* @ingroup Gengrid
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @endif
*/
EAPI void elm_gengrid_item_tooltip_style_set(Elm_Object_Item *it, const char *style);
/**
+ * @MOBILE_ONLY
+ *
* Get the style set a given gengrid item's tooltip.
*
* @param it gengrid item with tooltip already set on.
* @see elm_gengrid_item_tooltip_style_set() for more details
*
* @ingroup Gengrid
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @endif
*/
EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Object_Item *it);
/**
+ * @MOBILE_ONLY
+ *
* @brief Disable size restrictions on an object's tooltip
* @param it The tooltip's anchor object
* @param disable If @c EINA_TRUE, size restrictions are disabled
*
* This function allows a tooltip to expand beyond its parent window's canvas.
* It will instead be limited only by the size of the display.
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @endif
*/
EAPI Eina_Bool elm_gengrid_item_tooltip_window_mode_set(Elm_Object_Item *it, Eina_Bool disable);
/**
+ * @MOBILE_ONLY
+ *
* @brief Get size restriction state of an object's tooltip
* @param it The tooltip's anchor object
* @return If @c EINA_TRUE, size restrictions are disabled
* This function returns whether a tooltip is allowed to expand beyond
* its parent window's canvas.
* It will instead be limited only by the size of the display.
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @endif
*/
EAPI Eina_Bool elm_gengrid_item_tooltip_window_mode_get(const Elm_Object_Item *it);
/**
+ * @MOBILE_ONLY
+ *
* Set the type of mouse pointer/cursor decoration to be shown,
* when the mouse pointer is over the given gengrid widget item
*
* @see elm_gengrid_item_cursor_unset()
*
* @ingroup Gengrid
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @endif
*/
EAPI void elm_gengrid_item_cursor_set(Elm_Object_Item *it, const char *cursor);
/**
+ * @MOBILE_ONLY
+ *
* Get the type of mouse pointer/cursor decoration set to be shown,
* when the mouse pointer is over the given gengrid widget item
*
* @see elm_gengrid_item_cursor_unset()
*
* @ingroup Gengrid
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @endif
*/
EAPI const char *elm_gengrid_item_cursor_get(const Elm_Object_Item *it);
/**
+ * @MOBILE_ONLY
+ *
* Unset any custom mouse pointer/cursor decoration set to be
* shown, when the mouse pointer is over the given gengrid widget
* item, thus making it show the @b default cursor again.
* @see elm_gengrid_item_cursor_set() for more details
*
* @ingroup Gengrid
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @endif
*/
EAPI void elm_gengrid_item_cursor_unset(Elm_Object_Item *it);
/**
+ * @MOBILE_ONLY
+ *
* Set a different @b style for a given custom cursor set for a
* gengrid item.
*
* @see elm_gengrid_item_cursor_style_get()
*
* @ingroup Gengrid
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @endif
*/
EAPI void elm_gengrid_item_cursor_style_set(Elm_Object_Item *it, const char *style);
/**
+ * @MOBILE_ONLY
+ *
* Get the current @b style set for a given gengrid item's custom
* cursor
*
* @see elm_gengrid_item_cursor_style_set() for more details
*
* @ingroup Gengrid
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @endif
*/
EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Object_Item *it);
/**
+ * @MOBILE_ONLY
+ *
* Set if the (custom) cursor for a given gengrid item should be
* searched in its theme, also, or should only rely on the
* rendering engine.
* provided by the rendering engine.
*
* @ingroup Gengrid
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @endif
*/
EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Object_Item *it, Eina_Bool engine_only);
/**
+ * @MOBILE_ONLY
+ *
* Get if the (custom) cursor for a given gengrid item is being
* searched in its theme, also, or is only relying on the rendering
* engine.
* @see elm_gengrid_item_cursor_engine_only_set(), for more details
*
* @ingroup Gengrid
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @endif
*/
EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Object_Item *it);
/**
+ * @MOBILE_ONLY
+ *
* Get a given gengrid item's position, relative to the whole
* gengrid's grid area.
*
* second column.
*
* @ingroup Gengrid
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @endif
*/
EAPI void elm_gengrid_item_pos_get(const Elm_Object_Item *it, unsigned int *x, unsigned int *y);
/**
+ * @MOBILE_ONLY
+ *
* Set the gengrid item's select mode.
*
* @param it The gengrid item object
* @see elm_gengrid_item_select_mode_get()
*
* @ingroup Gengrid
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @endif
*/
EAPI void elm_gengrid_item_select_mode_set(Elm_Object_Item *it, Elm_Object_Select_Mode mode);
/**
+ * @MOBILE_ONLY
+ *
* Get the gengrid item's select mode.
*
* @param it The gengrid item object
* @see elm_gengrid_item_select_mode_set()
*
* @ingroup Gengrid
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @endif
*/
EAPI Elm_Object_Select_Mode elm_gengrid_item_select_mode_get(const Elm_Object_Item *it);
methods {
@property prev {
get {
- [[Get the previous item in a gengrid widget's internal list of items, given a handle to one of those items.
+ [[\@MOBILE_ONLY
+
+ Get the previous item in a gengrid widget's internal list of items, given a handle to one of those items.
This returns the item placed before the $item, on the container
- gengrid.]]
+ gengrid.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
}
values {
item: Elm.Widget_Item *; [[The item before $item, or $NULL if there's none (and on errors)]]
}
@property next {
get {
- [[Get the next item in a gengrid widget's internal list of items,
+ [[\@MOBILE_ONLY
+
+ Get the next item in a gengrid widget's internal list of items,
given a handle to one of those items.
This returns the item placed after the $item, on the container
- gengrid.]]
+ gengrid.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
}
values {
item: Elm.Widget_Item *; [[The item after $item, or $NULL if there's none (and on errors)]]
true, any other previously selected items will get
unselected in favor of this new one.]]
get {
+ [[\@MOBILE_ONLY
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
}
set {
+ [[\@MOBILE_ONLY
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
}
values {
selected: bool; [[the selected state ($true selected, $false not selected)]]
}
@property item_class {
get {
- [[Get the Gengrid Item class for the given Gengrid Item.
+ [[\@MOBILE_ONLY
+
+ Get the Gengrid Item class for the given Gengrid Item.
This returns the Gengrid_Item_Class for the given item. It can be used to examine
- the function pointers and item_style.]]
+ the function pointers and item_style.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
}
values {
itc: const (Elm_Gengrid_Item_Class) *; [[Gengrid Item class for the given item]]
}
@property index {
get {
- [[Get the index of the item. It is only valid once displayed.]]
+ [[\@MOBILE_ONLY
+
+ Get the index of the item. It is only valid once displayed.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
}
values {
index: int(-1); [[the position inside the list of item.]]
}
@property pos {
get {
- [[Get a given gengrid item's position, relative to the whole gengrid's grid area.
+ [[\@MOBILE_ONLY
+
+ Get a given gengrid item's position, relative to the whole gengrid's grid area.
This returns the "logical" position of the item within the
gengrid. For example, $(0, 1) would stand for first row,
- second column.]]
+ second column.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
}
values {
x: uint; [[Pointer to variable to store the item's <b>row number</b>.]]
small screen devices. So it is enabled, the item can be shrink than
predefined finger-size value. And the item will be updated.]]
get {
+ [[\@MOBILE_ONLY
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
}
set {
+ [[\@MOBILE_ONLY
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
}
values {
mode: Elm.Object.Select_Mode(Elm.Object.Select_Mode.max); [[The selected mode]]
}
}*/
show {
- [[Show the portion of a gengrid's internal grid containing a given
+ [[\@MOBILE_ONLY
+
+ Show the portion of a gengrid's internal grid containing a given
item, immediately.
This causes gengrid to redraw its viewport's contents to the
region containing the given $item item, if it is not fully
- visible.]]
+ visible.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
params {
@in type: Elm_Gengrid_Item_Scrollto_Type; [[Where to position the item in the viewport.]]
}
}
bring_in {
- [[Animatedly bring in, to the visible area of a gengrid, a given item on it.
+ [[\@MOBILE_ONLY
+
+ Animatedly bring in, to the visible area of a gengrid, a given item on it.
This causes gengrid to jump to the given $item and show
it (by scrolling), if it is not fully visible. This will use
- animation to do so and take a period of time to complete.]]
+ animation to do so and take a period of time to complete.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
params {
@in type: Elm_Gengrid_Item_Scrollto_Type; [[Where to position the item in the viewport.]]
}
}
update {
- [[Update the contents of a given gengrid item
+ [[\@MOBILE_ONLY
+
+ Update the contents of a given gengrid item
This updates an item by calling all the item class functions
again to get the contents, texts and states. Use this when the
original item data has changed and you want the changes to be
- reflected.]]
+ reflected.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
}
fields_update {
- [[Update the part of an item
+ [[\@MOBILE_ONLY
+
+ Update the part of an item
This updates an item's part by calling item's fetching functions again
to get the contents, texts and states. Use this when the original
Use elm_gengrid_realized_items_update() to update an item's all
property.
- @since 1.15]]
+ \@if MOBILE \@since_tizen 2.4
+ \@endif
+
+ @since 1.15
+ ]]
params {
@in parts: const (char) *; [[The name of item's part]]
@in itf: Elm.Gengrid.Item.Field_Type; [[The type of item's part type]]
}
}
item_class_update {
- [[Update the item class of a gengrid item.
+ [[\@MOBILE_ONLY
+
+ Update the item class of a gengrid item.
This sets another class of the item, changing the way that it is
displayed. After changing the item class, elm_gengrid_item_update() is
- called on the item $it.]]
+ called on the item $it.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
params {
@in itc: const (Elm_Gengrid_Item_Class) *; [[The gengrid item class describing the function pointers and the item style.]]
}
This instructs gengrid to release references to contents in the item,
meaning that they will no longer be managed by gengrid and are
floating "orphans" that can be re-used elsewhere if the user wants
- to.]]
+ to.
+
+ \@if MOBILE \@since_tizen 2.4
+ \@elseif WEARABLE \@since_tizen 3.0
+ \@endif
+ ]]
params {
@out l: own(list<own(Evas.Object *)> *); [[The contents list to return.]]
}
/**
+ * @MOBILE_ONLY
+ *
* Add a new gengrid widget to the given parent Elementary
* (container) object
*
* @see elm_gengrid_clear()
*
* @ingroup Gengrid
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @endif
*/
EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent);
/**
+ * @MOBILE_ONLY
+ *
* Get the nth item, in a given gengrid widget, placed at position @p nth, in
* its internal items list
*
*
* @ingroup Genilst
* @since 1.8
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @endif
*/
EAPI Elm_Object_Item *elm_gengrid_nth_item_get(const Evas_Object *obj, unsigned int nth);
/**
+ * @MOBILE_ONLY
+ *
* @deprecated Deprecated since 2.4. Use elm_scroller_page_show() instead.
* Show a specific virtual region within the gengrid content object by page number.
*
* @endcode
*
* @see elm_scroller_page_bring_in()
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @endif
*/
EINA_DEPRECATED EAPI void elm_gengrid_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber);
/**
+ * @internal
+ *
* Set the scrollbar policy
*
* @param obj The gengrid object
EINA_DEPRECATED EAPI void elm_gengrid_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v);
/**
+ * @internal
+ *
* Get the scrollbar policy
*
* @param obj The gengrid object
EINA_DEPRECATED EAPI void elm_gengrid_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v);
/**
+ * @internal
+ *
* Enable or disable bouncing effect for a given gengrid widget
*
* @param obj The gengrid object
EINA_DEPRECATED EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
/**
+ * @internal
+ *
* Get whether bouncing effects are enabled or disabled, for a
* given gengrid widget, on each axis
*
EINA_DEPRECATED EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
/**
+ * @internal
+ *
* @brief Get gengrid current page number.
*
* @param obj The gengrid object
EINA_DEPRECATED EAPI void elm_gengrid_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
/**
+ * @internal
+ *
* @brief Get gengrid last page number.
*
* @param obj The gengrid object
EINA_DEPRECATED EAPI void elm_gengrid_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
/**
+ * @internal
+ *
* Show a specific virtual region within the gengrid content object by page number.
*
* @param obj The gengrid object
items' callbacks are called only when the item is needed.
Note: This also works well with group index.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
- [[Get whether the homogeneous mode is enabled.]]
+ [[Get whether the homogeneous mode is enabled.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
homogeneous: bool; [[Assume the items within the genlist are of
be called. #ELM_OBJECT_SELECT_MODE_NONE will turn off the
ability to select items entirely and they will neither appear
selected nor call selected callback functions.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
- [[Get the genlist select mode.]]
+ [[Get the genlist select mode.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
mode: Elm.Object.Select_Mode(Elm.Object.Select_Mode.max); [[The select mode.]]
}
}
@property focus_on_selection {
- set {
+ set @internal {
[[Set focus upon items selection mode
When enabled, every selection of an item inside the genlist
an item will couse this particular item to get focus as usual.
]]
}
- get {
+ get @internal {
[[Get whether focus upon item's selection mode is enabled.]]
}
values {
Warning: If you set the longpress timeout value with this API,
your genlist will not be affected by the longpress value of
elementary config value later.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
- [[Get the timeout in seconds for the longpress event.]]
+ [[Get the timeout in seconds for the longpress event.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
timeout: double; [[Timeout in seconds. Default is elm config value (1.0).]]
This enables ($true) or disables ($false) multi-selection in
the list. This allows more than 1 item to be selected. To
retrieve the list of selected items, use @.selected_items.get.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
- [[Get if multi-selection in genlist is enabled or disabled.]]
+ [[Get if multi-selection in genlist is enabled or disabled.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
multi: bool; [[Multi-select enable/disable. Default is disabled.]]
After turning on the reorder mode, longpress on normal item
will trigger reordering of the item. You can move the item
up and down. However, reorder does not work with group item.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
- [[Get the reorder mode.]]
+ [[Get the reorder mode.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
reorder_mode: bool; [[The reorder mode.]]
}
}
@property decorate_mode {
- set {
+ set @internal {
[[Set Genlist decorate mode.
This sets Genlist decorate mode to all items.
]]
}
- get {
+ get @internal {
[[Get Genlist decorate mode.]]
}
values {
}
}
@property multi_select_mode {
- set {
+ set @internal {
[[Set the genlist multi select mode.
#ELM_OBJECT_MULTI_SELECT_MODE_DEFAULT means that
@since 1.8
]]
}
- get {
+ get @internal {
[[Get the genlist multi select mode.
@since 1.8
lists, so unless you know you will have a lot of objects
visible in the screen at the same time, don't try to
change this.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
- [[Get the maximum number of items within an item block.]]
+ [[Get the maximum number of items within an item block.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
count: int; [[Maximum number of items within an item block. Default is 32.]]
}
@property tree_effect_enabled {
[[Control genlist tree effect.]]
- set {}
- get {}
+ set @internal {
+ }
+ get @internal {
+ }
values {
enabled: bool; [[The tree effect status.]]
}
called.
Highlight is enabled by default.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
[[Get whether the genlist items' should be highlighted when
item selected.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
in genlist which can be on the flying resizable (such as
TEXTBLOCK). If then, some dynamic esizable objects in
genlist would not diplayed properly.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
- [[Get the horizontal stretching mode.]]
+ [[Get the horizontal stretching mode.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
mode: Elm_List_Mode(4); [[The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).]]
}
}
@property decorated_item {
- get {
+ get @internal {
[[Get active genlist mode item.
This function returns the item that was activated with a mode,
@.selected_items.get for when multi-selection is used).
If no item is selected, $null is returned.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
return: Elm.Widget_Item *; [[The selected item, or $null if none is selected.]]
}
[[Get the first item in the genlist.
This returns the first item in the list.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
return: Elm.Widget_Item *; [[The first item or $null.]]
}
freed by the caller when done with \@ref eina_list_free. The
item pointers in the list are only valid so long as those
items are not deleted or the genlist is not deleted.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
return: free(own(list<Elm_Gen_Item *> *), eina_list_free) @warn_unused;
}
Note: If not in multi-select mode, consider using function
@.selected_item.get instead.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
return: const(list<Elm.Widget_Item *>)*;
}
[[Get the last item in the genlist
This returns the last item in the list.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
return: Elm.Widget_Item *;
}
This inserts an item before another in the list. It will be in
the same tree level or group as the item it is inserted before.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
return: Elm.Widget_Item *;
params {
desired to be reflected.
To update just one item, use \@ref elm_genlist_item_update.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
item_insert_after {
This inserts an item after another in the list. It will be in the
same tree level or group as the item it is inserted after.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
return: Elm.Widget_Item *;
params {
as an item (no item found there), then posret may indicate -1 or
1 based if the coordinate is above or below all items
respectively in the genlist.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
return: Elm.Widget_Item *;
params {
}
}
@property filter {
- set {
+ set @internal {
[[Set filter mode with key.
This initiates the filter mode of genlist with user/application
key: void *; [[Filter key]]
}
}
- filter_iterator_new {
+ filter_iterator_new @internal {
[[Returns an iterator over the list of filtered items.
Return NULL if filter is not set. Application must take care
This behavior is O(1) and includes items which may or may not
be realized.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
return: uint;
}
This adds an item to the beginning of the list or beginning of
the children of the parent if given.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
return: Elm.Widget_Item *;
params {
[[Remove all items from a given genlist widget.
This removes (and deletes) all items in $obj, leaving it empty.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
item_append {
This adds the given item to the end of the list or the end of
the children list if the $parent is given.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
return: Elm.Widget_Item *;
params {
This inserts an item in the genlist based on user defined
comparison function. The two arguments passed to the function
$func are genlist item handles to compare.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
return: Elm.Widget_Item *;
params {
@in func_data: const(void)* @optional; [[Data passed to $func above.]]
}
}
- search_by_text_item_get {
+ search_by_text_item_get @internal {
[[Get genlist item by given string.
It takes pointer to the genlist item that will be used to start
* @see elm_genlist_item_append()
*
* @ingroup Genlist
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Elm_Genlist_Item_Class *elm_genlist_item_class_new(void);
* @see elm_genlist_item_class_unref()
*
* @ingroup Genlist
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_genlist_item_class_free(Elm_Genlist_Item_Class *itc);
* @see elm_genlist_item_class_unref()
*
* @ingroup Genlist
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_genlist_item_class_ref(Elm_Genlist_Item_Class *itc);
* @see elm_genlist_item_class_free()
*
* @ingroup Genlist
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_genlist_item_class_unref(Elm_Genlist_Item_Class *itc);
/**
+ * @MOBILE_ONLY
+ *
* Set the text to be shown in a given genlist item's tooltips.
*
* @param it The genlist item
* elm_genlist_item_tooltip_content_cb_set().
*
* @ingroup Genlist
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @endif
*/
EAPI void elm_genlist_item_tooltip_text_set(Elm_Object_Item *it, const char *text);
/**
+ * @MOBILE_ONLY
+ *
* Set the content to be shown in a given genlist item's tooltips
*
* @param it The genlist item.
* elm_genlist_item_tooltip_text_set().
*
* @ingroup Genlist
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @endif
*/
EAPI void elm_genlist_item_tooltip_content_cb_set(Elm_Object_Item *it, Elm_Tooltip_Item_Content_Cb func, const void *data, Evas_Smart_Cb del_cb);
/**
+ * @MOBILE_ONLY
+ *
* Unset a tooltip from a given genlist item
*
* @param it genlist item to remove a previously set tooltip from.
* @see elm_genlist_item_tooltip_content_cb_set()
*
* @ingroup Genlist
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @endif
*/
EAPI void elm_genlist_item_tooltip_unset(Elm_Object_Item *it);
/**
+ * @MOBILE_ONLY
+ *
* Set a different @b style for a given genlist item's tooltip.
*
* @param it genlist item with tooltip set
* @see elm_genlist_item_tooltip_style_get()
*
* @ingroup Genlist
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @endif
*/
EAPI void elm_genlist_item_tooltip_style_set(Elm_Object_Item *it, const char *style);
/**
+ * @MOBILE_ONLY
+ *
* Get the style set a given genlist item's tooltip.
*
* @param it genlist item with tooltip already set on.
* @see elm_genlist_item_tooltip_style_set() for more details
*
* @ingroup Genlist
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @endif
*/
EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Object_Item *it);
/**
+ * @MOBILE_ONLY
+ *
* @brief Disable size restrictions on an object's tooltip
* @param it The tooltip's anchor object
* @param disable If @c EINA_TRUE, size restrictions are disabled
*
* This function allows a tooltip to expand beyond its parent window's canvas.
* It will instead be limited only by the size of the display.
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @endif
*/
EAPI Eina_Bool elm_genlist_item_tooltip_window_mode_set(Elm_Object_Item *it, Eina_Bool disable);
/**
+ * @MOBILE_ONLY
+ *
* @brief Get size restriction state of an object's tooltip
* @param it The tooltip's anchor object
* @return If @c EINA_TRUE, size restrictions are disabled
* This function returns whether a tooltip is allowed to expand beyond
* its parent window's canvas.
* It will instead be limited only by the size of the display.
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @endif
*/
EAPI Eina_Bool elm_genlist_item_tooltip_window_mode_get(const Elm_Object_Item *it);
* @see elm_genlist_item_cursor_unset()
*
* @ingroup Genlist
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_genlist_item_cursor_set(Elm_Object_Item *it, const char *cursor);
* @see elm_genlist_item_cursor_unset()
*
* @ingroup Genlist
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI const char *elm_genlist_item_cursor_get(const Elm_Object_Item *it);
* @see elm_genlist_item_cursor_set() for more details
*
* @ingroup Genlist
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_genlist_item_cursor_unset(Elm_Object_Item *it);
* @see elm_genlist_item_cursor_style_get()
*
* @ingroup Genlist
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_genlist_item_cursor_style_set(Elm_Object_Item *it, const char *style);
* @see elm_genlist_item_cursor_style_set() for more details
*
* @ingroup Genlist
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Object_Item *it);
* provided by the rendering engine.
*
* @ingroup Genlist
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Object_Item *it, Eina_Bool engine_only);
* @see elm_genlist_item_cursor_engine_only_set(), for more details
*
* @ingroup Genlist
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Object_Item *it);
This returns the item placed before the $item, on
the container genlist.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
This returns the item placed after the $item, on
the container genlist.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
This returns the item that was specified as parent
of the item $it on \@ref elm_genlist_item_append
and insertion related functions.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
}
}
@property subitems {
- get {
+ get @internal {
[[et the list of subitems of a given item
This returns the list of subitems that an item
}
@property selected {
get {
- [[Get whether a given genlist item is selected or not.]]
+ [[Get whether a given genlist item is selected or not.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
set {
[[Set whether a given genlist item is selected or not
selection is not enabled on the containing genlist
and $selected is $true, any other previously selected
items will get unselected in favor of this new one.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
[[Get the expanded state of an item
This gets the expanded state of an item.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
set {
of this item (if it is a parent). You must manually
delete and create them on the callbacks of
the "expanded" or "contracted" signals.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
}
@property expanded_depth {
get {
- [[Get the depth of expanded item.]]
+ [[Get the depth of expanded item.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
depth: int; [[The depth of expanded item.]]
This returns the Genlist_Item_Class for the given item.
It can be used to examine the function pointers and
item_style.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
[[Get the index of the item. It is only valid once displayed.
The index start from 1.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
}
}
@property decorate_mode {
- get {
+ get @internal {
[[Get the item's decorate mode.
This function just returns the name of the item's
}
}
@property flip {
- get {
+ get @internal {
[[Get the flip state of a given genlist item.
This function returns the flip state of a given
returns $false.
]]
}
- set {
+ set @internal {
[[Set the flip state of a given genlist item.
This function sets the flip state of a given genlist
[[Get the genlist item's select mode.
It's ELM_OBJECT_SELECT_MODE_MAX on failure.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
set {
some touch or small screen devices. So it is
enabled, the item can be shrink than predefined
finger-size value. And the item will be updated.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
This function returns the item's type. Normally the
item's type. If it failed, return value is
ELM_GENLIST_ITEM_MAX.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
const(void)* data;
}
}*/
- subitems_count {
+ subitems_count @internal {
[[Get the number of subitems of a given item.
This returns the number of subitems that an item possesses.
This removes all items that are children (and their
descendants) of the given item $it.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
promote {
- [[Promote an item to the top of the list.]]
+ [[Promote an item to the top of the list.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
demote {
- [[Demote an item to the end of the list.]]
+ [[Demote an item to the end of the list.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
show {
[[Show the portion of a genlist's internal list containing
This causes genlist to jump to the given item $it and
show it (by jumping to that position), if it is not
fully visible.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
params {
@in type: Elm.Genlist.Item.Scrollto_Type; [[The position to bring in, the given item to.
show it (by animatedly scrolling), if it is not fully
visible. This may use animation and take a some time
to do so.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
params {
@in type: Elm.Genlist.Item.Scrollto_Type; [[The position to bring in, the given item to.
in the item, meaning that they will no longer be managed
by genlist and are floating "orphans" that can be re-used
elsewhere if the user wants to.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
params {
@out l: own(list<own(Evas.Object *)> *); [[The contents list to return.]]
because edje_object is deleted and created again by this
API. If you want to avoid this, please use
\@ref elm_genlist_item_fields_update.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
fields_update {
Use \@ref elm_genlist_realized_items_update to update an
item's all property.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
params {
@in parts: const (char) *; [[The name of item's part.]]
This sets another class of the item, changing the way
that it is displayed. After changing the item class
@.update is called on the item $it.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
params {
@in itc: const (Elm_Genlist_Item_Class) *; [[The item class for the item.]]
}
}
- decorate_mode_set {
+ decorate_mode_set @internal {
[[Activate a genlist mode on an item.
A genlist mode is a different way of selecting an item.
* @see elm_genlist_clear()
*
* @ingroup Genlist
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Evas_Object *elm_genlist_add(Evas_Object *parent);
*
* @ingroup Genilst
* @since 1.8
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Elm_Object_Item *
elm_genlist_nth_item_get(const Evas_Object *obj, unsigned int nth);
methods {
@property zoom_step {
[[Control step value for zoom action.]]
- set {}
- get {}
+ set {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
+ }
+ get {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
+ }
values {
step: double; [[The zoom step value.]]
}
Set to 0 if you want GLayer to use the system finger size
value (default).
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+
@since 1.8
]]
}
get {
[[This function returns the gesture layer finger-size for taps
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+
@since 1.8
]]
}
Clear this if you like gesture layer to forward events as
testing gestures.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
- [[Get the repeat-events setting.]]
+ [[Get the repeat-events setting.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
hold_events: bool;
[[This function sets the step value for rotate action.
Set to 0 to cancel step setting.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
- [[This function returns step-value for rotate action.]]
+ [[This function returns step-value for rotate action.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
step: double; [[New rotate step value.]]
When all callbacks for the gesture are set to $null,
it means this gesture is disabled.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
A gesture layer's target may be any Evas object. This object
will be used to listen to mouse and key events.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
return: bool; [[$true on success, $false otherwise.]]
params {
}
}
cb_del {
- [[Remove a gesture callback.]]
+ [[Remove a gesture callback.
+
+ \@if MOBILE \@since_tizen 3.0
+ \@elseif WEARABLE \@since_tizen 3.0
+ \@endif
+ ]]
params {
@in idx: Elm_Gesture_Type; [[The gesture you want to track state of.]]
@in cb_type: Elm_Gesture_State; [[The event the callback tracks (START, MOVE, END, ABORT).]]
will be replaced by the new one. For ABI compat, callbacks
added by @.cb_add will be removed. It is recommended to
use only one of these functions for a gesture object.
+
+ \@if MOBILE \@since_tizen 3.0
+ \@elseif WEARABLE \@since_tizen 3.0
+ \@endif
]]
params {
@in idx: Elm_Gesture_Type; [[The gesture you want to track state of.]]
* @param line_min_length the length.
*
* @since 1.8
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_gesture_layer_line_min_length_set(Evas_Object *obj, int line_min_length);
* @return the length.
*
* @since 1.8
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI int elm_gesture_layer_line_min_length_get(const Evas_Object *obj);
* @param zoom_distance_tolerance zoom distance tolerance
*
* @since 1.8
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_gesture_layer_zoom_distance_tolerance_set(Evas_Object *obj, Evas_Coord zoom_distance_tolerance);
* @return zoom distance tolerance
*
* @since 1.8
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Evas_Coord elm_gesture_layer_zoom_distance_tolerance_get(const Evas_Object *obj);
* @param line_distance_tolerance line distance tolerance
*
* @since 1.8
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_gesture_layer_line_distance_tolerance_set(Evas_Object *obj, Evas_Coord line_distance_tolerance);
* @return line distance tolerance
*
* @since 1.8
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Evas_Coord elm_gesture_layer_line_distance_tolerance_get(const Evas_Object *obj);
* @param line_angular_tolerance line angular tolerance
*
* @since 1.8
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_gesture_layer_line_angular_tolerance_set(Evas_Object *obj, double line_angular_tolerance);
* @return line angular tolerance
*
* @since 1.8
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI double elm_gesture_layer_line_angular_tolerance_get(const Evas_Object *obj);
* @param zoom_wheel_factor zoom wheel factor
*
* @since 1.8
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_gesture_layer_zoom_wheel_factor_set(Evas_Object *obj, double zoom_wheel_factor);
* @return zoom wheel factor
*
* @since 1.8
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI double elm_gesture_layer_zoom_wheel_factor_get(const Evas_Object *obj);
* @param zoom_finger_factor zoom finger factor
*
* @since 1.8
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_gesture_layer_zoom_finger_factor_set(Evas_Object *obj, double zoom_finger_factor);
* @return zoom finger factor
*
* @since 1.8
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI double elm_gesture_layer_zoom_finger_factor_get(const Evas_Object *obj);
* @param rotate_angular_tolerance rotate angular tolerance
*
* @since 1.8
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_gesture_layer_rotate_angular_tolerance_set(Evas_Object *obj, double rotate_angular_tolerance);
* @return rotate angular tolerance
*
* @since 1.8
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI double elm_gesture_layer_rotate_angular_tolerance_get(const Evas_Object *obj);
* @param flick_time_limit_ms flick time limit (in ms)
*
* @since 1.8
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_gesture_layer_flick_time_limit_ms_set(Evas_Object *obj, unsigned int flick_time_limit_ms);
* @return flick time limit (in ms)
*
* @since 1.8
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI unsigned int elm_gesture_layer_flick_time_limit_ms_get(const Evas_Object *obj);
* @param long_tap_start_timeout long tap start timeout
*
* @since 1.8
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_gesture_layer_long_tap_start_timeout_set(Evas_Object *obj, double long_tap_start_timeout);
* @return long tap start timeout
*
* @since 1.8
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI double elm_gesture_layer_long_tap_start_timeout_get(const Evas_Object *obj);
* @param continues_enable continues enable
*
* @since 1.8
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_gesture_layer_continues_enable_set(Evas_Object *obj, Eina_Bool continues_enable);
* @return continues enable
*
* @since 1.8
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Eina_Bool elm_gesture_layer_continues_enable_get(const Evas_Object *obj);
* @param double_tap_timeout double tap timeout
*
* @since 1.8
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_gesture_layer_double_tap_timeout_set(Evas_Object *obj, double double_tap_timeout);
* @return double tap timeout
*
* @since 1.8
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI double elm_gesture_layer_double_tap_timeout_get(const Evas_Object *obj);
* @param sz Finger size
*
* @since 1.8
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_gesture_layer_tap_finger_size_set(Evas_Object *obj, Evas_Coord sz);
* @return Finger size that is currently used by Gesture Layer for taps.
*
* @since 1.8
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Evas_Coord elm_gesture_layer_tap_finger_size_get(const Evas_Object *obj);
* call elm_gesture_layer_attach() in order to 'activate' gesture-layer.
*
* @ingroup Elm_Gesture_Layer
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent);
* @see elm_gesture_layer_tap_longpress_cb_del
* @since 1.8
* @ingroup Elm_Gesture_Layer
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI void elm_gesture_layer_tap_longpress_cb_add(Evas_Object *obj, Elm_Gesture_State state, Elm_Gesture_Event_Cb cb, void *data);
* @see elm_gesture_layer_tap_longpress_cb_add
* @since 1.8
* @ingroup Elm_Gesture_Layer
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI void elm_gesture_layer_tap_longpress_cb_del(Evas_Object *obj, Elm_Gesture_State state, Elm_Gesture_Event_Cb cb, void *data);
}
@property size {
set {
- [[Sets the size of the glview.]]
+ [[Sets the size of the glview.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
[[Get the size of the glview.
glview. This means that when the scale policy is set to
#ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
size.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
specified size. If the policy is set to
#ELM_GLVIEW_RESIZE_POLICY_SCALE, however, glview only
scales the image object and not the underlying GL Surface.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
return: bool;
}
}
@property changed {
set {
- [[Notifies that there has been changes in the GLView.]]
+ [[Notifies that there has been changes in the GLView.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
}
@property resize_func {
This function allows glview to hide all the rendering
context/surface details and have the user just call GL
alls that they desire when resize happens.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
is deleted. This function allows glview to hide all the
rendering context/surface details and have the user just
call GL calls that they desire when delete happens.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
render loop. This function allows glview to hide all the
rendering context/surface details and have the user just
call GL calls that they desire for initialization GL calls.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
policy is set to #ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it
redraws regardless of whether it is visible or needs
redrawing.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
return: bool;
}
the window given that the right conditions are met. Otherwise
it falls back to rendering to an offscreen buffer before it
gets composited to the window.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
return: bool;
}
The render function gets called in the main loop but whether
it runs depends on the rendering policy and whether
@.changed.set gets called.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
}
@property gl_api {
get {
- [[Get the gl api struct for gl rendering.]]
+ [[Get the gl api struct for gl rendering.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
return: Evas_GL_API *;
}
}
still owned by the view. But this pointer can be used then
to call all the evas_gl_ functions.
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+
@since 1.12
]]
return: Evas_GL *;
application when setting the internal rotation matrix for
the view.
+ \@if MOBILE \@since_tizen 2.4
+ \@elseif WEARABLE \@since_tizen 3.0
+ \@endif
+
@since 1.12
]]
return: int; [[A window rotation in degrees (0, 90, 180 or 270).]]
* @return The new object or NULL if it cannot be created
*
* @ingroup GLView
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Evas_Object *elm_glview_add(Evas_Object *parent);
* @return The new object or @c NULL if it cannot be created
*
* @since 1.12
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Evas_Object *elm_glview_version_add(Evas_Object *parent, Evas_GL_Context_Version version);
methods {
@property size {
set {
- [[Set the virtual size of the grid]]
+ [[Set the virtual size of the grid
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
- [[Get the virtual size of the grid]]
+ [[Get the virtual size of the grid
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
w: Evas.Coord; [[The virtual width of the grid]]
It's up to the user to destroy it when it no longer needs it.
It's possible to remove objects from the grid when walking this
list, but these removals won't be reflected on it.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
return: free(own(list<Evas.Object *> *), eina_list_free) @warn_unused;
}
}
clear {
- [[Faster way to remove all child objects from a grid object.]]
+ [[Faster way to remove all child objects from a grid object.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
params {
@in clear: bool; [[If true, it will delete just removed children]]
}
}
unpack {
- [[Unpack a child from a grid object]]
+ [[Unpack a child from a grid object
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
params {
@in subobj: Evas.Object *; [[The child to unpack]]
}
}
pack {
- [[Pack child at given position and size]]
+ [[Pack child at given position and size
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
params {
@in subobj: Evas.Object *; [[The child to pack.]]
@in x: Evas.Coord; [[The virtual x coord at which to pack it.]]
* @return The new object or NULL if it cannot be created
*
* @ingroup Grid
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
* @param h The virtual height at which to pack it
*
* @ingroup Grid
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_grid_pack_set(Evas_Object *subobj, Evas_Coord x, Evas_Coord y, Evas_Coord w, Evas_Coord h);
* @param h Pointer to integer to store the virtual height
*
* @ingroup Grid
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_grid_pack_get(Evas_Object *subobj, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h);
} Elm_Regexp_Status;
/**
+ * @internal
+ *
* @brief Create a new regex validator.
* General designed for validate inputed entry text.
*
elm_validator_regexp_new(const char *pattern, const char *signal) EINA_ARG_NONNULL(1);
/**
+ * @internal
+ *
* @brief Delete the existing regex validator.
*
* @param validator The given validator
elm_validator_regexp_free(Elm_Validator_Regexp *validator) EINA_ARG_NONNULL(1);
/**
+ * @internal
+ *
* @brief Get the validation status.
*
* @param The given validator
#ifdef EO_BETA_API
/**
+ * @internal
+ *
* @brief The regex validator. Used as callback to validate event.
*
* Example:
eo_prefix: elm_obj_hover;
methods {
@property target {
- set {
+ set @internal {
[[Sets the target object for the hover.
This function will cause the hover to be centered on the
target object.
]]
}
- get {
+ get @internal {
[[Get the target object for the hover.]]
}
values {
for the hover object to use]]
}
}
- dismiss {
+ dismiss @internal {
[[Dismiss a hover object]]
}
}
/**
+ * @internal
+ *
* @brief Adds a hover object to @p parent
*
* @param parent The parent object
EAPI Evas_Object *elm_hover_add(Evas_Object *parent);
/**
+ * @internal
+ *
* @brief Sets the parent object for the hover.
*
* @param obj The hover object
EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent);
/**
+ * @internal
+ *
* @brief Get the parent object for the hover.
*
* @param obj The hover object
Note: The initial button will display horizontally regradless of this setting.]]
set {
+ [[\@MOBILE_ONLY
+
+ \@if MOBILE \@since_tizen 2.4
+ \@endif
+ ]]
}
get {
+ [[\@MOBILE_ONLY
+
+ \@if MOBILE \@since_tizen 2.4
+ \@endif
+ ]]
}
values {
horizontal: bool; [[If $true, the hover will expand horizontally to the right.]]
hoversel is clicked. Should probably be the window that the hoversel is
in.]]
set {
+ [[\@MOBILE_ONLY
+
+ \@if MOBILE \@since_tizen 2.4
+ \@endif
+ ]]
}
get {
+ [[\@MOBILE_ONLY
+
+ \@if MOBILE \@since_tizen 2.4
+ \@endif
+ ]]
}
values {
parent: Evas.Object * @nullable; [[The parent to use]]
}
@property expanded {
get {
- [[Returns whether the hoversel is expanded.]]
+ [[\@MOBILE_ONLY
+
+ Returns whether the hoversel is expanded.
+
+ \@if MOBILE \@since_tizen 2.4
+ \@endif
+ ]]
return: bool; [[$true if the hoversel is expanded or $false otherwise]]
}
}
@property items {
get {
- [[Get the list of items within the given hoversel.]]
+ [[\@MOBILE_ONLY
+
+ Get the list of items within the given hoversel.
+
+ \@if MOBILE \@since_tizen 2.4
+ \@endif
+ ]]
return: const(list<Elm.Widget_Item *>)*;
}
}
@property auto_update {
[[Update icon and text of hoversel same to those of selected item automatically.]]
get{
+ [[\@MOBILE_ONLY
+
+ \@if MOBILE \@since_tizen 3.0
+ \@endif
+ ]]
}
set{
+ [[\@MOBILE_ONLY
+
+ \@if MOBILE \@since_tizen 3.0
+ \@endif
+ ]]
}
values {
auto_update: bool; [[$true if hoversel is updated automatically or $false otherwise]]
}
}
hover_begin {
- [[This triggers the hoversel popup from code, the same as if the user had clicked the button.]]
+ [[\@MOBILE_ONLY
+
+ This triggers the hoversel popup from code, the same as if the user had clicked the button.
+
+ \@if MOBILE \@since_tizen 2.4
+ \@endif
+ ]]
}
clear {
- [[This will remove all the children items from the hoversel.
+ [[\@MOBILE_ONLY
+
+ This will remove all the children items from the hoversel.
Warning Should *not* be called while the hoversel is active; use
- @Elm.Hoversel.expanded.get to check first.]]
+ @Elm.Hoversel.expanded.get to check first.
+
+ \@if MOBILE \@since_tizen 2.4
+ \@endif
+ ]]
}
hover_end {
- [[This dismisses the hoversel popup as if the user had clicked outside the hover.]]
+ [[\@MOBILE_ONLY
+
+ This dismisses the hoversel popup as if the user had clicked outside the hover.
+
+ \@if MOBILE \@since_tizen 2.4
+ \@endif
+ ]]
}
item_add {
- [[Add an item to the hoversel button
+ [[\@MOBILE_ONLY
+
+ Add an item to the hoversel button
This adds an item to the hoversel to show when it is clicked. Note: if you
need to use an icon from an edje file then use Elm.Hoversel_Item.icon.set
- right after this function, and set icon_file to $null here.]]
+ right after this function, and set icon_file to $null here.
+
+ \@if MOBILE \@since_tizen 2.4
+ \@endif
+ ]]
/* FIXME: Make the hoversel_item reference in the doc a real ref. */
/* FIXME-doc
The icon can be loaded from the standard set, from an image file, or from an edje file.]]
get {
+ [[\@MOBILE_ONLY
+
+ \@if MOBILE \@since_tizen 2.4
+ \@endif
+ ]]
}
set {
+ [[\@MOBILE_ONLY
+
+ \@if MOBILE \@since_tizen 2.4
+ \@endif
+ ]]
}
values {
icon_file: const (char) * @nullable; [[An image file path on disk to use for the icon or standard icon name]]
[[Sets the icon lookup order used by elm_icon_standard_set().
See also @.order_lookup.get, @Elm.Icon.Lookup_Order.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
[[Get the icon lookup order.
See also @.order_lookup.set, @Elm.Icon.Lookup_Order.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
Note: This function does not accept relative icon path.
See also @.standard.get.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
return: bool; [[true on success, false on error]]
}
If the icon image was set using elm_image_file_set() instead of
@.standard.set, then this function will return null.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
When set the file indicated has a thumbnail generated and cached
on disk for future use or will directly use an existing cached
thumbnail if it is valid.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
* @see elm_image_file_set()
*
* @ingroup Icon
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Evas_Object *elm_icon_add(Evas_Object *parent);
This means the image is a valid drag target for drag and drop, and can be
cut or pasted too.]]
set {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
set: bool; [[Turn on or off editability. Default is $false.]]
resizing of the image can keep the smooth scaling enabled (even if the
image is already scaled, since the scaled image will be cached).]]
set {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
smooth: bool; [[$true if smooth scaling should be used, $false otherwise. Default is $true.]]
size/resize in any way. For that effect, take a look at
@.resizable and @Elm.Widget.scale]]
set {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
no_scale: bool; [[$true if the object is not scalable, $false otherwise. Default is $false.]]
The original aspect ratio (width / height) of the image is usually
distorted to match the object's size. Enabling this option will retain
this original aspect, and the way that the image is fit into the object's
- area depends on the option set by @.fill_outside.]]
+ area depends on the option set by @.fill_outside.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
fixed: bool; [[$true if the image should retain the aspect, $false otherwise.]]
This function allows to rotate or flip the given image.]]
set {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
orient: Elm_Image_Orient; [[The image orientation Elm_Image_Orient Default is #ELM_IMAGE_ORIENT_NONE.]]
See also @.fill_inside.]]
set {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
fill_outside: bool; [[$true if the object is filled outside, $false otherwise. Default is $false.]]
$false, the object can't have its height or width resized to a value
higher than the original image size. Same is valid for $size_down.]]
set {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
up: bool; [[A bool to set if the object is resizable up. Default is $true.]]
}
@property preload_disabled {
set {
- [[Enable or disable preloading of the image]]
+ [[Enable or disable preloading of the image
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
disabled: bool; [[If true, preloading will be disabled]]
"correct" loader first, before trying a range of other possible
loaders until one succeeds.
- @since 1.7]]
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+
+ @since 1.7
+ ]]
return: bool; [[$true = success, $false = error]]
}
the pixel data, save the image to a file, etc.
Note: Be careful to not manipulate it, as it is under control of
- elementary.]]
+ elementary.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
return: Evas.Object *; [[The inlined image object, or NULL if none exists]]
}
get {
[[Get the current size of the image.
- This is the real size of the image, not the size of the object.]]
+ This is the real size of the image, not the size of the object.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
w: int; [[Pointer to store width, or NULL.]]
* @see elm_image_file_set()
*
* @ingroup Image
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Evas_Object *elm_image_add(Evas_Object *parent);
* unwanted frames.
*
* @ingroup Image
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group);
* @param[out] group The group that the image belongs to, in case it's an
EET (including Edje case) file. This can be used as a key inside
evas image cache if this is a normal image file not eet file.
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_image_file_get(const Eo *obj, const char **file, const char **group);
* @see elm_bg_load_size_set()
*
* @ingroup Image
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_image_prescale_set(Evas_Object *obj, int size);
* @see elm_image_prescale_set()
*
* @ingroup Image
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI int elm_image_prescale_get(const Evas_Object *obj);
* unwanted frames.
*
* @ingroup Image
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI Eina_Bool elm_image_mmap_set(Evas_Object *obj, const Eina_File *file, const char *group);
*
* @param[in] play @c EINA_TRUE to start the animation, @c EINA_FALSE
otherwise. Default is @c EINA_FALSE.
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_image_animated_play_set(Evas_Object *obj, Eina_Bool play);
*
* @ingroup Image
* @since 1.7
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Eina_Bool elm_image_animated_play_get(const Evas_Object *obj);
*
* @param[in] anim @c EINA_TRUE if the object is to animate itself,
* @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_image_animated_set(Evas_Object *obj, Eina_Bool anim);
* @ingroup Image
* @since 1.7
*
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Eina_Bool elm_image_animated_get(const Evas_Object *obj);
* @ingroup Image
* @since 1.7
*
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Eina_Bool elm_image_animated_available_get(const Evas_Object *obj);
@property autohide_disabled {
[[Enable or disable auto hiding feature for a given index widget.]]
set {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
disabled: bool; [[$true to disable auto hiding, $false to enable]]
@since 1.8]]
set {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
enabled: bool; [[$true to enable omit feature, $false to disable]]
@since 1.16]]
set {
+ [[
+ \@if MOBILE \@since_tizen 3.0
+ \@elseif WEARABLE \@since_tizen 3.0
+ \@endif
+ ]]
}
get {
+ [[
+ \@if MOBILE \@since_tizen 3.0
+ \@elseif WEARABLE \@since_tizen 3.0
+ \@endif
+ ]]
}
values {
priority: int; [[$priority target priority value in index]]
On horizontal mode items are displayed on index from left to right,
instead of from top to bottom. Also, the index will scroll horizontally.]]
set {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
horizontal: bool; [[$true to enable horizontal or $false to
Note: delay time is 0.2 sec by default.]]
set {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
dtime: double; [[The delay change time to set.]]
In Index widget, Indicator notes popup text, which shows a letter has been selecting.]]
set {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
disabled: bool; [[$true to disable it, $false to enable it]]
See: elm_index_item_level_get()]]
set {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
level: int; [[$0 or $1, the currently implemented levels.]]
go. You should call this before any changes you expect to work. This
is similar to elm_list_go().
- Warning: If not called, it won't display the index properly.]]
+ Warning: If not called, it won't display the index properly.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
params {
@in level: int; [[The index level (one of $0 or $1) where changes were made]]
}
entries.
$item will be the pointer returned back on $"changed",
- "delay,changed" and $"selected" smart events.]]
+ "delay,changed" and $"selected" smart events.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
return: Elm.Widget_Item *; [[A handle to the item added or $NULL, on errors]]
params {
[[Removes all items from a given index widget.
If deletion callbacks are set, via elm_object_item_del_cb_set(),
- that callback function will be called for each item in $obj.]]
+ that callback function will be called for each item in $obj.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
item_insert_after {
[[Insert a new item into the index object after item $after.
"delay,changed" and $"selected" smart events.
Note: If $relative is $NULL this function will behave as
- elm_index_item_append().]]
+ elm_index_item_append().
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
return: Elm.Widget_Item *; [[A handle to the item added or $NULL, on errors]]
params {
}
}
item_find {
- [[Find a given index widget's item, using item data.]]
+ [[Find a given index widget's item, using item data.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
return: Elm.Widget_Item *; [[The index item handle, if found, or $NULL otherwise]]
params {
"delay,changed" and $"selected" smart events.
Note: If $relative is $NULL this function will behave as
- elm_index_item_prepend().]]
+ elm_index_item_prepend().
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
return: Elm.Widget_Item *; [[A handle to the item added or $NULL, on errors]]
params {
entries.
$item will be the pointer returned back on $"changed",
- "delay,changed" and $"selected" smart events.]]
+ "delay,changed" and $"selected" smart events.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
return: Elm.Widget_Item *; [[A handle to the item added or $NULL, on errors]]
params {
}
}
selected_item_get @const {
- [[Returns the last selected item, for a given index widget.]]
+ [[Returns the last selected item, for a given index widget.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
return: Elm.Widget_Item *; [[The last item selected on $obj (or $NULL, on errors).]]
params {
entries.
$item will be the pointer returned back on $"changed",
- "delay,changed" and $"selected" smart events.]]
+ "delay,changed" and $"selected" smart events.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
return: Elm.Widget_Item *; [[A handle to the item added or $NULL, on errors]]
params {
Previously selected item can be get with function
elm_index_selected_item_get().
- Selected items will be highlighted.]]
+ Selected items will be highlighted.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
selected: bool; [[$true if selected, $false otherwise]]
The value of the priority starts from 0.
In elm_index_level_go, the items are sorted in ascending order according to priority.
- Items of the same priority make a group and the primary group is shown by default.]]
+ Items of the same priority make a group and the primary group is shown by default.
+
+ \@if MOBILE \@since_tizen 3.0
+ \@elseif WEARABLE \@since_tizen 3.0
+ \@endif
+ ]]
}
values {
priority: int; [[The priority]]
}
}
letter_get @const {
- [[Get the letter (string) set on a given index widget item.]]
+ [[Get the letter (string) set on a given index widget item.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
return: const (char)*; [[The letter string set on $item]]
}
}
* This function inserts a new index widget on the canvas.
*
* @ingroup Index
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Evas_Object *elm_index_add(Evas_Object *parent);
}
@property name {
get {
- [[Gets an string describing ATSPI widget role name. Should be free by a user.]]
+ [[Gets an string describing ATSPI widget role name. Should be free by a user.
+
+ \@if MOBILE \@since_tizen 2.4
+ \@elseif WEARABLE \@since_tizen 3.0
+ \@endif
+ ]]
}
set {
+ [[
+ \@if MOBILE \@since_tizen 2.4
+ \@elseif WEARABLE \@since_tizen 3.0
+ \@endif
+ ]]
}
values {
name: char*; [[obj name]]
}
@property role {
get {
- [[Gets the role of the widget in ATSPI Accessibility domain.]]
+ [[Gets the role of the widget in ATSPI Accessibility domain.
+
+ \@if MOBILE \@since_tizen 2.4
+ \@elseif WEARABLE \@since_tizen 3.0
+ \@endif
+ ]]
}
set {
+ [[
+ \@if MOBILE \@since_tizen 2.4
+ \@elseif WEARABLE \@since_tizen 3.0
+ \@endif
+ ]]
}
values {
role: Elm_Atspi_Role;
}
@property description {
get {
- [[Gets widget contextual information.]]
+ [[Gets widget contextual information.
+
+ \@if MOBILE \@since_tizen 2.4
+ \@elseif WEARABLE \@since_tizen 3.0
+ \@endif
+ ]]
}
set {
- [[Sets contextual information about widget.]]
+ [[Sets contextual information about widget.
+
+ \@if MOBILE \@since_tizen 2.4
+ \@elseif WEARABLE \@since_tizen 3.0
+ \@endif
+ ]]
}
values {
description: const(char)*;
@property translation_domain {
get {
[[Gets the translation domain of "name" and "description"
- properties.]]
+ properties.
+
+ \@if MOBILE \@since_tizen 2.4
+ \@elseif WEARABLE \@since_tizen 3.0
+ \@endif
+ ]]
}
set {
[[Sets the translation domain of "name" and "description"
It is application developer responsibility to ensure that
translation files are loaded and binded to translation domain
- when accessibility is enabled.]]
+ when accessibility is enabled.
+
+ \@if MOBILE \@since_tizen 2.4
+ \@elseif WEARABLE \@since_tizen 3.0
+ \@endif
+ ]]
}
values {
domain: const(char)*; [[ translation domain ]]
object A.
return: EINA_TRUE is relationship was successfully appended, EINA_FALSE
- otherwise]]
+ otherwise
+
+ \@if MOBILE \@since_tizen 2.4
+ \@elseif WEARABLE \@since_tizen 3.0
+ \@endif
+ ]]
return: bool;
params {
@in type: Elm_Atspi_Relation_Type;
If relation_object is NULL function removes all relations
of given type.
+
+ \@if MOBILE \@since_tizen 2.4
+ \@elseif WEARABLE \@since_tizen 3.0
+ \@endif
]]
params {
@in type: Elm_Atspi_Relation_Type;
/**
* Free Elm_Atspi_Attributes_List
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI void elm_atspi_attributes_list_free(Eina_List *list);
/**
* Frees relation.
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI void elm_atspi_relation_free(Elm_Atspi_Relation *relation);
/**
* Clones relation.
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI Elm_Atspi_Relation * elm_atspi_relation_clone(const Elm_Atspi_Relation *relation);
/**
* Appends relation to relation set
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI Eina_Bool elm_atspi_relation_set_relation_append(Elm_Atspi_Relation_Set *set, Elm_Atspi_Relation_Type type, const Eo *rel_obj);
/**
* Removes relation from relation set
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI void elm_atspi_relation_set_relation_remove(Elm_Atspi_Relation_Set *set, Elm_Atspi_Relation_Type type, const Eo *rel_obj);
/**
* Removes all relation from relation set of a given type
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI void elm_atspi_relation_set_relation_type_remove(Elm_Atspi_Relation_Set *set, Elm_Atspi_Relation_Type type);
/**
* Frees Elm_Atspi_Relation_Set
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI void elm_atspi_relation_set_free(Elm_Atspi_Relation_Set *set);
/**
* Clones Elm_Atspi_Relation_Set
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI Elm_Atspi_Relation_Set elm_atspi_relation_set_clone(const Elm_Atspi_Relation_Set *set);
/**
* @brief Free Elm_Atspi_Text_Attribute structure
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI void elm_atspi_text_text_attribute_free(Elm_Atspi_Text_Attribute *attr);
onto its content.
The object's theme will also receive the signal "elm,action,show" with
- source "elm".]]
+ source "elm".
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
legacy: elm_win_inwin_activate;
}
* @return The new object or NULL if it cannot be created
*
* @ingroup Inwin
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Evas_Object *elm_win_inwin_add(Evas_Object *parent);
* @param content The object to set as content
*
* @ingroup Inwin
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content);
* @return The content that is being used
*
* @ingroup Inwin
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj);
* @return The content that was being used
*
* @ingroup Inwin
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj);
Warning: This is only relevant if the label is inside a container.]]
set {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
w: Evas.Coord; [[The wrap width in pixels at a minimum where words need to wrap]]
See @.slide_duration.set]]
set {
+ [[
+ \@if MOBILE \@since_tizen 3.0
+ \@elseif WEARABLE \@since_tizen 3.0
+ \@endif
+ ]]
}
get {
+ [[
+ \@if MOBILE \@since_tizen 3.0
+ \@elseif WEARABLE \@since_tizen 3.0
+ \@endif
+ ]]
}
values {
speed: double; [[The speed of the slide animation in px per seconds]]
@since 1.8]]
set {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
mode: Elm.Label.Slide_Mode; [[The slide mode]]
you cannot get the correct duration using this function until the label
is actually rendered and resized.]]
set {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
duration: double; [[The duration in seconds in moving text from slide begin position to slide end position]]
$ELM_WRAP_WORD - wrap between words
$ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap]]
set {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
wrap: Elm.Wrap.Type; [[To wrap text or not]]
Warning This doesn't work with slide(elm_label_slide_set()) or if the
chosen wrap method was $ELM_WRAP_WORD.]]
set {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
ellipsis: bool; [[To ellipsis text or not]]
slide_go {
[[Start slide effect.
- See @.slide_mode.set.]]
+ See @.slide_mode.set.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
}
implements {
* @return The new object or NULL if it cannot be created
*
* @ingroup Label
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Evas_Object *elm_label_add(Evas_Object *parent);
[[Set accessibility to all texblock(text) parts in the layout
object.
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+
@since 1.7
]]
return: bool; [[$true on success or $false on failure. If $obj
[[Get accessibility state of texblock(text) parts in the layout
object
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+
@since 1.7
]]
}
Note that $style will be the new style of $obj too, as in an
\@ref elm_object_style_set call.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
return: bool;
}
All the common stuff (setting text, emitting signals,
hooking callbacks to signals, etc.) can be done with
proper elementary functions.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
return: Evas.Object *; [[An Evas_Object with the edje layout
settings loaded \@ref elm_layout_file_set.]]
The objects will be removed from the box part and their lifetime
will not be handled by the layout anymore. This is equivalent to
@.box_remove for all box children.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
return: bool;
params {
Note: Before you set if should look on theme you should define a
cursor with @.part_cursor_set. By default it will only look for
cursors provided by the engine.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
return: bool; [[$true on success or $false on failure, that may be
part not exists or it did not had a cursor set.]]
}
}
part_cursor_engine_only_get @const {
- [[Get a specific cursor engine_only for an edje part.]]
+ [[Get a specific cursor engine_only for an edje part.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
return: bool; [[Whenever the cursor is just provided by engine
or also from theme.]]
params {
The object will be unpacked from the table part and its lifetime
will not be handled by the layout anymore. This is equivalent to
\@ref elm_layout_content_unset for table.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
return: Evas.Object *; [[The object that was being used, or $null if not found.]]
params {
nest, requiring an equal number of thaws.
See also @.thaw.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
return: int; [[The frozen state or 0 on error.]]
}
Also note that a standard signal of "size,eval" "elm" emitted
from the edje object will cause this to happen too.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
box_remove {
The object will be removed from the box part and its lifetime
will not be handled by the layout anymore. This is equivalent to
\@ref elm_layout_content_unset for box.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
return: Evas.Object *; [[The object that was being used, or $null if not found.]]
params {
Calling this function will restrict the minimum size in the Edje
calculation to whatever size it the layout has at the moment.
+ \@if MOBILE \@since_tizen 3.0
+ \@elseif WEARABLE \@since_tizen 3.0
+ \@endif
+
@since 1.8
]]
params {
}
}
part_cursor_style_set {
- [[Sets a specific cursor style for an edje part.]]
+ [[Sets a specific cursor style for an edje part.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
return: bool; [[True on success or false on failure, that may be
part not exists or it did not had a cursor set.]]
params {
}
}
part_cursor_style_get @const {
- [[Get a specific cursor style for an edje part.]]
+ [[Get a specific cursor style for an edje part.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
return: const(char)*; [[The theme style in use, defaults to "default".
If the object does not have a cursor set,
then $null is returned.]]
}
}
text_set {
- [[Set the text of the given part.]]
+ [[Set the text of the given part.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
return: bool;
params {
@in part: const(char)* @nullable; [[The TEXT part where to set the text.]]
}
}
text_get @const {
- [[Get the text set in the given part.]]
+ [[Get the text set in the given part.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
return: const(char)*;
params {
@in part: const(char)*; [[The TEXT part to retrieve the text off.]]
This function connects a callback function to a signal emitted by
the underlying Edje object of $obj. Globs are accepted in either
the emission or source strings.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
params {
@in emission: const(char)*; [[The signal's name string.]]
}
}
part_cursor_set {
- [[Sets a specific cursor for an edje part.]]
+ [[Sets a specific cursor for an edje part.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
return: bool; [[$true on success or $false on failure, that may be
part not exists or it has "mouse_events: 0".]]
params {
}
}
part_cursor_get @const {
- [[Get the cursor to be shown when mouse is over an edje part.]]
+ [[Get the cursor to be shown when mouse is over an edje part.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
return: const(char)*;
params {
@in part_name: const(char)*; [[A part from loaded edje group.]]
Its lifetime will be bound to the layout, whenever the layout
dies the child will be deleted automatically. One should use
@.box_remove to make this layout forget about the object.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
return: bool;
params {
Its lifetime will be bound to the layout, whenever the layout
dies the child will be deleted automatically. One should use
@.box_remove to make this layout forget about the object.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
return: bool;
params {
In EDC this comes from a data block within the group block that
$obj was loaded from.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
/* FIXME-doc
@code
Its lifetime will be bound to the layout, whenever the layout
dies the child will be deleted automatically. One should use
@.box_remove to make this layout forget about the object.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
return: bool;
params {
$emission, $source and $func matching exactly those passed to a
previous call to @.signal_callback_add. The data pointer that
was passed to this call will be returned.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
return: void *; [[The data pointer of the signal callback (passed on
@.signal_callback_add) or $null on errors.]]
thaws will be required.
See also @.freeze.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
return: int; [[The frozen state or 0 if the object is not frozen or on error.]]
}
Its lifetime will be bound to the layout, whenever the layout
dies the child will be deleted automatically. One should use
@.box_remove to make this layout forget about the object.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
return: bool;
params {
$obj. An Edje program on that Edje object's definition can
respond to a signal by specifying matching 'signal' and
'source' fields.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
params {
@in emission: const(char)*; [[The signal's name string.]]
more space than a single cell.
See also @.table_unpack, @.table_clear.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
/* FIXME-doc
For instance, the following code:
}
}
part_cursor_unset {
- [[Unsets a cursor previously set with @.part_cursor_set.]]
+ [[Unsets a cursor previously set with @.part_cursor_set.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
return: bool;
params {
@in part_name: const(char)*; [[A part from loaded edje group,
The objects will be removed from the table part and their
lifetime will not be handled by the layout anymore. This
is equivalent to @.table_unpack for all table children.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
return: bool;
params {
* @see elm_layout_theme_set()
*
* @ingroup Layout
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Evas_Object *elm_layout_add(Evas_Object *parent);
* @since 1.9
*
* @ingroup Layout
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI Eina_List *elm_layout_content_swallow_list_get(const Evas_Object *obj);
* @see @ref secBox
*
* @ingroup Layout
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Eina_Bool elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content);
* @return The swallowed object or NULL if none or an error occurred
*
* @ingroup Layout
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow);
* Unparent and return the content object which was set for this part.
*
* @ingroup Layout
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow);
*
* @param[in] file The path to file (edj) that will be used as layout
* @param[in] group The group that the layout belongs in edje file
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Eina_Bool elm_layout_file_set(Eo *obj, const char *file, const char *group);
* @param group The group that the layout belongs in edje file
*
* @since 1.14
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI void elm_layout_file_get(Eo *obj, const char **file, const char **group);
Each item will presents left icon on top and right icon, or end, at
the bottom.]]
set {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
horizontal: bool; [[$true to enable horizontal or $false to disable it, i.e., to enable vertical mode.]]
entirely and they will neither appear selected nor call selected
callback functions.]]
set {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
mode: Elm.Object.Select_Mode(Elm.Object.Select_Mode.max); [[The select mode]]
clicking an unfocusable area in an item or selecting it with a key movement. Clicking on a
focusable widget inside an item will couse this particular item to get focus as usual.]]
set {
+ [[
+ \@if MOBILE \@since_tizen 3.0
+ \@elseif WEARABLE \@since_tizen 3.0
+ \@endif
+ ]]
}
get {
+ [[
+ \@if MOBILE \@since_tizen 3.0
+ \@elseif WEARABLE \@since_tizen 3.0
+ \@endif
+ ]]
}
values {
enabled: bool; [[The tree effect status (true = enabled, false = disabled)]]
If a selected item is selected again, it will be unselected.]]
set {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
multi: bool; [[$true to enable multi selection or $false to disable it.]]
@since 1.8]]
set {
+ [[
+ \@if MOBILE \@since_tizen 3.0
+ \@elseif WEARABLE \@since_tizen 3.0
+ \@endif
+ ]]
}
get {
+ [[
+ \@if MOBILE \@since_tizen 3.0
+ \@elseif WEARABLE \@since_tizen 3.0
+ \@endif
+ ]]
}
values {
mode: Elm.Object.Multi_Select_Mode(Elm.Object.Multi_Select_Mode.max); [[The multi select mode]]
elm_scroller_content_min_limit(), so use either one of them, but
not both.]]
set {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
mode: Elm.List.Mode(Elm.List.Mode.last); [[One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL, #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.]]
The selected item can be unselected with function
elm_list_item_selected_set().
- The selected item always will be highlighted on list.]]
+ The selected item always will be highlighted on list.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
return: Elm.Widget_Item *; [[The selected list item.]]
}
}
@property items {
get {
- [[Get a list of all the list items.]]
+ [[Get a list of all the list items.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
return: const(list<Elm.Widget_Item *>)*; [[A $list of list items, #Elm.Widget_Item, or $NULL on failure.]]
}
get {
[[Get the first item in the list
- This returns the first item in the list.]]
+ This returns the first item in the list.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
return: Elm.Widget_Item *; [[The first item, or NULL if none]]
}
[[Return a list of the currently selected list items.
Multiple items can be selected if multi select is enabled. It can be
- done with elm_list_multi_select_set().]]
+ done with elm_list_multi_select_set().
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
return: const(list<Elm.Widget_Item *>)*; [[An $list of list items, #Elm.Widget_Item, or $NULL on failure.]]
}
get {
[[Get the last item in the list
- This returns the last item in the list.]]
+ This returns the last item in the list.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
return: Elm.Widget_Item *; [[The last item, or NULL if none]]
}
Note: Remember that the label parameter is copied inside the list. So if an
application dynamically allocated the label, the application should free the
- label after this call.]]
+ label after this call.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
return: Elm.Widget_Item *; [[The created item or $NULL upon failure.]]
params {
[[Starts the list.
Note: Call before running show() on the list object.
- Warning: If not called, it won't display the list properly.]]
+ Warning: If not called, it won't display the list properly.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
/* FIXME-doc
@code
Note: Remember that the label parameter is copied inside the list. So if an
application dynamically allocated the label, the application should free the
- label after this call.]]
+ label after this call.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
return: Elm.Widget_Item *; [[The created item or $NULL upon failure.]]
params {
middle section (0) or on the lower part (1). If NULL is returned as
an item (no item found there), then posret may indicate -1 or 1
based if the coordinate is above or below all items respectively in
- the list.]]
+ the list.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
return: Elm.Widget_Item *; [[The item at the coordinates or NULL if none]]
params {
Note: Remember that the label parameter is copied inside the list. So if an
application dynamically allocated the label, the application should free the
- label after this call.]]
+ label after this call.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
/* FIXME-doc
Simple example (with no function callback or data associated):
Note: Remember that the label parameter is copied inside the list. So if an
application dynamically allocated the label, the application should free the
- label after this call.]]
+ label after this call.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
return: Elm.Widget_Item *; [[The created item or $NULL upon failure.]]
params {
}
}
clear {
- [[Remove all list's items.]]
+ [[Remove all list's items.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
item_sorted_insert {
[[Insert a new item into the sorted list object.
Note: Remember that the label parameter is copied inside the list. So if an
application dynamically allocated the label, the application should free the
- label after this call.]]
+ label after this call.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
return: Elm.Widget_Item *; [[The created item or $NULL upon failure.]]
params {
methods {
@property separator {
get {
- [[Get a value whether item is a separator or not.]]
+ [[Get a value whether item is a separator or not.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
set {
[[Set or unset item as a separator.
If set as separator it will display separator theme,
so won't display icons or label.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
}
@property selected {
get {
- [[Get whether the item is selected or not.]]
+ [[Get whether the item is selected or not.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
set {
[[Set the selected state of an item.
\@ref elm_list_selected_item_get.
Selected items will be highlighted.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
Base object is the $Evas_Object that represents that
item.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
[[Get the item before the item in list.
Note: If it is the first item, $null will be returned.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
legacy: elm_list_item_prev;
}
[[Get the item after the item in list.
Note: If it is the last item, $null will be returned.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
legacy: elm_list_item_next;
}
It won't animate list until item is visible. If such
behavior is wanted, use @.bring_in instead.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
bring_in {
This may use animation to do so and take a period of time.
If animation isn't wanted, @.show can be used.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
}
* This function inserts a new list widget on the canvas.
*
* @ingroup List
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Evas_Object *elm_list_add(Evas_Object *parent);
This function should be used when zoom mode is set to
#ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and
can be set with @.zoom_mode.set.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
#ELM_MAP_ZOOM_MODE_MANUAL (which is the default), the zoom
level may be changed at any time by the map object itself
to account for map size and map viewport size.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
This will stop zooming using animation, changing zoom levels
will change instantly. This will stop any existing animations
that are running.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
[[Get a value whether map is paused or not.
This gets the current paused state for the map object.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
map.
Wheel is enabled by default.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
Mouse wheel can be used for the user to zoom in or zoom out
the map.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
}
@property zoom_min {
set {
- [[Set the minimum zoom of the source.]]
+ [[Set the minimum zoom of the source.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
- [[Get the minimum zoom of the source.]]
+ [[Get the minimum zoom of the source.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
zoom: int(-1); [[Minimum zoom value to be used.]]
}
@property rotate {
set {
- [[Rotate the map.]]
+ [[Rotate the map.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
- [[Get the rotate degree of the map.]]
+ [[Get the rotate degree of the map.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
degree: double; [[Angle from 0.0 to 360.0 to rotate around Z axis.]]
The $user_agent identification string will transmitted in
a header field $User-Agent.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
- [[Get the user agent used by the map object.]]
+ [[Get the user agent used by the map object.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
user_agent: const(char)*; [[The user agent to be used by the map.]]
}
@property zoom_max {
set {
- [[Set the maximum zoom of the source.]]
+ [[Set the maximum zoom of the source.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
- [[Get the maximum zoom of the source.]]
+ [[Get the maximum zoom of the source.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
zoom: int(-1); [[Maximum zoom value to be used.]]
ensure no pixels within the frame are left unfilled. Do not
forget that the valid sizes are 2^zoom, consequently the map
may be smaller than the scroller view.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
This function returns the current zoom mode used by the ma
object.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
This gets the current center coordinates of the map object.
It can be set by @.region_bring_in and @.region_show.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
This list includes group overlays also.
So this can be changed dynamically while zooming and panning.
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+
@since 1.7
]]
return: list<Elm_Map_Overlay *> *; [[The list of all overlays or $null upon failure.]]
[[Get the information of tile load status.
This gets the current tile loaded status for the map object.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
@.sources_get.
The current source can be get using @.source_get.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
params {
@in type: Elm_Map_Source_Type; [[Source type.]]
}
}
source_get @const {
- [[Get the name of currently used source for a specific type.]]
+ [[Get the name of currently used source for a specific type.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
return: const(char)*; [[The name of the source in use.]]
params {
@in type: Elm_Map_Source_Type; [[Source type.]]
Routes created with this method can be deleted with
\@ref elm_map_route_del and distance can be get with
\@ref elm_map_route_distance_get.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
return: Elm_Map_Route *; [[The created route or $null upon failure.]]
params {
}
}
track_add {
- [[Add a track on the map.]]
+ [[Add a track on the map.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
return: Evas.Object *; [[The route object. This is an elm object of type Route.]]
params {
@in emap: void *; [[The emap route object.]]
This gets canvas x, y coordinates from longitude and latitude.
The canvas coordinates mean x, y coordinate from current viewport.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
params {
@in lon: double; [[The longitude to convert.]]
Overlay created with this method can be deleted with
\@ref elm_map_overlay_del.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
return: Elm_Map_Overlay *; [[The created overlay or $null upon failure.]]
Also these changes have a influence on the overlays in the
same class even if each overlay is alone and is not grouped.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
return: Elm_Map_Overlay *; [[The created overlay or $null upon failure.]]
}
Overlay created with this method can be deleted with
\@ref elm_map_overlay_del.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
return: Elm_Map_Overlay *; [[The created overlay or $null upon failure.]]
}
At least available sources of route type are "Yours".
At least available sources of name type are "Nominatim".
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
return: const(char)**; [[The char pointer array of source names.]]
params {
Overlay created with this method can be deleted with
\@ref elm_map_overlay_del.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
return: Elm_Map_Overlay *; [[The created overlay or $null upon failure.]]
}
Overlay created with this method can be deleted with
\@ref elm_map_overlay_del.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
return: Elm_Map_Overlay *; [[The created overlay or $null upon failure.]]
params {
center of the map.
See @.region_bring_in for a function to move with animation.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
params {
@in lon: double; [[Longitude to center at.]]
To get the longitude and latitude, \@ref elm_map_region_get
should be used.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
return: Elm_Map_Name *; [[A #Elm_Map_Name handle for this coordinate.]]
params {
\@internal
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+
@since 1.8
]]
params {
take a period of time to complete.
See @.region_show for a function to avoid animation.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
params {
@in lon: double; [[Longitude to center at.]]
See also @.region_bring_in.
+ \@if MOBILE \@since_tizen 3.0
+ \@elseif WEARABLE \@since_tizen 3.0
+ \@endif
+
@since 1.11
]]
params {
}
}
track_remove {
- [[Remove a track from the map.]]
+ [[Remove a track from the map.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
params {
@in route: Evas.Object *; [[The track to remove.]]
}
Overlay created with this method can be deleted with
\@ref elm_map_overlay_del.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
return: Elm_Map_Overlay *; [[The created overlay or $null upon failure.]]
params {
Overlay created with this method can be deleted with
\@ref elm_map_overlay_del.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
return: Elm_Map_Overlay *; [[The created overlay or $null upon failure.]]
params {
Overlay created with this method can be deleted by
\@ref elm_map_overlay_del.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
return: Elm_Map_Overlay *; [[The created overlay or $null upon failure.]]
params {
This gets longitude and latitude from canvas x, y coordinates.
The canvas coordinates mean x, y coordinate from current viewport.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
params {
@in x: Evas.Coord; [[Horizontal coordinate of the point to convert.]]
* @see elm_map_overlay_add()
* @see elm_map_overlay_class_add()
* @see elm_map_overlay_bubble_add()
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_map_overlay_del(Elm_Map_Overlay *overlay);
* @see elm_map_overlay_add()
* @see elm_map_overlay_class_add()
* @see elm_map_overlay_bubble_add()
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Elm_Map_Overlay_Type elm_map_overlay_type_get(const Elm_Map_Overlay *overlay);
* @param data A pointer of user data
*
* @see elm_map_overlay_data_get()
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_map_overlay_data_set(Elm_Map_Overlay *overlay, void *data);
* or @c NULL, if none has been set.
*
* @see elm_map_overlay_data_set()
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void * elm_map_overlay_data_get(const Elm_Map_Overlay *overlay);
* @param hide Use @c EINA_TRUE to hide the overlay or @c EINA_FALSE to show.
*
* @see elm_map_overlay_hide_get()
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_map_overlay_hide_set(Elm_Map_Overlay *overlay, Eina_Bool hide);
* This gets the current hidden state for the overlay.
*
* @see elm_map_overlay_hide_set()
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Eina_Bool elm_map_overlay_hide_get(const Elm_Map_Overlay *overlay);
* or bigger.
*
* @see elm_map_overlay_displayed_zoom_min_get()
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_map_overlay_displayed_zoom_min_set(Elm_Map_Overlay *overlay, int zoom);
* @return zoom The minimum zoom.
*
* @see elm_map_overlay_displayed_zoom_min_set()
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI int elm_map_overlay_displayed_zoom_min_get(const Elm_Map_Overlay *overlay);
* even if map being scrolled or zoomed.
*
* @see elm_map_overlay_paused_get()
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_map_overlay_paused_set(Elm_Map_Overlay *overlay, Eina_Bool paused);
* This gets the current paused state for the overlay.
*
* @see elm_map_overlay_paused_set()
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Eina_Bool elm_map_overlay_paused_get(const Elm_Map_Overlay *overlay);
* This value can be changed dynamically while zooming and panning
*
* @since 1.7
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Eina_Bool elm_map_overlay_visible_get(const Elm_Map_Overlay *overlay);
* If @p obj is @c NULL, content inside the overlay is deleted.
*
* @see elm_map_overlay_content_get()
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_map_overlay_content_set(Elm_Map_Overlay *overlay, Evas_Object *obj);
* The content can be set by elm_map_overlay_content_set().
*
* @see elm_map_overlay_content_set()
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI const Evas_Object * elm_map_overlay_content_get(const Elm_Map_Overlay *overlay);
* If @p icon is @c NULL, icon inside the overlay will be deleted.
*
* @see elm_map_overlay_icon_get()
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_map_overlay_icon_set(Elm_Map_Overlay *overlay, Evas_Object *icon);
* The icon can be set by elm_map_overlay_icon_set().
*
* @see elm_map_overlay_icon_set()
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI const Evas_Object * elm_map_overlay_icon_get(const Elm_Map_Overlay *overlay);
* get by elm_map_overlay_region_get().
*
* @see elm_map_overlay_region_get()
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_map_overlay_region_set(Elm_Map_Overlay *overlay, double lon, double lat);
* set by elm_map_overlay_region_set().
*
* @see elm_map_overlay_region_set()
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_map_overlay_region_get(const Elm_Map_Overlay *overlay, double *lon, double *lat);
* and ELM_MAP_OVERLAY_TYPE_ROUTE Elm_Map_Overlay_Type types.
*
* @see elm_map_overlay_color_get()
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_map_overlay_color_set(Elm_Map_Overlay *overlay, int r, int g, int b, int a);
* @param a Pointer to store the alpha channel value.
*
* @see elm_map_overlay_color_set()
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_map_overlay_color_get(const Elm_Map_Overlay *overlay, int *r, int *g, int *b, int *a);
* moved to the center of the map.
*
* @see elm_map_overlays_show() if more than one overlay need to be displayed.
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_map_overlay_show(Elm_Map_Overlay *overlay);
* @warning All the overlays should belong to the same map object.
*
* @see elm_map_overlay_show() to show a single overlay.
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_map_overlays_show(Eina_List *overlays);
* is clicked, callback will be called and return a virtual group overlays.
*
* You can delete this callback function by setting @c NULL.
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_map_overlay_get_cb_set(Elm_Map_Overlay *overlay, Elm_Map_Overlay_Get_Cb get_cb, void *data);
* You can delete this callback function by setting @c NULL.
*
* @since 1.7
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_map_overlay_del_cb_set(Elm_Map_Overlay *overlay, Elm_Map_Overlay_Del_Cb del_cb, void *data);
* @param overlay The overlay to be added to the class overlay.
*
* @see elm_map_overlay_class_remove()
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_map_overlay_class_append(Elm_Map_Overlay *clas, Elm_Map_Overlay *overlay);
* @param overlay The overlay to be deleted from the class overlay.
*
* @see elm_map_overlay_class_append()
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_map_overlay_class_remove(Elm_Map_Overlay *clas, Elm_Map_Overlay *overlay);
* is displayed at less than @p zoom.
*
* @see elm_map_overlay_class_zoom_max_get()
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_map_overlay_class_zoom_max_set(Elm_Map_Overlay *clas, int zoom);
* @return The maximum zoom.
*
* @see elm_map_overlay_class_zoom_max_set()
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI int elm_map_overlay_class_zoom_max_get(const Elm_Map_Overlay *clas);
* Do not modifty the group overlay itself.
*
* @see elm_map_overlay_class_add()
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Eina_List * elm_map_overlay_group_members_get(const Elm_Map_Overlay *grp);
* Bubble overlay will follow the parent overlay's movement (hide, show, move).
*
* @see elm_map_overlay_bubble_add()
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_map_overlay_bubble_follow(Elm_Map_Overlay *bubble, const Elm_Map_Overlay *parent);
* Added contents will be displayed inside the bubble overlay.
*
* @see elm_map_overlay_bubble_content_clear()
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_map_overlay_bubble_content_append(Elm_Map_Overlay *bubble, Evas_Object *content);
* This will delete all contents inside the bubble overlay.
*
* @see elm_map_overlay_bubble_content_append()
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_map_overlay_bubble_content_clear(Elm_Map_Overlay *bubble);
*
* @see elm_map_overlay_polygon_add()
* @see elm_map_overlay_del()
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_map_overlay_polygon_region_add(Elm_Map_Overlay *overlay, double lon, double lat);
* @param route The route to remove.
*
* @see elm_map_route_add()
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_map_route_del(Elm_Map_Route *route);
*
* @param route The route object.
* @return The distance of route (unit : km).
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI double elm_map_route_distance_get(const Elm_Map_Route *route);
*
* @param route The route object.
* @return Returns a string with the nodes of route.
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route);
*
* @param route the route object.
* @return Returns a string with information about waypoint of route.
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route);
* conversion functions.
*
* @see elm_map_name_add()
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name);
* conversion functions.
*
* @see elm_map_name_add()
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat);
* between address and coordinates will be lost.
*
* @see elm_map_name_add()
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_map_name_del(Elm_Map_Name *name);
* This function inserts a new map widget on the canvas.
*
* @ingroup Map
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Evas_Object *elm_map_add(Evas_Object *parent);
base on current properties of the mapbuf object.
Auto mode is disabled by default.
+
+ \@if MOBILE \@since_tizen 3.0
+ \@elseif WEARABLE \@since_tizen 3.0
+ \@endif
]]
}
get {
- [[Get a value whether auto mode is enabled or not.]]
+ [[Get a value whether auto mode is enabled or not.
+
+ \@if MOBILE \@since_tizen 3.0
+ \@elseif WEARABLE \@since_tizen 3.0
+ \@endif
+ ]]
}
values {
on: bool; [[The auto mode state.]]
smooth settings for this object and the map must be turned off.
By default smooth maps are enabled.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
- [[Get a value whether smooth map rendering is enabled or not.]]
+ [[Get a value whether smooth map rendering is enabled or not.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
smooth: bool; [[The smooth mode state.]]
object and/or all sub-objects is 100% solid.
Alpha is enabled by default.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
- [[Get a value whether alpha blending is enabled or not.]]
+ [[Get a value whether alpha blending is enabled or not.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
alpha: bool; [[The alpha state.]]
to enabling the map will be restored.
It's disabled by default.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
- [[Get a value whether map is enabled or not.]]
+ [[Get a value whether map is enabled or not.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
enabled: bool; [[The enabled state.]]
solid (255, 255, 255, 255) which means it will have no affect
on modifying the texture pixels.
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+
@since 1.9
]]
params {
This gets the color set by @.point_color_set on the given vertex
of the mapbuf.
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+
@since 1.9
]]
params {
* This function inserts a new mapbuf widget on the canvas.
*
* @ingroup Mapbuf
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent);
eo_prefix: elm_obj_menu;
methods {
@property selected_item {
- get {
+ get @internal {
[[Get the selected item in the menu.]]
return: Elm.Widget_Item *; [[The selected item or $null.]]
}
}
@property items {
- get {
+ get @internal {
[[Returns a list of the item's items.]]
return: const(list<Elm.Widget_Item *>)*;
}
}
@property first_item {
- get {
+ get @internal {
[[Get the first item in the menu.]]
return: Elm.Widget_Item *;
}
}
@property last_item {
- get {
+ get @internal {
[[Get the last item in the menu.]]
return: Elm.Widget_Item *;
}
}
- move {
+ move @internal {
[[Move the menu to a new position
Sets the top-left position of the menu to ($x, $y).
@in y: Evas.Coord; [[The new position.]]
}
}
- item_add {
+ item_add @internal {
[[Add an item at the end of the given menu widget.
Note: This function does not accept relative icon path.
@in data: const(void)* @optional; [[Data sent by the callback.]]
}
}
- close {
+ close @internal {
[[Close a opened menu
Hides the menu and all it's sub-menus.
]]
}
- item_separator_add {
+ item_separator_add @internal {
[[Add a separator item to menu $obj under $parent.]]
return: Elm.Widget_Item *; [[The created item or $null.]]
params {
eo_prefix: elm_obj_menu_item;
methods {
@property icon_name {
- get {
+ get @internal {
[[Get the string representation from the icon of a menu item
Once this icon is set, any previously set icon will be deleted.
To hide icon set it to "".
]]
}
- set {
+ set @internal {
[[Set the icon of a menu item to the standard icon with the
given name.
}
}
@property selected {
- get {
+ get @internal {
[[Get the selected state of $item.]]
}
- set {
+ set @internal {
[[Set the selected state of $item.]]
}
values {
[[Get the next item in the menu.]]
return: uint;
}
- subitems_clear {
+ subitems_clear @internal {
[[Remove all sub-items (children) of the given item
This removes all items that are children (and their descendants)
/**
+ * @internal
+ *
* @brief Add a new menu to the parent
*
* @param parent The parent object.
EAPI Evas_Object *elm_menu_add(Evas_Object *parent);
/**
+ * @internal
+ *
* @brief Set the parent for the given menu widget
*
* @param obj The menu object.
EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent);
/**
+ * @internal
+ *
* @brief Get the parent for the given menu widget
*
* @param obj The menu object.
* @return @c EINA_TRUE if mirrored is set, @c EINA_FALSE otherwise
*
* @ingroup Mirroring
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj);
* @param mirrored @c EINA_TRUE to set mirrored mode, @c EINA_FALSE to unset it.
*
* @ingroup Mirroring
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored);
* @return mirrored mode setting of the object.
*
* @ingroup Mirroring
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj);
* manual.
*
* @ingroup Mirroring
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic);
@since 1.7]]
set {
+ [[\@MOBILE_ONLY
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
}
get {
+ [[\@MOBILE_ONLY
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
}
values {
editable: bool; [[If $true, user can add/delete item in multibuttonentry, if not, the multibuttonentry is non-editable.]]
In expanded state, the complete entry will be displayed.
Otherwise, only single line of the entry will be displayed.]]
set {
+ [[\@MOBILE_ONLY
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
}
get {
+ [[\@MOBILE_ONLY
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
}
values {
expanded: bool; [[the value of expanded state. Set this to $true for expanded state. Set this to false for single line state.]]
}
@property format_function {
set {
- [[Set a function to format the string that will be used to display the hidden items counter.
+ [[\@MOBILE_ONLY
+
+ Set a function to format the string that will be used to display the hidden items counter.
If $format_function is $NULL, the default format will be used,
which is $"... + %d".
- @since 1.9]]
+ \@if MOBILE \@since_tizen 3.0
+ \@endif
+
+ @since 1.9
+ ]]
}
values {
format_function: Elm_Multibuttonentry_Format_Cb @nullable; [[format_function The actual format function]]
}
@property items {
get {
- [[Get a list of items in the multibuttonentry]]
+ [[\@MOBILE_ONLY
+
+ Get a list of items in the multibuttonentry
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
return: const(list<Elm.Widget_Item *>)*; [[The list of items, or NULL if none]]
}
}
@property first_item {
get {
- [[Get the first item in the multibuttonentry]]
+ [[\@MOBILE_ONLY
+
+ Get the first item in the multibuttonentry
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
return: Elm.Widget_Item *; [[The first item, or NULL if none]]
}
}
@property last_item {
get {
- [[Get the last item in the multibuttonentry]]
+ [[\@MOBILE_ONLY
+
+ Get the last item in the multibuttonentry
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
return: Elm.Widget_Item *; [[The last item, or NULL if none]]
}
}
@property entry {
get {
- [[Get the entry of the multibuttonentry object]]
+ [[\@MOBILE_ONLY
+
+ Get the entry of the multibuttonentry object
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
return: Evas.Object *; [[The entry object, or NULL if none]]
}
}
@property selected_item {
get {
- [[Get the selected item in the multibuttonentry]]
+ [[\@MOBILE_ONLY
+
+ Get the selected item in the multibuttonentry
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
return: Elm.Widget_Item *; [[The selected item, or NULL if none]]
}
}
item_prepend {
- [[Prepend a new item to the multibuttonentry
+ [[\@MOBILE_ONLY
- See @Elm.Widget_Item.del to delete the item.]]
+ Prepend a new item to the multibuttonentry
+
+ See @Elm.Widget_Item.del to delete the item.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
return: Elm.Widget_Item *; [[A handle to the item added or NULL if not possible]]
params {
}
}
clear {
- [[Remove all items in the multibuttonentry.]]
+ [[\@MOBILE_ONLY
+
+ Remove all items in the multibuttonentry.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
}
item_filter_remove {
- [[Remove a filter from the list
+ [[\@MOBILE_ONLY
+
+ Remove a filter from the list
Removes the given callback from the filter list. See elm_multibuttonentry_item_filter_append()
- for more information.]]
+ for more information.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
params {
@in func: Elm_Multibuttonentry_Item_Filter_Cb; [[The filter function to remove]]
}
}
item_insert_before {
- [[Add a new item to the multibuttonentry before the indicated object reference.
+ [[\@MOBILE_ONLY
+
+ Add a new item to the multibuttonentry before the indicated object reference.
+
+ See @Elm.Widget_Item.del to delete the item.
- See @Elm.Widget_Item.del to delete the item.]]
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
return: Elm.Widget_Item *; [[A handle to the item added or NULL if not possible]]
params {
}
}
item_append {
- [[Append a new item to the multibuttonentry
+ [[\@MOBILE_ONLY
- See @Elm.Widget_Item.del to delete the item.]]
+ Append a new item to the multibuttonentry
+
+ See @Elm.Widget_Item.del to delete the item.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
return: Elm.Widget_Item *; [[A handle to the item added or NULL if not possible]]
params {
}
}
item_filter_prepend {
- [[Prepend a filter function for text inserted in the Multibuttonentry
+ [[\@MOBILE_ONLY
+
+ Prepend a filter function for text inserted in the Multibuttonentry
Prepend the given callback to the list. See elm_multibuttonentry_item_filter_append()
- for more information]]
+ for more information
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
params {
@in func: Elm_Multibuttonentry_Item_Filter_Cb; [[The function to use as text filter]]
@in data: void *; [[User data to pass to $func]]
}
}
item_filter_append {
- [[Append an item filter function for text inserted in the Multibuttonentry
+ [[\@MOBILE_ONLY
+
+ Append an item filter function for text inserted in the Multibuttonentry
Append the given callback to the list. This functions will be called
whenever any text is inserted into the Multibuttonentry, with the text to be inserted
it wants, but it must remember to free the given pointer and update it.
If the new text is to be discarded, the function can free it and set it text
parameter to NULL. This will also prevent any following filters from being
- called.]]
+ called.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
params {
@in func: Elm_Multibuttonentry_Item_Filter_Cb; [[The function to use as item filter]]
}
}
item_insert_after {
- [[Add a new item to the multibuttonentry after the indicated object
+ [[\@MOBILE_ONLY
+
+ Add a new item to the multibuttonentry after the indicated object
+
+ See @Elm.Widget_Item.del to delete the item.
- See @Elm.Widget_Item.del to delete the item.]]
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
return: Elm.Widget_Item *; [[A handle to the item added or NULL if not possible]]
params {
@property selected {
[[Control the selected state of an item]]
get {
+ [[\@MOBILE_ONLY
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
}
set {
+ [[\@MOBILE_ONLY
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
}
values {
selected: bool; [[$true if selected $false otherwise]]
}
}
prev_get @const {
- [[Get the previous item in the multibuttonentry]]
+ [[\@MOBILE_ONLY
+
+ Get the previous item in the multibuttonentry
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
return: Elm.Widget_Item *; [[The item before the item]]
}
next_get @const {
- [[Get the next item in the multibuttonentry]]
+ [[\@MOBILE_ONLY
+
+ Get the next item in the multibuttonentry
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
return: Elm.Widget_Item *; [[The item after the item]]
}
}
Warning: Events will be blocked by calling evas_object_freeze_events_set()
internally. So don't call the API whiling pushing/popping items.]]
set {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
enabled: bool; [[Events are received when enabled is $true, and ignored otherwise.]]
@property content_preserve_on_pop {
[[Preserve the content objects when items are popped.]]
set {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
preserve: bool; [[Enable the preserve mode if $true, disable otherwise]]
@property prev_btn_auto_pushed {
[[Control if creating prev button automatically or not]]
set {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
auto_pushed: bool; [[If $true, the previous button(back button) will be created internally when you pass the $NULL to the prev_btn parameter in elm_naviframe_item_push]]
}
@property items {
get {
- [[Get a list of all the naviframe items.]]
+ [[Get a list of all the naviframe items.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
return: free(own(list<Elm.Widget_Item *> *), eina_list_free) @warn_unused; [[A list of naviframe items, @Elm.Widget_Item, or $NULL on failure. Note: The returned list MUST be freed.]]
}
}
@property top_item {
get {
- [[Get a top item on the naviframe stack]]
+ [[Get a top item on the naviframe stack
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
return: Elm.Widget_Item *; [[The top item on the naviframe stack or $NULL, if the stack is empty]]
}
}
@property bottom_item {
get {
- [[Get a bottom item on the naviframe stack]]
+ [[Get a bottom item on the naviframe stack
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
return: Elm.Widget_Item *; [[The bottom item on the naviframe stack or $NULL, if the stack is empty]]
}
When pop transition animation is in progress, new pop operation is blocked until current pop operation
is complete.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
return: Evas.Object *; [[$NULL or the content object(if the elm_naviframe_content_preserve_on_pop_get is true).]]
[[Insert a new item into the naviframe before item $before.
The item is inserted into the naviframe straight away without any
- transition operations. This item will be deleted when it is popped.]]
+ transition operations. This item will be deleted when it is popped.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
return: Elm.Widget_Item *; [[The created item or $NULL upon failure.]]
params {
When push transition animation is in progress, pop operation is blocked until push is complete.
The following styles are available for this item:
- "default"]]
+ "default"
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
return: Elm.Widget_Item *; [[The created item or $NULL upon failure.]]
params {
}
}
item_simple_promote {
- [[Simple version of item_promote.]]
+ [[Simple version of item_promote.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
params {
@in content: Evas.Object *;
transition operations. This item will be deleted when it is popped.
The following styles are available for this item:
- "default"]]
+ "default"
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
return: Elm.Widget_Item *; [[The created item or $NULL upon failure.]]
params {
methods {
@property style {
get {
- [[Get an item style.]]
+ [[Get an item style.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
set {
- [[Set an item style.]]
+ [[Set an item style.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
style: const (char) * @nullable; [[The current item style name. $null would be default]]
elm_naviframe_item_pop_cb_set is not called for items between the
top item and the destination item since those items are deleted
without being popped.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
title_enabled_get @const {
- [[Get a value whether title area is enabled or not.]]
+ [[Get a value whether title area is enabled or not.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
return: bool; [[If $true, title area will be enabled, disabled otherwise]]
}
title_enabled_set {
When the title area is disabled, then the controls would be
hidden so as to expand the content area to full-size.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
params {
@in enable: bool; [[If $true, title area will be enabled, disabled otherwise]]
This will take the indicated item and promote it to the top of
the stack as if it had been pushed there. The item must already
be inside the naviframe stack to work.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
popped. Therefore, the pop callback function is not called if the
item is deleted without being popped.
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+
@since 1.8
]]
params {
/**
+ * @internal
+ *
* Request that your elementary application needs Efreet
*
* This initializes the Efreet library when called and if support exists
EAPI Eina_Bool elm_need_efreet(void);
/**
+ * @internal
+ *
* Request that your elementary application needs Elm_Systray
*
* This initializes the Elm_Systray when called and, if support exists,
EAPI Eina_Bool elm_need_systray(void);
/**
+ * @internal
+ *
* Request that your elementary application needs Elm_Sys_Notify
*
* This initializes the Elm_Sys_Notify when called and if support exists
EAPI Eina_Bool elm_need_sys_notify(void);
/**
+ * @internal
+ *
* Request that your elementary application needs e_dbus
*
* This initializes the E_dbus library when called and if support exists
EAPI Eina_Bool elm_need_e_dbus(void) EINA_DEPRECATED;
/**
+ * @internal
+ *
* Request that your elementary application needs eldbus
*
* This initializes the eldbus (aka v2) library when called and if
EAPI Eina_Bool elm_need_eldbus(void);
/**
+ * @internal
+ *
* Request that your elementary application needs elocation
*
* This initializes the elocation library when called and if
EAPI Eina_Bool elm_need_elocation(void);
/**
+ * @internal
+ *
* Request that your elementary application needs ethumb
*
* This initializes the Ethumb library when called and if support exists
EAPI Eina_Bool elm_need_ethumb(void);
/**
+ * @internal
+ *
* Request that your elementary application needs web support
*
* This initializes the Ewebkit library when called and if support exists
Note: To fill the notify box in the parent area, please pass the
ELM_NOTIFY_ALIGN_FILL to horizontal and vertical.
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+
@since 1.8
]]
}
get {
[[Get the alignment of the notify object
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+
@since 1.8
]]
}
be caught by the others widgets, else the events are blocked.
Note: The default value is true.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
- [[Return true if events are allowed below the notify object.]]
+ [[Return true if events are allowed below the notify object.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
allow: bool; [[true if events are allowed, otherwise false]]
Note: If the value > 0.0 and the notify is previously visible,
the timer will be started with this value, canceling any running
timer.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
- [[Return the timeout value (in seconds)]]
+ [[Return the timeout value (in seconds)
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
timeout: double; [[The timeout in seconds]]
}
}
dismiss {
- [[Dismiss a notify object.]]
+ [[Dismiss a notify object.
+
+ \@if MOBILE \@since_tizen 2.4
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
}
implements {
* @return The new object or NULL if it cannot be created
*
* @ingroup Notify
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Evas_Object *elm_notify_add(Evas_Object *parent);
* and replaced.
*
* @ingroup Notify
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent);
* @see elm_notify_parent_set()
*
* @ingroup Notify
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj);
* @note Elementary objects may have many text parts (e.g. Action Slider)
*
* @ingroup General
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_object_part_text_set(Evas_Object *obj, const char *part, const char *text);
* @note Elementary objects may have many text parts (e.g. Action Slider)
*
* @ingroup General
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI const char *elm_object_part_text_get(const Evas_Object *obj, const char *part);
* @since 1.8
*
* @ingroup General
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_object_domain_translatable_part_text_set(Evas_Object *obj, const char *part, const char *domain, const char *text);
* @since 1.8
*
* @ingroup General
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI const char *elm_object_translatable_part_text_get(const Evas_Object *obj, const char *part);
* @since 1.8
*
* @ingroup General
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_object_domain_part_text_translatable_set(Evas_Object *obj, const char *part, const char *domain, Eina_Bool translatable);
* @see elm_object_part_content_get()
*
* @ingroup General
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_object_part_content_set(Evas_Object *obj, const char *part, Evas_Object *content);
* @see elm_object_part_content_set() for more details
*
* @ingroup General
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Evas_Object *elm_object_part_content_get(const Evas_Object *obj, const char *part);
* @see elm_object_part_content_set() for more details
*
* @ingroup General
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Evas_Object *elm_object_part_content_unset(Evas_Object *obj, const char *part);
* @param txt The text that describes the widget to people with poor or no vision
*
* @ingroup General
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
* @ingroup General
*
* @since 1.14
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI const char *elm_object_access_info_get(Evas_Object *obj);
* without limit.
*
* @ingroup General
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Evas_Object *elm_object_name_find(const Evas_Object *obj, const char *name, int recurse);
* @see elm_theme_overlay_del()
*
* @ingroup Styles
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Eina_Bool elm_object_style_set(Evas_Object *obj, const char *style);
* @see elm_object_style_set()
*
* @ingroup Styles
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI const char *elm_object_style_get(const Evas_Object *obj);
* enabling it back.
*
* @ingroup General
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled);
* This gets the state of the widget, which might be enabled or disabled.
*
* @ingroup General
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Eina_Bool elm_object_disabled_get(const Evas_Object *obj);
* @return @c EINA_TRUE if it is an elementary widget variant,
* @c EINA_FALSE otherwise
* @ingroup WidgetNavigation
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Eina_Bool elm_object_widget_check(const Evas_Object *obj);
* objects would have valid Elementary widget parents.
*
* @ingroup WidgetNavigation
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj);
* @return The top level Elementary widget, or @c NULL if parent cannot be
* found.
* @ingroup WidgetNavigation
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj);
* @param obj the object to query.
* @return Elementary widget name, or @c NULL if not a valid widget.
* @ingroup WidgetNavigation
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI const char *elm_object_widget_type_get(const Evas_Object *obj);
* @param emission The signal's name.
* @param source The signal's source.
* @ingroup General
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source);
* emitted.
* @param data A pointer to data to pass to the callback function.
* @ingroup General
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_object_signal_callback_add(Evas_Object *obj, const char *emission, const char *source, Edje_Signal_Cb func, void *data);
* to this call will be returned.
*
* @ingroup General
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void *elm_object_signal_callback_del(Evas_Object *obj, const char *emission, const char *source, Edje_Signal_Cb func);
* @see elm_object_event_callback_del()
*
* @ingroup General
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data);
* @param data Data to pass in to the callback function.
* @return The data pointer
* @ingroup General
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data);
* @since 1.8
*
* @ingroup General
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_object_orientation_mode_disabled_set(Evas_Object *obj, Eina_Bool disabled);
* @since 1.8
*
* @ingroup General
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Eina_Bool elm_object_orientation_mode_disabled_get(const Evas_Object *obj);
*
* @note Every elm_object_item supports this API
* @ingroup General
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void *elm_object_item_data_get(const Elm_Object_Item *it);
*
* @note Every elm_object_item supports this API
* @ingroup General
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_object_item_data_set(Elm_Object_Item *it, void *data);
\ No newline at end of file
data: Elm_Pan_Smart_Data;
methods {
@property gravity {
- set {
+ set @internal {
}
- get {
+ get @internal {
}
values {
x: double;
}
}
@property pos {
- set {
+ set @internal {
}
- get {
+ get @internal {
}
values {
x: Evas.Coord;
}
}
@property content_size {
- get {
+ get @internal {
}
values {
w: Evas.Coord;
}
}
@property pos_min {
- get {
+ get @internal {
}
values {
x: Evas.Coord;
}
}
@property pos_max {
- get {
+ get @internal {
}
values {
x: Evas.Coord;
[[Set the orientation of the panel
Set from where the panel will (dis)appear.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
- [[Get the orientation of the panel.]]
+ [[Get the orientation of the panel.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
orient: Elm.Panel.Orient(Elm.Panel.Orient.left); [[The panel orientation.]]
}
@property hidden {
set {
- [[Set the state of the panel.]]
+ [[Set the state of the panel.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
- [[Get the state of the panel.]]
+ [[Get the state of the panel.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
hidden: bool; [[If true, the panel will run the animation to disappear.]]
}
@property scrollable {
set {
- [[Set the scrollability of the panel.]]
+ [[Set the scrollability of the panel.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
[[Get the state of the scrollability.
+ \@if MOBILE \@since_tizen 3.0
+ \@elseif WEARABLE \@since_tizen 3.0
+ \@endif
+
@since 1.12
]]
}
}
@property scrollable_content_size {
set {
- [[Set the size of the scrollable panel.]]
+ [[Set the size of the scrollable panel.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
ratio: double;
}
}
toggle {
- [[Toggle the hidden state of the panel from code]]
+ [[Toggle the hidden state of the panel from code
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
}
implements {
* @return The panel object, or NULL on failure
*
* @ingroup Panel
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Evas_Object *elm_panel_add(Evas_Object *parent);
Note: This proportion will change when user drags the panes bar.]]
set {
+ [[\@MOBILE_ONLY
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
}
get {
+ [[\@MOBILE_ONLY
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
}
values {
size: double; [[Value between 0.0 and 1.0 representing size proportion of left side.]]
By default panes is in a vertical mode.]]
set {
+ [[\@MOBILE_ONLY
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
}
get {
+ [[\@MOBILE_ONLY
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
}
values {
horizontal: bool; [[Use $true to make $obj to split panes
By default panes' contents are resizable by user interaction.]]
set {
+ [[\@MOBILE_ONLY
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
}
get {
+ [[\@MOBILE_ONLY
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
}
values {
fixed: bool; [[Use $true to fix the left and right panes sizes and make
Note: This proportion will change when user drags the panes bar.]]
set {
+ [[\@MOBILE_ONLY
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
}
get {
+ [[\@MOBILE_ONLY
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
}
values {
size: double; [[Value between 0.0 and 1.0 representing size proportion of right side.]]
Note: If displayed vertically, left content is displayed at top.]]
set {
+ [[\@MOBILE_ONLY
+
+ \@if MOBILE \@since_tizen 3.0
+ \@endif
+ ]]
}
get {
+ [[\@MOBILE_ONLY
+
+ \@if MOBILE \@since_tizen 3.0
+ \@endif
+ ]]
}
values {
size: double; [[value between 0.0 and 1.0 representing size proportion of minimum size of left side.]]
Note: If displayed vertically, right content is displayed at bottom.]]
set {
+ [[\@MOBILE_ONLY
+
+ \@if MOBILE \@since_tizen 3.0
+ \@endif
+ ]]
}
get {
+ [[\@MOBILE_ONLY
+
+ \@if MOBILE \@since_tizen 3.0
+ \@endif
+ ]]
}
values {
size: double; [[value between 0.0 and 1.0 representing size proportion of minimum size of right side.]]
Note: If displayed vertically, left content is displayed at top.]]
set {
+ [[\@MOBILE_ONLY
+
+ \@if MOBILE \@since_tizen 3.0
+ \@endif
+ ]]
}
get {
+ [[\@MOBILE_ONLY
+
+ \@if MOBILE \@since_tizen 3.0
+ \@endif
+ ]]
}
values {
size: Evas.Coord; [[value representing minimum size of left side in pixels.]]
Note: If displayed vertically, right content is displayed at bottom.]]
set {
+ [[\@MOBILE_ONLY
+
+ \@if MOBILE \@since_tizen 3.0
+ \@endif
+ ]]
}
get {
+ [[\@MOBILE_ONLY
+
+ \@if MOBILE \@since_tizen 3.0
+ \@endif
+ ]]
}
values {
size: Evas.Coord; [[value representing minimum size of right side in pixels.]]
/**
+ * @MOBILE_ONLY
+ *
* Add a new panes widget to the given parent Elementary
* (container) object.
*
* This function inserts a new panes widget on the canvas.
*
* @ingroup Panes
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @endif
*/
EAPI Evas_Object *elm_panes_add(Evas_Object *parent);
eo_prefix: elm_obj_photo;
methods {
@property editable {
- set {
+ set @internal {
[[Set editability of the photo.
An editable photo can be dragged to or from, and can be cut or
the image will delete the existing content.
]]
}
- get {
+ get @internal {
[[Get editability of the photo.]]
}
values {
}
}
@property fill_inside {
- set {
+ set @internal {
[[Set if the photo should be completely visible or not.]]
}
- get {
+ get @internal {
[[Get if the photo should be completely visible or not.]]
}
values {
}
}
@property aspect_fixed {
- set {
+ set @internal {
[[Set whether the original aspect ratio of the photo should be kept
on resize.
See also @.aspect_fixed.get.
]]
}
- get {
+ get @internal {
[[Get if the object keeps the original aspect ratio.]]
}
values {
}
}
@property size {
- set {
+ set @internal {
[[Set the size that will be used on the photo]]
}
- get {
+ get @internal {
[[Get the size that will be used on the photo]]
}
values {
/**
+ * @internal
+ *
* Add a new photo to the parent
*
* @param parent The parent object
EAPI Evas_Object *elm_photo_add(Evas_Object *parent);
/**
+ * @internal
+ *
*
* Set the file that will be used as the photo widget's image.
*
default is off. This will stop zooming using animation on
zoom level changes and change instantly. This will stop any
existing animations that are running.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
[[Get the paused state for photocam
This gets the current paused state for the photocam object.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
This sets the gesture state to on or off for photocam. The
default is off. This will start multi touch zooming.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
[[Get the gesture state for photocam.
This gets the current gesture state for the photocam object.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
be 4x4 photo pixels as 1 screen pixel, and so on. The $zoom
parameter must be greater than 0. It is suggested to stick
to powers of 2. (1, 2, 4, 8, 16, 32, etc.).
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
#ELM_PHOTOCAM_ZOOM_MODE_MANUAL (which is the default), the
zoom level may be changed at any time by the photocam object
itself to account for photo size and photocam viewport size.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
fits EXACTLY inside the scroll frame with no pixels outside this
region. #ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but
ensure no pixels within the frame are left unfilled.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
[[Get the zoom mode
This gets the current zoom mode of the photocam object.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
[[Get the region of the image that is currently shown
See also @.image_region_show.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
This gets the internal image object inside photocam. Do not
modify it. It is for inspection only, and hooking callbacks
to. Nothing else. It may be deleted at any time as well.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
return: Evas.Object *; [[The internal image object handle or $null]]
}
This gets the current photo pixel width and height (for the
original). The size will be returned in the integers $w and $h
that are pointed to.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
This function allows to rotate or flip the photocam image.
+ \@if MOBILE \@since_tizen 3.0
+ \@elseif WEARABLE \@since_tizen 3.0
+ \@endif
+
@since 1.14
]]
}
get {
[[Get the photocam image orientation.
+ \@if MOBILE \@since_tizen 3.0
+ \@elseif WEARABLE \@since_tizen 3.0
+ \@endif
+
@since 1.14
]]
}
[[Set the viewed region of the image
This shows the region of the image without using animation.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
params {
@in x: int; [[X-coordinate of region in image original pixels]]
* @return The new object or NULL if it cannot be created
*
* @ingroup Photocam
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Evas_Object *elm_photocam_add(Evas_Object *parent);
* This shows the region of the image using animation.
*
* @ingroup Photocam
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h);
* @ingroup Photocam
*
* @param[in] file The photo file
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file);
*
* @ingroup Photocam
*
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI const char *elm_photocam_file_get(const Evas_Object *obj);
Note: Be careful to not manipulate it, as it is under control of
elementary.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
return: Evas.Object *; [[The inlined image object or $null.]]
}
}
connect {
- [[Connect a plug widget to service provided by socket image.]]
+ [[Connect a plug widget to service provided by socket image.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
return: bool; [[$true on success, $false on error.]]
params {
@in svcname: const(char)*; [[The service name to connect to set up by the socket.]]
* @return The new plug image object or NULL if it cannot be created
*
* @ingroup Plug
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Evas_Object *elm_plug_add(Evas_Object *parent);
Sets the alignment in which the popup will appear in its parent.
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+
@since 1.9
]]
}
get {
[[Get the alignment of the popup object.
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+
@since 1.9
]]
}
are blocked.
Note: The default value is $false.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
- [[Returns value indicating whether allow event is enabled or not.]]
+ [[Returns value indicating whether allow event is enabled or not.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
allow: bool; [[If $true, events are passed to lower objects.]]
[[Control the wrapping type of content text packed in content
area of popup object.
]]
- set {}
- get {}
+ set {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
+ }
+ get {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
+ }
values {
wrap: Elm.Wrap.Type; [[Wrapping type of type Elm_Wrap_Type.]]
}
Sets the position in which popup will appear in its parent.
By default, #ELM_POPUP_ORIENT_CENTER is set.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
- [[Returns the orientation of the popup.]]
+ [[Returns the orientation of the popup.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
orient: Elm.Popup.Orient; [[The orientation of the popup.]]
Note: If the value > 0.0 and the popup is previously visible,
the timer will be started with this value, canceling any
running timer.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
- [[Returns the timeout value set to the popup (in seconds).]]
+ [[Returns the timeout value set to the popup (in seconds).
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
timeout: double; [[The timeout in seconds.]]
}
}
@property scrollable {
- set {
+ set @internal {
[[Enable or disable scroller in popup content area
Normally content area does not contain scroller.
@since 1.15.1
]]
}
- get {
+ get @internal {
[[Get the scrollable state of popup content area
Normally content area does not contain scroller.
previous content of the content area is deleted. At a time,
only one of content, content-text and item(s) can be there
in a popup content area.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
return: Elm.Widget_Item *; [[A handle to the item added or $null on errors.]]
params {
}
}
dismiss {
- [[Dismiss a Popup object.]]
+ [[Dismiss a Popup object.
+
+ \@if MOBILE \@since_tizen 2.4
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
}
implements {
is gone.
@since 1.8]]
- set {
+ set @internal {
return: bool; [[$true, on success, $false otherwise]]
}
- get {
+ get @internal {
}
values {
data: Elm_Prefs_Data * @nullable; [[A valid prefs_data handle]]
will happen.
@since 1.8]]
- set {
+ set @internal {
}
- get {
+ get @internal {
}
values {
autosave: bool; [[$true to save automatically, $false otherwise.]]
}
}
- reset {
+ reset @internal {
[[Reset the values of a given prefs widget to a previous state.
As can be seen on #Elm_Prefs_Reset_Mode, there are two possible
@in mode: Elm_Prefs_Reset_Mode; [[The reset mode to apply on $prefs]]
}
}
- item_value_set {
+ item_value_set @internal {
[[Set the value on a given prefs widget's item.
This will change the value of item named $name programatically.
@out value: Eina_Value; [[Where to store the value of the item. It will be overwritten and setup with the type the item is bound to]]
}
}
- item_object_get {
+ item_object_get @internal {
[[Get the Elementary widget bound to a given prefs widget's item.
This will retrieve a handle to the real widget implementing a given
@in name: const(char)*; [[The name of the item (as declared in the prefs collection) to get object from]]
}
}
- item_disabled_set {
+ item_disabled_set @internal {
[[Set whether the widget bound to a given prefs widget's item is disabled or not.
@since 1.8]]
@in name: const(char)*; [[The name of the item (as declared in the prefs collection) to get disabled state from]]
}
}
- item_swallow {
+ item_swallow @internal {
[["Swallows" an object into a SWALLOW item of a prefs widget.
@since 1.8]]
@in child: Evas.Object *; [[The object to occupy the item]]
}
}
- item_editable_set {
+ item_editable_set @internal {
[[Set whether the widget bound to a given prefs widget's item is editable or not.
Note: Only $TEXT or $TEXTAREA items' default widgets implement
@in name: const(char)*; [[The name of the item (as declared in the prefs collection) to get editable state from]]
}
}
- item_unswallow {
+ item_unswallow @internal {
[[Unswallow an object from a SWALLOW item of a prefs widget.
@since 1.8]]
@in name: const(char)*; [[the name of the SWALLOW item (as declared in the prefs collection)]]
}
}
- item_visible_set {
+ item_visible_set @internal {
[[Set whether the widget bound to given prefs widget's item should be visible or not.
Each prefs item may have a default visibility state, declared on
} Elm_Prefs_Reset_Mode;
/**
+ * @internal
+ *
* @brief Add a new prefs widget
*
* @param parent The parent widget to hold the new one
};
/**
+ * @internal
+ *
* Mass-register widgets implementing prefs @b items interfaces.
*
* @param array An array of #Elm_Prefs_Iface_Info structs, @c NULL
EAPI void elm_prefs_item_iface_register(const Elm_Prefs_Item_Iface_Info *array);
/**
+ * @internal
+ *
* Mass-unregister widgets implementing prefs @b items interfaces.
*
* @param array An array of #Elm_Prefs_Iface_Info structs, @c NULL
};
/**
+ * @internal
+ *
* Mass-register widgets implementing prefs @b pages interfaces.
*
* @param array An array of #Elm_Prefs_Iface_Info structs, @c NULL
EAPI void elm_prefs_page_iface_register(const Elm_Prefs_Page_Iface_Info *array);
/**
+ * @internal
+ *
* Mass-unregister widgets implementing prefs @b pages interfaces.
*
* @param array An array of #Elm_Prefs_Iface_Info structs, @c NULL
} Elm_Prefs_Data_Event_Changed;
/**
+ * @internal
+ *
* Create a new prefs data handle.
*
* @param data_file The (user) file where to read data from
Eet_File_Mode mode);
/**
+ * @internal
+ *
* Set the version field of a given prefs data handle.
*
* @param prefs_data A valid prefs data handle
unsigned int version);
/**
+ * @internal
+ *
* Get the version field of a given prefs data handle.
*
* @param prefs_data A valid prefs data handle
EAPI unsigned int elm_prefs_data_version_get(const Elm_Prefs_Data *prefs_data);
/**
+ * @internal
+ *
* Increment reference count on a given prefs data handle.
*
* @param prefs_data A valid prefs data handle
EAPI Elm_Prefs_Data *elm_prefs_data_ref(Elm_Prefs_Data *prefs_data);
/**
+ * @internal
+ *
* Decrement reference count on a given prefs data handle.
*
* @param prefs_data A valid prefs data handle
EAPI void elm_prefs_data_unref(Elm_Prefs_Data *prefs_data);
/**
+ * @internal
+ *
* Set (or delete) one value of a given prefs data handle.
*
* @param prefs_data A valid prefs data handle
const Eina_Value *value);
/**
+ * @internal
+ *
* Get one value of a given prefs data handle (by key).
*
* @param prefs_data A valid prefs data handle
Eina_Value *value);
/**
+ * @internal
+ *
* Register a callback for one of the prefs data events.
*
* @param prefs_data A valid prefs data handle
Elm_Prefs_Data_Event_Cb cb,
const void *cb_data);
/**
+ * @internal
+ *
* Unregister a callback for one of the prefs data events.
*
* @param prefs_data A valid prefs data handle
const void *cb_data);
/**
+ * @internal
+ *
* Set whether a given elm prefs data handle should save its values
* back automatically on changes.
*
Eina_Bool autosave);
/**
+ * @internal
+ *
* Get whether a given elm prefs data handle is saving its values
* back automatically on changes.
*
EAPI Eina_Bool elm_prefs_data_autosave_get(const Elm_Prefs_Data *prefs_data);
/**
+ * @internal
+ *
* Save, manually, a given elm prefs data handle data back, on the given
* file and key.
*
/**
+ * @internal
+ *
* @ingroup Prefs
*
* @{
Evas_Object *obj);
/**
+ * @internal
+ *
*
* Set file and page to populate a given prefs widget's interface.
*
EAPI Eina_Bool elm_prefs_file_set(Eo *obj, const char *file, const char *page);
/**
+ * @internal
+ *
*
* Get file and page bound to a given prefs widget.
*
own space, which will make $obj to require more the $size,
actually.]]
set {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
size: Evas.Coord; [[The length of the progress bar's bar region]]
without exact progress values. In the default theme, it will
animate its bar with the contents filling in constantly and back
to non-filled, in a loop. To start and stop this pulsing
- animation, one has to explicitly call elm_progressbar_pulse().]]
+ animation, one has to explicitly call elm_progressbar_pulse().
+ ]]
set {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
pulse: bool; [[$true to put $obj in pulsing mode, $false to put it back to its default one]]
$val, it will be interpreted as the closest of the boundary
values in the range.]]
set {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
val: double; [[The progress value (must be between $0.0 and 1.0)]]
the low values on the former and high values on the latter,
respectively, for horizontal and vertical modes.]]
set {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
inverted: bool; [[Use $true to make $obj inverted, $false to bring it back to default, non-inverted values.]]
Use this function to change how your progress bar is to be
disposed: vertically or horizontally.]]
set {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
horizontal: bool; [[Use $true to make $obj to be horizontal, $false to make it vertical]]
Note: The default format string for a progress bar is an integer
percentage, as in $"%.0f %%".]]
set {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
units: const(char)* @nullable; [[The format string for $obj's units label]]
See: @.unit_format.set for more info on how this works.
- @since 1.7]]
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+
+ @since 1.7
+ ]]
}
values {
func: progressbar_func_type @nullable; [[The unit format function]]
Use this call to set progress bar status for more than one progress status .
- @since 1.8]]
+ \@if MOBILE \@since_tizen 3.0
+ \@elseif WEARABLE \@since_tizen 3.0
+ \@endif
+
+ @since 1.8
+ ]]
params {
@in part: const(char)*; [[The partname to which val have to set]]
@in val: double; [[The progress value (must be between $0.0 and 1.0)]]
part_value_get @const {
[[Get the progress value (in percentage) on a given progress bar widget for a particular part
- @since 1.8]]
+ \@if MOBILE \@since_tizen 3.0
+ \@elseif WEARABLE \@since_tizen 3.0
+ \@endif
+
+ @since 1.8
+ ]]
return: double; [[The value of the progressbar]]
params {
@in part: const(char)*; [[The part name of the progress bar]]
pulse {
[[Start/stop a given progress bar "pulsing" animation, if its under that mode
- Note: This call won't do anything if $obj is not under "pulsing mode".]]
+ Note: This call won't do anything if $obj is not under "pulsing mode".
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
params {
@in state: bool; [[$true, to start the pulsing animation, $false to stop it]]
}
* This function inserts a new progress bar widget on the canvas.
*
* @ingroup Progressbar
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent);
[[Set the integer value that this radio object represents
This sets the value of the radio.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
[[Get the integer value that this radio object represents
This gets the value of the radio.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
This sets the value of the radio group and will also set the
value if pointed to, to the value supplied, but will not call
any callbacks.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
- [[Get the value of the radio group]]
+ [[Get the value of the radio group
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
value: int; [[The value to use for the group]]
valuep is not NULL, then when this is called, the radio objects
state will also be modified to reflect the value of the integer
valuep points to, just like calling elm_radio_value_set().
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
}
@property selected_object {
get {
- [[Get the selected radio object.]]
+ [[Get the selected radio object.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
return: Evas.Object *; [[The selected radio object]]
}
}
integer value assigned. In order to have them work as a group, they
need to know about each other. This adds the given radio object to
the group of which the group object indicated is a member.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
params {
* @return The new object or NULL if it cannot be created
*
* @ingroup Radio
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Evas_Object *elm_radio_add(Evas_Object *parent);
EINA_DEPRECATED EAPI void elm_object_focus(Evas_Object *obj);
/**
+ * @internal
+ *
* Give focus to next object in object tree.
*
* Give focus to next object in focus chain of one object sub-tree.
EINA_DEPRECATED EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj);
/**
+ * @MOBILE_ONLY
+ *
* Set the left content of the panes widget.
*
* @param obj The panes object.
*
* @deprecated use elm_object_part_content_set() instead
*
+ * @if MOBILE @since_tizen 3.0
+ * @endif
*/
EINA_DEPRECATED EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content);
/**
+ * @MOBILE_ONLY
+ *
* Set the right content of the panes widget.
*
* @param obj The panes object.
*
* @deprecated use elm_object_part_content_set() instead
*
+ * @if MOBILE @since_tizen 3.0
+ * @endif
*/
EINA_DEPRECATED EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content);
/**
+ * @MOBILE_ONLY
+ *
* Get the left content of the panes.
*
* @param obj The panes object.
*
* @deprecated use elm_object_part_content_get() instead
*
+ * @if MOBILE @since_tizen 3.0
+ * @endif
*/
EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj);
/**
+ * @MOBILE_ONLY
+ *
* Get the right content of the panes.
*
* @param obj The panes object
*
* @deprecated use elm_object_part_content_get() instead
*
+ * @if MOBILE @since_tizen 3.0
+ * @endif
*/
EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj);
/**
+ * @MOBILE_ONLY
+ *
* Unset the left content used for the panes.
*
* @param obj The panes object.
*
* @deprecated use elm_object_part_content_unset() instead
*
+ * @if MOBILE @since_tizen 3.0
+ * @endif
*/
EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj);
/**
+ * @MOBILE_ONLY
+ *
* Unset the right content used for the panes.
*
* @param obj The panes object.
*
* @deprecated use elm_object_part_content_unset() instead
*
+ * @if MOBILE @since_tizen 3.0
+ * @endif
*/
EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj);
/**
* elm_index_item_prepend().
*
* @deprecated please use "elm_index_item_insert_before" instead.
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EINA_DEPRECATED EAPI Elm_Object_Item *elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const Elm_Object_Item *relative);
eo_prefix: elm_obj_route;
methods {
@property emap {
- set {
+ set @internal {
[[No description supplied by the EAPI.]]
}
values {
}
}
@property longitude_min_max {
- get {
+ get @internal {
[[Get the minimum and maximum values along the longitude.
Note: If only one value is needed, the other pointer can be
}
}
@property latitude_min_max {
- get {
+ get @internal {
[[Get the minimum and maximum values along the latitude.
Note: If only one value is needed, the other pointer can be
/**
+ * @internal
+ *
* Add a new route object to the parent's canvas
*
* @param parent The parent object
* no scaling)
*
* @ingroup Scaling
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_object_scale_set(Evas_Object *obj, double scale);
* @return The scaling factor set by elm_object_scale_set()
*
* @ingroup Scaling
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI double elm_object_scale_get(const Evas_Object *obj);
*
* @param obj The object
* @ingroup Scrollhints
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_object_scroll_hold_push(Evas_Object *obj);
*
* @param obj The object
* @ingroup Scrollhints
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_object_scroll_hold_pop(Evas_Object *obj);
* @return The scroll hold count
* @since 1.7
* @ingroup Scrollhints
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI int elm_object_scroll_hold_get(const Evas_Object *obj);
*
* @param obj The object
* @ingroup Scrollhints
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_object_scroll_freeze_push(Evas_Object *obj);
*
* @param obj The object
* @ingroup Scrollhints
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj);
* @return The scroll freeze count
* @since 1.7
* @ingroup Scrollhints
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI int elm_object_scroll_freeze_get(const Evas_Object *obj);
* @param obj The object
* @param lock The lock state (1 == locked, 0 == unlocked)
* @ingroup Scrollhints
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock);
* @param obj The object
* @param lock The lock state (1 == locked, 0 == unlocked)
* @ingroup Scrollhints
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock);
*
* @param obj The object
* @ingroup Scrollhints
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj);
*
* @param obj The object
* @ingroup Scrollhints
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj);
* @see elm_object_scroll_item_loop_enabled_get()
* @since 1.10
* @ingroup Scrollitem
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI void elm_object_scroll_item_loop_enabled_set(Evas_Object *obj, Eina_Bool enable);
* @see elm_objecdt_scroll_item_enabled_set()
* @since 1.10
* @ingroup Scrollitem
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI Eina_Bool elm_object_scroll_item_loop_enabled_get(const Evas_Object *obj);
This enables or disables event propagation from the scroller
content to the scroller and its parent. By default event
propagation is enabled.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
[[Get event propagation for a scroller
This gets the event propagation for a scroller.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
}
}
@property custom_widget_base_theme {
- set {
+ set @internal {
[[Set custom theme elements for the scroller]]
}
values {
The value of maximum movable page should be more than 1.
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+
@since 1.8
]]
params {
page_scroll_limit_get @const {
[[Get the maximum of the movable page at a flicking.
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+
@since 1.8
]]
params {
* @return The new object or NULL if it cannot be created
*
* @ingroup Scroller
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Evas_Object *elm_scroller_add(Evas_Object *parent);
* that direction.
*
* @ingroup Scroller
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h);
* virtual content object) is shown within the scroller.
*
* @ingroup Scroller
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_scroller_region_show(Evas_Object *obj, Evas_Coord x, Evas_Coord y, Evas_Coord w, Evas_Coord h);
* respectively for the horizontal and vertical scrollbars.
*
* @ingroup Scroller
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v);
* @see elm_scroller_policy_set()
*
* @ingroup Scroller
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v);
* @since 1.8
*
* @ingroup Scroller
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_scroller_single_direction_set(Evas_Object *obj, Elm_Scroller_Single_Direction single_dir);
* @since 1.8
*
* @ingroup Scroller
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Elm_Scroller_Single_Direction elm_scroller_single_direction_get(const Evas_Object *obj);
* @see elm_scroller_region_show()
*
* @ingroup Scroller
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_scroller_region_get(const Evas_Object *obj, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h);
* This gets the size of the content object of the scroller.
*
* @ingroup Scroller
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h);
* @since 1.8
*
* @ingroup Scroller
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI void elm_scroller_page_snap_set(Evas_Object *obj, Eina_Bool page_h_snap, Eina_Bool page_v_snap);
* @since 1.8
*
* @ingroup Scroller
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI void elm_scroller_page_snap_get(const Evas_Object *obj, Eina_Bool *page_h_snap, Eina_Bool *page_v_snap);
* for the given axis with the boolean parameters for each axis.
*
* @ingroup Scroller
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
* @see elm_scroller_bounce_set()
*
* @ingroup Scroller
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
* the other axis.
*
* @ingroup Scroller
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel);
* @since 1.7
*
* @ingroup Scroller
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_scroller_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel);
* @see elm_scroller_page_size_get()
*
* @ingroup Scroller
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize);
* @since 1.7
*
* @ingroup Scroller
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_scroller_page_size_get(const Evas_Object *obj, Evas_Coord *h_pagesize, Evas_Coord *v_pagesize);
* @see elm_scroller_page_bring_in()
*
* @ingroup Scroller
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_scroller_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
* @see elm_scroller_page_bring_in()
*
* @ingroup Scroller
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_scroller_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
* @see elm_scroller_page_bring_in()
*
* @ingroup Scroller
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber);
* @see elm_scroller_page_show()
*
* @ingroup Scroller
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber);
* @see elm_scroller_region_show()
*
* @ingroup Scroller
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_scroller_region_bring_in(Evas_Object *obj, Evas_Coord x, Evas_Coord y, Evas_Coord w, Evas_Coord h);
* Default values for x and y are 0.0
*
* @ingroup Scroller
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_scroller_gravity_set(Evas_Object *obj, double x, double y);
* @see elm_scroller_gravity_set()
*
* @ingroup Scroller
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_scroller_gravity_get(const Evas_Object *obj, double *x, double *y);
* @since 1.8
*
* @ingroup Scroller
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_scroller_movement_block_set(Evas_Object *obj, Elm_Scroller_Movement_Block block);
* @see elm_scroller_movement_block_set() for more details
*
* @ingroup Scroller
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Elm_Scroller_Movement_Block elm_scroller_movement_block_get(const Evas_Object *obj);
* @since 1.13
*
* @ingroup Scroller
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI void elm_scroller_step_size_set(Evas_Object *obj, Evas_Coord x, Evas_Coord y);
* @since 1.13
*
* @ingroup Scroller
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI void elm_scroller_step_size_get(const Evas_Object *obj, Evas_Coord *x, Evas_Coord *y);
* @since 1.14
*
* @ingroup Scroller
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_scroller_loop_set(Evas_Object *obj, Eina_Bool loop_h, Eina_Bool loop_v);
* @see elm_scroller_loop_set() for more details
*
* @ingroup Scroller
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI void elm_scroller_loop_get(const Evas_Object *obj, Eina_Bool *loop_h, Eina_Bool *loop_v);
* @see elm_scroller_wheel_disabled_get()
*
* @ingroup Scroller
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI void elm_scroller_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled);
* @see elm_scroller_wheel_disabled_set()
*
* @ingroup Scroller
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI Eina_Bool elm_scroller_wheel_disabled_get(const Evas_Object *obj);
methods {
@property item_count {
get {
- [[Get the Segment items count from segment control.
+ [[\@MOBILE_ONLY
- It will just return the number of items added to segment control $obj.]]
+ Get the Segment items count from segment control.
+
+ It will just return the number of items added to segment control $obj.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
return: int; [[Segment items count.]]
}
}
@property item_selected {
get {
- [[Get the selected item.
+ [[\@MOBILE_ONLY
+
+ Get the selected item.
The selected item can be unselected with function
elm_segment_control_item_selected_set().
- The selected item always will be highlighted on segment control.]]
+ The selected item always will be highlighted on segment control.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
return: Elm.Widget_Item *; [[The selected item or $NULL if none of segment items is selected.]]
}
}
item_label_get @const {
- [[Get the label of item.
+ [[\@MOBILE_ONLY
+
+ Get the label of item.
The return value is a pointer to the label associated to the item when
it was created, with function elm_segment_control_item_add(), or later
with function elm_object_item_text_set. If no label
- was passed as argument, it will return $NULL.]]
+ was passed as argument, it will return $NULL.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
return: const(char)*; [[The label of the item at $index.]]
params {
}
}
item_insert_at {
- [[Insert a new item to the segment control object at specified position.
+ [[\@MOBILE_ONLY
+
+ Insert a new item to the segment control object at specified position.
Index values must be between $0, when item will be prepended to
segment control, and items count, that can be get with
If an item
only has icon, it will be displayed bigger and centered. If it has
icon and label, even that an empty string, icon will be smaller and
- positioned at left.]]
+ positioned at left.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
return: Elm.Widget_Item *; [[The created item or $NULL upon failure.]]
params {
}
}
item_get @const {
- [[Get the item placed at specified index.
+ [[\@MOBILE_ONLY
+
+ Get the item placed at specified index.
Index is the position of an item in segment control widget. Its
range is from $0 to <tt> count - 1 </tt>.
Count is the number of items, that can be get with
- elm_segment_control_item_count_get().]]
+ elm_segment_control_item_count_get().
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
return: Elm.Widget_Item *; [[The segment control item or $NULL on failure.]]
params {
}
}
item_del_at {
- [[Remove a segment control item at given index from its parent, deleting it.
+ [[\@MOBILE_ONLY
+
+ Remove a segment control item at given index from its parent, deleting it.
+
+ Items can be added with elm_segment_control_item_add() or elm_segment_control_item_insert_at().
- Items can be added with elm_segment_control_item_add() or elm_segment_control_item_insert_at().]]
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
params {
@in idx: int; [[The position of the segment control item to be deleted.]]
}
}
item_add {
- [[Append a new item to the segment control object.
+ [[\@MOBILE_ONLY
+
+ Append a new item to the segment control object.
A new item will be created and appended to the segment control, i.e., will
be set as last item.
If an item
only has icon, it will be displayed bigger and centered. If it has
icon and label, even that an empty string, icon will be smaller and
- positioned at left.]]
+ positioned at left.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
/* FIXME-doc
Simple example:
}
}
item_icon_get @const {
- [[Get the icon associated to the item.
+ [[\@MOBILE_ONLY
+
+ Get the icon associated to the item.
The return value is a pointer to the icon associated to the item when
it was created, with function elm_segment_control_item_add(), or later
with function elm_object_item_part_content_set(). If no icon
- was passed as argument, it will return $NULL.]]
+ was passed as argument, it will return $NULL.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
return: Evas.Object *; [[The left side icon associated to the item at $index.]]
params {
@in idx: int; [[The index of the segment item.]]
eo_prefix: elm_obj_segment_control_item;
methods {
index_get @const {
- [[Get the index of an item.
+ [[\@MOBILE_ONLY
+
+ Get the index of an item.
Index is the position of an item in segment control widget. Its
range is from 0 to (count - 1).
- Count is the number of items, that can be get with elm_segment_control_item_count_get()]]
+ Count is the number of items, that can be get with elm_segment_control_item_count_get()
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
return: int(-1); [[The position of item in segment control widget.]]
}
object_get @const {
- [[Get the real Evas(Edje) object created to implement the view of a given segment_control item.
+ [[\@MOBILE_ONLY
+
+ Get the real Evas(Edje) object created to implement the view of a given segment_control item.
- Base object is the @Evas.Object that represents that item.]]
+ Base object is the @Evas.Object that represents that item.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
return: Evas.Object*; [[The base Edje object associated with $it]]
}
selected_set {
- [[Set the selected state of an item.
+ [[\@MOBILE_ONLY
+
+ Set the selected state of an item.
This sets the selected state of the given item $it.
$true for selected, $false for not selected.
If a new item is selected the previously selected will be unselected.
Selected item can be got with function elm_segment_control_item_selected_get().
- The selected item always will be highlighted on segment control.]]
+ The selected item always will be highlighted on segment control.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
params {
selected: bool; [[The selected state.]]
/**
+ * @MOBILE_ONLY
+ *
* Add a new segment control widget to the given parent Elementary
* (container) object.
*
* This function inserts a new segment control widget on the canvas.
*
* @ingroup SegmentControl
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @endif
*/
EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent);
eo_prefix: elm_obj_separator;
methods {
@property horizontal {
- set {
+ set @internal {
[[Set the horizontal mode of a separator object]]
}
- get {
+ get @internal {
[[Get the horizontal mode of a separator object]]
}
values {
/**
+ * @internal
+ *
* @brief Add a separator object to @p parent
*
* @param parent The parent object
disposed: vertically or horizontally.
By default it's displayed horizontally.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
- [[Get the orientation of a given slider widget.]]
+ [[Get the orientation of a given slider widget.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
horizontal: bool;
Note: The value must to be between min and max values. This values
are set by @.min_max.set.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
- [[Get the value displayed by the slider.]]
+ [[Get the value displayed by the slider.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
val: double; [[The value to be displayed.]]
3.14159.
Default is indicator label disabled.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
The slider may display its value somewhere else then unit label,
for example, above the slider knob that is dragged around. This
function gets the format string used for this.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
values on the right or bottom, as opposed to normally have
the low values on the former and high values on the latter,
respectively, for horizontal and vertical modes.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
[[Get whether a given slider widget's displaying values are
inverted or not.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
Warning: It won't display values set with @.indicator_format.set
if you disable indicator.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
- [[Get whether a given slider widget's enlarging indicator or not.]]
+ [[Get whether a given slider widget's enlarging indicator or not.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
show: bool; [[$true will make it enlarge, $false will
Warning: maximum must be greater than minimum, otherwise behavior
is undefined.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
Note: If only one value is needed, the other pointer can be passed
as $null.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
3.14159.
Default is unit label disabled.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
Unit label is displayed all the time, if set, after slider's bar.
In horizontal mode, at right and in vertical mode, at bottom.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
}
@property indicator_show_on_focus {
set {
- [[Show the indicator of slider on focus.]]
+ [[Show the indicator of slider on focus.
+
+ \@if MOBILE \@since_tizen 3.0
+ \@elseif WEARABLE \@since_tizen 3.0
+ \@endif
+ ]]
}
get {
- [[Get whether the indicator of the slider is set or not.]]
+ [[Get whether the indicator of the slider is set or not.
+
+ \@if MOBILE \@since_tizen 3.0
+ \@elseif WEARABLE \@since_tizen 3.0
+ \@endif
+ ]]
}
values {
flag: bool;
Note: Icon, end, label, indicator and unit text around $obj
will require their own space, which will make $obj to require
more the $size, actually.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
If that size was not set previously, with @.span_size.set, this
call will return $0.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
or in case when accessibility is set and flick event is used to
inc/dec slider values. By default step value is equal to 0.05.
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+
@since 1.8
]]
}
get {
[[Get the step by which slider indicator moves.
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+
@since 1.8
]]
}
}
@property indicator_visible_mode {
set {
- [[Set the visible mode of indicator.]]
+ [[Set the visible mode of indicator.
+
+ \@if MOBILE \@since_tizen 2.4
+ \@elseif WEARABLE \@since_tizen 3.0
+ \@endif
+ ]]
}
get {
- [[Get the visible mode of indicator.]]
+ [[Get the visible mode of indicator.
+
+ \@if MOBILE \@since_tizen 2.4
+ \@elseif WEARABLE \@since_tizen 3.0
+ \@endif
+ ]]
}
values {
indicator_visible_mode: Elm_Slider_Indicator_Visible_Mode; [[The indicator visible mode.]]
[[Set the format function pointer for the indicator label
Set the callback function to format the indicator string.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
[[Set the format function pointer for the units label
Set the callback function to format the units string.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
* This function inserts a new slider widget on the canvas.
*
* @ingroup Slider
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Evas_Object *elm_slider_add(Evas_Object *parent);
eo_prefix: elm_obj_slideshow;
methods {
@property cache_after {
- set {
+ set @internal {
[[Set the number of items to cache, on a given slideshow widget,
after the current item.
\@ref Slideshow_Caching "slideshow caching" for more details.
]]
}
- get {
+ get @internal {
[[Get the number of items to cache, on a given slideshow widget,
after the current item.
]]
}
}
@property cache_before {
- set {
+ set @internal {
[[Set the number of items to cache, on a given slideshow widget,
before the current item.
\@ref Slideshow_Caching "slideshow caching" for more details.
]]
}
- get {
+ get @internal {
[[Get the number of items to cache, on a given slideshow widget,
before the current item.
]]
}
}
@property layout {
- set {
+ set @internal {
[[Set the current slide layout in use for a given slideshow widget
If $layout is implemented in $obj's theme (i.e., is contained
See @.layouts.get for more details.
]]
}
- get {
+ get @internal {
[[Get the current slide layout in use for a given slideshow widget.]]
}
values {
}
}
@property transition {
- set {
+ set @internal {
[[Set the current slide transition/effect in use for a given
slideshow widget.
new sliding effect will be used on the widget.
]]
}
- get {
+ get @internal {
[[Get the current slide transition/effect in use for a given
slideshow widget.
]]
}
}
@property loop {
- set {
+ set @internal {
[[Set if, after a slideshow is started, for a given slideshow
widget, its items should be displayed cyclically or not.
affects only the "automatic" slideshow, as set by @.timeout.set.
]]
}
- get {
+ get @internal {
[[Get if, after a slideshow is started, for a given slideshow
widget, its items are to be displayed cyclically or not.
]]
}
}
@property timeout {
- set {
+ set @internal {
[[Set the interval between each image transition on a given
slideshow widget and start the slideshow itself.
could be happening on $obj.
]]
}
- get {
+ get @internal {
[[Get the interval set for image transitions on a given
slideshow widget.
]]
}
}
@property items {
- get {
+ get @internal {
[[Get the internal list of items in a given slideshow widget.
This list is not to be modified in any way and must not be
}
}
@property transitions {
- get {
+ get @internal {
[[Returns the list of sliding transition/effect names available,
for a given slideshow widget.
}
}
@property count {
- get {
+ get @internal {
[[Get the number of items stored in a given slideshow widget.]]
return: uint; [[The number of items on $obj, at the moment of this call.]]
}
}
@property item_current {
- get {
+ get @internal {
[[Returns the currently displayed item, in a given slideshow widget.]]
return: Elm.Widget_Item *; [[A handle to the item being displayed
in $obj or $null, if none is (and
}
}
@property layouts {
- get {
+ get @internal {
[[Returns the list of layout names available, for a given
slideshow widget.
]]
}
}
- previous {
+ previous @internal {
[[Slide to the previous item, in a given slideshow widget
The sliding animation $obj is set to use will be the
(0 being the first).]]
}
}
- next {
+ next @internal {
[[Slide to the next item, in a given slideshow widget.
The sliding animation $obj is set to use will be the
reached, it'll wrap around to the list's beginning, again.
]]
}
- clear {
+ clear @internal {
[[Remove all items from a given slideshow widget.
This removes (and deletes) all items in $obj, leaving it empty.
]]
}
- item_add {
+ item_add @internal {
[[Add (append) a new item in a given slideshow widget.
Add a new item to $obj's internal list of items, appending it.
@in data: const(void)*; [[The item's data.]]
}
}
- item_sorted_insert {
+ item_sorted_insert @internal {
[[Insert a new item into the given slideshow widget, using the
$func function to sort items (by item handles).
{
eo_prefix: elm_obj_slideshow_item;
methods {
- show {
+ show @internal {
[[Display a given slideshow widget's item, programmatically.
The change between the current item and $item will use the
/**
+ * @internal
+ *
* Add a new slideshow widget to the given parent Elementary
* (container) object
*
Warning: Maximum must be greater than minimum.]]
set {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
min: double; [[The minimum value.]]
By default step value is equal to 1.]]
set {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
step: double; [[The step value.]]
When the user decrement value (using left or bottom arrow), it will
displays $50.]]
set {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
wrap: bool; [[$true to enable wrap or $false to disable it.]]
The default starting interval value for automatic changes is
$0.85 seconds.]]
set {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
interval: double; [[The (first) interval value in seconds.]]
Sets the rounding value used for value rounding in the spinner.]]
set {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
rnd: int; [[The rounding value]]
It's enabled by default.]]
set {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
editable: bool; [[$true to allow users to edit it or $false to don't allow users to edit it directly.]]
Example: round = 2, base = 5.5
Values: ..., -0.5, 1.5, 3.5, 5.5, 7.5, 9.5, 11.5, ...]]
set {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
base: double; [[The base value]]
Warning The value must to be between min and max values. This values
are set by elm_spinner_min_max_set().]]
set {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
val: double; [[The value to be displayed.]]
Default is "%0.f".]]
set {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
fmt: const(char)* @nullable; [[The format string for the label display.]]
better indicated by a label than a value. For example, weekdays or months.
Note: If another label was previously set to $value, it will be replaced
- by the new label.]]
+ by the new label.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
/* FIXME-doc
E.g.:
*
* @ingroup Spinner
*
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Evas_Object *elm_spinner_add(Evas_Object *parent);
*
* @ingroup Spinner
* @since 1.8
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_spinner_special_value_del(Evas_Object *obj, double value);
*
* @ingroup Spinner
* @since 1.8
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI const char *elm_spinner_special_value_get(Evas_Object *obj, double value);
#define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it) /**< Use this to get the offset in bytes in memory for where the data for the mapping lives relative to the item data (a private struct pointed to owned by the user */
/**
+ * @internal
+ *
* Create a new store object
*
* This creates a new store object to then configure so it works.
*/
EAPI Elm_Store *elm_store_filesystem_new(void);
/**
+ * @internal
+ *
* Free the store object and all items it manages
*
* This frees the given @p st store and all the items it manages. It will
EAPI void elm_store_free(Elm_Store *st);
/**
+ * @internal
+ *
* Set the path to the directory to scan for a filesystem store
*
* This sets the directory (@p dir) to scan and begins scanning in the
EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir);
/**
+ * @internal
+ *
* Get the directory set on a filesystem store
*
* This gets the directory set by elm_store_filesystem_directory_set(). This
EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st);
/**
+ * @internal
+ *
* Get the path of a specific store item
*
* This returns the full path of a store item. This string is valid only
EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti);
/**
+ * @internal
+ *
* Set the target genlist to fill in from the store
*
* This tells the store the target genlist to use to fill in content from
EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj);
/**
+ * @internal
+ *
* Set the maximum number of items that are not visible to keep cached
*
* Store may keep some items around for caching purposes that cannot be seen,
EAPI void elm_store_cache_set(Elm_Store *st, int max);
/**
+ * @internal
+ *
* Get the maximum number if items to cache
*
* This returns the number of items at most to cache.
EAPI int elm_store_cache_get(const Elm_Store *st);
/**
+ * @internal
+ *
* Set the function used to deal with listing of items
*
* This function is called per item that is found so it can examine the item
EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data);
/**
+ * @internal
+ *
* Set the function used to deal with fetching of items
*
* This function is called per item that needs data to be fetched when it
EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data);
/**
+ * @internal
+ *
* Set the function used to free the structure allocated for the item
*
* This function is called per item when it is not needed in memory anymore
EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data);
/**
+ * @internal
+ *
* Enable or disable fetching in a thread for Store
*
* @param st The store to modify
EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread);
/**
+ * @internal
+ *
* Get the thread enabled fetching option for Store
*
* @return The state set currently for the store.
EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st);
/**
+ * @internal
+ *
* Set if items are to be sorted or not.
*
* By default items are not sorted, but read "in order" as they are found. If
EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted);
/**
+ * @internal
+ *
* Get the sorting flag
*
* Get the sorted flag as set by elm_store_sorted_set().
EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st);
/**
+ * @internal
+ *
* Set the item data holding item fields to map to item values in genlist
*
* Once you decode an item, allocate a structure for it and fill the structure,
EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data);
/**
+ * @internal
+ *
* Get the item data
*
* This gets the data pointer set by elm_store_item_data_set().
EAPI void *elm_store_item_data_get(Elm_Store_Item *sti);
/**
+ * @internal
+ *
* Fetch the store than a store item belongs to
*
* This fetches the store object that owns the store item.
EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti);
/**
+ * @internal
+ *
* Fetch the genlist item that this store item controls
*
* @param sti The store item to query
/**
* Emitted when the signal NotificationClosed is received.
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI extern int ELM_EVENT_SYS_NOTIFY_NOTIFICATION_CLOSED;
-1, NULL, NULL)
/**
+ * @internal
+ *
* Causes a notification to be forcefully closed and removed from the user's
* view. It can be used, for example, in the event that what the notification
* pertains to is no longer relevant, or to cancel a notification * with no
EAPI void elm_sys_notify_close(unsigned int id);
/**
+ * @internal
+ *
* Sends a notification to the notification server.
*
* @param replaces_id Notification ID that this notification replaces.
data: null;
methods {
@property id {
- set {
+ set @internal {
[[Set the id of the Status Notifier Item.]]
}
- get {
+ get @internal {
[[Get the id of the Status Notifier Item.]]
}
values {
}
}
@property category {
- set {
+ set @internal {
[[Set the category of the Status Notifier Item.]]
}
- get {
+ get @internal {
[[Get the category of the Status Notifier Item.]]
}
values {
}
}
@property icon_theme_path {
- set {
+ set @internal {
[[Set the path to the theme where the icons can be found. Set this value to "" to use the default path.]]
}
- get {
+ get @internal {
[[Get the path to the icon's theme currently in use.]]
}
values {
}
}
@property menu {
- set {
+ set @internal {
[[Set the object path of the D-Bus Menu that is to be show when the Status Notifier Item is activated by the user.]]
}
- get {
+ get @internal {
[[Get the object path of the D-Bus Menu currently in use.]]
}
values {
}
}
@property att_icon_name {
- set {
+ set @internal {
[[Set the name of the attention icon to be used by the Status Notifier Item.]]
}
- get {
+ get @internal {
[[Get the name of the attention icon used by the Status Notifier Item.]]
}
values {
}
}
@property status {
- set {
+ set @internal {
[[Set the status of the Status Notifier Item.]]
}
- get {
+ get @internal {
[[Get the status of the Status Notifier Item.]]
}
values {
}
}
@property icon_name {
- set {
+ set @internal {
[[Set the name of the icon to be used by the Status Notifier Item.]]
}
- get {
+ get @internal {
[[Get the name of the icon used by the Status Notifier Item.]]
}
values {
}
}
@property title {
- set {
+ set @internal {
[[Set the title of the Status Notifier Item.]]
}
- get {
+ get @internal {
[[Get the title of the Status Notifier Item.]]
}
values {
title: const(char)* @nullable;
}
}
- register {
+ register @internal {
[[Register this Status Notifier Item in the System Tray Watcher. This function should only be called after the event #ELM_EVENT_SYSTRAY_READY is emitted.]]
return: bool;
}
/**
* Emitted when the systray is ready to be used by the application.
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI extern int ELM_EVENT_SYSTRAY_READY;
methods {
@property homogeneous {
[[Control the homogenous state in a table.]]
- set {}
- get {}
+ set {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
+ }
+ get {
+ [[
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
+ }
values {
homogeneous: bool; [[A boolean to set if the layout is
homogeneous in the table.]]
}
@property padding {
set {
- [[Set padding between cells. Default value is 0.]]
+ [[Set padding between cells. Default value is 0.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
- [[Get padding between cells.]]
+ [[Get padding between cells.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
horizontal: Evas.Coord; [[The horizontal padding.]]
set {
[[Set alignment of table. Default value is 0.5.
+ \@if MOBILE \@since_tizen 3.0
+ \@elseif WEARABLE \@since_tizen 3.0
+ \@endif
+
@since 1.13
]]
}
get {
[[Get alignment of table.
+ \@if MOBILE \@since_tizen 3.0
+ \@elseif WEARABLE \@since_tizen 3.0
+ \@endif
+
@since 1.13
]]
}
}
}
clear {
- [[Faster way to remove all child objects from a table object.]]
+ [[Faster way to remove all child objects from a table object.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
params {
@in clear: bool; [[If true, will delete children, else just remove from table.]]
}
}
child_get @const {
- [[Get child object of table at given coordinates.]]
+ [[Get child object of table at given coordinates.
+
+ \@if MOBILE \@since_tizen 3.0
+ \@elseif WEARABLE \@since_tizen 3.0
+ \@endif
+ ]]
return: Evas.Object *; [[Child of object if find if not return $null.]]
params {
@in col: int; [[Column number of child object.]]
legacy: null;
}
unpack {
- [[Remove child from table.]]
+ [[Remove child from table.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
params {
@in subobj: Evas.Object *; [[The subobject.]]
}
inside 16bit unsigned values cleanly. You will be warned once
values exceed 15bit storage, and attempting to use values not
able to fit in 16bits will result in failure.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
params {
@in subobj: Evas.Object *; [[The subobject to be added to the table.]]
* @return The new object or NULL if it cannot be created
*
* @ingroup Table
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Evas_Object *elm_table_add(Evas_Object *parent);
* value of 1 for colspan and rowspan means @p subobj only takes that 1 cell.
*
* @ingroup Table
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_table_pack_set(Evas_Object *subobj, int col, int row, int colspan, int rowspan);
* @see elm_table_pack_set()
*
* @ingroup Table
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_table_pack_get(Evas_Object *subobj, int *col, int *row, int *colspan, int *rowspan);
* applications).
*
* @ingroup Theme
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Elm_Theme *elm_theme_new(void);
* This frees a theme created with elm_theme_new().
*
* @ingroup Theme
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_theme_free(Elm_Theme *th);
* overlays and extensions that @p th had.
*
* @ingroup Theme
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
* don't apply, it will fall through to @p thref for configuration.
*
* @ingroup Theme
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
* If no theme is set as a reference, NULL is returned.
*
* @ingroup Theme
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Elm_Theme *elm_theme_ref_get(const Elm_Theme *th);
* as a shorthand of NULL.
*
* @ingroup Theme
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Elm_Theme *elm_theme_default_get(void);
* @see elm_theme_overlay_mmap_add()
*
* @ingroup Theme
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
* @see elm_theme_overlay_add()
*
* @ingroup Theme
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
* @see elm_theme_overlay_add()
*
* @ingroup Theme
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI void elm_theme_overlay_mmap_add(Elm_Theme *th, const Eina_File *f);
* @see elm_theme_overlay_mmap_add()
*
* @ingroup Theme
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI void elm_theme_overlay_mmap_del(Elm_Theme *th, const Eina_File *f);
* @see elm_theme_overlay_add()
*
* @ingroup Theme
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI const Eina_List *elm_theme_overlay_list_get(const Elm_Theme *th);
* @see elm_object_style_set()
*
* @ingroup Theme
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
* @see elm_theme_extension_add()
*
* @ingroup Theme
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
* @see elm_object_style_set()
*
* @ingroup Theme
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI void elm_theme_extension_mmap_add(Elm_Theme *th, const Eina_File *f);
* @see elm_theme_extension_add()
*
* @ingroup Theme
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI void elm_theme_extension_mmap_del(Elm_Theme *th, const Eina_File *f);
* @see elm_theme_extension_add()
*
* @ingroup Theme
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI const Eina_List *elm_theme_extension_list_get(const Elm_Theme *th);
* @see elm_theme_list_get()
*
* @ingroup Theme
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
* @see elm_theme_list_get()
*
* @ingroup Theme
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI const char *elm_theme_get(Elm_Theme *th);
* @see elm_theme_get()
*
* @ingroup Theme
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
* and @c EINA_FALSE otherwise.
*
* @ingroup Theme
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
* make any caches Elementary kept invalid.
*
* @ingroup Theme
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_theme_flush(Elm_Theme *th);
* elm_theme_flush() on each of them.
*
* @ingroup Theme
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_theme_full_flush(void);
* elm_theme_name_available_list_free() when you are done with the list.
*
* @ingroup Theme
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Eina_List *elm_theme_name_available_list_new(void);
* be used. a new list mys be created.
*
* @ingroup Theme
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_theme_name_available_list_free(Eina_List *list);
* helped.
*
* @ingroup Theme
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th);
* for more information.
*
* @ingroup Theme
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj);
* It works the same way as edje_file_data_get() except that the return is stringshared.
*
* @ingroup Theme
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI const char *elm_theme_data_get(Elm_Theme *th, const char *key);
*
* @since 1.8
* @ingroup Theme
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI const char *elm_theme_group_path_find(Elm_Theme *th, const char *group);
*
* @since 1.8
* @ingroup Theme
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI Eina_List *elm_theme_group_base_list(Elm_Theme *th, const char *base);
*
* @since 1.8
* @ingroup Theme
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI const char *elm_theme_system_dir_get(void);
*
* @since 1.8
* @ingroup Theme
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI const char *elm_theme_user_dir_get(void);
eo_prefix: elm_obj_thumb;
methods {
@property compress {
- set {
+ set @internal {
[[Set the compression for the thumb object.
@since 1.8
]]
}
- get {
+ get @internal {
[[Get the compression of the thumb object.
@since 1.8
}
}
@property format {
- set {
+ set @internal {
[[Set the format for the thumb object.
@since 1.8
]]
}
- get {
+ get @internal {
[[Get the format of the thumb object.
@since 1.8
}
}
@property animate {
- set {
+ set @internal {
[[Set the animation state for the thumb object.
If its content is an animated video, you may start/stop the
animation or tell it o play continuously and looping.
]]
}
- get {
+ get @internal {
[[Get the animation state for the thumb object.]]
}
values {
}
}
@property fdo_size {
- set {
+ set @internal {
[[Set the FDO size for the thumb object.
@since 1.8
]]
}
- get {
+ get @internal {
[[Get the fdo size of the thumb object.
@since 1.8
}
}
@property orientation {
- set {
+ set @internal {
[[Set the orientation for the thumb object.
@since 1.8
]]
}
- get {
+ get @internal {
[[Get the orientation of the thumb object.
@since 1.8
}
}
@property editable {
- set {
+ set @internal {
[[Make the thumbnail 'editable'.
This means the thumbnail is a valid drag target for drag and
]]
return: bool;
}
- get {
+ get @internal {
[[Get whether the thumbnail is editable.
This means the thumbnail is a valid drag target for drag and
}
}
@property aspect {
- set {
+ set @internal {
[[Set the aspect for the thumb object.
@since 1.8
]]
}
- get {
+ get @internal {
[[Get the aspect of the thumb object.
@since 1.8
}
}
@property quality {
- set {
+ set @internal {
[[Set the quality for the thumb object.
@since 1.8
]]
}
- get {
+ get @internal {
[[Get the quality of the thumb object.
@since 1.8
}
}
@property size {
- set {
+ set @internal {
[[Set the size for the thumb object.
@since 1.8
]]
}
- get {
+ get @internal {
[[Get the size of the thumb object.
@since 1.8
}
}
@property crop_align {
- set {
+ set @internal {
[[Set the crop alignment for the thumb object.
@since 1.8
]]
}
- get {
+ get @internal {
[[Get the crop alignment of the thumb object.
@since 1.8
}
}
@property path {
- get {
+ get @internal {
[[Get the path and key to the image or video thumbnail generated
by ethumb.
key: const(char)* @optional; [[Pointer to thumb key.]]
}
}
- reload {
+ reload @internal {
[[Reload thumbnail if it was generated before.
This is useful if the ethumb client configuration changed, like its
} Elm_Thumb_Animation_Setting;
/**
+ * @internal
+ *
* Get the ethumb_client handle so custom configuration can be made.
*
* @return Ethumb_Client instance or NULL.
EAPI void *elm_thumb_ethumb_client_get(void);
/**
+ * @internal
+ *
* Get the ethumb_client connection state.
*
* @return @c EINA_TRUE if the client is connected to the server or @c
/**
+ * @internal
+ *
* Add a new thumb object to the parent.
*
* @param parent The parent object.
EAPI Evas_Object *elm_thumb_add(Evas_Object *parent);
/**
+ * @internal
+ *
*
* Set the file that will be used as thumbnail @b source.
*
EAPI void elm_thumb_file_set(Eo *obj, const char *file, const char *key);
/**
+ * @internal
+ *
*
* Get the image or video path and key used to generate the thumbnail.
*
This will enable the homogeneous mode where items are of the same size.]]
set {
+ [[\@MOBILE_ONLY
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
}
get {
+ [[\@MOBILE_ONLY
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
}
values {
homogeneous: bool; [[Assume the items within the toolbar are of the same size (true = on, false = off). Default is $false.]]
Centered items by default.]]
set {
+ [[\@MOBILE_ONLY
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
}
get {
+ [[\@MOBILE_ONLY
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
}
values {
align: double; [[The new alignment, a float between 0.0 and 1.0.]]
entirely and they will neither appear selected nor call selected
callback functions.]]
set {
+ [[\@MOBILE_ONLY
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
}
get {
+ [[\@MOBILE_ONLY
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
}
values {
mode: Elm.Object.Select_Mode(Elm.Object.Select_Mode.max); [[The select mode If getting mode fails, it returns #ELM_OBJECT_SELECT_MODE_MAX]]
Note: Default value is $32. It reads value from elm config.]]
set {
+ [[\@MOBILE_ONLY
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
}
get {
+ [[\@MOBILE_ONLY
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
}
values {
icon_size: int; [[The icon size in pixels]]
By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.]]
set {
+ [[\@MOBILE_ONLY
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
}
get {
+ [[\@MOBILE_ONLY
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
}
values {
horizontal: bool; [[If $true, the toolbar is horizontal.]]
Icons added before calling this function will not be affected.
The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.]]
set {
+ [[\@MOBILE_ONLY
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
}
get {
+ [[\@MOBILE_ONLY
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
}
values {
order: Elm_Icon_Lookup_Order(1); [[The icon lookup order. (If getting the icon order loopup fails, it returns #ELM_ICON_LOOKUP_THEME_FDO)]]
Warning: This function's behavior will clash with those of
elm_scroller_policy_set(), so use either one of them, but not both.]]
set {
+ [[\@MOBILE_ONLY
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
}
get {
+ [[\@MOBILE_ONLY
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
}
values {
shrink_mode: Elm.Toolbar.Shrink_Mode; [[Toolbar's items display behavior]]
See: elm_menu_parent_set() for details.
See: elm_toolbar_item_menu_set() for details.]]
set {
+ [[\@MOBILE_ONLY
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
}
get {
+ [[\@MOBILE_ONLY
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
}
values {
parent: Evas.Object *; [[The parent of the menu objects.]]
@since 1.7]]
set {
+ [[\@MOBILE_ONLY
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
}
get {
+ [[\@MOBILE_ONLY
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
}
values {
priority: int; [[The standard_priority of visible items]]
}
@property selected_item {
get {
- [[Get the selected item.
+ [[\@MOBILE_ONLY
+
+ Get the selected item.
The selected item can be unselected with function
elm_toolbar_item_selected_set().
- The selected item always will be highlighted on toolbar.]]
+ The selected item always will be highlighted on toolbar.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
return: Elm.Widget_Item *; [[The selected toolbar item.]]
}
}
@property first_item {
get {
- [[Get the first item in the given toolbar widget's list of items.
+ [[\@MOBILE_ONLY
+
+ Get the first item in the given toolbar widget's list of items.
+
+ See: @.item_append and @.last_item
- See: @.item_append and @.last_item]]
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
return: Elm.Widget_Item *; [[The first item or $NULL, if it has no items (and on errors)]]
}
}
@property more_item {
get {
- [[Get the more item which is auto-generated by toolbar.
+ [[\@MOBILE_ONLY
+
+ Get the more item which is auto-generated by toolbar.
Toolbar generates 'more' item when there is no more space to fit items in
and toolbar is in #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_EXPAND mode.
The more item can be manipulated by elm_object_item_text_set() and
- elm_object_item_content_set.]]
+ elm_object_item_content_set.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
return: Elm.Widget_Item *; [[The toolbar more item.]]
}
}
@property last_item {
get {
- [[Get the last item in the given toolbar widget's list of items.
+ [[\@MOBILE_ONLY
- See: @.item_prepend and @.first_item]]
+ Get the last item in the given toolbar widget's list of items.
+
+ See: @.item_prepend and @.first_item
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
return: Elm.Widget_Item *; [[The last item or $NULL, if it has no items (and on errors)]]
}
}
item_insert_before {
- [[Insert a new item into the toolbar object before item $before.
+ [[\@MOBILE_ONLY
+
+ Insert a new item into the toolbar object before item $before.
A new item will be created and added to the toolbar. Its position in
this toolbar will be just before item $before.
Note: This function does not accept relative icon path.
- See: elm_toolbar_item_icon_set()]]
+ See: elm_toolbar_item_icon_set()
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
return: Elm.Widget_Item *; [[The created item or $NULL upon failure.]]
params {
}
}
item_insert_after {
- [[Insert a new item into the toolbar object after item $after.
+ [[\@MOBILE_ONLY
+
+ Insert a new item into the toolbar object after item $after.
A new item will be created and added to the toolbar. Its position in
this toolbar will be just after item $after.
Note: This function does not accept relative icon path.
- See: elm_toolbar_item_icon_set()]]
+ See: elm_toolbar_item_icon_set()
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
return: Elm.Widget_Item *; [[The created item or $NULL upon failure.]]
params {
}
}
item_append {
- [[Append item to the toolbar.
+ [[\@MOBILE_ONLY
+
+ Append item to the toolbar.
A new item will be created and appended to the toolbar, i.e., will
be set as last item.
Note: This function does not accept relative icon path.
- See: elm_toolbar_item_icon_set()]]
+ See: elm_toolbar_item_icon_set()
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
return: Elm.Widget_Item *; [[The created item or $NULL upon failure.]]
params {
}
}
items_count @const {
- [[Get the number of items in a toolbar]]
+ [[\@MOBILE_ONLY
+
+ Get the number of items in a toolbar
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
return: uint; [[The number of items in $obj toolbar]]
}
item_prepend {
- [[Prepend item to the toolbar.
+ [[\@MOBILE_ONLY
+
+ Prepend item to the toolbar.
A new item will be created and prepended to the toolbar, i.e., will
be set as first item.
Note: This function does not accept relative icon path.
- See: elm_toolbar_item_icon_set()]]
+ See: elm_toolbar_item_icon_set()
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
return: Elm.Widget_Item *; [[The created item or $NULL upon failure.]]
params {
}
}
item_find_by_label @const {
- [[Returns a pointer to a toolbar item by its label.]]
+ [[\@MOBILE_ONLY
+
+ Returns a pointer to a toolbar item by its label.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
return: Elm.Widget_Item *; [[The pointer to the toolbar item matching $label or $NULL on failure.]]
params {
typedef struct _Elm_Toolbar_Item_State Elm_Toolbar_Item_State; /**< State of a Elm_Toolbar_Item. Can be created with elm_toolbar_item_state_add() and removed with elm_toolbar_item_state_del(). */
/**
+ * @MOBILE_ONLY
+ *
* Unset the state of @p it.
*
* @param it The toolbar item.
* The default icon and label from this item will be displayed.
*
* @see elm_toolbar_item_state_set() for more details.
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @endif
*/
EAPI void elm_toolbar_item_state_unset(Elm_Object_Item *it);
methods {
@property prev {
get {
- [[Get the item before $item in toolbar.
+ [[\@MOBILE_ONLY
+
+ Get the item before $item in toolbar.
Note: If it is the first item, $null will be returned.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
]]
}
values {
}
@property next {
get {
- [[Get the item after $item in toolbar.
+ [[\@MOBILE_ONLY
+
+ Get the item after $item in toolbar.
Note: If it is the last item, $null will be returned.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
]]
}
values {
}
@property priority {
get {
- [[Get the priority of a toolbar item.]]
+ [[\@MOBILE_ONLY
+
+ Get the priority of a toolbar item.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
}
set {
- [[Set the priority of a toolbar item.
+ [[\@MOBILE_ONLY
+
+ Set the priority of a toolbar item.
This is used only when the toolbar shrink mode is set
to #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
dynamically-created menu, while items with higher
priority will remain on the toolbar, with the same
order they were added.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
]]
}
values {
}
@property selected {
get {
- [[Get whether the $item is selected or not.]]
+ [[\@MOBILE_ONLY
+
+ Get whether the $item is selected or not.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
}
set {
- [[Set the selected state of an item.
+ [[\@MOBILE_ONLY
+
+ Set the selected state of an item.
This sets the selected state of the given item $it.
$true for selected, $false for not selected.
function @Elm.Toolbar.selected_item.get.
Selected items will be highlighted.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
]]
}
values {
}
@property icon {
get {
- [[Get the string used to set the icon of $item.]]
+ [[\@MOBILE_ONLY
+
+ Get the string used to set the icon of $item.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
}
set {
- [[Set the icon associated with $item.
+ [[\@MOBILE_ONLY
+
+ Set the icon associated with $item.
Toolbar will load icon image from fdo or current theme.
This behavior can be set by
from a file.
Note: This function does not accept relative icon path.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
]]
}
values {
}
@property object {
get {
- [[Get the real Evas(Edje) object created to implement the
+ [[\@MOBILE_ONLY
+
+ Get the real Evas(Edje) object created to implement the
view of a given toolbar $item.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
]]
}
values {
}
@property icon_object {
get {
- [[Get the icon object of $item.
+ [[\@MOBILE_ONLY
+
+ Get the icon object of $item.
See also @.icon.set, @.icon_file_set, @.icon_memfile_set.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
]]
}
values {
}
@property separator {
get {
- [[Get a value whether item is a separator or not.]]
+ [[\@MOBILE_ONLY
+
+ Get a value whether item is a separator or not.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
}
set {
- [[Set or unset item as a separator.
+ [[\@MOBILE_ONLY
+
+ Set or unset item as a separator.
Items aren't set as separator by default.
If set as separator it will display separator theme, so
won't display icons or label.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
]]
}
values {
}
}
@property menu {
- get {
+ get @internal {
[[Get toolbar item's menu.
If $item wasn't set as menu item with @.menu_set,
}
@property state {
get {
- [[Get the current state of $it.]]
+ [[\@MOBILE_ONLY
+
+ Get the current state of $it.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
}
set {
- [[Set $state as the current state of $it.
+ [[\@MOBILE_ONLY
+
+ Set $state as the current state of $it.
If $state is $NULL, it won't select any state and the
default item's icon and label will be used. It's the
behavior as \@ref elm_toolbar_item_state_unset.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
]]
return: bool;
}
}
}*/
icon_memfile_set {
- [[Set the icon associated with $item to an image in a binary buffer.
+ [[\@MOBILE_ONLY
+
+ Set the icon associated with $item to an image in a binary buffer.
Note: The icon image set by this function can be changed by
@.icon.set.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
]]
params {
@in img: const (void) *; [[The binary data that will be used as an image.]]
return: bool;
}
icon_file_set {
- [[Set the icon associated with $item to an image in a binary buffer.
+ [[\@MOBILE_ONLY
+
+ Set the icon associated with $item to an image in a binary buffer.
Note: The icon image set by this function can be changed by
elm_toolbar_item_icon_set().
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
]]
params {
@in file: const (char) *; [[The file that contains the image.]]
return: bool;
}
state_add {
- [[Add a new state to $item.
+ [[\@MOBILE_ONLY
+
+ Add a new state to $item.
Toolbar will load icon image from fdo or current theme.
This behavior can be set by @Elm.Toolbar.icon_order_lookup.set
States created with this function can be removed with
@.state_del.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
]]
params {
@in icon: const (char) *; [[A string with icon name or the absolute path of an image file.]]
return: Elm_Toolbar_Item_State *; [[The toolbar item state, or $null upon failure.]]
}
state_del {
- [[Delete a previously added state to $item.]]
+ [[\@MOBILE_ONLY
+
+ Delete a previously added state to $item.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+ ]]
params {
@in state: Elm_Toolbar_Item_State *; [[The state to be deleted.]]
}
return: bool; [[$true on success or $false on failure.]]
}
state_next {
- [[Get the state after selected state in toolbar's $item.
+ [[\@MOBILE_ONLY
+
+ Get the state after selected state in toolbar's $item.
If last state is selected, this function will return first
state.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
]]
return: Elm_Toolbar_Item_State *; [[The state after current state, or $null on failure.]]
}
state_prev {
- [[Get the state before selected state in toolbar's $item.
+ [[\@MOBILE_ONLY
+
+ Get the state before selected state in toolbar's $item.
If first state is selected, this function will return last
state.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
]]
return: Elm_Toolbar_Item_State *; [[The state before current state, or $null on failure.]]
}
show {
- [[Show a specific item, when the toolbar can be scrolled.
+ [[\@MOBILE_ONLY
+
+ Show a specific item, when the toolbar can be scrolled.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
@since 1.8
]]
}
}
bring_in {
- [[Show a specific item with scroll animation, when the toolbar
+ [[\@MOBILE_ONLY
+
+ Show a specific item with scroll animation, when the toolbar
can be scrolled.
+ \@if MOBILE \@since_tizen 2.3
+ \@endif
+
@since 1.8
]]
params {
@in scrollto: Elm.Toolbar_Item.Scrollto_Type; [[The position the item should appear at.]]
}
}
- menu_set {
+ menu_set @internal {
[[Set whether the toolbar item opens a menu.
A toolbar item can be set to be a menu, using this function.
/**
+ * @MOBILE_ONLY
+ *
* Add a new toolbar widget to the given parent Elementary
* (container) object.
*
* This function inserts a new toolbar widget on the canvas.
*
* @ingroup Toolbar
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @endif
*/
EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent);
/**
+ * @MOBILE_ONLY
+ *
* Set reorder mode
*
* @param obj The toolbar object
* (@c EINA_TRUE = on, @c EINA_FALSE = off)
*
* @ingroup Toolbar
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @endif
*/
EAPI void elm_toolbar_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode);
/**
+ * @MOBILE_ONLY
+ *
* Get the reorder mode
*
* @param obj The toolbar object
* (@c EINA_TRUE = on, @c EINA_FALSE = off)
*
* @ingroup Toolbar
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @endif
*/
EAPI Eina_Bool elm_toolbar_reorder_mode_get(const Evas_Object *obj);
/**
+ * @MOBILE_ONLY
+ *
* Set the item's transverse expansion of a given toolbar widget @p obj.
*
* @param obj The toolbar object.
* The default is what the transverse length of the item is set according its min value.
*
* @ingroup Toolbar
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @endif
*/
EAPI void elm_toolbar_transverse_expanded_set(Evas_Object *obj, Eina_Bool transverse_expanded);
/**
+ * @MOBILE_ONLY
+ *
* Get the transverse expansion of toolbar @p obj.
*
* @param obj The toolbar object.
* @see elm_toolbar_transverse_expand_set() for details.
*
* @ingroup Toolbar
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @endif
*/
EAPI Eina_Bool elm_toolbar_transverse_expanded_get(const Evas_Object *obj);
* @see elm_object_tooltip_move_freeze_pop()
* @see elm_object_tooltip_move_freeze_get()
* @since 1.9
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI void elm_object_tooltip_move_freeze_push(Evas_Object *obj);
* @ingroup Tooltips
* @see elm_object_tooltip_move_freeze_push()
* @since 1.9
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI void elm_object_tooltip_move_freeze_pop(Evas_Object *obj);
* @ingroup Tooltips
* @see elm_object_tooltip_move_freeze_push()
* @since 1.9
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI int elm_object_tooltip_move_freeze_get(const Evas_Object *obj);
* @ingroup Tooltips
* @see Elm_Tooltip_Orient for possible values.
* @since 1.9
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI void elm_object_tooltip_orient_set(Evas_Object *obj, Elm_Tooltip_Orient orient);
* @ingroup Tooltips
* @see elm_object_tooltip_orient_set()
* @ref Elm_Tooltip_Orient for possible values.
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI Elm_Tooltip_Orient elm_object_tooltip_orient_get(const Evas_Object *obj);
typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb)(void *data, Evas_Object *obj, Evas_Object *tooltip, void *item);
/**
+ * @MOBILE_ONLY
+ *
* @brief Force show tooltip of object
*
* @param obj Target object
* This can force show more than one tooltip at a time.
*
* @ingroup Tooltips
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @endif
*/
EAPI void elm_object_tooltip_show(Evas_Object *obj);
/**
+ * @MOBILE_ONLY
+ *
* @brief Force hide tooltip of object
*
* @param obj Target object
* Force hide the tooltip and (re)enable future mouse interations.
*
* @ingroup Tooltips
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @endif
*/
EAPI void elm_object_tooltip_hide(Evas_Object *obj);
/**
+ * @MOBILE_ONLY
+ *
* @brief Set the text to be displayed inside the tooltip.
*
* @param obj The tooltip object.
* @param text The text to be displayed.
*
* @ingroup Tooltips
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @endif
*/
EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text);
EAPI void elm_object_tooltip_domain_translatable_text_set(Evas_Object *obj, const char *domain, const char *text);
#define elm_object_tooltip_translatable_text_set(obj, text) elm_object_tooltip_domain_translatable_text_set((obj), NULL, (text))
/**
+ * @MOBILE_ONLY
+ *
* @brief Set the content to be shown in the tooltip object
*
* @param obj The object being attached a tooltip.
* tooltip system and is deleted when the tooltip is gone.
*
* @ingroup Tooltips
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @endif
*/
EAPI void elm_object_tooltip_content_cb_set(Evas_Object *obj, Elm_Tooltip_Content_Cb func, const void *data, Evas_Smart_Cb del_cb);
/**
+ * @MOBILE_ONLY
+ *
* @brief Unset tooltip from object
*
* @param obj Target object
* @see elm_object_tooltip_content_cb_set()
*
* @ingroup Tooltips
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @endif
*/
EAPI void elm_object_tooltip_unset(Evas_Object *obj);
/**
+ * @MOBILE_ONLY
+ *
* @brief Set a different style for this object tooltip.
*
* @note before you set a style you should define a tooltip with
* @param style the theme style to use (default, transparent, ...)
*
* @ingroup Tooltips
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @endif
*/
EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style);
/**
+ * @MOBILE_ONLY
+ *
* @brief Get the style for this object tooltip.
*
* @param obj an object with tooltip already set.
* object does not have a tooltip set, then NULL is returned.
*
* @ingroup Tooltips
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @endif
*/
EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj);
/**
+ * @MOBILE_ONLY
+ *
* @brief Disable size restrictions on an object's tooltip
*
* @param obj The tooltip's anchor object
* It will instead be limited only by the size of the display.
*
* @ingroup Tooltips
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @endif
*/
EAPI Eina_Bool elm_object_tooltip_window_mode_set(Evas_Object *obj, Eina_Bool disable);
/**
+ * @MOBILE_ONLY
+ *
* @brief Get size restriction state of an object's tooltip
*
* @param obj The tooltip's anchor object
* It will instead be limited only by the size of the display.
*
* @ingroup Tooltips
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @endif
*/
EAPI Eina_Bool elm_object_tooltip_window_mode_get(const Evas_Object *obj);
* @return The transit object.
*
* @ingroup Transit
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Elm_Transit *elm_transit_add(void);
* @param transit The transit object to be deleted.
*
* @ingroup Transit
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_transit_del(Elm_Transit *transit);
* @warning The transit will free the context data at the and of the
* transition with the data_free_cb function.
* Do not share the context data in between different transit objects.
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_transit_effect_add(Elm_Transit *transit, Elm_Transit_Effect_Transition_Cb transition_cb, Elm_Transit_Effect *effect, Elm_Transit_Effect_End_Cb end_cb);
* @param effect The context data of the effect.
*
* @ingroup Transit
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_transit_effect_del(Elm_Transit *transit, Elm_Transit_Effect_Transition_Cb transition_cb, Elm_Transit_Effect *effect);
*
* @ingroup Transit
* @warning It is not allowed to add a new object after transit begins.
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj);
*
* @ingroup Transit
* @warning It is not allowed to remove objects after transit begins.
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj);
* @return a Eina_List with the objects from the transit.
*
* @ingroup Transit
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit);
* @param state_keep retain the state or not.
*
* @ingroup Transit
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep);
* If @p transit is NULL, @c EINA_FALSE is returned
*
* @ingroup Transit
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit);
* ignored otherwise.
*
* @ingroup Transit
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled);
* @c EINA_FALSE is returned
*
* @ingroup Transit
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit);
* @param data Callback function user data. It is the @p op parameter.
*
* @ingroup Transit
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data);
* @param reverse @c EINA_TRUE means the auto_reverse is on.
*
* @ingroup Transit
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse);
* @c EINA_FALSE is returned
*
* @ingroup Transit
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit);
* @param repeat Repeat count
*
* @ingroup Transit
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat);
* 0 is returned
*
* @ingroup Transit
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit);
* @param tween_mode The tween type.
*
* @ingroup Transit
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode);
* ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
*
* @ingroup Transit
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit);
* @see elm_transit_tween_mode_factor_get()
*
* @ingroup Transit
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_transit_tween_mode_factor_set(Elm_Transit *transit, double v1, double v2);
* @see elm_transit_tween_mode_factor_set()
*
* @ingroup Transit
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_transit_tween_mode_factor_get(const Elm_Transit *transit, double *v1, double *v2);
* @see elm_transit_tween_mode_factor_set()
* @since 1.13
* @ingroup Transit
+ *
+ * @if MOBILE @since_tizen 2.4
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_transit_tween_mode_factor_n_set(Elm_Transit *transit, unsigned int v_size, double *v);
* @param duration The animation time.
*
* @ingroup Transit
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration);
* @return The transit animation time.
*
* @ingroup Transit
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI double elm_transit_duration_get(const Elm_Transit *transit);
* @param transit The transit object.
*
* @ingroup Transit
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_transit_go(Elm_Transit *transit);
*
* @since 1.14
* @ingroup Transit
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI void elm_transit_go_in(Elm_Transit *transit, double in);
* @param paused Whether the transition should be paused or not.
*
* @ingroup Transit
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused);
* @c EINA_FALSE is returned
*
* @ingroup Transit
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit);
* 0 is returned
*
* @ingroup Transit
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI double elm_transit_progress_value_get(const Elm_Transit *transit);
* transit_example_02_explained for a full example.
*
* @ingroup Transit
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit);
* This function remove the @p chain_transit transition from the @p transit.
*
* @ingroup Transit
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit);
* @return chain transit list.
*
* @ingroup Transit
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
* @since 1.8
*
* @ingroup Transit
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_transit_smooth_set(Elm_Transit *transit, Eina_Bool enabled);
* @see elm_transit_smooth_set()
* @since 1.8
*
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Eina_Bool elm_transit_smooth_get(const Elm_Transit *transit);
* @return Resizing effect context data.
*
* @ingroup Transit
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Elm_Transit_Effect *elm_transit_effect_resizing_add(Elm_Transit *transit, Evas_Coord from_w, Evas_Coord from_h, Evas_Coord to_w, Evas_Coord to_h);
* the window that the objects of the transit belongs has already been created.
* This is because this effect needs the geometry information about the objects,
* and if the window was not created yet, it can get a wrong information.
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Elm_Transit_Effect *elm_transit_effect_translation_add(Elm_Transit *transit, Evas_Coord from_dx, Evas_Coord from_dy, Evas_Coord to_dx, Evas_Coord to_dy);
* the window that the objects of the transit belongs has already been created.
* This is because this effect needs the geometry information about the objects,
* and if the window was not created yet, it can get a wrong information.
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
* the window that the objects of the transit belongs has already been created.
* This is because this effect needs the geometry information about the objects,
* and if the window was not created yet, it can get a wrong information.
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
* the window that the objects of the transit belongs has already been created.
* This is because this effect needs the geometry information about the objects,
* and if the window was not created yet, it can get a wrong information.
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
* the window that the objects of the transit belongs has already been created.
* This is because this effect needs the geometry information about the objects,
* and if the window was not created yet, it can get a wrong information.
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
* @return Color effect context data.
*
* @ingroup Transit
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Elm_Transit_Effect *elm_transit_effect_color_add(Elm_Transit *transit, unsigned int from_r, unsigned int from_g, unsigned int from_b, unsigned int from_a, unsigned int to_r, unsigned int to_g, unsigned int to_b, unsigned int to_a);
* the window that the objects of the transit belongs has already been created.
* This is because this effect needs the color information about the objects,
* and if the window was not created yet, it can get a wrong information.
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
* the window that the objects of the transit belongs has already been created.
* This is because this effect needs the color information about the objects,
* and if the window was not created yet, it can get a wrong information.
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
* the window that the objects of the transit belongs has already been created.
* This is because this effect needs the geometry information about the objects,
* and if the window was not created yet, it can get a wrong information.
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
* @return Image Animation effect context data.
*
* @ingroup Transit
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
/**
eo_prefix: elm_obj_video;
methods {
@property audio_level {
- set {
+ set @internal {
[[Set the audio level of an Elm_Video object.]]
}
- get {
+ get @internal {
[[Get the audio level of the current video.]]
}
values {
}
}
@property remember_position {
- set {
+ set @internal {
[[Set whether the object can remember the last played position.
Note: This API only serves as indication. System support is
required.
]]
}
- get {
+ get @internal {
[[Set whether the object can remember the last played position.
Note: This API only serves as indication. System support is
}
}
@property play_position {
- set {
+ set @internal {
[[Set the current position (in seconds) to be played in the
Elm_Video object.]]
}
- get {
+ get @internal {
[[Get the current position (in seconds) being played in the
Elm_Video object.]]
}
}
}
@property audio_mute {
- set {
+ set @internal {
[[Change the mute state of the Elm_Video object.]]
}
- get {
+ get @internal {
[[Get whether audio is muted.]]
}
values {
}
}
@property is_playing {
- get {
+ get @internal {
[[Is the video actually playing.
You should consider watching event on the object instead of
}
}
@property play_length {
- get {
+ get @internal {
[[Get the total playing time (in seconds) of the Elm_Video object.]]
return: double; [[The total duration (in seconds) of the media file.]]
}
}
@property emotion {
- get {
+ get @internal {
[[Get the underlying Emotion object.]]
return: Evas.Object *; [[the underlying Emotion object.]]
}
}
@property is_seekable {
- get {
+ get @internal {
[[Is it possible to seek inside the video.]]
return: bool; [[true if is possible to seek inside the video.]]
}
}
@property title {
- get {
+ get @internal {
[[Get the title (for instance DVD title) from this emotion object.
This function is only useful when playing a DVD.
return: const(char)*; [[A string containing the title.]]
}
}
- play {
+ play @internal {
[[Start playing a video.]]
}
- pause {
+ pause @internal {
[[Pause a video.]]
}
- stop {
+ stop @internal {
[[Stop a video.]]
}
}
/**
+ * @internal
+ *
* @brief Add a new Elm_Player object to the given parent Elementary (container) object.
*
* @param parent The parent object
EAPI Evas_Object *elm_player_add(Evas_Object *parent);
/**
+ * @internal
+ *
* @brief Add a new Elm_Video object to the given parent Elementary (container) object.
*
* @param parent The parent object
EAPI Evas_Object *elm_video_add(Evas_Object *parent);
/**
+ * @internal
+ *
*
* @brief Define the file or URI that will be the video source.
*
EAPI Eina_Bool elm_video_file_set(Eo *obj, const char *filename);
/**
+ * @internal
+ *
*
* @brief Get the file or URI that is used as the video source.
*
eo_prefix: elm_obj_web;
methods {
@property text_matches_highlight {
- set {
+ set @internal {
[[Sets whether to highlight the matched marks.
If enabled, marks set with @.text_matches_mark will be
]]
return: bool;
}
- get {
+ get @internal {
[[Get whether highlighting marks is enabled.]]
}
values {
}
}
@property useragent {
- set {
+ set @internal {
[[Change useragent of a elm_web object.]]
}
- get {
+ get @internal {
[[Return current useragent of elm_web object.]]
}
values {
}
}
@property url {
- set {
+ set @internal {
[[Sets the URL for the web object.
It must be a full URL, with resource included, in the form
]]
return: bool;
}
- get {
+ get @internal {
[[Get the current URL for the object.
The returned string must not be freed and is guaranteed to be
}
}
@property bg_color {
- set {
+ set @internal {
[[Sets the background color to be used by the web object.
This is the color that will be used by default when the
pre-multiplied.
]]
}
- get {
+ get @internal {
[[Get the background color to be used by the web object.
This is the color that will be used by default when the
}
}
@property inwin_mode {
- set {
+ set @internal {
[[Sets the default dialogs to use an Inwin instead of a
normal window.
Otherwise they will use a normal separated window.
]]
}
- get {
+ get @internal {
[[Get whether Inwin mode is set for the current object.]]
}
values {
}
}
@property tab_propagate {
- set {
+ set @internal {
[[Sets whether to use tab propagation.
If tab propagation is enabled, whenever the user presses the
objects, jumping to the next widget only when that cycle ends.
]]
}
- get {
+ get @internal {
[[Get the status of the tab propagation.]]
}
values {
}
}
@property history_enabled {
- set {
+ set @internal {
[[Enables or disables the browsing history.]]
}
- get {
+ get @internal {
[[Get whether browsing history is enabled for the given object.]]
}
values {
}
}
@property zoom_mode {
- set {
+ set @internal {
[[Sets the zoom mode to use.
The modes can be any of those defined in .Elm_Web_Zoom_Mode,
leaving any space unused.
]]
}
- get {
+ get @internal {
[[Get the currently set zoom mode.]]
}
values {
}
}
@property zoom {
- set {
+ set @internal {
[[Sets the zoom level of the web object.
Zoom level matches the Webkit API, so 1.0 means normal zoom,
with @.zoom_mode.set is .ELM_WEB_ZOOM_MODE_MANUAL.
]]
}
- get {
+ get @internal {
[[Get the current zoom level set on the web object
Note that this is the zoom level set on the web object and
}
}
@property console_message_hook {
- set {
+ set @internal {
[[Sets the function to call when a console message is emitted
from JS.
}
}
@property window_create_hook {
- set {
+ set @internal {
[[Sets the function to call when a new window is requested.
This hook will be called when a request to create a new
}
}
@property dialog_file_selector_hook {
- set {
+ set @internal {
[[Sets the function to call when an file selector dialog.
This hook will be called when a JavaScript file selector
}
}
@property dialog_confirm_hook {
- set {
+ set @internal {
[[Sets the function to call when an confirm dialog.
This hook will be called when a JavaScript confirm dialog is
}
}
@property popup_selected {
- set {
+ set @internal {
[[Tells the web object which index in the currently open popup
was selected.
}
}
@property dialog_prompt_hook {
- set {
+ set @internal {
[[Sets the function to call when an prompt dialog.
This hook will be called when a JavaScript prompt dialog is
}
}
@property dialog_alert_hook {
- set {
+ set @internal {
[[Sets the function to call when an alert dialog.
This hook will be called when a JavaScript alert dialog is
}
}
@property forward_possible {
- get {
+ get @internal {
[[Queries whether it's possible to go forward in history.]]
return: bool;
}
}
@property webkit_view {
- get {
+ get @internal {
[[Get internal ewk_view object from web object.
Elementary may not provide some low level features of EWebKit,
}
}
@property back_possible {
- get {
+ get @internal {
[[Queries whether it's possible to go back in history.]]
return: bool;
}
}
@property load_progress {
- get {
+ get @internal {
[[Get the overall loading progress of the page.
Returns the estimated loading progress of the page, with a
}
}
@property selection {
- get {
+ get @internal {
[[Get a copy of the currently selected text.
The string returned must be freed by the user when it's done
}
}
@property title {
- get {
+ get @internal {
[[Get the current title.
The returned string must not be freed and is guaranteed to be
]]
}
}
- navigate {
+ navigate @internal {
[[Jumps the given number of steps in the browsing history.
The $steps value can be a negative integer to back in history,
@in steps: int; [[The number of steps to jump.]]
}
}
- back {
+ back @internal {
[[Goes back one step in the browsing history.
This is equivalent to calling elm_web_object_navigate(obj, -1);
]]
return: bool;
}
- html_string_load {
+ html_string_load @internal {
[[Loads the specified $html string as the content of the web
object.
@in wrap: bool; [[If search should wrap at the end.]]
}
}
- popup_destroy {
+ popup_destroy @internal {
[[Dismisses an open dropdown popup
When the popup from a dropdown widget is to be dismissed, either
return: bool; [[$true if the menu was successfully destroyed, or
$false if there was no menu to destroy.]]
}
- region_show {
+ region_show @internal {
[[Shows the given region in the web object.]]
params {
@in x: int; [[The x coordinate of the region to show.]]
@in h: int; [[The height of the region to show.]]
}
}
- forward {
+ forward @internal {
[[Goes forward one step in the browsing history.
This is equivalent to calling elm_web_object_navigate(obj, 1);
]]
return: bool; [[$true on success, $false otherwise.]]
}
- text_matches_mark {
+ text_matches_mark @internal {
[[Marks matches of the given string in a document.]]
return: uint; [[Number of matched $string.]]
params {
@in limit: uint; [[Maximum amount of matches, or zero to unlimited.]]
}
}
- region_bring_in {
+ region_bring_in @internal {
[[Brings in the region to the visible area.
Like @.region_show, but it animates the scrolling of the object
@in h: int; [[The height of the region to show.]]
}
}
- stop {
+ stop @internal {
[[Stops loading the current page.
Cancels the loading of the current page in the web object. This
]]
return: bool; [[$true if the cancel was successful, $false otherwise.]]
}
- navigate_possible_get {
+ navigate_possible_get @internal {
[[Queries whether it's possible to jump the given number of steps.
The $steps value can be a negative integer to back in history,
@in steps: int; [[The number of steps to check for.]]
}
}
- reload_full {
+ reload_full @internal {
[[Requests a reload of the current document, avoiding any
existing caches.
]]
return: bool; [[$true on success, $false otherwise.]]
}
- text_matches_unmark_all {
+ text_matches_unmark_all @internal {
[[Clears all marked matches in the document.]]
return: bool; [[$true on success, $false otherwise.]]
}
- reload {
+ reload @internal {
[[Requests a reload of the current document in the object.]]
return: bool; [[$true on success, $false otherwise.]]
}
typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char *message, unsigned int line_number, const char *source_id);
/**
+ * @internal
+ *
* Get boolean properties from Elm_Web_Window_Features
* (such as statusbar, menubar, etc) that are on a window.
*
EAPI Eina_Bool elm_web_window_features_property_get(const Elm_Web_Window_Features *wf, Elm_Web_Window_Feature_Flag flag);
/**
+ * @internal
+ *
*
* TODO : Add documentation.
*
/**
+ * @internal
+ *
* Add a new web object to the parent.
*
* @param parent The parent object.
EAPI Evas_Object *elm_web_add(Evas_Object *parent);
/**
+ * @internal
+ *
* Sets the URI for the web object
*
* It must be a full URI, with resource included, in the form
EINA_DEPRECATED EAPI Eina_Bool elm_web_uri_set(Evas_Object *obj, const char *uri);
/**
+ * @internal
+ *
* Get the current URI for the object
*
* The returned string must not be freed and is guaranteed to be
methods {
@property keyboard_win {
set {
- [[Sets whether the window is a keyboard.]]
+ [[Sets whether the window is a keyboard.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
- [[Get whether the window is a keyboard.]]
+ [[Get whether the window is a keyboard.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
is_keyboard: bool; [[If true, the window is a virtual keyboard.]]
signal is emitted. If $autodel is $false, then the window
will not be destroyed and is up to the program to do so
when it's required.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
- [[Get the window's autodel state.]]
+ [[Get the window's autodel state.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
autodel: bool; [[If true, the window will automatically delete
]]
set {
+ [[
+ \@if MOBILE \@since_tizen 3.0
+ \@elseif WEARABLE \@since_tizen 3.0
+ \@endif
+ ]]
}
get {
+ [[
+ \@if MOBILE \@since_tizen 3.0
+ \@elseif WEARABLE \@since_tizen 3.0
+ \@endif
+ ]]
}
values {
autohide: bool; [[If true, the window will automatically hide
reason and with a lot of care. Mishandling override windows
may result situations that disrupt the normal workflow of
the end user.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
- [[Get the override state of a window.]]
+ [[Get the override state of a window.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
override: bool; [[If true, the window is overridden.]]
}
@property iconified {
set {
- [[Set the iconified state of a window.]]
+ [[Set the iconified state of a window.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
- [[Get the iconified state of a window.]]
+ [[Get the iconified state of a window.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
iconified: bool; [[If true, the window is iconified.]]
the hints to WM. WM will refer this hints and set the
orientation window properly.
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+
@since 1.9
]]
legacy: elm_win_wm_rotation_available_rotations_set;
This function is used to get the available rotations.
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+
@since 1.9
]]
legacy: elm_win_wm_rotation_available_rotations_get;
}
@property quickpanel_zone {
set {
- [[Set which zone this quickpanel should appear in.]]
+ [[Set which zone this quickpanel should appear in.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
- [[Get which zone this quickpanel should appear in.]]
+ [[Get which zone this quickpanel should appear in.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
zone: int; [[The requested zone for this quickpanel.]]
}
@property maximized {
set {
- [[Set the maximized state of a window.]]
+ [[Set the maximized state of a window.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
- [[Get the maximized state of a window.]]
+ [[Get the maximized state of a window.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
maximized: bool; [[If true, the window is maximized.]]
}
@property modal {
set {
- [[Set the modal state of a window.]]
+ [[Set the modal state of a window.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
- [[Get the modal state of a window.]]
+ [[Get the modal state of a window.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
modal: bool; [[If true, the window is modal.]]
}
@property icon_name {
set {
- [[Set the icon name of the window.]]
+ [[Set the icon name of the window.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
[[Get the icon name of the window.
The returned string is an internal one and should not be
freed or modified. It will also be invalid if a new icon
name is set or if the window is destroyed.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
}
@property withdrawn {
set {
- [[Set the withdrawn state of a window.]]
+ [[Set the withdrawn state of a window.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
- [[Get the withdrawn state of a window.]]
+ [[Get the withdrawn state of a window.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
withdrawn: bool; [[If true, the window is withdrawn.]]
}
@property role {
set {
- [[Set the role of the window.]]
+ [[Set the role of the window.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
[[Get the role of the window.
The returned string is an internal one and should not be
freed or modified. It will also be invalid if a new role
is set or if the window is destroyed.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
Base size + stepping is what is calculated for window sizing
restrictions.
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+
@since 1.7
]]
}
get {
[[Get the stepping of a window.
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+
@since 1.7
]]
}
Sets the style to use for theming the highlight of focused
objects on the given window. If $style is NULL, the default
will be used.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
- [[Get the style set for the focus highlight object.]]
+ [[Get the style set for the focus highlight object.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
style: const(char)* @nullable; [[The style or $null if none.]]
This function requests the Window Manager to not draw any
decoration around the window.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
- [[Get the borderless state of a window.]]
+ [[Get the borderless state of a window.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
borderless: bool; [[If true, the window is borderless.]]
When $constrain is $true, $obj will never resize larger than
the screen.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
When this function returns $true, $obj will never resize
larger than the screen.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
set {
[[Set the array of available profiles to a window.
+ \@if MOBILE \@since_tizen 3.0
+ \@elseif WEARABLE \@since_tizen 3.0
+ \@endif
+
@since 1.8
]]
values {
get {
[[Get the array of available profiles of a window.
+ \@if MOBILE \@since_tizen 3.0
+ \@elseif WEARABLE \@since_tizen 3.0
+ \@endif
+
@since 1.8
]]
values {
This function will enable or disable the focus highlight only
for the given window, regardless of the global setting for it.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
- [[Get the enabled value of the focus highlight for this window.]]
+ [[Get the enabled value of the focus highlight for this window.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
enabled: bool; [[The enabled value for the highlight.]]
}
@property title {
set {
- [[Set the title of the window.]]
+ [[Set the title of the window.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
[[Get the title of the window.
The returned string is an internal one and should not be
freed or modified. It will also be invalid if a new title
is set or if the window is destroyed.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
"true" in window style(eg. elm/win/base/default), the window
is switched to alpha automatically without the explicit api
call.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
- [[Get the alpha channel state of a window.]]
+ [[Get the alpha channel state of a window.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
alpha: bool; [[$true if the window alpha channel is enabled,
}
@property urgent {
set {
- [[Set the urgent state of a window.]]
+ [[Set the urgent state of a window.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
- [[Get the urgent state of a window.]]
+ [[Get the urgent state of a window.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
urgent: bool; [[If true, the window is urgent.]]
resized to adjust to the new geometry of its contents. If
you want to keep the window size,
see @.rotation_with_resize.set.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
- [[Get the rotation of the window.]]
+ [[Get the rotation of the window.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
rotation: int; [[The rotation of the window, in degrees (0-360),
then call this function again to source the image pixels
and put them on the window's icon. Note that only Evas
image objects are allowed.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
/* FIXME-doc
Example of usage:
The object returns is the one marked by @.icon_object.set as
the object to use for the window icon.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
values {
icon: const(Evas.Object)* @nullable; [[The Evas image object to use for an icon.]]
}
@property quickpanel_priority_minor {
set {
- [[Set the minor priority of a quickpanel window.]]
+ [[Set the minor priority of a quickpanel window.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
- [[Get the minor priority of a quickpanel window.]]
+ [[Get the minor priority of a quickpanel window.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
priority: int(-1); [[The minor priority for this quickpanel.]]
Hints the Window Manager that the window in $obj should be
left fixed at its position even when the virtual desktop
it's on moves or changes.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
- [[Get the sticky state of the window.]]
+ [[Get the sticky state of the window.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
sticky: bool; [[If true, the window's sticky state is enabled.]]
}
@property keyboard_mode {
set {
- [[Sets the keyboard mode of the window.]]
+ [[Sets the keyboard mode of the window.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
- [[Get the keyboard mode of the window.]]
+ [[Get the keyboard mode of the window.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
mode: Elm.Win.Keyboard_Mode; [[The mode, one of #Elm_Win_Keyboard_Mode.]]
This function will enable or disable the animation of focus
highlight only for the given window, regardless of the
global setting for it.
+
+ \@if MOBILE \@since_tizen 3.0
+ \@elseif WEARABLE \@since_tizen 3.0
+ \@endif
]]
}
get {
- [[Get the animate value of the focus highlight for this window.]]
+ [[Get the animate value of the focus highlight for this window.
+
+ \@if MOBILE \@since_tizen 3.0
+ \@elseif WEARABLE \@since_tizen 3.0
+ \@endif
+ ]]
}
values {
animate: bool; [[The enabled value for the highlight animation.]]
}
@property aspect {
set {
- [[Set the aspect ratio of a window.]]
+ [[Set the aspect ratio of a window.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
- [[Get the aspect ratio of a window.]]
+ [[Get the aspect ratio of a window.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
aspect: double; [[If 0, the window has no aspect limits,
}
@property quickpanel_priority_major {
set {
- [[Set the major priority of a quickpanel window.]]
+ [[Set the major priority of a quickpanel window.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
- [[Get the major priority of a quickpanel window.]]
+ [[Get the major priority of a quickpanel window.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
priority: int(-1); [[The major priority for this quickpanel or -1.]]
}
@property indicator_opacity {
set {
- [[Sets the indicator opacity mode of the window.]]
+ [[Sets the indicator opacity mode of the window.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
- [[Get the indicator opacity mode of the window.]]
+ [[Get the indicator opacity mode of the window.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
mode: Elm.Win.Indicator_Opacity_Mode; [[The mode, one of #Elm_Win_Indicator_Opacity_Mode.]]
}
@property demand_attention {
set {
- [[Set the demand_attention state of a window.]]
+ [[Set the demand_attention state of a window.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
- [[Get the demand_attention state of a window.]]
+ [[Get the demand_attention state of a window.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
demand_attention: bool; [[If true, the window is demand_attention.]]
This function is used to get the preferred rotoation value.
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+
@since 1.9
]]
legacy: elm_win_wm_rotation_preferred_rotation_get;
be placed below all others, more than 5 means that the
window will be placed above all others, and anything else
means that the window will be placed in the default layer.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
- [[Get the layer of the window.]]
+ [[Get the layer of the window.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
layer: int; [[The layer of the window.]]
set {
[[Set the profile of a window.
+ \@if MOBILE \@since_tizen 2.4
+ \@elseif WEARABLE \@since_tizen 3.0
+ \@endif
+
@since 1.8
]]
}
get {
[[Get the profile of a window.
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+
@since 1.8
]]
}
background object or cover the entire window in any other way,
or the parts of the canvas that have no data will show
framebuffer artifacts.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
- [[Get the shaped state of a window.]]
+ [[Get the shaped state of a window.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
shaped: bool; [[If $true, the window is shaped.]]
}
@property fullscreen {
set {
- [[Set the fullscreen state of a window.]]
+ [[Set the fullscreen state of a window.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
- [[Get the fullscreen state of a window.]]
+ [[Get the fullscreen state of a window.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
fullscreen: bool; [[If $true, the window is fullscreen.]]
rotation done mode, it's disabled and user should call
this explicitly to sends the message.
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+
@since 1.9
]]
legacy: elm_win_wm_rotation_manual_rotation_done_set;
This function is used to get the state of manual rotation
done mode.
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+
@since 1.9
]]
legacy: elm_win_wm_rotation_manual_rotation_done_get;
}
@property indicator_mode {
set {
- [[Sets the indicator mode of the window.]]
+ [[Sets the indicator mode of the window.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
- [[Get the indicator mode of the window.]]
+ [[Get the indicator mode of the window.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
mode: Elm.Win.Indicator_Mode; [[The mode, one of #Elm_Win_Indicator_Mode.]]
}
@property conformant {
set {
- [[Set if this window is an illume conformant window.]]
+ [[Set if this window is an illume conformant window.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
get {
- [[Get if this window is an illume conformant window.]]
+ [[Get if this window is an illume conformant window.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
conformant: bool; [[The conformant flag.]]
Base size + stepping is what is calculated for window sizing
restrictions.
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+
@since 1.7
]]
}
get {
[[Get the base size of a window.
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+
@since 1.7
]]
}
[[Set a window to be an illume quickpanel window.
By default window objects are not quickpanel windows.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
get {
- [[Get if this window is a quickpanel or not.]]
+ [[Get if this window is a quickpanel or not.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
quickpanel: bool; [[The quickpanel flag.]]
Like @.rotation.set, but it also resizes the window's
contents so that they fit inside the current window geometry.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
side-effects like making the window non-accessible in
some cases unless the window is specially handled. Use
this with care.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
values {
}
@property screen_position {
get {
- [[Get the screen position of a window.]]
+ [[Get the screen position of a window.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
x: int; [[The int to store the x coordinate to.]]
See also @.wm_preferred_rotation, @.wm_available_rotations,
@.wm_manual_rotation_done.
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+
@since 1.9
]]
return: bool;
}
}
@property xwindow {
- get {
+ get @internal {
[[Get the Ecore_X_Window of an Evas_Object.]]
return: Ecore_X_Window;
}
}
@property focus {
get {
- [[Get whether a window has focus.]]
+ [[Get whether a window has focus.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
return: bool;
}
}
@property screen_size {
get {
- [[Get screen geometry details for the screen that a window is on.]]
+ [[Get screen geometry details for the screen that a window is on.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
x: int; [[Where to return the horizontal offset value. May be $null.]]
}
}
@property main_menu {
- get {
+ get @internal {
[[Get the Main Menu of a window.]]
return: Evas.Object *; [[The Main Menu of the window ($null on error).]]
}
}
@property wl_window {
- get {
+ get @internal {
[[Get the Ecore_Wl_Window of an Evas_Object.]]
return: Ecore_Wl_Window *; [[The Ecore_Wl_Window of $obj.]]
legacy: null;
}
}
@property window_id {
- get {
+ get @internal {
[[Get the Ecore_Window of an Evas_Object
When Elementary is using a Wayland engine, this function
get {
[[Get screen dpi for the screen that a window is on.
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+
@since 1.7
]]
}
object (be careful to not manipulate it as it is under
control of elementary), and use it to do things like get
pixel data, save the image to a file, etc.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
return: Evas.Object *; [[The inlined image object or $null if none exists.]]
}
@endcode
*/
set {
- [[Can only be used at creation time, within \@ref eo_add.]]
+ [[Can only be used at creation time, within \@ref eo_add.
+
+ \@if MOBILE \@since_tizen 3.0
+ \@elseif WEARABLE \@since_tizen 3.0
+ \@endif
+ ]]
}
values {
name: const(char)* @nullable;
@endcode
*/
set {
- [[Can only be used at creation time, within \@ref eo_add.]]
+ [[Can only be used at creation time, within \@ref eo_add.
+
+ \@if MOBILE \@since_tizen 3.0
+ \@elseif WEARABLE \@since_tizen 3.0
+ \@endif
+ ]]
}
get {
- [[If the object is not window object, return #ELM_WIN_UNKNOWN.]]
+ [[If the object is not window object, return #ELM_WIN_UNKNOWN.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
}
values {
type: Elm.Win.Type(Elm.Win.Type.unknown);
noblank property may have no effect if the window is
iconified/minimized or hidden.
+ \@if MOBILE \@since_tizen 3.0
+ \@elseif WEARABLE \@since_tizen 3.0
+ \@endif
+
@since 1.11
]]
}
get {
[[Get the noblank property of a window.
+ \@if MOBILE \@since_tizen 3.0
+ \@elseif WEARABLE \@since_tizen 3.0
+ \@endif
+
@since 1.11
]]
}
get {
[[Get the trap data associated with a window.
+ \@if MOBILE \@since_tizen 3.0
+ \@elseif WEARABLE \@since_tizen 3.0
+ \@endif
+
@since 1.12
]]
}
}
@property fake_canvas @protected {
set {
- [[Internal. Used to completent the fake window type.]]
+ [[Internal. Used to completent the fake window type.
+
+ \@if MOBILE \@since_tizen 3.0
+ \@elseif WEARABLE \@since_tizen 3.0
+ \@endif
+ ]]
}
values {
oee: Ecore_Evas *;
This function is used to notify the rotation done to WM manually.
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+
@since 1.9
]]
legacy: elm_win_wm_rotation_manual_rotation_done;
}
socket_listen {
- [[Create a socket to provide the service for Plug widget.]]
+ [[Create a socket to provide the service for Plug widget.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+ ]]
return: bool;
params {
@in svcname: const(char)*; [[The name of the service to be advertised.
which part of the environment to control (the part that this
window lives in), and provides a command and an optional
parameter structure (use NULL for this if not needed).
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
params {
@in command: Elm.Illume_Command; [[The command to send.]]
Note: This is just a request that a Window Manager may ignore,
so calling this function does not ensure in any way that the
window will be the active one after it.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
resize_object_add {
window, set this hint before adding it as a resize object (this
happens because the size of the window and the object are
evaluated as soon as the object is added to the window).
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
params {
@in subobj: Evas.Object *; [[The resize object to add.]]
If @.override.set is not set, the Window Manager may ignore this
request.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
lower {
If @.override.set is not set, the Window Manager may ignore this
request.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
}
resize_object_del {
of the window $obj. It will not delete the object itself, which
will be left unmanaged and should be deleted by the developer,
manually handled or set as child of some other container.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
params {
@in subobj: Evas.Object *; [[The resize object to add.]]
This function centers window $obj horizontally and/or vertically
based on the values of $h and $v.
+
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
]]
params {
@in v: bool; [[If true, center vertically. If false, do not change vertical location.]]
}
}
- keygrab_set {
+ keygrab_set @internal {
[[Set keygrab value of the window
This function grabs the $key of window using $grab_mode.
@in grab_mode: Elm.Win.Keygrab_Mode; [[According to the grabmode, it can grab key differently.]]
}
}
- keygrab_unset {
+ keygrab_unset @internal {
[[Unset keygrab value of the window
This function unset keygrab value. Ungrab $key of window.
* @warning this is an advanced feature that you should avoid using.
*
* @since 1.7
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Eina_Bool elm_win_trap_set(const Elm_Win_Trap *trap);
* @return The created object, or @c NULL on failure
*
* @ingroup Win
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
* @ingroup Win
*
* @since 1.13
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI Evas_Object *elm_win_fake_add(Ecore_Evas *ee);
* @see elm_win_add()
*
* @ingroup Win
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Evas_Object *elm_win_util_standard_add(const char *name, const char *title);
*
* @ingroup Win
* @since 1.13
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI Evas_Object *elm_win_util_dialog_add(Evas_Object *parent, const char *name, const char *title);
* @ingroup Win
* @see elm_win_floating_mode_get()
* @since 1.8
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_win_floating_mode_set(Evas_Object *obj, Eina_Bool floating);
* @ingroup Win
* @see elm_win_floating_mode_set()
* @since 1.8
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI Eina_Bool elm_win_floating_mode_get(const Evas_Object *obj);
* @see elm_win_render()
* @ingroup Win
* @since 1.7
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_win_norender_push(Evas_Object *obj);
* @see elm_win_render()
* @ingroup Win
* @since 1.7
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_win_norender_pop(Evas_Object *obj);
* @see elm_win_render()
* @ingroup Win
* @since 1.7
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI int elm_win_norender_get(const Evas_Object *obj);
* @see elm_win_norender_get()
* @ingroup Win
* @since 1.7
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_win_render(Evas_Object *obj);
/* Wayland specific call - returns NULL on non-Wayland engines */
/**
+ * @internal
+ *
* Get the Ecore_Wl_Window of an Evas_Object
*
* Do not use this function if you'd like your application/library be portable.
*
* ingroup Win
* @since 1.9
+ *
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
EAPI void elm_win_wm_rotation_preferred_rotation_set(const Evas_Object *obj, int rotation);
/**
+ * @internal
+ *
* Get the Ecore_Window of an Evas_Object
*
* When Elementary is using a Wayland engine, this function will return the surface id of the elm window's surface.
projects / platform / upstream / elementary.git / commitdiff