forked from enlightenment/efl
elm: enhance documentation for following files
- elm_config.h - elm_focus.h - elm_genlist.h - elm_icon.h - elm_image.h - elm_image_legacy.h - elm_index.h
This commit is contained in:
parent
63a97dc8b4
commit
06eee29b76
|
@ -799,6 +799,10 @@ EAPI void elm_config_scroll_thumbscroll_acceleration_weight_set(double w
|
||||||
* elementary will automatically scroll the focused area to the visible
|
* elementary will automatically scroll the focused area to the visible
|
||||||
* viewport.
|
* viewport.
|
||||||
*
|
*
|
||||||
|
* @return ELM_FOCUS_AUTOSCROLL_MODE_SHOW if directly show the focused region or item automatically.
|
||||||
|
* ELM_FOCUS_AUTOSCROLL_MODE_NONE if do not show the focused region or item automatically.
|
||||||
|
* ELM_FOCUS_AUTOSCROLL_MODE_BRING_IN if bring_in the focused region or item automatically which might invole the scrolling.
|
||||||
|
*
|
||||||
* @see elm_config_focus_autoscroll_mode_set()
|
* @see elm_config_focus_autoscroll_mode_set()
|
||||||
* @ingroup Elm_Focus
|
* @ingroup Elm_Focus
|
||||||
* @since 1.10
|
* @since 1.10
|
||||||
|
@ -1209,6 +1213,7 @@ EAPI Eina_List *elm_config_text_classes_list_get(void);
|
||||||
/**
|
/**
|
||||||
* Free Elementary's list of supported text classes.
|
* Free Elementary's list of supported text classes.
|
||||||
*
|
*
|
||||||
|
* @param list The text classes list.
|
||||||
* @ingroup Elm_Fonts
|
* @ingroup Elm_Fonts
|
||||||
*
|
*
|
||||||
* @see elm_config_text_classes_list_get().
|
* @see elm_config_text_classes_list_get().
|
||||||
|
@ -1335,6 +1340,7 @@ EAPI void elm_config_font_overlay_apply(void);
|
||||||
* EVAS_FONT_HINTING_AUTO < Automatic font hinting
|
* EVAS_FONT_HINTING_AUTO < Automatic font hinting
|
||||||
* EVAS_FONT_HINTING_BYTECODE < Bytecode font hinting
|
* EVAS_FONT_HINTING_BYTECODE < Bytecode font hinting
|
||||||
*
|
*
|
||||||
|
* @param type The font hinting type
|
||||||
* @ingroup Elm_Fonts
|
* @ingroup Elm_Fonts
|
||||||
*
|
*
|
||||||
* This applies font hint changes to all windows of the current application.
|
* This applies font hint changes to all windows of the current application.
|
||||||
|
|
|
@ -132,6 +132,7 @@ EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj);
|
||||||
* Get custom focus chain
|
* Get custom focus chain
|
||||||
*
|
*
|
||||||
* @param obj The container object
|
* @param obj The container object
|
||||||
|
* @return Chain of objects to pass focus.
|
||||||
* @ingroup Elm_Focus
|
* @ingroup Elm_Focus
|
||||||
*/
|
*/
|
||||||
EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj);
|
EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj);
|
||||||
|
|
|
@ -5,8 +5,6 @@
|
||||||
* @image html genlist_inheritance_tree.png
|
* @image html genlist_inheritance_tree.png
|
||||||
* @image latex genlist_inheritance_tree.eps
|
* @image latex genlist_inheritance_tree.eps
|
||||||
*
|
*
|
||||||
* @image html img/widget/genlist/preview-00.png
|
|
||||||
* @image latex img/widget/genlist/preview-00.eps
|
|
||||||
* @image html img/genlist.png
|
* @image html img/genlist.png
|
||||||
* @image latex img/genlist.eps
|
* @image latex img/genlist.eps
|
||||||
*
|
*
|
||||||
|
@ -89,25 +87,9 @@
|
||||||
* available item styles:
|
* available item styles:
|
||||||
* - default
|
* - default
|
||||||
* - default_style - The text part is a textblock
|
* - default_style - The text part is a textblock
|
||||||
*
|
|
||||||
* @image html img/widget/genlist/preview-04.png
|
|
||||||
* @image latex img/widget/genlist/preview-04.eps
|
|
||||||
*
|
|
||||||
* - double_label
|
* - double_label
|
||||||
*
|
|
||||||
* @image html img/widget/genlist/preview-01.png
|
|
||||||
* @image latex img/widget/genlist/preview-01.eps
|
|
||||||
*
|
|
||||||
* - icon_top_text_bottom
|
* - icon_top_text_bottom
|
||||||
*
|
|
||||||
* @image html img/widget/genlist/preview-02.png
|
|
||||||
* @image latex img/widget/genlist/preview-02.eps
|
|
||||||
*
|
|
||||||
* - group_index
|
* - group_index
|
||||||
*
|
|
||||||
* @image html img/widget/genlist/preview-03.png
|
|
||||||
* @image latex img/widget/genlist/preview-03.eps
|
|
||||||
*
|
|
||||||
* - one_icon - Only 1 icon (left) (since 1.7)
|
* - one_icon - Only 1 icon (left) (since 1.7)
|
||||||
* - end_icon - Only 1 icon (at end/right) (since 1.7)
|
* - end_icon - Only 1 icon (at end/right) (since 1.7)
|
||||||
* - no_icon - No icon (at end/right) (since 1.7)
|
* - no_icon - No icon (at end/right) (since 1.7)
|
||||||
|
|
|
@ -5,9 +5,6 @@
|
||||||
* @image html icon_inheritance_tree.png
|
* @image html icon_inheritance_tree.png
|
||||||
* @image latex icon_inheritance_tree.eps
|
* @image latex icon_inheritance_tree.eps
|
||||||
*
|
*
|
||||||
* @image html img/widget/icon/preview-00.png
|
|
||||||
* @image latex img/widget/icon/preview-00.eps
|
|
||||||
*
|
|
||||||
* An icon object is used to display standard icon images ("delete",
|
* An icon object is used to display standard icon images ("delete",
|
||||||
* "edit", "arrows", etc.) or images coming from a custom file (PNG,
|
* "edit", "arrows", etc.) or images coming from a custom file (PNG,
|
||||||
* JPG, EDJE, etc.), on icon contexts.
|
* JPG, EDJE, etc.), on icon contexts.
|
||||||
|
|
|
@ -5,9 +5,6 @@
|
||||||
* @image html image_inheritance_tree.png
|
* @image html image_inheritance_tree.png
|
||||||
* @image latex image_inheritance_tree.eps
|
* @image latex image_inheritance_tree.eps
|
||||||
*
|
*
|
||||||
* @image html img/widget/image/preview-00.png
|
|
||||||
* @image latex img/widget/image/preview-00.eps
|
|
||||||
*
|
|
||||||
* An Elementary image object is a direct realization of
|
* An Elementary image object is a direct realization of
|
||||||
* @ref elm-image-class, and it allows one to load and display an @b image
|
* @ref elm-image-class, and it allows one to load and display an @b image
|
||||||
* file on it, be it from a disk file or from a memory
|
* file on it, be it from a disk file or from a memory
|
||||||
|
|
|
@ -201,6 +201,7 @@ EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj);
|
||||||
* @ingroup Elm_Image
|
* @ingroup Elm_Image
|
||||||
* @since 1.7
|
* @since 1.7
|
||||||
*
|
*
|
||||||
|
* @param obj The image object
|
||||||
* @param[in] play @c EINA_TRUE to start the animation, @c EINA_FALSE
|
* @param[in] play @c EINA_TRUE to start the animation, @c EINA_FALSE
|
||||||
otherwise. Default is @c EINA_FALSE.
|
otherwise. Default is @c EINA_FALSE.
|
||||||
*/
|
*/
|
||||||
|
@ -209,6 +210,7 @@ EAPI void elm_image_animated_play_set(Evas_Object *obj, Eina_Bool pl
|
||||||
/**
|
/**
|
||||||
* Get whether an image object is under animation or not.
|
* Get whether an image object is under animation or not.
|
||||||
*
|
*
|
||||||
|
* @param obj The image object
|
||||||
* @return @c EINA_TRUE, if the image is being animated, @c EINA_FALSE
|
* @return @c EINA_TRUE, if the image is being animated, @c EINA_FALSE
|
||||||
* otherwise.
|
* otherwise.
|
||||||
*
|
*
|
||||||
|
@ -236,6 +238,7 @@ EAPI Eina_Bool elm_image_animated_play_get(const Evas_Object *obj);
|
||||||
* @ingroup Elm_Image
|
* @ingroup Elm_Image
|
||||||
* @since 1.7
|
* @since 1.7
|
||||||
*
|
*
|
||||||
|
* @param obj The image object
|
||||||
* @param[in] anim @c EINA_TRUE if the object is to animate itself,
|
* @param[in] anim @c EINA_TRUE if the object is to animate itself,
|
||||||
* @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
|
* @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
|
||||||
*/
|
*/
|
||||||
|
@ -245,6 +248,7 @@ EAPI void elm_image_animated_set(Evas_Object *obj, Eina_Bool anim);
|
||||||
*
|
*
|
||||||
* Get whether an image object has animation enabled or not.
|
* Get whether an image object has animation enabled or not.
|
||||||
*
|
*
|
||||||
|
* @param obj The image object
|
||||||
* @return @c EINA_TRUE if the image has animation enabled,
|
* @return @c EINA_TRUE if the image has animation enabled,
|
||||||
* @c EINA_FALSE otherwise.
|
* @c EINA_FALSE otherwise.
|
||||||
*
|
*
|
||||||
|
@ -533,6 +537,9 @@ EAPI Eina_Bool elm_image_aspect_fixed_get(const Evas_Object *obj);
|
||||||
/**
|
/**
|
||||||
* @brief Enable asynchronous file I/O for elm_image_file_set.
|
* @brief Enable asynchronous file I/O for elm_image_file_set.
|
||||||
*
|
*
|
||||||
|
* @param obj The image object
|
||||||
|
* @param[in] async @ true will make elm_image_file_set() an asynchronous operation
|
||||||
|
*
|
||||||
* If @c true, this will make elm_image_file_set() an asynchronous operation.
|
* If @c true, this will make elm_image_file_set() an asynchronous operation.
|
||||||
* Use of this function is not recommended and the standard EO-based
|
* Use of this function is not recommended and the standard EO-based
|
||||||
* asynchronous I/O API should be preferred instead.
|
* asynchronous I/O API should be preferred instead.
|
||||||
|
|
|
@ -5,9 +5,6 @@
|
||||||
* @image html index_inheritance_tree.png
|
* @image html index_inheritance_tree.png
|
||||||
* @image latex index_inheritance_tree.eps
|
* @image latex index_inheritance_tree.eps
|
||||||
*
|
*
|
||||||
* @image html img/widget/index/preview-00.png
|
|
||||||
* @image latex img/widget/index/preview-00.eps
|
|
||||||
*
|
|
||||||
* An index widget gives you an index for fast access to whichever
|
* An index widget gives you an index for fast access to whichever
|
||||||
* group of other UI items one might have. It's a list of text
|
* group of other UI items one might have. It's a list of text
|
||||||
* items (usually letters, for alphabetically ordered access).
|
* items (usually letters, for alphabetically ordered access).
|
||||||
|
|
Loading…
Reference in New Issue