* Exposed symbol used only by macros and should not be used by apps
*/
EAPI void elm_quicklaunch_mode_set(Eina_Bool ql_on);
-
+
/**
* Exposed symbol used only by macros and should not be used by apps
*/
EAPI Eina_Bool elm_quicklaunch_mode_get(void);
-
+
/**
* Exposed symbol used only by macros and should not be used by apps
*/
EAPI int elm_quicklaunch_init(int argc, char **argv);
-
+
/**
* Exposed symbol used only by macros and should not be used by apps
*/
EAPI int elm_quicklaunch_sub_init(int argc, char **argv);
-
+
/**
* Exposed symbol used only by macros and should not be used by apps
*/
EAPI int elm_quicklaunch_sub_shutdown(void);
-
+
/**
* Exposed symbol used only by macros and should not be used by apps
*/
EAPI int elm_quicklaunch_shutdown(void);
-
+
/**
* Exposed symbol used only by macros and should not be used by apps
*/
EAPI void elm_quicklaunch_seed(void);
-
+
/**
* Exposed symbol used only by macros and should not be used by apps
*/
EAPI Eina_Bool elm_quicklaunch_prepare(int argc, char **argv);
-
+
/**
* Exposed symbol used only by macros and should not be used by apps
*/
EAPI Eina_Bool elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
-
+
/**
* Exposed symbol used only by macros and should not be used by apps
*/
EAPI void elm_quicklaunch_cleanup(void);
-
+
/**
* Exposed symbol used only by macros and should not be used by apps
*/
EAPI int elm_quicklaunch_fallback(int argc, char **argv);
-
+
/**
* Exposed symbol used only by macros and should not be used by apps
*/
* @ingroup Efreet
*/
EAPI Eina_Bool elm_need_efreet(void);
-
+
/**
* Request that your elementary application needs e_dbus
*
* applications).
*/
EAPI Elm_Theme *elm_theme_new(void);
+
/**
* Free a specific theme
*
* This frees a theme created with elm_theme_new().
*/
EAPI void elm_theme_free(Elm_Theme *th);
+
/**
* Copy the theme fom the source to the destination theme
*
* overlays and extensions that @p th had.
*/
EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
+
/**
* Tell the source theme to reference the ref theme
*
* don't apply, it will fall through to @p thref for configuration.
*/
EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
+
/**
* Return the theme referred to
*
* If no theme is set as a reference, NULL is returned.
*/
EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
+
/**
* Return the default theme
*
* as a shorthand of NULL.
*/
EAPI Elm_Theme *elm_theme_default_get(void);
+
/**
* Prepends a theme overlay to the list of overlays
*
* @see elm_theme_extension_add()
*/
EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
+
/**
* Delete a theme overlay from the list of overlays
*
* @see elm_theme_overlay_add()
*/
EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
+
/**
* Appends a theme extension to the list of extensions.
*
* @see elm_object_style_set()
*/
EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
+
/**
* Deletes a theme extension from the list of extensions.
*
* @see elm_theme_extension_add()
*/
EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
+
/**
* Set the theme search order for the given theme
*
* @see elm_theme_list_get()
*/
EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
+
/**
* Return the theme search order
*
* @see elm_theme_list_get()
*/
EAPI const char *elm_theme_get(Elm_Theme *th);
+
/**
* Return a list of theme elements to be used in a theme.
*
* @see elm_theme_get()
*/
EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
+
/**
* Return the full patrh for a theme element
*
* and EINA_FALSE otherwise.
*/
EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
+
/**
* Flush the current theme.
*
* make any caches Elementary kept invalid.
*/
EAPI void elm_theme_flush(Elm_Theme *th);
+
/**
* This flushes all themes (default and specific ones).
*
* elm_theme_flush() on each of them.
*/
EAPI void elm_theme_full_flush(void);
+
/**
* Set the theme for all elementary using applications on the current display
*
* environment variable.
*/
EAPI void elm_theme_all_set(const char *theme);
+
/**
* Return a list of theme elements in the theme search path
*
* elm_theme_name_available_list_free() when you are done with the list.
*/
EAPI Eina_List *elm_theme_name_available_list_new(void);
+
/**
* Free the list returned by elm_theme_name_available_list_new()
*
* be used. a new list mys be created.
*/
EAPI void elm_theme_name_available_list_free(Eina_List *list);
+
/**
* Set a specific theme to be used for this object and its children
*
* helped.
*/
EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
+
/**
* Get the specific theme to be used
*
* It works the same way as edje_file_data_get() except that the return is stringshared.
*/
EAPI const char *elm_theme_data_get(Elm_Theme *th, const char *key) EINA_ARG_NONNULL(2);
+
/**
* @}
*/
* @return The created object, or NULL on failure
*/
EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
+
/**
* Adds a window object with standard setup
*
* @see elm_win_add()
*/
EAPI Evas_Object *elm_win_util_standard_add(const char *name, const char *title);
+
/**
* Add @p subobj as a resize object of window @p obj.
*
* @param subobj The resize object to add
*/
EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
+
/**
* Delete @p subobj as a resize object of window @p obj.
*
* @param subobj The resize object to add
*/
EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
+
/**
* Set the title of the window
*
* @param title The title to set
*/
EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
+
/**
* Get the title of the window
*
* @return The title
*/
EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Set the window's autodel state.
*
* closed
*/
EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
+
/**
* Get the window's autodel state.
*
* @see elm_win_autodel_set()
*/
EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Activate a window object.
*
* @param obj The window object
*/
EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Lower a window object.
*
* @param obj The window object
*/
EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Raise a window object.
*
* @param obj The window object
*/
EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Center a window on its screen
*
* @param v If true, center vertically. If false, do not change vertical location.
*/
EAPI void elm_win_center(Evas_Object *obj, Eina_Bool h, Eina_Bool v) EINA_ARG_NONNULL(1);
+
/**
* Set the borderless state of a window.
*
* @param borderless If true, the window is borderless
*/
EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
+
/**
* Get the borderless state of a window.
*
* @return If true, the window is borderless
*/
EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Set the shaped state of a window.
*
* @see elm_win_alpha_set()
*/
EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
+
/**
* Get the shaped state of a window.
*
* @see elm_win_shaped_set()
*/
EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Set the alpha channel state of a window.
*
* @see elm_win_alpha_set()
*/
EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
+
/**
* Get the transparency state of a window.
*
* @see elm_win_transparent_set()
*/
EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Set the transparency state of a window.
*
* @see elm_win_alpha_set()
*/
EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
+
/**
* Get the alpha channel state of a window.
*
* @return If true, the window has an alpha channel
*/
EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Set the override state of a window.
*
* @param override If true, the window is overridden
*/
EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
+
/**
* Get the override state of a window.
*
* @see elm_win_override_set()
*/
EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Set the fullscreen state of a window.
*
* @param fullscreen If true, the window is fullscreen
*/
EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
+
/**
* Get the fullscreen state of a window.
*
* @return If true, the window is fullscreen
*/
EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Set the maximized state of a window.
*
* @param maximized If true, the window is maximized
*/
EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
+
/**
* Get the maximized state of a window.
*
* @return If true, the window is maximized
*/
EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Set the iconified state of a window.
*
* @param iconified If true, the window is iconified
*/
EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
+
/**
* Get the iconified state of a window.
*
* @return If true, the window is iconified
*/
EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Set the layer of the window.
*
* @param layer The layer of the window
*/
EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
+
/**
* Get the layer of the window.
*
* @see elm_win_layer_set()
*/
EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Set the rotation of the window.
*
* counter-clockwise.
*/
EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
+
/**
* Rotates the window and resizes it.
*
* counter-clockwise.
*/
EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
+
/**
* Get the rotation of the window.
*
* @see elm_win_rotation_with_resize_set()
*/
EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Set the sticky state of the window.
*
* @param sticky If true, the window's sticky state is enabled
*/
EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
+
/**
* Get the sticky state of the window.
*
* @see elm_win_sticky_set()
*/
EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Set if this window is an illume conformant window
*
* @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
*/
EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
+
/**
* Get if this window is an illume conformant window
*
* @return A boolean if this window is illume conformant or not
*/
EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Set a window to be an illume quickpanel window
*
* @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
*/
EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
+
/**
* Get if this window is a quickpanel or not
*
* @return A boolean if this window is a quickpanel or not
*/
EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Set the major priority of a quickpanel window
*
* @param priority The major priority for this quickpanel
*/
EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
+
/**
* Get the major priority of a quickpanel window
*
* @return The major priority of this quickpanel
*/
EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Set the minor priority of a quickpanel window
*
* @param priority The minor priority for this quickpanel
*/
EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
+
/**
* Get the minor priority of a quickpanel window
*
* @return The minor priority of this quickpanel
*/
EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Set which zone this quickpanel should appear in
*
* @param zone The requested zone for this quickpanel
*/
EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
+
/**
* Get which zone this quickpanel should appear in
*
* @return The requested zone for this quickpanel
*/
EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Set the window to be skipped by keyboard focus
*
* @param skip The skip flag state (EINA_TRUE if it is to be skipped)
*/
EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
+
/**
* Send a command to the windowing environment
*
* @param params Optional parameters for the command
*/
EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
+
/**
* Get the inlined image object handle
*
* @return The inlined image object, or NULL if none exists
*/
EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
+
/**
* Determine whether a window has focus
* @param obj The window to query
* @return EINA_TRUE if the window exists and has focus, else EINA_FALSE
*/
EAPI Eina_Bool elm_win_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Constrain the maximum width and height of a window to the width and height of its screen
*
* @param constrain EINA_TRUE to restrict the window's maximum size, EINA_FALSE to disable restriction
*/
EAPI void elm_win_screen_constrain_set(Evas_Object *obj, Eina_Bool constrain) EINA_ARG_NONNULL(1);
+
/**
* Retrieve the constraints on the maximum width and height of a window relative to the width and height of its screen
*
* @return EINA_TRUE to restrict the window's maximum size, EINA_FALSE to disable restriction
*/
EAPI Eina_Bool elm_win_screen_constrain_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Get screen geometry details for the screen that a window is on
* @param obj The window to query
* @param h where to return the height value. May be NULL.
*/
EAPI void elm_win_screen_size_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
+
/**
* Set the enabled status for the focus highlight in a window
*
* @param enabled The enabled value for the highlight
*/
EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
+
/**
* Get the enabled value of the focus highlight for this window
*
* @return EINA_TRUE if enabled, EINA_FALSE otherwise
*/
EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Set the style for the focus highlight on this window
*
* @param style The style to set
*/
EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
+
/**
* Get the style set for the focus highlight object
*
* @return The style set or NULL if none was. Default is used in that case.
*/
EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/*...
* ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
* ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
* (blank mouse, private mouse obj, defaultmouse)
*
*/
+
/**
* Sets the keyboard mode of the window.
*
* @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
*/
EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
+
/**
* Gets the keyboard mode of the window.
*
* @return The mode, one of #Elm_Win_Keyboard_Mode
*/
EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Sets whether the window is a keyboard.
*
* @param is_keyboard If true, the window is a virtual keyboard
*/
EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
+
/**
* Gets whether the window is a keyboard.
*
* @param y The int to store the y coordinate to
*/
EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
+
/**
* @}
*/
*
* @{
*/
+
/**
* Adds an inwin to the current window
*
* @return The new object or NULL if it cannot be created
*/
EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Activates an inwin object, ensuring its visibility
*
* @param obj The inwin to activate
*/
EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Set the content of an inwin object.
*
* @param content The object to set as content
*/
EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
+
/**
* Get the content of an inwin object.
*
* @return The content that is being used
*/
EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Unset the content of an inwin object.
*
* @return The content that was being used
*/
EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @}
*/
* @ingroup Bg
*/
EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
- /* smart callbacks called:
+
+ /**
+ * @}
*/
/**
ELM_ICON_FILE,
ELM_ICON_STANDARD
} Elm_Icon_Type;
+
/**
* @enum _Elm_Icon_Lookup_Order
* @typedef Elm_Icon_Lookup_Order
* @ingroup Icon
*/
EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+
/**
* Set the file that will be used as icon.
*
* @ingroup Icon
*/
EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
+
/**
* Set a location in memory to be used as an icon
*
* @ingroup Icon
*/
EAPI Eina_Bool elm_icon_memfile_set(Evas_Object *obj, const void *img, size_t size, const char *format, const char *key) EINA_ARG_NONNULL(1, 2);
+
/**
* Get the file that will be used as icon.
*
* @ingroup Icon
*/
EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
+
/**
* Set the file that will be used, but use a generated thumbnail.
*
* @ingroup Icon
*/
EAPI void elm_icon_thumb_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
+
/**
* Set the icon by icon standards names.
*
* @ingroup Icon
*/
EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
+
/**
* Get the icon name set by icon standard names.
*
* @ingroup Icon
*/
EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Set the smooth scaling for an icon object.
*
* @ingroup Icon
*/
EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
+
/**
* Get whether smooth scaling is enabled for an icon object.
*
* @ingroup Icon
*/
EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Disable scaling of this object.
*
* @ingroup Icon
*/
EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
+
/**
* Get whether scaling is disabled on the object.
*
* @ingroup Icon
*/
EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Set if the object is (up/down) resizable.
*
* @ingroup Icon
*/
EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
+
/**
* Get if the object is (up/down) resizable.
*
* @ingroup Icon
*/
EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
+
/**
* Get the object's image size
*
* @ingroup Icon
*/
EAPI void elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
+
/**
* Set if the icon fill the entire object area.
*
* @ingroup Icon
*/
EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
+
/**
* Get if the object is filled outside.
*
* @ingroup Icon
*/
EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Set the prescale size for the icon.
*
* @ingroup Icon
*/
EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
+
/**
* Get the prescale size for the icon.
*
* @ingroup Icon
*/
EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Gets the image object of the icon. DO NOT MODIFY THIS.
*
* @ingroup Icon
*/
EAPI Evas_Object *elm_icon_object_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Sets the icon lookup order used by elm_icon_standard_set().
*
* @ingroup Icon
*/
EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
+
/**
* Gets the icon lookup order.
*
* @ingroup Icon
*/
EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Enable or disable preloading of the icon
*
* @ingroup Icon
*/
EAPI void elm_icon_preload_set(Evas_Object *obj, Eina_Bool disable) EINA_ARG_NONNULL(1);
+
/**
* Get if the icon supports animation or not.
*
* @ingroup Icon
*/
EAPI Eina_Bool elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Set animation mode of the icon.
*
* @ingroup Icon
*/
EAPI void elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
+
/**
* Get animation mode of the icon.
*
* @ingroup Icon
*/
EAPI Eina_Bool elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Set animation play mode of the icon.
*
* @ingroup Icon
*/
EAPI void elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
+
/**
* Get animation play mode of the icon.
*
* @ingroup Image
*/
EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+
/**
* Set the file that will be used as image.
*
* @ingroup Image
*/
EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
+
/**
* Get the file that will be used as image.
*
* @ingroup Image
*/
EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
+
/**
* Set the smooth effect for an image.
*
* @ingroup Image
*/
EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
+
/**
* Get the smooth effect for an image.
*
* @ingroup Image
*/
EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
+
/**
* Disable scaling of this object.
*
* @ingroup Image
*/
EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
+
/**
* Get whether scaling is disabled on the object.
*
* @ingroup Image
*/
EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Set if the object is (up/down) resizable.
*
* @ingroup Image
*/
EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
+
/**
* Get if the object is (up/down) resizable.
*
* @ingroup Image
*/
EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
+
/**
* Set if the image fills the entire object area, when keeping the aspect ratio.
*
* @ingroup Image
*/
EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
+
/**
* Get if the object is filled outside
*
* @ingroup Image
*/
EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Set the prescale size for the image
*
* @ingroup Image
*/
EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
+
/**
* Get the prescale size for the image
*
* @ingroup Image
*/
EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Set the image orientation.
*
* @ingroup Image
*/
EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
+
/**
* Get the image orientation.
*
* @ingroup Image
*/
EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Make the image 'editable'.
*
* @ingroup Image
*/
EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
+
/**
* Check if the image 'editable'.
*
* @ingroup Image
*/
EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Get the basic Evas_Image object from this object (widget).
*
* @ingroup Image
*/
EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Set whether the original aspect ratio of the image should be kept on resize.
*
* @ingroup Image
*/
EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
+
/**
* Get if the object retains the original aspect ratio.
*
* @return The new object or NULL if it cannot be created
*/
EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+
/**
* Set the horizontal orientation
*
* EINA_FALSE = vertical)
*/
EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
+
/**
* Get the horizontal orientation
*
* @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
*/
EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Set the box to arrange its children homogeneously
*
* @param homogeneous The homogeneous flag
*/
EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
+
/**
* Get whether the box is using homogeneous mode or not
*
* @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
*/
EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Add an object to the beginning of the pack list
*
* @see elm_box_clear()
*/
EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
+
/**
* Add an object at the end of the pack list
*
* @see elm_box_clear()
*/
EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
+
/**
* Adds an object to the box before the indicated object
*
* @see elm_box_clear()
*/
EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
+
/**
* Adds an object to the box after the indicated object
*
* @see elm_box_clear()
*/
EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
+
/**
* Clear the box of all children
*
* @see elm_box_unpack_all()
*/
EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Unpack a box item
*
* @see elm_box_clear()
*/
EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
+
/**
* Remove all items from the box, without deleting them
*
* @see elm_box_unpack()
*/
EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Retrieve a list of the objects packed into the box
*
* @param obj The box object
*/
EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Set the space (padding) between the box's elements.
*
* @param vertical The vertical space between elements
*/
EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
+
/**
* Get the space (padding) between the box's elements.
*
* @see elm_box_padding_set()
*/
EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
+
/**
* Set the alignment of the whole bouding box of contents.
*
* @param vertical The vertical alignment of elements
*/
EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
+
/**
* Get the alignment of the whole bouding box of contents.
*
* @see elm_box_layout_transition()
*/
EAPI void elm_box_layout_set(Evas_Object *obj, Evas_Object_Box_Layout cb, const void *data, void (*free_data)(void *data)) EINA_ARG_NONNULL(1);
+
/**
* Special layout function that animates the transition from one layout to another
*
* @see elm_box_layout_set
*/
EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
+
/**
* Create a new ::Elm_Box_Transition to animate the switch of layouts
*
* @see elm_box_layout_transition
*/
EAPI Elm_Box_Transition *elm_box_transition_new(const double duration, Evas_Object_Box_Layout start_layout, void *start_layout_data, void(*start_layout_free_data)(void *data), Evas_Object_Box_Layout end_layout, void *end_layout_data, void(*end_layout_free_data)(void *data), void(*transition_end_cb)(void *data), void *transition_end_data) EINA_ARG_NONNULL(2, 5);
+
/**
* Free a Elm_Box_Transition instance created with elm_box_transition_new().
*
* @see elm_box_layout_transition
*/
EAPI void elm_box_transition_free(void *data);
+
/**
* @}
*/
* Follow through a complete example @ref button_example_01 "here".
* @{
*/
+
/**
* Add a new button to the parent's canvas
*
* @return The new object or NULL if it cannot be created
*/
EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+
/**
* Set the label used in the button
*
* @deprecated use elm_object_text_set() instead.
*/
EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
+
/**
* Get the label set for the button
*
* @deprecated use elm_object_text_set() instead.
*/
EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Set the icon used for the button
*
* @deprecated use elm_object_part_content_set() instead.
*/
EINA_DEPRECATED EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
+
/**
* Get the icon used for the button
*
* @deprecated use elm_object_part_content_get() instead
*/
EINA_DEPRECATED EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Remove the icon set without deleting it and return the object
*
* @deprecated use elm_object_part_content_unset() instead.
*/
EINA_DEPRECATED EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Turn on/off the autorepeat event generated when the button is kept pressed
*
* @param on A bool to turn on/off the event
*/
EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
+
/**
* Get whether the autorepeat feature is enabled
*
* @see elm_button_autorepeat_set()
*/
EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Set the initial timeout before the autorepeat event is generated
*
* @see elm_button_autorepeat_gap_timeout_set()
*/
EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
+
/**
* Get the initial timeout before the autorepeat event is generated
*
* @see elm_button_autorepeat_initial_timeout_set()
*/
EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Set the interval between each generated autorepeat event
*
* @see elm_button_autorepeat_initial_timeout_set()
*/
EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
+
/**
* Get the interval between each generated autorepeat event
*
* @return Interval in seconds
*/
EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @}
*/
* this API.
* @{
*/
+
/**
* @brief Type that controls when scrollbars should appear.
*
ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
ELM_SCROLLER_POLICY_LAST
} Elm_Scroller_Policy;
+
/**
* @brief Add a new scroller to the parent
*
* @return The new object or NULL if it cannot be created
*/
EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+
/**
* @brief Set the content of the scroller widget (the object to be scrolled around).
*
* @deprecated use elm_object_content_set() instead
*/
EINA_DEPRECATED EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
+
/**
* @brief Get the content of the scroller widget
*
* @deprecated use elm_object_content_get() instead.
*/
EINA_DEPRECATED EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Unset the content of the scroller widget
*
* @deprecated use elm_object_content_unset() instead.
*/
EINA_DEPRECATED EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Set custom theme elements for the scroller
*
* @param base The base name to use (default is "base")
*/
EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
+
/**
* @brief Make the scroller minimum size limited to the minimum size of the content
*
* that direction.
*/
EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
+
/**
* @brief Show a specific virtual region within the scroller content object
*
* virtual content object) is shown within the scroller.
*/
EAPI void elm_scroller_region_show(Evas_Object *obj, Evas_Coord x, Evas_Coord y, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
+
/**
* @brief Set the scrollbar visibility policy
*
* respectively for the horizontal and vertical scrollbars.
*/
EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
+
/**
* @brief Gets scrollbar visibility policy
*
* @see elm_scroller_policy_set()
*/
EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
+
/**
* @brief Get the currently visible content region
*
* @see elm_scroller_region_show()
*/
EAPI void elm_scroller_region_get(const Evas_Object *obj, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
+
/**
* @brief Get the size of the content object
*
* This gets the size of the content object of the scroller.
*/
EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
+
/**
* @brief Set bouncing behavior
*
* for the given axis with the boolean parameters for each axis.
*/
EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
+
/**
* @brief Get the bounce behaviour
*
* @see elm_scroller_bounce_set()
*/
EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
+
/**
* @brief Set scroll page size relative to viewport size.
*
* the other axis.
*/
EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
+
/**
* @brief Set scroll page size.
*
* @see elm_scroller_page_relative_set()
*/
EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
+
/**
* @brief Get scroll current page number.
*
* @see elm_scroller_page_brint_in()
*/
EAPI void elm_scroller_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
+
/**
* @brief Get scroll last page number.
*
* @see elm_scroller_page_brint_in()
*/
EAPI void elm_scroller_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
+
/**
* Show a specific virtual region within the scroller content object by page number.
*
* @see elm_scroller_page_bring_in()
*/
EAPI void elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
+
/**
* Show a specific virtual region within the scroller content object by page number.
*
* @see elm_scroller_page_show()
*/
EAPI void elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
+
/**
* @brief Show a specific virtual region within the scroller content object.
*
* @see elm_scroller_region_show()
*/
EAPI void elm_scroller_region_bring_in(Evas_Object *obj, Evas_Coord x, Evas_Coord y, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
+
/**
* @brief Set event propagation on a scroller
*
* the scroller and its parent. By default event propagation is disabled.
*/
EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation) EINA_ARG_NONNULL(1);
+
/**
* @brief Get event propagation for a scroller
*
* @see elm_scroller_propagate_events_set()
*/
EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Set scrolling gravity on a scroller
*
* Default values for x and y are 0.0
*/
EAPI void elm_scroller_gravity_set(Evas_Object *obj, double x, double y) EINA_ARG_NONNULL(1);
+
/**
* @brief Get scrolling gravity values for a scroller
*
*
*/
EAPI void elm_scroller_gravity_get(const Evas_Object *obj, double *x, double *y) EINA_ARG_NONNULL(1);
+
/**
* @}
*/
* See @ref tutorial_label for a demonstration of how to use a label widget.
* @{
*/
+
/**
* @brief Add a new label to the parent
*
* @return The new object or NULL if it cannot be created
*/
EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+
/**
* @brief Set the label on the label object
*
* @param label The label will be used on the label object
* @deprecated See elm_object_text_set()
*/
- EINA_DEPRECATED EAPI void elm_label_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_set instead */
+ EINA_DEPRECATED EAPI void elm_label_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
+
/**
* @brief Get the label used on the label object
*
* @return The string inside the label
* @deprecated See elm_object_text_get()
*/
- EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
+ EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Set the wrapping behavior of the label
*
* @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
*/
EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
+
/**
* @brief Get the wrapping behavior of the label
*
* @see elm_label_line_wrap_set()
*/
EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Set wrap width of the label
*
* @warning This is only relevant if the label is inside a container.
*/
EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
+
/**
* @brief Get wrap width of the label
*
* @see elm_label_wrap_width_set()
*/
EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Set wrap height of the label
*
* @warning This is only relevant if the label is inside a container.
*/
EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
+
/**
* @brief get wrap width of the label
*
* @return The wrap height in pixels at a minimum where words need to wrap
*/
EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Set the font size on the label object.
*
* instead. e.g. "default", "marker", "slide_long" etc.
*/
EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
+
/**
* @brief Set the text color on the label object
*
* instead. e.g. "default", "marker", "slide_long" etc.
*/
EAPI void elm_label_text_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a) EINA_ARG_NONNULL(1);
+
/**
* @brief Set the text align on the label object
*
* instead. e.g. "default", "marker", "slide_long" etc.
*/
EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
+
/**
* @brief Set background color of the label
*
* instead. e.g. "default", "marker", "slide_long" etc.
*/
EAPI void elm_label_background_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a) EINA_ARG_NONNULL(1);
+
/**
* @brief Set the ellipsis behavior of the label
*
* choosen wrap method was ELM_WRAP_WORD.
*/
EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
+
/**
* @brief Set the text slide of the label
*
* "slide_bounce".
*/
EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
+
/**
* @brief Get the text slide mode of the label
*
* @see elm_label_slide_set()
*/
EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Set the slide duration(speed) of the label
*
* to slide end position
*/
EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
+
/**
* @brief Get the slide duration(speed) of the label
*
* @see elm_label_slide_duration_set()
*/
EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @}
*/
* @ref tutorial_toggle show how to use a toggle.
* @{
*/
+
/**
* @brief Add a toggle to @p parent.
*
* @return The toggle object
*/
EINA_DEPRECATED EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+
/**
* @brief Sets the label to be displayed with the toggle.
*
* @deprecated use elm_object_text_set() instead.
*/
EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
+
/**
* @brief Gets the label of the toggle
*
* @deprecated use elm_object_text_get() instead.
*/
EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Set the icon used for the toggle
*
* @deprecated use elm_object_part_content_set() instead.
*/
EINA_DEPRECATED EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
+
/**
* @brief Get the icon used for the toggle
*
* @deprecated use elm_object_part_content_get() instead.
*/
EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Unset the icon used for the toggle
*
* @deprecated use elm_object_part_content_unset() instead.
*/
EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Sets the labels to be associated with the on and off states of the toggle.
*
* instead.
*/
EINA_DEPRECATED EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
+
/**
* @brief Gets the labels associated with the on and off states of the
* toggle.
* instead.
*/
EINA_DEPRECATED EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
+
/**
* @brief Sets the state of the toggle to @p state.
*
* @deprecated use elm_check_state_set() instead.
*/
EINA_DEPRECATED EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
+
/**
* @brief Gets the state of the toggle to @p state.
*
* @deprecated use elm_check_state_get() instead.
*/
EINA_DEPRECATED EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Sets the state pointer of the toggle to @p statep.
*
* @deprecated use elm_check_state_pointer_set() instead.
*/
EINA_DEPRECATED EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
+
/**
* @}
*/
*
* @{
*/
+
/**
* @brief Add a new frame to the parent
*
* @return The new object or NULL if it cannot be created
*/
EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+
/**
* @brief Set the frame label
*
* @deprecated use elm_object_text_set() instead.
*/
EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
+
/**
* @brief Get the frame label
*
* @deprecated use elm_object_text_get() instead.
*/
EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Set the content of the frame widget
*
* @deprecated use elm_object_content_set() instead.
*/
EINA_DEPRECATED EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
+
/**
* @brief Get the content of the frame widget
*
* @deprecated use elm_object_content_get() instead.
*/
EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Unset the content of the frame widget
*
* @deprecated use elm_object_content_unset() instead.
*/
EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @}
*/
*
* @{
*/
+
/**
* @brief Add a new table to the parent
*
* @return The new object or NULL if it cannot be created
*/
EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+
/**
* @brief Set the homogeneous layout in the table
*
* table (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
*/
EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
+
/**
* @brief Get the current table homogeneous mode.
*
* (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
*/
EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Set padding between cells.
*
* Default value is 0.
*/
EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
+
/**
* @brief Get padding between cells.
*
* @param vertical set the vertical padding.
*/
EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
+
/**
* @brief Add a subobject on the table with the coordinates passed
*
* value of 1 for w and h means @p subobj only takes that 1 cell.
*/
EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
+
/**
* @brief Remove child from table.
*
* @param subobj The subobject
*/
EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
+
/**
* @brief Faster way to remove all child objects from a table object.
*
* @param clear If true, will delete children, else just remove from table.
*/
EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
+
/**
* @brief Set the packing location of an existing child of the table
*
* value of 1 for w and h means @p subobj only takes that 1 cell.
*/
EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
+
/**
* @brief Get the packing location of an existing child of the table
*
* @see elm_table_pack_set()
*/
EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
+
/**
* @}
*/
typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
#define Elm_Gengrid_Item Elm_Gen_Item /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
+
/**
* Text fetching class function for Elm_Gen_Item_Class.
* @param data The data passed in the item creation function
* @return The allocated (NOT stringshared) string to set as the text
*/
typedef char *(*Elm_Gengrid_Item_Text_Get_Cb) (void *data, Evas_Object *obj, const char *part);
+
/**
* Content (swallowed object) fetching class function for Elm_Gen_Item_Class.
* @param data The data passed in the item creation function
* @return The content object to swallow
*/
typedef Evas_Object *(*Elm_Gengrid_Item_Content_Get_Cb) (void *data, Evas_Object *obj, const char *part);
+
/**
* State fetching class function for Elm_Gen_Item_Class.
* @param data The data passed in the item creation function
* @return The hell if I know
*/
typedef Eina_Bool (*Elm_Gengrid_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part);
+
/**
* Deletion class function for Elm_Gen_Item_Class.
* @param data The data passed in the item creation function
} func;
}; /**< #Elm_Gengrid_Item_Class member definitions */
#define Elm_Gengrid_Item_Class_Func Elm_Gen_Item_Class_Func
+
/**
* Add a new gengrid widget to the given parent Elementary
* (container) object
* @ingroup Gengrid
*/
EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
+
/**
* @brief Disable size restrictions on an object's tooltip
* @param item The tooltip's anchor object
* It will instead be limited only by the size of the display.
*/
EAPI Eina_Bool elm_gengrid_item_tooltip_window_mode_set(Elm_Gengrid_Item *item, Eina_Bool disable);
+
/**
* @brief Retrieve size restriction state of an object's tooltip
* @param item The tooltip's anchor object
* It will instead be limited only by the size of the display.
*/
EAPI Eina_Bool elm_gengrid_item_tooltip_window_mode_get(const Elm_Gengrid_Item *item);
+
/**
* Set the type of mouse pointer/cursor decoration to be shown,
* when the mouse pointer is over the given gengrid widget item
* @ingroup Layout
*/
EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+
/**
* Set the file that will be used as layout
*
* @ingroup Layout
*/
EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
+
/**
* Set the edje group from the elementary theme that will be used as layout
*
* @ingroup Layout
*/
EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
+
/**
* Set the layout content.
*
* @ingroup Layout
*/
EINA_DEPRECATED EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
+
/**
* Get the child object in the given content part.
*
* @ingroup Layout
*/
EINA_DEPRECATED EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
+
/**
* Unset the layout content.
*
* @ingroup Layout
*/
EINA_DEPRECATED EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
+
/**
* Set the text of the given part
*
* @deprecated use elm_object_part_text_set() instead.
*/
EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
+
/**
* Get the text set in the given part
*
* @deprecated use elm_object_part_text_get() instead.
*/
EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
+
/**
* Append child to layout box part.
*
* @ingroup Layout
*/
EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
+
/**
* Prepend child to layout box part.
*
* @ingroup Layout
*/
EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
+
/**
* Insert child to layout box part before a reference object.
*
* @ingroup Layout
*/
EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
+
/**
* Insert child to layout box part at a given position.
*
* @ingroup Layout
*/
EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
+
/**
* Remove a child of the given part box.
*
* @ingroup Layout
*/
EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
+
/**
* Remove all children of the given part box.
*
* @ingroup Layout
*/
EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
+
/**
* Insert child to layout table part.
*
* @ingroup Layout
*/
EAPI void elm_layout_table_pack(Evas_Object *obj, const char *part, Evas_Object *child_obj, unsigned short col, unsigned short row, unsigned short colspan, unsigned short rowspan) EINA_ARG_NONNULL(1);
+
/**
* Unpack (remove) a child of the given part table.
*
* @ingroup Layout
*/
EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
+
/**
* Remove all the child objects of the given part table.
*
* @ingroup Layout
*/
EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
+
/**
* Get the edje layout
*
* @ingroup Layout
*/
EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Get the edje data from the given layout
*
* @ingroup Layout
*/
EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
+
/**
* Eval sizing
*
*
* @{
*/
+
/**
* @brief Possible orient values for notify.
*
ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
} Elm_Notify_Orient;
+
/**
* @brief Add a new notify to the parent
*
* @return The new object or NULL if it cannot be created
*/
EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+
/**
* @brief Set the content of the notify widget
*
*
*/
EINA_DEPRECATED EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
+
/**
* @brief Unset the content of the notify widget
*
*
*/
EINA_DEPRECATED EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Return the content of the notify widget
*
*
*/
EINA_DEPRECATED EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Set the notify parent
*
* and replaced.
*/
EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
+
/**
* @brief Get the notify parent
*
* @see elm_notify_parent_set()
*/
EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Set the orientation
*
* @see @ref Elm_Notify_Orient for possible values.
*/
EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
+
/**
* @brief Return the orientation
* @param obj The notify object
* @see Elm_Notify_Orient
*/
EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Set the time interval after which the notify window is going to be
* hidden.
* timer will be started with this value, canceling any running timer.
*/
EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
+
/**
* @brief Return the timeout value (in seconds)
* @param obj the notify object
* @see elm_notify_timeout_set()
*/
EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Sets whether events should be passed to by a click outside
* its area.
* @note The default value is EINA_TRUE.
*/
EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
+
/**
* @brief Return true if events are repeat below the notify object
* @param obj the notify object
* @see elm_notify_repeat_events_set()
*/
EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @}
*/
ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
} Elm_Hover_Axis;
+
/**
* @brief Adds a hover object to @p parent
*
* @return The hover object or NULL if one could not be created
*/
EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+
/**
* @brief Sets the target object for the hover.
*
* This function will cause the hover to be centered on the target object.
*/
EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
+
/**
* @brief Gets the target object for the hover.
*
* @see elm_hover_target_set()
*/
EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Sets the parent object for the hover.
*
* parent object fills.
*/
EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
+
/**
* @brief Gets the parent object for the hover.
*
* @see elm_hover_parent_set()
*/
EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Sets the content of the hover object and the direction in which it
* will pop out.
* using it will be deleted, and vice-versa.
*/
EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
+
/**
* @brief Get the content of the hover object, in a given direction.
*
* @see elm_hover_content_set()
*/
EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
+
/**
* @brief Unset the content of the hover object, in a given direction.
*
* @see elm_hover_content_set()
*/
EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
+
/**
* @brief Returns the best swallow location for content in the hover.
*
* @see elm_hover_content_set()
*/
EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
+
/**
* @}
*/
*
* @{
*/
+
/**
* @typedef Elm_Entry_Anchor_Info
*
* by entries.
*/
typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
+
/**
* @struct _Elm_Entry_Anchor_Info
*
w, /**< Anchor geometry, relative to canvas */
h; /**< Anchor geometry, relative to canvas */
};
+
/**
* @typedef Elm_Entry_Filter_Cb
* This callback type is used by entry filters to modify text.
* @return The new object or NULL if it cannot be created
*/
EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+
/**
* Sets the entry to single line mode.
*
* will be on a single line.
*/
EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
+
/**
* Gets whether the entry is set to be single line.
*
* @see elm_entry_single_line_set()
*/
EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Sets the entry to password mode.
*
* @param password If true, password mode is enabled.
*/
EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
+
/**
* Gets whether the entry is set to password mode.
*
* @see elm_entry_password_set()
*/
EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* This sets the text displayed within the entry to @p entry.
*
* @note Using this function bypasses text filters
*/
EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
+
/**
* This returns the text currently shown in object @p entry.
* See also elm_entry_entry_set().
* @deprecated Use elm_object_text_get() instead.
*/
EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Appends @p entry to the text of the entry.
*
* @see elm_entry_text_filter_append()
*/
EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
+
/**
* Gets whether the entry is empty.
*
* @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
*/
EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Gets any selected text within the entry.
*
* @return The selected text within the entry or NULL on failure
*/
EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Returns the actual textblock object of the entry.
*
* @return The textblock object.
*/
EAPI const Evas_Object *elm_entry_textblock_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Forces calculation of the entry size and text layouting.
*
* @see elm_entry_textblock_get()
*/
EAPI void elm_entry_calc_force(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Inserts the given text into the entry at the current cursor position.
*
* @see elm_entry_text_filter_append()
*/
EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
+
/**
* Set the line wrap type to use on multi-line entries.
*
* @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
*/
EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
+
/**
* Gets the wrap mode the entry was set to use.
*
* @see also elm_entry_line_wrap_set()
*/
EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Sets if the entry is to be editable or not.
*
* if not, the entry is read-only and no user input is allowed.
*/
EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
+
/**
* Gets whether the entry is editable or not.
*
* @see elm_entry_editable_set()
*/
EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* This drops any existing text selection within the entry.
*
* @param obj The entry object
*/
EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* This selects all text within the entry.
*
* @param obj The entry object
*/
EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* This moves the cursor one place to the right within the entry.
*
* @return EINA_TRUE upon success, EINA_FALSE upon failure
*/
EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* This moves the cursor one place to the left within the entry.
*
* @return EINA_TRUE upon success, EINA_FALSE upon failure
*/
EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* This moves the cursor one line up within the entry.
*
* @return EINA_TRUE upon success, EINA_FALSE upon failure
*/
EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* This moves the cursor one line down within the entry.
*
* @return EINA_TRUE upon success, EINA_FALSE upon failure
*/
EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* This moves the cursor to the beginning of the entry.
*
* @param obj The entry object
*/
EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* This moves the cursor to the end of the entry.
*
* @param obj The entry object
*/
EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* This moves the cursor to the beginning of the current line.
*
* @param obj The entry object
*/
EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* This moves the cursor to the end of the current line.
*
* @param obj The entry object
*/
EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* This begins a selection within the entry as though
* the user were holding down the mouse button to make a selection.
* @param obj The entry object
*/
EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* This ends a selection within the entry as though
* the user had just released the mouse button while making a selection.
* @param obj The entry object
*/
EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Gets whether a format node exists at the current cursor position.
*
* @see elm_entry_cursor_is_visible_format_get()
*/
EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Gets if the current cursor position holds a visible format node.
*
* @see elm_entry_cursor_is_format_get()
*/
EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Gets the character pointed by the cursor at its current position.
*
* @return The text pointed by the cursors.
*/
EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* This function returns the geometry of the cursor.
*
* @return EINA_TRUE upon success, EINA_FALSE upon failure
*/
EAPI Eina_Bool elm_entry_cursor_geometry_get(const Evas_Object *obj, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
+
/**
* Sets the cursor position in the entry to the given value
*
* @param pos The position of the cursor
*/
EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
+
/**
* Retrieves the current position of the cursor in the entry
*
* @return The cursor position
*/
EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* This executes a "cut" action on the selected text in the entry.
*
* @param obj The entry object
*/
EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* This executes a "copy" action on the selected text in the entry.
*
* @param obj The entry object
*/
EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* This executes a "paste" action in the entry.
*
* @param obj The entry object
*/
EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* This clears and frees the items in a entry's contextual (longpress)
* menu.
* @see elm_entry_context_menu_item_add()
*/
EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* This adds an item to the entry's contextual menu.
*
* @param data The data to associate with the item for related functions
*/
EAPI void elm_entry_context_menu_item_add(Evas_Object *obj, const char *label, const char *icon_file, Elm_Icon_Type icon_type, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
+
/**
* This disables the entry's contextual (longpress) menu.
*
* @param disabled If true, the menu is disabled
*/
EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
+
/**
* This returns whether the entry's contextual (longpress) menu is
* disabled.
* @return If true, the menu is disabled
*/
EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* This appends a custom item provider to the list for that entry
*
* @see @ref entry-items
*/
EAPI void elm_entry_item_provider_append(Evas_Object *obj, Evas_Object *(*func) (void *data, Evas_Object *entry, const char *item), void *data) EINA_ARG_NONNULL(1, 2);
+
/**
* This prepends a custom item provider to the list for that entry
*
* @param data The data passed to @p func
*/
EAPI void elm_entry_item_provider_prepend(Evas_Object *obj, Evas_Object *(*func) (void *data, Evas_Object *entry, const char *item), void *data) EINA_ARG_NONNULL(1, 2);
+
/**
* This removes a custom item provider to the list for that entry
*
* @param data The data passed to @p func
*/
EAPI void elm_entry_item_provider_remove(Evas_Object *obj, Evas_Object *(*func) (void *data, Evas_Object *entry, const char *item), void *data) EINA_ARG_NONNULL(1, 2);
+
/**
* Append a filter function for text inserted in the entry
*
* @param data User data to pass to @p func
*/
EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
+
/**
* Prepend a filter function for text insdrted in the entry
*
* @param data User data to pass to @p func
*/
EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
+
/**
* Remove a filter from the list
*
* @param data The user data passed when adding the function
*/
EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
+
/**
* This converts a markup (HTML-like) string into UTF-8.
*
* @return The converted string (in UTF-8). It should be freed.
*/
EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
+
/**
* This converts a UTF-8 string into markup (HTML-like).
*
* @return The converted string (in markup). It should be freed.
*/
EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
+
/**
* This sets the file (and implicitly loads it) for the text to display and
* then edit. All changes are written back to the file after a short delay if
* @param format The file format
*/
EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
+
/**
* Gets the file being edited by the entry.
*
* @param format The file format
*/
EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
+
/**
* This function writes any changes made to the file set with
* elm_entry_file_set()
* @param obj The entry object
*/
EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* This sets the entry object to 'autosave' the loaded text file or not.
*
* @see elm_entry_file_set()
*/
EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
+
/**
* This gets the entry object's 'autosave' status.
*
* @see elm_entry_file_set()
*/
EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Control pasting of text and images for the widget.
*
* text+image+other.
*/
EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
+
/**
* Getting elm_entry text paste/drop mode.
*
* @return If the widget only accepts text from pastes.
*/
EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Enable or disable scrolling in entry
*
* @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
*/
EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
+
/**
* Get the scrollable state of the entry
*
* @return The scrollable state
*/
EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
+
/**
* This sets a widget to be displayed to the left of a scrolled entry.
*
* @see elm_entry_end_set()
*/
EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
+
/**
* Gets the leftmost widget of the scrolled entry. This object is
* owned by the scrolled entry and should not be modified.
* @return the left widget inside the scroller
*/
EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
+
/**
* Unset the leftmost widget of the scrolled entry, unparenting and
* returning it.
* @see elm_entry_icon_set()
*/
EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
+
/**
* Sets the visibility of the left-side widget of the scrolled entry,
* set by elm_entry_icon_set().
* EINA_FALSE if not.
*/
EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
+
/**
* This sets a widget to be displayed to the end of a scrolled entry.
*
* @see elm_entry_icon_set
*/
EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
+
/**
* Gets the endmost widget of the scrolled entry. This object is owned
* by the scrolled entry and should not be modified.
* @return the right widget inside the scroller
*/
EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
+
/**
* Unset the endmost widget of the scrolled entry, unparenting and
* returning it.
* @see elm_entry_icon_set()
*/
EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
+
/**
* Sets the visibility of the end widget of the scrolled entry, set by
* elm_entry_end_set().
* EINA_FALSE if not.
*/
EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
+
/**
* This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
* them).
* @param v The vertical scrollbar policy to apply
*/
EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
+
/**
* This enables/disables bouncing within the entry.
*
* @param v The vertical bounce state
*/
EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
+
/**
* Get the bounce mode
*
* Data for the elm_entry_filter_limit_size() entry filter.
*/
typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
+
/**
* @struct _Elm_Entry_Filter_Limit_Size
*
int max_char_count; /**< The maximum number of characters allowed. */
int max_byte_count; /**< The maximum number of bytes allowed*/
};
+
/**
* Filter inserted text based on user defined character and byte limits
*
* elm_entry_entry_set()).
*/
EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
+
/**
* @typedef Elm_Entry_Filter_Accept_Set
*
* Data for the elm_entry_filter_accept_set() entry filter.
*/
typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
+
/**
* @struct _Elm_Entry_Filter_Accept_Set
*
const char *accepted; /**< Set of characters accepted in the entry. */
const char *rejected; /**< Set of characters rejected from the entry. */
};
+
/**
* Filter inserted text based on accepted or rejected sets of characters
*
* @param layout layout type
*/
EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
+
/**
* Get the input panel layout of the entry
*
* @see elm_entry_input_panel_layout_set
*/
EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Set the autocapitalization type on the immodule.
*
* @param autocapital_type The type of autocapitalization
*/
EAPI void elm_entry_autocapital_type_set(Evas_Object *obj, Elm_Autocapital_Type autocapital_type) EINA_ARG_NONNULL(1);
+
/**
* Retrieve the autocapitalization type on the immodule.
*
* @return autocapitalization type
*/
EAPI Elm_Autocapital_Type elm_entry_autocapital_type_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Sets the attribute to show the input panel automatically.
*
* @param enabled If true, the input panel is appeared when entry is clicked or has a focus
*/
EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
+
/**
* Retrieve the attribute to show the input panel automatically.
*
*
* @{
*/
+
/**
* @typedef Elm_Entry_Anchorview_Info
*
* the Anchorview widget.
*/
typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
+
/**
* @struct _Elm_Entry_Anchorview_Info
*
below the hover. See @ref
hover_left */
};
+
/**
* Add a new Anchorview object
*
* @return The new object or NULL if it cannot be created
*/
EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+
/**
* Set the text to show in the anchorview
*
* @deprecated use elm_object_text_set() instead.
*/
EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
+
/**
* Get the markup text set for the anchorview
*
* @deprecated use elm_object_text_set() instead.
*/
EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Set the parent of the hover popup
*
* @param parent The object to use as parent for the hover
*/
EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
+
/**
* Get the parent of the hover popup
*
* @return The object used as parent for the hover, NULL if none is set.
*/
EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Set the style that the hover should use
*
* @see elm_object_style_set()
*/
EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
+
/**
* Get the style that the hover should use
*
* @see elm_object_style_set()
*/
EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Ends the hover popup in the anchorview
*
* @param obj The anchorview object
*/
EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Set bouncing behaviour when the scrolled content reaches an edge
*
* @see elm_scroller_bounce_set()
*/
EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
+
/**
* Get the set bouncing behaviour of the internal scroller
*
* @see elm_scroller_bounce_get()
*/
EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
+
/**
* Appends a custom item provider to the given anchorview
*
* @see elm_entry_item_provider_append()
*/
EAPI void elm_anchorview_item_provider_append(Evas_Object *obj, Evas_Object *(*func) (void *data, Evas_Object *anchorview, const char *item), void *data) EINA_ARG_NONNULL(1, 2);
+
/**
* Prepend a custom item provider to the given anchorview
*
* @param data User data that will be passed to the callback function
*/
EAPI void elm_anchorview_item_provider_prepend(Evas_Object *obj, Evas_Object *(*func) (void *data, Evas_Object *anchorview, const char *item), void *data) EINA_ARG_NONNULL(1, 2);
+
/**
* Remove a custom item provider from the list of the given anchorview
*
* @param data The data matching the function to remove from the list
*/
EAPI void elm_anchorview_item_provider_remove(Evas_Object *obj, Evas_Object *(*func) (void *data, Evas_Object *anchorview, const char *item), void *data) EINA_ARG_NONNULL(1, 2);
+
/**
* @}
*/
* Since examples are usually better than plain words, we might as well
* try @ref tutorial_anchorblock_example "one".
*/
+
/**
* @addtogroup Anchorblock
* @{
*/
+
/**
* @typedef Elm_Entry_Anchorblock_Info
*
* the Anchorblock widget.
*/
typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
+
/**
* @struct _Elm_Entry_Anchorblock_Info
*
below the hover. See @ref
hover_left */
};
- /**
+
+/**
* Add a new Anchorblock object
*
* @param parent The parent object
* @return The new object or NULL if it cannot be created
*/
EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+
/**
* Set the text to show in the anchorblock
*
* @deprecated use elm_object_text_set() instead.
*/
EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
+
/**
* Get the markup text set for the anchorblock
*
* @deprecated use elm_object_text_set() instead.
*/
EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Set the parent of the hover popup
*
* @param parent The object to use as parent for the hover
*/
EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
+
/**
* Get the parent of the hover popup
*
* @return The object used as parent for the hover, NULL if none is set.
*/
EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Set the style that the hover should use
*
* @see elm_object_style_set()
*/
EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
+
/**
* Get the style that the hover should use
*
* @see elm_object_style_set()
*/
EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Ends the hover popup in the anchorblock
*
* @param obj The anchorblock object
*/
EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Appends a custom item provider to the given anchorblock
*
* @see elm_entry_item_provider_append()
*/
EAPI void elm_anchorblock_item_provider_append(Evas_Object *obj, Evas_Object *(*func) (void *data, Evas_Object *anchorblock, const char *item), void *data) EINA_ARG_NONNULL(1, 2);
+
/**
* Prepend a custom item provider to the given anchorblock
*
* @param data User data that will be passed to the callback function
*/
EAPI void elm_anchorblock_item_provider_prepend(Evas_Object *obj, Evas_Object *(*func) (void *data, Evas_Object *anchorblock, const char *item), void *data) EINA_ARG_NONNULL(1, 2);
+
/**
* Remove a custom item provider from the list of the given anchorblock
*
* @param data The data matching the function to remove from the list
*/
EAPI void elm_anchorblock_item_provider_remove(Evas_Object *obj, Evas_Object *(*func) (void *data, Evas_Object *anchorblock, const char *item), void *data) EINA_ARG_NONNULL(1, 2);
+
/**
* @}
*/
* This function adds a text bubble to the given parent evas object.
*/
EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+
/**
* Set the label of the bubble
*
* @deprecated use elm_object_text_set() instead.
*/
EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
+
/**
* Get the label of the bubble
*
* @deprecated use elm_object_text_get() instead.
*/
EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Set the info of the bubble
*
* @deprecated use elm_object_part_text_set() instead. (with "info" as the parameter).
*/
EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
+
/**
* Get the info of the bubble
*
* @deprecated use elm_object_part_text_get() instead. (with "info" as the parameter).
*/
EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Set the content to be shown in the bubble
*
*
*/
EINA_DEPRECATED EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
+
/**
* Get the content shown in the bubble
*
*
*/
EINA_DEPRECATED EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Unset the content shown in the bubble
*
*
*/
EINA_DEPRECATED EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Set the icon of the bubble
*
*
*/
EINA_DEPRECATED EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
+
/**
* Get the icon of the bubble
*
*
*/
EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Unset the icon of the bubble
*
*
*/
EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Set the corner of the bubble
*
* @li "bottom_right"
*/
EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
+
/**
* Get the corner of the bubble
*
* This function gets the selected corner of the bubble.
*/
EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @}
*/
* @ingroup Thumb
*/
EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+
/**
* Reload thumbnail if it was generated before.
*
* @ingroup Thumb
*/
EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Set the file that will be used as thumbnail.
*
* @ingroup Thumb
*/
EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
+
/**
* Get the image or video path and key used to generate the thumbnail.
*
* @ingroup Thumb
*/
EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
+
/**
* Get the path and key to the image or video generated by ethumb.
*
* @ingroup Thumb
*/
EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
+
/**
* Set the animation state for the thumb object. If its content is an animated
* video, you may start/stop the animation or tell it to play continuously and
* @ingroup Thumb
*/
EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
+
/**
* Get the animation state for the thumb object.
*
* @ingroup Thumb
*/
EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Get the ethumb_client handle so custom configuration can be made.
*
* @ingroup Thumb
*/
EAPI void *elm_thumb_ethumb_client_get(void);
+
/**
* Get the ethumb_client connection state.
*
* otherwise.
*/
EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
+
/**
* Make the thumbnail 'editable'.
*
* @ingroup Thumb
*/
EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
+
/**
* Make the thumbnail 'editable'.
*
* eina_stringshare_ref()).
*/
typedef struct _Elm_Web_Frame_Load_Error Elm_Web_Frame_Load_Error;
+
/**
* Structure used to report load errors.
*
* Structure describing the items in a menu
*/
typedef struct _Elm_Web_Menu_Item Elm_Web_Menu_Item;
+
/**
* Structure describing the items in a menu
*/
* @see elm_web_popup_destroy()
*/
typedef struct _Elm_Web_Menu Elm_Web_Menu;
+
/**
* Structure describing the menu of a popup
*
ELM_WEB_ZOOM_MODE_AUTO_FILL, /**< Zoom until content fills web object */
ELM_WEB_ZOOM_MODE_LAST
} Elm_Web_Zoom_Mode;
+
/**
* Opaque handler containing the features (such as statusbar, menubar, etc)
* that are to be set on a newly requested window.
*/
typedef struct _Elm_Web_Window_Features Elm_Web_Window_Features;
+
/**
* Callback type for the create_window hook.
*
* @see elm_web_window_create_hook_set()
*/
typedef Evas_Object *(*Elm_Web_Window_Open)(void *data, Evas_Object *obj, Eina_Bool js, const Elm_Web_Window_Features *window_features);
+
/**
* Callback type for the JS alert hook.
*
* @see elm_web_dialog_alert_hook_set()
*/
typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const char *message);
+
/**
* Callback type for the JS confirm hook.
*
* @see elm_web_dialog_confirm_hook_set()
*/
typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, const char *message, Eina_Bool *ret);
+
/**
* Callback type for the JS prompt hook.
*
* @see elm_web_dialog_prompt_hook_set()
*/
typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, const char *message, const char *def_value, char **value, Eina_Bool *ret);
+
/**
* Callback type for the JS file selector hook.
*
* @see elm_web_dialog_file selector_hook_set()
*/
typedef Evas_Object *(*Elm_Web_Dialog_File_Selector)(void *data, Evas_Object *obj, Eina_Bool allows_multiple, Eina_List *accept_types, Eina_List **selected, Eina_Bool *ret);
+
/**
* Callback type for the JS console message hook.
*
* @see elm_web_console_message_hook_set()
*/
typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char *message, unsigned int line_number, const char *source_id);
+
/**
* Add a new web object to the parent.
*
* @param data User data
*/
EAPI void elm_web_window_create_hook_set(Evas_Object *obj, Elm_Web_Window_Open func, void *data);
+
/**
* Sets the function to call when an alert dialog
*
* @see elm_web_inwin_mode_set()
*/
EAPI void elm_web_dialog_alert_hook_set(Evas_Object *obj, Elm_Web_Dialog_Alert func, void *data);
+
/**
* Sets the function to call when an confirm dialog
*
* @see elm_web_inwin_mode_set()
*/
EAPI void elm_web_dialog_confirm_hook_set(Evas_Object *obj, Elm_Web_Dialog_Confirm func, void *data);
+
/**
* Sets the function to call when an prompt dialog
*
* @see elm_web_inwin_mode_set()
*/
EAPI void elm_web_dialog_prompt_hook_set(Evas_Object *obj, Elm_Web_Dialog_Prompt func, void *data);
+
/**
* Sets the function to call when an file selector dialog
*
* @see elm_web_inwin_mode_set()
*/
EAPI void elm_web_dialog_file_selector_hook_set(Evas_Object *obj, Elm_Web_Dialog_File_Selector func, void *data);
+
/**
* Sets the function to call when a console message is emitted from JS
*
* @param data User data
*/
EAPI void elm_web_console_message_hook_set(Evas_Object *obj, Elm_Web_Console_Message func, void *data);
+
/**
* Gets the status of the tab propagation
*
* @see elm_web_tab_propagate_set()
*/
EAPI Eina_Bool elm_web_tab_propagate_get(const Evas_Object *obj);
+
/**
* Sets whether to use tab propagation
*
* @param propagate Whether to propagate Tab keys to Elementary or not
*/
EAPI void elm_web_tab_propagate_set(Evas_Object *obj, Eina_Bool propagate);
+
/**
* Sets the URI for the web object
*
* @return EINA_TRUE if the URI could be, EINA_FALSE if an error occurred
*/
EAPI Eina_Bool elm_web_uri_set(Evas_Object *obj, const char *uri);
+
/**
* Gets the current URI for the object
*
* failure
*/
EAPI const char *elm_web_uri_get(const Evas_Object *obj);
+
/**
* Gets the current title
*
* failure
*/
EAPI const char *elm_web_title_get(const Evas_Object *obj);
+
/**
* Sets the background color to be used by the web object
*
* @param a Alpha component
*/
EAPI void elm_web_bg_color_set(Evas_Object *obj, int r, int g, int b, int a);
+
/**
* Gets the background color to be used by the web object
*
* @param a Alpha component
*/
EAPI void elm_web_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a);
+
/**
* Gets a copy of the currently selected text
*
* error occurred
*/
EAPI char *elm_view_selection_get(const Evas_Object *obj);
+
/**
* Tells the web object which index in the currently open popup was selected
*
* @see elm_web_popup_destroy()
*/
EAPI void elm_web_popup_selected_set(Evas_Object *obj, int index);
+
/**
* Dismisses an open dropdown popup
*
* if there was no menu to destroy
*/
EAPI Eina_Bool elm_web_popup_destroy(Evas_Object *obj);
+
/**
* Searches the given string in a document.
*
* or failure
*/
EAPI Eina_Bool elm_web_text_search(const Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool forward, Eina_Bool wrap);
+
/**
* Marks matches of the given string in a document.
*
* @return number of matched @a string
*/
EAPI unsigned int elm_web_text_matches_mark(Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool highlight, unsigned int limit);
+
/**
* Clears all marked matches in the document
*
* @return EINA_TRUE on success, EINA_FALSE otherwise
*/
EAPI Eina_Bool elm_web_text_matches_unmark_all(Evas_Object *obj);
+
/**
* Sets whether to highlight the matched marks
*
* @return EINA_TRUE on success, EINA_FALSE otherwise
*/
EAPI Eina_Bool elm_web_text_matches_highlight_set(Evas_Object *obj, Eina_Bool highlight);
+
/**
* Gets whether highlighting marks is enabled
*
* otherwise
*/
EAPI Eina_Bool elm_web_text_matches_highlight_get(const Evas_Object *obj);
+
/**
* Gets the overall loading progress of the page
*
* failure
*/
EAPI double elm_web_load_progress_get(const Evas_Object *obj);
+
/**
* Stops loading the current page
*
* @return EINA_TRUE if the cancel was successful, EINA_FALSE otherwise
*/
EAPI Eina_Bool elm_web_stop(Evas_Object *obj);
+
/**
* Requests a reload of the current document in the object
*
* @return EINA_TRUE on success, EINA_FALSE otherwise
*/
EAPI Eina_Bool elm_web_reload(Evas_Object *obj);
+
/**
* Requests a reload of the current document, avoiding any existing caches
*
* @return EINA_TRUE on success, EINA_FALSE otherwise
*/
EAPI Eina_Bool elm_web_reload_full(Evas_Object *obj);
+
/**
* Goes back one step in the browsing history
*
* @see elm_web_navigate()
*/
EAPI Eina_Bool elm_web_back(Evas_Object *obj);
+
/**
* Goes forward one step in the browsing history
*
* @see elm_web_navigate()
*/
EAPI Eina_Bool elm_web_forward(Evas_Object *obj);
+
/**
* Jumps the given number of steps in the browsing history
*
* @see elm_web_forward()
*/
EAPI Eina_Bool elm_web_navigate(Evas_Object *obj, int steps);
+
/**
* Queries whether it's possible to go back in history
*
* otherwise
*/
EAPI Eina_Bool elm_web_back_possible(Evas_Object *obj);
+
/**
* Queries whether it's possible to go forward in history
*
* otherwise
*/
EAPI Eina_Bool elm_web_forward_possible(Evas_Object *obj);
+
/**
* Queries whether it's possible to jump the given number of steps
*
* EINA_FALSE otherwise
*/
EAPI Eina_Bool elm_web_navigate_possible(Evas_Object *obj, int steps);
+
/**
* Gets whether browsing history is enabled for the given object
*
* @return EINA_TRUE if history is enabled, EINA_FALSE otherwise
*/
EAPI Eina_Bool elm_web_history_enable_get(const Evas_Object *obj);
+
/**
* Enables or disables the browsing history
*
* @param enable Whether to enable or disable the browsing history
*/
EAPI void elm_web_history_enable_set(Evas_Object *obj, Eina_Bool enable);
+
/**
* Sets the zoom level of the web object
*
* @param zoom The zoom level to set
*/
EAPI void elm_web_zoom_set(Evas_Object *obj, double zoom);
+
/**
* Gets the current zoom level set on the web object
*
* @return The zoom level set on the object
*/
EAPI double elm_web_zoom_get(const Evas_Object *obj);
+
/**
* Sets the zoom mode to use
*
* @param mode The mode to set
*/
EAPI void elm_web_zoom_mode_set(Evas_Object *obj, Elm_Web_Zoom_Mode mode);
+
/**
* Gets the currently set zoom mode
*
* ::ELM_WEB_ZOOM_MODE_LAST on error
*/
EAPI Elm_Web_Zoom_Mode elm_web_zoom_mode_get(const Evas_Object *obj);
+
/**
* Shows the given region in the web object
*
* @param h The height of the region to show
*/
EAPI void elm_web_region_show(Evas_Object *obj, int x, int y, int w, int h);
+
/**
* Brings in the region to the visible area
*
* @param h The height of the region to show
*/
EAPI void elm_web_region_bring_in(Evas_Object *obj, int x, int y, int w, int h);
+
/**
* Sets the default dialogs to use an Inwin instead of a normal window
*
* @param value EINA_TRUE to use Inwin, EINA_FALSE to use a normal window
*/
EAPI void elm_web_inwin_mode_set(Evas_Object *obj, Eina_Bool value);
+
/**
* Gets whether Inwin mode is set for the current object
*
* @{
*/
typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
+
/**
* @brief Add a new Hoversel object
*
* @return The new object or NULL if it cannot be created
*/
EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+
/**
* @brief This sets the hoversel to expand horizontally.
*
* setting.
*/
EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
+
/**
* @brief This returns whether the hoversel is set to expand horizontally.
*
* @see elm_hoversel_horizontal_set()
*/
EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Set the Hover parent
*
* @see elm_hoversel_hover_parent_set()
*/
EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Set the hoversel button label
*
* @deprecated elm_object_text_set()
*/
EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
+
/**
* @brief Get the hoversel button label
*
* @deprecated elm_object_text_get()
*/
EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Set the icon of the hoversel button
*
* @see elm_object_content_set() for the button widget
*/
EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
+
/**
* @brief Get the icon of the hoversel button
*
* @see elm_hoversel_icon_set()
*/
EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Get and unparent the icon of the hoversel button
*
* @see elm_object_content_unset() for the button widget
*/
EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief This triggers the hoversel popup from code, the same as if the user
* had clicked the button.
* @param obj The hoversel object
*/
EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief This dismisses the hoversel popup as if the user had clicked
* outside the hover.
* @param obj The hoversel object
*/
EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Returns whether the hoversel is expanded.
*
* EINA_FALSE if it is not expanded.
*/
EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief This will remove all the children items from the hoversel.
*
* @see elm_hoversel_item_del()
*/
EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Get the list of items within the given hoversel.
*
* @see elm_hoversel_item_add()
*/
EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Add an item to the hoversel button
*
* @ref Icon "icon documentation".
*/
EAPI Elm_Hoversel_Item *elm_hoversel_item_add(Evas_Object *obj, const char *label, const char *icon_file, Elm_Icon_Type icon_type, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
+
/**
* @brief Delete an item from the hoversel
*
* @see elm_hoversel_item_del_cb_set()
*/
EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
+
/**
* @brief Set the function to be called when an item from the hoversel is
* freed.
* @see elm_hoversel_item_add()
*/
EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
+
/**
* @brief This returns the data pointer supplied with elm_hoversel_item_add()
* that will be passed to associated function callbacks.
* @see elm_hoversel_item_add()
*/
EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
+
/**
* @brief This returns the label text of the given hoversel item.
*
* @see elm_hoversel_item_add()
*/
EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
+
/**
* @brief This sets the icon for the given hoversel item.
*
* @see elm_hoversel_item_add()
*/
EAPI void elm_hoversel_item_icon_set(Elm_Hoversel_Item *it, const char *icon_file, const char *icon_group, Elm_Icon_Type icon_type) EINA_ARG_NONNULL(1);
+
/**
* @brief Get the icon object of the hoversel item
*
* @see elm_hoversel_item_add()
*/
EAPI void elm_hoversel_item_icon_get(const Elm_Hoversel_Item *it, const char **icon_file, const char **icon_group, Elm_Icon_Type *icon_type) EINA_ARG_NONNULL(1);
+
/**
* @}
*/
* @ingroup Toolbar
*/
EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+
/**
* Set the icon size, in pixels, to be used by toolbar items.
*
* @ingroup Toolbar
*/
EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
+
/**
* Get the icon size, in pixels, to be used by toolbar items.
*
* @ingroup Toolbar
*/
EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Sets icon lookup order, for toolbar items' icons.
*
* @ingroup Toolbar
*/
EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
+
/**
* Gets the icon lookup order.
*
* @ingroup Toolbar
*/
EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Set whether the toolbar should always have an item selected.
*
* @ingroup Toolbar
*/
EAPI void elm_toolbar_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
+
/**
* Get whether the toolbar should always have an item selected.
*
* @ingroup Toolbar
*/
EAPI Eina_Bool elm_toolbar_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Set whether the toolbar items' should be selected by the user or not.
*
* @ingroup Toolbar
*/
EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Append item to the toolbar.
*
* @ingroup Toolbar
*/
EAPI Elm_Object_Item *elm_toolbar_item_append(Evas_Object *obj, const char *icon, const char *label, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
+
/**
* Prepend item to the toolbar.
*
* @ingroup Toolbar
*/
EAPI Elm_Object_Item *elm_toolbar_item_prepend(Evas_Object *obj, const char *icon, const char *label, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
+
/**
* Insert a new item into the toolbar object before item @p before.
*
* @ingroup Toolbar
*/
EAPI Elm_Object_Item *elm_toolbar_item_insert_after(Evas_Object *obj, Elm_Object_Item *after, const char *icon, const char *label, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
+
/**
* Get the first item in the given toolbar widget's list of
* items.
* @ingroup Toolbar
*/
EAPI Elm_Object_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Get the last item in the given toolbar widget's list of
* items.
* @ingroup Toolbar
*/
EAPI Elm_Object_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Get the item after @p item in toolbar.
*
* @ingroup Toolbar
*/
EAPI Elm_Object_Item *elm_toolbar_item_next_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
+
/**
* Get the item before @p item in toolbar.
*
* @ingroup Toolbar
*/
EAPI Elm_Object_Item *elm_toolbar_item_prev_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
+
/**
* Get the toolbar object from an item.
*
* @ingroup Toolbar
*/
EINA_DEPRECATED EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
+
/**
* Set the priority of a toolbar item.
*
* @ingroup Toolbar
*/
EAPI void elm_toolbar_item_priority_set(Elm_Object_Item *it, int priority) EINA_ARG_NONNULL(1);
+
/**
* Get the priority of a toolbar item.
*
* @ingroup Toolbar
*/
EAPI int elm_toolbar_item_priority_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
+
/**
* Get the label of item.
*
* @ingroup Toolbar
*/
EINA_DEPRECATED EAPI const char *elm_toolbar_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
+
/**
* Set the label of item.
*
* @ingroup Toolbar
*/
EINA_DEPRECATED EAPI void elm_toolbar_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
+
/**
* Return the data associated with a given toolbar widget item.
*
*
* @see elm_toolbar_item_data_set()
*
- * @deprecated use elm_object_item_data_get() instead.
+ * @deprecated use elm_object_item_data_get() instead.
* @ingroup Toolbar
*/
EINA_DEPRECATED EAPI void *elm_toolbar_item_data_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
+
/**
* Set the data associated with a given toolbar widget item.
*
* @warning The old data pointer won't be touched by this function, so
* the user had better to free that old data himself/herself.
*
- * @deprecated use elm_object_item_data_set() instead.
+ * @deprecated use elm_object_item_data_set() instead.
* @ingroup Toolbar
*/
EINA_DEPRECATED EAPI void elm_toolbar_item_data_set(Elm_Object_Item *it, const void *data) EINA_ARG_NONNULL(1);
+
/**
* Returns a pointer to a toolbar item by its label.
*
* @ingroup Toolbar
*/
EAPI Elm_Object_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
+
/*
* Get whether the @p item is selected or not.
*
* @ingroup Toolbar
*/
EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
+
/**
* Set the selected state of an item.
*
* @ingroup Toolbar
*/
EAPI void elm_toolbar_item_selected_set(Elm_Object_Item *it, Eina_Bool selected) EINA_ARG_NONNULL(1);
+
/**
* Get the selected item.
*
* @ingroup Toolbar
*/
EAPI Elm_Object_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Set the icon associated with @p item.
*
* @ingroup Toolbar
*/
EAPI void elm_toolbar_item_icon_set(Elm_Object_Item *it, const char *icon) EINA_ARG_NONNULL(1);
+
/**
* Get the string used to set the icon of @p item.
*
* @ingroup Toolbar
*/
EAPI const char *elm_toolbar_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
+
/**
* Get the object of @p item.
*
* @ingroup Toolbar
*/
EAPI Evas_Object *elm_toolbar_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
+
/**
* Get the icon object of @p item.
*
* @ingroup Toolbar
*/
EAPI Evas_Object *elm_toolbar_item_icon_object_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
+
/**
* Set the icon associated with @p item to an image in a binary buffer.
*
* @ingroup Toolbar
*/
EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Set the parent object of the toolbar items' menus.
*
* @ingroup Toolbar
*/
EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
+
/**
* Get the parent object of the toolbar items' menus.
*
* @ingroup Toolbar
*/
EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Set the alignment of the items.
*
* @ingroup Toolbar
*/
EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
+
/**
* Get the alignment of the items.
*
* @ingroup Toolbar
*/
EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Set whether the toolbar item opens a menu.
*
* @ingroup Toolbar
*/
EAPI void elm_toolbar_item_menu_set(Elm_Object_Item *it, Eina_Bool menu) EINA_ARG_NONNULL(1);
+
/**
* Get toolbar item's menu.
*
* @ingroup Toolbar
*/
EAPI Evas_Object *elm_toolbar_item_menu_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
+
/**
* Add a new state to @p item.
*
* @ingroup Toolbar
*/
EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_add(Elm_Object_Item *it, const char *icon, const char *label, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
+
/**
* Delete a previoulsy added state to @p item.
*
* @see elm_toolbar_item_state_add()
*/
EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Object_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
+
/**
* Set @p state as the current state of @p it.
*
* @ingroup Toolbar
*/
EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Object_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
+
/**
* Unset the state of @p it.
*
* @ingroup Toolbar
*/
EAPI void elm_toolbar_item_state_unset(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
+
/**
* Get the current state of @p it.
*
* @ingroup Toolbar
*/
EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
+
/**
* Get the state after selected state in toolbar's @p item.
*
* @ingroup Toolbar
*/
EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
+
/**
* Get the state before selected state in toolbar's @p item.
*
* @ingroup Toolbar
*/
EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
+
/**
* Set the text to be shown in a given toolbar item's tooltips.
*
* @ingroup Toolbar
*/
EAPI void elm_toolbar_item_tooltip_text_set(Elm_Object_Item *it, const char *text) EINA_ARG_NONNULL(1);
+
/**
* Set the content to be shown in the tooltip item.
*
* @ingroup Toolbar
*/
EAPI void elm_toolbar_item_tooltip_content_cb_set(Elm_Object_Item *it, Elm_Tooltip_Item_Content_Cb func, const void *data, Evas_Smart_Cb del_cb) EINA_ARG_NONNULL(1);
+
/**
* Unset tooltip from item.
*
* @ingroup Toolbar
*/
EAPI void elm_toolbar_item_tooltip_unset(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
+
/**
* Sets a different style for this item tooltip.
*
* @ingroup Toolbar
*/
EAPI void elm_toolbar_item_tooltip_style_set(Elm_Object_Item *it, const char *style) EINA_ARG_NONNULL(1);
+
/**
* Get the style for this item tooltip.
*
* @ingroup Toolbar
*/
EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
+
/**
* Set the type of mouse pointer/cursor decoration to be shown,
* when the mouse pointer is over the given toolbar widget item
* @return The new object or NULL if it cannot be created.
*/
EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+
/**
* @brief Set the parent for the given menu widget
*
* @param parent The new parent.
*/
EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
+
/**
* @brief Get the parent for the given menu widget
*
* @see elm_menu_parent_set()
*/
EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Move the menu to a new position
*
* @note @p x and @p y coordinates are relative to parent.
*/
EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
+
/**
* @brief Close a opened menu
*
* Hides the menu and all it's sub-menus.
*/
EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Returns a list of @p item's items.
*
* @return An Eina_List* of @p item's items
*/
EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Get the Evas_Object of an Elm_Object_Item
*
*
*/
EAPI Evas_Object *elm_menu_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
+
/**
* @brief Add an item at the end of the given menu widget
*
* @return Returns the new item.
*/
EAPI Elm_Object_Item *elm_menu_item_add(Evas_Object *obj, Elm_Object_Item *parent, const char *icon, const char *label, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
+
/**
* @brief Add an object swallowed in an item at the end of the given menu
* widget
* Add an evas object as an item to the menu.
*/
EAPI Elm_Object_Item *elm_menu_item_add_object(Evas_Object *obj, Elm_Object_Item *parent, Evas_Object *subobj, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
+
/**
* @brief Set the label of a menu item
*
* @deprecated Use elm_object_item_text_set() instead
*/
EINA_DEPRECATED EAPI void elm_menu_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
+
/**
* @brief Get the label of a menu item
*
* @deprecated Use elm_object_item_text_get() instead
*/
EINA_DEPRECATED EAPI const char *elm_menu_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
+
/**
* @brief Set the icon of a menu item to the standard icon with name @p icon
*
* Once this icon is set, any previously set icon will be deleted.
*/
EAPI void elm_menu_item_object_icon_name_set(Elm_Object_Item *it, const char *icon) EINA_ARG_NONNULL(1, 2);
+
/**
* @brief Get the string representation from the icon of a menu item
*
* @see elm_menu_item_object_icon_name_set()
*/
EAPI const char *elm_menu_item_object_icon_name_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
+
/**
* @brief Set the content object of a menu item
*
* @deprecated Use elm_object_item_content_set() instead
*/
EINA_DEPRECATED EAPI Eina_Bool elm_menu_item_object_content_set(Elm_Object_Item *it, Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Get the content object of a menu item
*
* @deprecated Use elm_object_item_content_get() instead
*/
EINA_DEPRECATED EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
+
/**
* @brief Set the selected state of @p item.
*
* @param selected The selected/unselected state of the item
*/
EAPI void elm_menu_item_selected_set(Elm_Object_Item *it, Eina_Bool selected) EINA_ARG_NONNULL(1);
+
/**
* @brief Get the selected state of @p item.
*
* @see elm_menu_item_selected_set()
*/
EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
+
/**
* @brief Set the disabled state of @p item.
*
* @deprecated Use elm_object_item_disabled_set() instead
*/
EINA_DEPRECATED EAPI void elm_menu_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
+
/**
* @brief Get the disabled state of @p item.
*
* @deprecated Use elm_object_item_disabled_get() instead
*/
EINA_DEPRECATED EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
+
/**
* @brief Add a separator item to menu @p obj under @p parent.
*
* This is item is a @ref Separator.
*/
EAPI Elm_Object_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Object_Item *parent) EINA_ARG_NONNULL(1);
+
/**
* @brief Returns whether @p item is a separator.
*
* @see elm_menu_item_separator_add()
*/
EAPI Eina_Bool elm_menu_item_is_separator(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
+
/**
* @brief Deletes an item from the menu.
*
* @see elm_menu_item_add()
*/
EAPI void elm_menu_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
+
/**
* @brief Set the function called when a menu item is deleted.
*
* @see elm_menu_item_del()
*/
EAPI void elm_menu_item_del_cb_set(Elm_Object_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
+
/**
* @brief Returns the data associated with menu item @p item.
*
* @return The data associated with @p item or NULL if none was set.
*
* This is the data set with elm_menu_add() or elm_menu_item_data_set().
- *
- * @deprecated Use elm_object_item_data_get() instead
+ *
+ * @deprecated Use elm_object_item_data_get() instead
*/
EINA_DEPRECATED EAPI void *elm_menu_item_data_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
+
/**
* @brief Sets the data to be associated with menu item @p item.
*
* @param it The item
* @param data The data to be associated with @p item
- *
- * @deprecated Use elm_object_item_data_set() instead
+ *
+ * @deprecated Use elm_object_item_data_set() instead
*/
EINA_DEPRECATED EAPI void elm_menu_item_data_set(Elm_Object_Item *it, const void *data) EINA_ARG_NONNULL(1);
* @see elm_menu_add()
*/
EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
+
/**
* @brief Get the position of a menu item
*
* @note Index values begin with 0
*/
EAPI unsigned int elm_menu_item_index_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1) EINA_PURE;
+
/**
* @brief @brief Return a menu item's owner menu
*
* Use this function to get the menu object owning an item.
*/
EAPI Evas_Object *elm_menu_item_menu_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1) EINA_PURE;
+
/**
* @brief Get the selected item in the menu
*
* @see elm_menu_item_selected_set()
*/
EAPI Elm_Object_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Get the last item in the menu
*
* @return The last item, or NULL if none
*/
EAPI Elm_Object_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Get the first item in the menu
*
* @return The first item, or NULL if none
*/
EAPI Elm_Object_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Get the next item in the menu.
*
* @return The item after it, or NULL if none
*/
EAPI Elm_Object_Item *elm_menu_item_next_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
+
/**
* @brief Get the previous item in the menu.
*
* @return The item before it, or NULL if none
*/
EAPI Elm_Object_Item *elm_menu_item_prev_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
+
/**
* @}
*/
*/
EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
-
/**
* Get the item before @p it in list.
*
*/
EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
-
/**
* @brief Disable size restrictions on an object's tooltip
* @param item The tooltip's anchor object
* @return The new actionslider object or NULL if it cannot be created
*/
EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+
/**
* Set actionslider labels.
*
* @deprecated use elm_object_text_set() instead.
*/
EINA_DEPRECATED EAPI void elm_actionslider_labels_set(Evas_Object *obj, const char *left_label, const char *center_label, const char *right_label) EINA_ARG_NONNULL(1);
+
/**
* Get actionslider labels.
*
* @deprecated use elm_object_text_set() instead.
*/
EINA_DEPRECATED EAPI void elm_actionslider_labels_get(const Evas_Object *obj, const char **left_label, const char **center_label, const char **right_label) EINA_ARG_NONNULL(1);
+
/**
* Get actionslider selected label.
*
* @return The selected label
*/
EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Set actionslider indicator position.
*
* @param pos The position of the indicator.
*/
EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
+
/**
* Get actionslider indicator position.
*
* @return The position of the indicator.
*/
EAPI Elm_Actionslider_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Set actionslider magnet position. To make multiple positions magnets @c or
* them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
* @param pos Bit mask indicating the magnet positions.
*/
EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
+
/**
* Get actionslider magnet position.
*
* @return The positions with magnet property.
*/
EAPI Elm_Actionslider_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Set actionslider enabled position. To set multiple positions as enabled @c or
* them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
* @param pos Bit mask indicating the enabled positions.
*/
EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
+
/**
* Get actionslider enabled position.
*
* @return The enabled positions.
*/
EAPI Elm_Actionslider_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Set the label used on the indicator.
*
* @deprecated use elm_object_text_set() instead.
*/
EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
+
/**
* Get the label used on the indicator object.
*
* @deprecated use elm_object_text_get() instead.
*/
EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @}
*/
typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
#define Elm_Genlist_Item Elm_Gen_Item /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
+
/**
* Text fetching class function for Elm_Gen_Item_Class.
* @param data The data passed in the item creation function
* @return The allocated (NOT stringshared) string to set as the text
*/
typedef char *(*Elm_Genlist_Item_Text_Get_Cb) (void *data, Evas_Object *obj, const char *part);
+
/**
* Content (swallowed object) fetching class function for Elm_Gen_Item_Class.
* @param data The data passed in the item creation function
* @return The content object to swallow
*/
typedef Evas_Object *(*Elm_Genlist_Item_Content_Get_Cb) (void *data, Evas_Object *obj, const char *part);
+
/**
* State fetching class function for Elm_Gen_Item_Class.
* @param data The data passed in the item creation function
* @return The hell if I know
*/
typedef Eina_Bool (*Elm_Genlist_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part);
+
/**
* Deletion class function for Elm_Gen_Item_Class.
* @param data The data passed in the item creation function
* @ingroup Genlist
*/
EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+
/**
* Remove all items from a given genlist widget.
*
* @ingroup Genlist
*/
EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Enable or disable multi-selection in the genlist
*
* @ingroup Genlist
*/
EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
+
/**
* Gets if multi-selection in genlist is enabled or disabled.
*
* @ingroup Genlist
*/
EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* This sets the horizontal stretching mode.
*
*/
EAPI void elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
EINA_DEPRECATED EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
+
/**
* Gets the horizontal stretching mode.
*
*/
EAPI Elm_List_Mode elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
EINA_DEPRECATED EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Set the always select mode.
*
* @ingroup Genlist
*/
EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
+
/**
* Get the always select mode.
*
* @ingroup Genlist
*/
EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Enable/disable the no select mode.
*
* @ingroup Genlist
*/
EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
+
/**
* Gets whether the no select mode is enabled.
*
* @ingroup Genlist
*/
EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Enable/disable compress mode.
*
* @ingroup Genlist
*/
EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
+
/**
* Get whether the compress mode is enabled.
*
* @ingroup Genlist
*/
EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Enable/disable height-for-width mode.
*
* @ingroup Genlist
*/
EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
+
/**
* Get whether the height-for-width mode is enabled.
*
* @ingroup Genlist
*/
EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Enable/disable horizontal and vertical bouncing effect.
*
* @ingroup Genlist
*/
EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
+
/**
* Get whether the horizontal and vertical bouncing effect is enabled.
*
* @ingroup Genlist
*/
EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
+
/**
* Enable/disable homogeneous mode.
*
* @ingroup Genlist
*/
EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
+
/**
* Get whether the homogeneous mode is enabled.
*
* @ingroup Genlist
*/
EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Set the maximum number of items within an item block
*
* @ingroup Genlist
*/
EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
+
/**
* Get the maximum number of items within an item block
*
* @ingroup Genlist
*/
EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Set the timeout in seconds for the longpress event.
*
* @ingroup Genlist
*/
EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
+
/**
* Get the timeout in seconds for the longpress event.
*
* @ingroup Genlist
*/
EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Append a new item in a given genlist widget.
*
* @ingroup Genlist
*/
EAPI Elm_Genlist_Item *elm_genlist_item_append(Evas_Object *obj, const Elm_Genlist_Item_Class *itc, const void *data, Elm_Genlist_Item *parent, Elm_Genlist_Item_Flags flags, Evas_Smart_Cb func, const void *func_data) EINA_ARG_NONNULL(1);
+
/**
* Prepend a new item in a given genlist widget.
*
* @ingroup Genlist
*/
EAPI Elm_Genlist_Item *elm_genlist_item_prepend(Evas_Object *obj, const Elm_Genlist_Item_Class *itc, const void *data, Elm_Genlist_Item *parent, Elm_Genlist_Item_Flags flags, Evas_Smart_Cb func, const void *func_data) EINA_ARG_NONNULL(1);
+
/**
* Insert an item before another in a genlist widget
*
* @ingroup Genlist
*/
EAPI Elm_Genlist_Item *elm_genlist_item_insert_before(Evas_Object *obj, const Elm_Genlist_Item_Class *itc, const void *data, Elm_Genlist_Item *parent, Elm_Genlist_Item *before, Elm_Genlist_Item_Flags flags, Evas_Smart_Cb func, const void *func_data) EINA_ARG_NONNULL(1, 5);
+
/**
* Insert an item after another in a genlist widget
*
* @ingroup Genlist
*/
EAPI Elm_Genlist_Item *elm_genlist_item_insert_after(Evas_Object *obj, const Elm_Genlist_Item_Class *itc, const void *data, Elm_Genlist_Item *parent, Elm_Genlist_Item *after, Elm_Genlist_Item_Flags flags, Evas_Smart_Cb func, const void *func_data) EINA_ARG_NONNULL(1, 5);
+
/**
* Insert a new item into the sorted genlist object
*
*/
EAPI Elm_Genlist_Item *elm_genlist_item_sorted_insert(Evas_Object *obj, const Elm_Genlist_Item_Class *itc, const void *data, Elm_Genlist_Item *parent, Elm_Genlist_Item_Flags flags, Eina_Compare_Cb comp, Evas_Smart_Cb func,const void *func_data);
EAPI Elm_Genlist_Item *elm_genlist_item_direct_sorted_insert(Evas_Object *obj, const Elm_Genlist_Item_Class *itc, const void *data, Elm_Genlist_Item *parent, Elm_Genlist_Item_Flags flags, Eina_Compare_Cb comp, Evas_Smart_Cb func, const void *func_data);
+
/* operations to retrieve existing items */
/**
* Get the selectd item in the genlist.
* @ingroup Genlist
*/
EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Get a list of selected items in the genlist.
*
* @ingroup Genlist
*/
EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Get the mode item style of items in the genlist
* @param obj The genlist object
* @ingroup Genlist
*/
EAPI const char *elm_genlist_mode_item_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Set the mode item style of items in the genlist
* @param obj The genlist object
* @ingroup Genlist
*/
EAPI void elm_genlist_mode_item_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
+
/**
* Get a list of realized items in genlist
*
* @ingroup Genlist
*/
EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Get the item that is at the x, y canvas coords.
*
* @ingroup Genlist
*/
EAPI Elm_Genlist_Item *elm_genlist_at_xy_item_get(const Evas_Object *obj, Evas_Coord x, Evas_Coord y, int *posret) EINA_ARG_NONNULL(1);
+
/**
* Get the first item in the genlist
*
* @ingroup Genlist
*/
EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Get the last item in the genlist
*
* @ingroup Genlist
*/
EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Set the scrollbar policy
*
* @ingroup Genlist
*/
EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
+
/**
* Get the scrollbar policy
*
* @ingroup Genlist
*/
EAPI void elm_genlist_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
+
/**
* Get the @b next item in a genlist widget's internal list of items,
* given a handle to one of those items.
* @ingroup Genlist
*/
EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
+
/**
* Get the @b previous item in a genlist widget's internal list of items,
* given a handle to one of those items.
* @ingroup Genlist
*/
EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
+
/**
* Get the genlist object's handle which contains a given genlist
* item
* @ingroup Genlist
*/
EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
+
/**
* Get the parent item of the given item
*
* @ingroup Genlist
*/
EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
+
/**
* Remove all sub-items (children) of the given item
*
* @ingroup Genlist
*/
EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
+
/**
* Set whether a given genlist item is selected or not
*
* @ingroup Genlist
*/
EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
+
/**
* Get whether a given genlist item is selected or not
*
* @ingroup Genlist
*/
EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
+
/**
* Sets the expanded state of an item.
*
* @ingroup Genlist
*/
EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
+
/**
* Get the expanded state of an item
*
* @ingroup Genlist
*/
EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
+
/**
* Get the depth of expanded item
*
* @ingroup Genlist
*/
EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
+
/**
* Set whether a given genlist item is disabled or not.
*
* @ingroup Genlist
*/
EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
+
/**
* Get whether a given genlist item is disabled or not.
*
* @ingroup Genlist
*/
EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
+
/**
* Sets the display only state of an item.
*
* @ingroup Genlist
*/
EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
+
/**
* Get the display only state of an item
*
* @ingroup Genlist
*/
EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
+
/**
* Show the portion of a genlist's internal list containing a given
* item, immediately.
* @ingroup Genlist
*/
EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
+
/**
* Animatedly bring in, to the visible are of a genlist, a given
* item on it.
* @ingroup Genlist
*/
EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
+
/**
* Show the portion of a genlist's internal list containing a given
* item, immediately.
* @ingroup Genlist
*/
EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
+
/**
* Animatedly bring in, to the visible are of a genlist, a given
* item on it.
* @ingroup Genlist
*/
EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
+
/**
* Show the portion of a genlist's internal list containing a given
* item, immediately.
* @ingroup Genlist
*/
EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
+
/**
* Animatedly bring in, to the visible are of a genlist, a given
* item on it.
* @ingroup Genlist
*/
EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
+
/**
* Remove a genlist item from the its parent, deleting it.
*
* @ingroup Genlist
*/
EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
+
/**
* Return the data associated to a given genlist item
*
* @ingroup Genlist
*/
EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
+
/**
* Set the data associated to a given genlist item
*
* @ingroup Genlist
*/
EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
+
/**
* Tells genlist to "orphan" contents fetchs by the item class
*
*/
EAPI void elm_genlist_item_contents_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
EINA_DEPRECATED EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
+
/**
* Get the real Evas object created to implement the view of a
* given genlist item
* @ingroup Genlist
*/
EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
+
/**
* Update the contents of an item
*
* @ingroup Genlist
*/
EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
+
/**
* Promote an item to the top of the list
*
* @ingroup Genlist
*/
EAPI void elm_genlist_item_promote(Elm_Gen_Item *it) EINA_ARG_NONNULL(1);
+
/**
* Demote an item to the end of the list
*
* @ingroup Genlist
*/
EAPI void elm_genlist_item_demote(Elm_Gen_Item *it) EINA_ARG_NONNULL(1);
+
/**
* Update the part of an item
*
* @ingroup Genlist
*/
EAPI void elm_genlist_item_fields_update(Elm_Genlist_Item *it, const char *parts, Elm_Genlist_Item_Field_Flags itf) EINA_ARG_NONNULL(1);
+
/**
* Update the item class of an item
*
*/
EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
+
/**
* Set the text to be shown in a given genlist item's tooltips.
*
* @ingroup Genlist
*/
EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
+
/**
* Set the content to be shown in a given genlist item's tooltips
*
* @ingroup Genlist
*/
EAPI void elm_genlist_item_tooltip_content_cb_set(Elm_Genlist_Item *item, Elm_Tooltip_Item_Content_Cb func, const void *data, Evas_Smart_Cb del_cb) EINA_ARG_NONNULL(1);
+
/**
* Unset a tooltip from a given genlist item
*
* @ingroup Genlist
*/
EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
+
/**
* Set a different @b style for a given genlist item's tooltip.
*
* @ingroup Genlist
*/
EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
+
/**
* Get the style set a given genlist item's tooltip.
*
* @ingroup Genlist
*/
EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
+
/**
* @brief Disable size restrictions on an object's tooltip
* @param item The tooltip's anchor object
* It will instead be limited only by the size of the display.
*/
EAPI Eina_Bool elm_genlist_item_tooltip_window_mode_set(Elm_Genlist_Item *item, Eina_Bool disable);
+
/**
* @brief Retrieve size restriction state of an object's tooltip
* @param item The tooltip's anchor object
* It will instead be limited only by the size of the display.
*/
EAPI Eina_Bool elm_genlist_item_tooltip_window_mode_get(const Elm_Genlist_Item *item);
+
/**
* Set the type of mouse pointer/cursor decoration to be shown,
* when the mouse pointer is over the given genlist widget item
* @ingroup Genlist
*/
EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
+
/**
* Get the type of mouse pointer/cursor decoration set to be shown,
* when the mouse pointer is over the given genlist widget item
* @ingroup Genlist
*/
EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
+
/**
* Unset any custom mouse pointer/cursor decoration set to be
* shown, when the mouse pointer is over the given genlist widget
* @ingroup Genlist
*/
EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
+
/**
* Set a different @b style for a given custom cursor set for a
* genlist item.
* @ingroup Genlist
*/
EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
+
/**
* Get the current @b style set for a given genlist item's custom
* cursor
* @ingroup Genlist
*/
EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
+
/**
* Set if the (custom) cursor for a given genlist item should be
* searched in its theme, also, or should only rely on the
* @ingroup Genlist
*/
EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
+
/**
* Get if the (custom) cursor for a given genlist item is being
* searched in its theme, also, or is only relying on the rendering
* @ingroup Genlist
*/
EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
+
/**
* Update the contents of all realized items.
*
* @ingroup Genlist
*/
EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Activate a genlist mode on an item
*
* @ingroup Genlist
*/
EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
+
/**
* Get the last (or current) genlist mode used.
*
* @ingroup Genlist
*/
EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Get active genlist mode item
*
* @return The new object or NULL if it cannot be created
*/
EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+
/**
* @brief Set the text label of the check object
*
* @deprecated use elm_object_text_set() instead.
*/
EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
+
/**
* @brief Get the text label of the check object
*
* @deprecated use elm_object_text_get() instead.
*/
EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Set the icon object of the check object
*
*
*/
EINA_DEPRECATED EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
+
/**
* @brief Get the icon object of the check object
*
*
*/
EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Unset the icon used for the check object
*
*
*/
EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Set the on/off state of the check object
*
* changed. Calling this @b doesn't cause the "changed" signal to be emited.
*/
EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
+
/**
* @brief Get the state of the check object
*
* @return The boolean state
*/
EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Set a convenience pointer to a boolean to change
*
* @ref tutorial_radio show most of this API in action.
* @{
*/
+
/**
* @brief Add a new radio to the parent
*
* @return The new object or NULL if it cannot be created
*/
EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+
/**
* @brief Set the text label of the radio object
*
* @deprecated use elm_object_text_set() instead.
*/
EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
+
/**
* @brief Get the text label of the radio object
*
* @deprecated use elm_object_text_set() instead.
*/
EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Set the icon object of the radio object
*
*
*/
EINA_DEPRECATED EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
+
/**
* @brief Get the icon object of the radio object
*
*
*/
EINA_DEPRECATED EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Unset the icon used for the radio object
*
*
*/
EINA_DEPRECATED EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Add this radio to a group of other radio objects
*
* the group object indicated is a member.
*/
EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
+
/**
* @brief Set the integer value that this radio object represents
*
* This sets the value of the radio.
*/
EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
+
/**
* @brief Get the integer value that this radio object represents
*
* @see elm_radio_value_set()
*/
EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Set the value of the radio.
*
* pointed to, to the value supplied, but will not call any callbacks.
*/
EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
+
/**
* @brief Get the state of the radio object
*
* @return The integer state
*/
EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Set a convenience pointer to a integer to change
*
* elm_radio_value_set().
*/
EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
+
/**
* @}
*/
* @ref tutorial_photocam shows the API in action.
* @{
*/
+
/**
* @brief Types of zoom available.
*/
ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT_IN, /**< Unzoom until photo fits in photocam */
ELM_PHOTOCAM_ZOOM_MODE_LAST
} Elm_Photocam_Zoom_Mode;
+
/**
* @brief Add a new Photocam object
*
* @return The new object or NULL if it cannot be created
*/
EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+
/**
* @brief Set the photo file to be shown
*
* quality needed.
*/
EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
+
/**
* @brief Returns the path of the current image file
*
* @see elm_photocam_file_set()
*/
EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Set the zoom level of the photo
*
* 16, 32, etc.).
*/
EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
+
/**
* @brief Get the zoom level of the photo
*
* @see elm_photocam_zoom_mode_set()
*/
EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Set the zoom mode
*
* pixels within the frame are left unfilled.
*/
EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
+
/**
* @brief Get the zoom mode
*
* @see elm_photocam_zoom_mode_set()
*/
EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Get the current image pixel width and height
*
* to.
*/
EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
+
/**
* @brief Get the area of the image that is currently shown
*
* @see elm_photocam_image_region_bring_in()
*/
EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
+
/**
* @brief Set the viewed portion of the image
*
* This shows the region of the image without using animation.
*/
EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
+
/**
* @brief Bring in the viewed portion of the image
*
* This shows the region of the image using animation.
*/
EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
+
/**
* @brief Set the paused state for photocam
*
* animations that are running.
*/
EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
+
/**
* @brief Get the paused state for photocam
*
* @see elm_photocam_paused_set()
*/
EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Get the internal low-res image used for photocam
*
* deleted at any time as well.
*/
EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Set the photocam scrolling bouncing.
*
* @param v_bounce bouncing for vertical
*/
EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
+
/**
* @brief Get the photocam scrolling bouncing.
*
* @see elm_photocam_bounce_set()
*/
EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
+
/**
* @}
*/
*/
typedef enum _Elm_Map_Route_Sources
{
- ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
+ ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
ELM_MAP_ROUTE_SOURCE_MONAV, /**< MoNav offers exact routing without heuristic assumptions. Its routing core is based on Contraction Hierarchies. It's not working with Map yet. */
- ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
+ ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
ELM_MAP_ROUTE_SOURCE_LAST
} Elm_Map_Route_Sources;
ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
} Elm_Panel_Orient;
+
/**
* @brief Adds a panel object
*
* @return The panel object, or NULL on failure
*/
EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+
/**
* @brief Sets the orientation of the panel
*
* Sets from where the panel will (dis)appear.
*/
EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
+
/**
* @brief Get the orientation of the panel.
*
* @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
*/
EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Set the content of the panel.
*
*
*/
EINA_DEPRECATED EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
+
/**
* @brief Get the content of the panel.
*
*
*/
EINA_DEPRECATED EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Unset the content of the panel.
*
*
*/
EINA_DEPRECATED EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Set the state of the panel.
*
* @param hidden If true, the panel will run the animation to contract
*/
EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
+
/**
* @brief Get the state of the panel.
*
* @param hidden If true, the panel is in the "hide" state
*/
EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Toggle the hidden state of the panel from code
*
* @param obj The panel object
*/
EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @}
*/
ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
} Elm_Flip_Direction;
+
/**
* @brief Add a new flip to the parent
*
* @return The new object or NULL if it cannot be created
*/
EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+
/**
* @brief Set the front content of the flip widget.
*
* elm_flip_content_front_unset() function.
*/
EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
+
/**
* @brief Set the back content of the flip widget.
*
* elm_flip_content_back_unset() function.
*/
EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
+
/**
* @brief Get the front content used for the flip
*
* Return the front content object which is set for this widget.
*/
EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Get the back content used for the flip
*
* Return the back content object which is set for this widget.
*/
EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Unset the front content used for the flip
*
* Unparent and return the front content object which was set for this widget.
*/
EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Unset the back content used for the flip
*
* Unparent and return the back content object which was set for this widget.
*/
EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Get flip front visibility state
*
* showing.
*/
EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Set flip perspective
*
* @warning This function currently does nothing.
*/
EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
+
/**
* @brief Runs the flip animation
*
* @image latex elm_flip.eps width=\textwidth
*/
EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
+
/**
* @brief Set the interactive flip mode
*
* happen, those can only be acheived with elm_flip_go();
*/
EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
+
/**
* @brief Get the interactive flip mode
*
* Returns the interactive flip mode set by elm_flip_interaction_set()
*/
EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
+
/**
* @brief Set which directions of the flip respond to interactive flip
*
* @see elm_flip_interaction_set()
*/
EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
+
/**
* @brief Get the enabled state of that flip direction
*
* @see elm_flip_interaction_set()
*/
EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
+
/**
* @brief Set the amount of the flip that is sensitive to interactive flip
*
* @see elm_flip_interaction_set()
*/
EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
+
/**
* @brief Get the amount of the flip that is sensitive to interactive flip
*
* elm_flip_interacton_direction_hitsize_set().
*/
EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
+
/**
* @}
*/
*/
EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
-
/**
* Get a list of all the calendar marks.
*
*/
EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
-
/**
* Sets a different style for this item tooltip.
*
*/
EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
-
/**
* Unset the cursor to be shown when mouse is over the diskselector item
*
*/
EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
-
/**
* Get the style for this item cursor.
*
* @ingroup Ctxpopup
*/
EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+
/**
* @brief Set the Ctxpopup's parent
*
* @ingroup Ctxpopup
*/
EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
+
/**
* @brief Get the Ctxpopup's parent
*
* @ingroup Ctxpopup
*/
EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Clear all items in the given ctxpopup object.
*
* @ingroup Ctxpopup
*/
EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Change the ctxpopup's orientation to horizontal or vertical.
*
* @ingroup Ctxpopup
*/
EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
+
/**
* @brief Get the value of current ctxpopup object's orientation.
*
* @ingroup Ctxpopup
*/
EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Add a new item to a ctxpopup object.
*
* @ingroup Ctxpopup
*/
Elm_Object_Item *elm_ctxpopup_item_append(Evas_Object *obj, const char *label, Evas_Object *icon, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
+
/**
* @brief Delete the given item in a ctxpopup object.
*
* @ingroup Ctxpopup
*/
EAPI void elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
+
/**
* @brief Set the ctxpopup item's state as disabled or enabled.
*
* @ingroup Ctxpopup
*/
EINA_DEPRECATED EAPI void elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
+
/**
* @brief Get the ctxpopup item's disabled/enabled state.
*
* @ingroup Ctxpopup
*/
EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
+
/**
* @brief Get the icon object for the given ctxpopup item.
*
* @ingroup Ctxpopup
*/
EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
+
/**
* @brief Sets the side icon associated with the ctxpopup item
*
* @ingroup Ctxpopup
*/
EINA_DEPRECATED EAPI void elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
+
/**
* @brief Get the label for the given ctxpopup item.
*
* @ingroup Ctxpopup
*/
EINA_DEPRECATED EAPI const char *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
+
/**
* @brief (Re)set the label on the given ctxpopup item.
*
* @ingroup Ctxpopup
*/
EINA_DEPRECATED EAPI void elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
+
/**
* @brief Set an elm widget as the content of the ctxpopup.
*
* @ingroup Ctxpopup
*/
EINA_DEPRECATED EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
+
/**
* @brief Unset the ctxpopup content
*
* @ingroup Ctxpopup
*/
EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Set the direction priority of a ctxpopup.
*
* @ingroup Ctxpopup
*/
EAPI void elm_ctxpopup_direction_priority_set(Evas_Object *obj, Elm_Ctxpopup_Direction first, Elm_Ctxpopup_Direction second, Elm_Ctxpopup_Direction third, Elm_Ctxpopup_Direction fourth) EINA_ARG_NONNULL(1);
+
/**
* @brief Get the direction priority of a ctxpopup.
*
ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
} Elm_Transit_Effect_Flip_Axis;
+
/**
* @enum Elm_Transit_Effect_Wipe_Dir
*
ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
} Elm_Transit_Effect_Wipe_Dir;
+
/** @enum Elm_Transit_Effect_Wipe_Type
*
* Whether the wipe effect should show or hide the object.
*/
typedef struct _Elm_Transit Elm_Transit;
typedef void Elm_Transit_Effect;
+
/**
* @typedef Elm_Transit_Effect_Transition_Cb
*
* Transition callback called for this effect on each transition iteration.
*/
typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
+
/**
* Elm_Transit_Effect_End_Cb
*
* @ingroup Naviframe
*/
EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+
/**
* @brief Push a new item to the top of the naviframe stack (and show it).
*
* @ingroup Naviframe
*/
EAPI Elm_Object_Item *elm_naviframe_item_push(Evas_Object *obj, const char *title_label, Evas_Object *prev_btn, Evas_Object *next_btn, Evas_Object *content, const char *item_style) EINA_ARG_NONNULL(1, 5);
- /**
+
+ /**
* @brief Insert a new item into the naviframe before item @p before.
*
* @param before The naviframe item to insert before.
* @ingroup Naviframe
*/
EAPI Elm_Object_Item *elm_naviframe_item_insert_before(Elm_Object_Item *before, const char *title_label, Evas_Object *prev_btn, Evas_Object *next_btn, Evas_Object *content, const char *item_style) EINA_ARG_NONNULL(1, 5);
+
/**
* @brief Insert a new item into the naviframe after item @p after.
*
* @ingroup Naviframe
*/
EAPI Elm_Object_Item *elm_naviframe_item_insert_after(Elm_Object_Item *after, const char *title_label, Evas_Object *prev_btn, Evas_Object *next_btn, Evas_Object *content, const char *item_style) EINA_ARG_NONNULL(1, 5);
+
/**
* @brief Pop an item that is on top of the stack
*
* @ingroup Naviframe
*/
EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Pop the items between the top and the above one on the given item.
*
* @ingroup Naviframe
*/
EAPI void elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
+
/**
- * Promote an item already in the naviframe stack to the top of the stack
- *
- * @param it The naviframe item
- *
- * 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.
- *
- */
+ * Promote an item already in the naviframe stack to the top of the stack
+ *
+ * @param it The naviframe item
+ *
+ * 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.
+ *
+ */
EAPI void elm_naviframe_item_promote(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
+
/**
* @brief Delete the given item instantly.
*
* @ingroup Naviframe
*/
EAPI void elm_naviframe_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
+
/**
* @brief preserve the content objects when items are popped.
*
* @ingroup Naviframe
*/
EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
+
/**
* @brief Get a value whether preserve mode is enabled or not.
*
* @ingroup Naviframe
*/
EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Get a top item on the naviframe stack
*
* @ingroup Naviframe
*/
EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Get a bottom item on the naviframe stack
*
* @ingroup Naviframe
*/
EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Set an item style
*
* @ingroup Naviframe
*/
EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
+
/**
* @brief Get an item style
*
* @ingroup Naviframe
*/
EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
+
/**
* @brief Show/Hide the title area
*
* @ingroup Naviframe
*/
EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
+
/**
* @brief Get a value whether title area is visible or not.
*
* @see also elm_naviframe_item_push()
*/
EAPI void elm_naviframe_prev_btn_auto_pushed_set(Evas_Object *obj, Eina_Bool auto_pushed) EINA_ARG_NONNULL(1);
+
/**
* @brief Get a value whether prev button(back button) will be auto pushed or
* not.
* elm_naviframe_prev_btn_auto_pushed_set()
*/
EAPI Eina_Bool elm_naviframe_prev_btn_auto_pushed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* @brief Get a list of all the naviframe items.
*
* Here is an example on its usage:
* @li @ref multibuttonentry_example
*/
- /**
+
+ /**
* @addtogroup Multibuttonentry
* @{
*/
*
*/
EAPI Evas_Object *elm_multibuttonentry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+
/**
* Get the label
*
*
*/
EAPI const char *elm_multibuttonentry_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Set the label
*
*
*/
EAPI void elm_multibuttonentry_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
+
/**
* Get the entry of the multibuttonentry object
*
*
*/
EAPI Evas_Object *elm_multibuttonentry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Get the guide text
*
*
*/
EAPI const char * elm_multibuttonentry_guide_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Set the guide text
*
*
*/
EAPI void elm_multibuttonentry_guide_text_set(Evas_Object *obj, const char *guidetext) EINA_ARG_NONNULL(1);
+
/**
* Get the value of shrink_mode state.
*
*
*/
EAPI int elm_multibuttonentry_shrink_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Set/Unset the multibuttonentry to shrink mode state of single line
*
*
*/
EAPI void elm_multibuttonentry_shrink_mode_set(Evas_Object *obj, int shrink) EINA_ARG_NONNULL(1);
+
/**
* Prepend a new item to the multibuttonentry
*
*
*/
EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_prepend(Evas_Object *obj, const char *label, void *data) EINA_ARG_NONNULL(1);
+
/**
* Append a new item to the multibuttonentry
*
*
*/
EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_append(Evas_Object *obj, const char *label, void *data) EINA_ARG_NONNULL(1);
+
/**
* Add a new item to the multibuttonentry before the indicated object
*
*
*/
EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_insert_before(Evas_Object *obj, Elm_Multibuttonentry_Item *before, const char *label, void *data) EINA_ARG_NONNULL(1);
+
/**
* Add a new item to the multibuttonentry after the indicated object
*
*
*/
EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_insert_after(Evas_Object *obj, Elm_Multibuttonentry_Item *after, const char *label, void *data) EINA_ARG_NONNULL(1);
+
/**
* Get a list of items in the multibuttonentry
*
*
*/
EAPI const Eina_List *elm_multibuttonentry_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Get the first item in the multibuttonentry
*
*
*/
EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Get the last item in the multibuttonentry
*
*
*/
EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Get the selected item in the multibuttonentry
*
*
*/
EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
/**
* Set the selected state of an item
*
*
*/
EAPI void elm_multibuttonentry_item_select(Elm_Multibuttonentry_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
+
/**
- * unselect all items.
- *
- * @param obj The multibuttonentry object
- *
- */
+ * unselect all items.
+ *
+ * @param obj The multibuttonentry object
+ *
+ */
EAPI void elm_multibuttonentry_item_unselect_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
- /**
- * Delete a given item
- *
- * @param item The item
- *
- */
+
+ /**
+ * Delete a given item
+ *
+ * @param item The item
+ *
+ */
EAPI void elm_multibuttonentry_item_del(Elm_Multibuttonentry_Item *item) EINA_ARG_NONNULL(1);
- /**
- * Remove all items in the multibuttonentry.
- *
- * @param obj The multibuttonentry object
- *
- */
+
+ /**
+ * Remove all items in the multibuttonentry.
+ *
+ * @param obj The multibuttonentry object
+ *
+ */
EAPI void elm_multibuttonentry_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
- /**
- * Get the label of a given item
- *
- * @param item The item
- * @return The label of a given item, or NULL if none
- *
- */
+
+ /**
+ * Get the label of a given item
+ *
+ * @param item The item
+ * @return The label of a given item, or NULL if none
+ *
+ */
EAPI const char *elm_multibuttonentry_item_label_get(const Elm_Multibuttonentry_Item *item) EINA_ARG_NONNULL(1);
- /**
- * Set the label of a given item
- *
- * @param item The item
- * @param label The text label string
- *
- */
+
+ /**
+ * Set the label of a given item
+ *
+ * @param item The item
+ * @param label The text label string
+ *
+ */
EAPI void elm_multibuttonentry_item_label_set(Elm_Multibuttonentry_Item *item, const char *str) EINA_ARG_NONNULL(1);
- /**
- * Get the previous item in the multibuttonentry
- *
- * @param item The item
- * @return The item before the item @p item
- *
- */
+
+ /**
+ * Get the previous item in the multibuttonentry
+ *
+ * @param item The item
+ * @return The item before the item @p item
+ *
+ */
EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_prev_get(const Elm_Multibuttonentry_Item *item) EINA_ARG_NONNULL(1);
- /**
- * Get the next item in the multibuttonentry
- *
- * @param item The item
- * @return The item after the item @p item
- *
- */
+
+ /**
+ * Get the next item in the multibuttonentry
+ *
+ * @param item The item
+ * @return The item after the item @p item
+ *
+ */
EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_next_get(const Elm_Multibuttonentry_Item *item) EINA_ARG_NONNULL(1);
- /**
- * Append a 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
- * as a parameter. The callback function is free to alter the text in any way
- * 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.
- *
- * @param obj The multibuttonentryentry object
- * @param func The function to use as item filter
- * @param data User data to pass to @p func
- *
- */
+
+ /**
+ * Append a 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
+ * as a parameter. The callback function is free to alter the text in any way
+ * 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.
+ *
+ * @param obj The multibuttonentryentry object
+ * @param func The function to use as item filter
+ * @param data User data to pass to @p func
+ *
+ */
EAPI void elm_multibuttonentry_item_filter_append(Evas_Object *obj, Elm_Multibuttonentry_Item_Filter_callback func, void *data) EINA_ARG_NONNULL(1);
- /**
- * Prepend a filter function for text inserted in the Multibuttentry
- *
- * Prepend the given callback to the list. See elm_multibuttonentry_item_filter_append()
- * for more information
- *
- * @param obj The multibuttonentry object
- * @param func The function to use as text filter
- * @param data User data to pass to @p func
- *
- */
+
+ /**
+ * Prepend a filter function for text inserted in the Multibuttentry
+ *
+ * Prepend the given callback to the list. See elm_multibuttonentry_item_filter_append()
+ * for more information
+ *
+ * @param obj The multibuttonentry object
+ * @param func The function to use as text filter
+ * @param data User data to pass to @p func
+ *
+ */
EAPI void elm_multibuttonentry_item_filter_prepend(Evas_Object *obj, Elm_Multibuttonentry_Item_Filter_callback func, void *data) EINA_ARG_NONNULL(1);
- /**
- * Remove a filter from the list
- *
- * Removes the given callback from the filter list. See elm_multibuttonentry_item_filter_append()
- * for more information.
- *
- * @param obj The multibuttonentry object
- * @param func The filter function to remove
- * @param data The user data passed when adding the function
- *
- */
+
+ /**
+ * Remove a filter from the list
+ *
+ * Removes the given callback from the filter list. See elm_multibuttonentry_item_filter_append()
+ * for more information.
+ *
+ * @param obj The multibuttonentry object
+ * @param func The filter function to remove
+ * @param data The user data passed when adding the function
+ *
+ */
EAPI void elm_multibuttonentry_item_filter_remove(Evas_Object *obj, Elm_Multibuttonentry_Item_Filter_callback func, void *data) EINA_ARG_NONNULL(1);
/**
projects / framework / uifw / elementary.git / commitdiff