From f2a3a707e72a58deea6b018e6d6d21a0a7fd8a04 Mon Sep 17 00:00:00 2001 From: "Myoungwoon Roy, Kim" Date: Thu, 24 Sep 2020 10:33:26 +0900 Subject: [PATCH] docs: Changes non public Tizen Elementary APIs to internal Change-Id: I29aac5af360035f887406491de850efd50e6c175 --- src/lib/elementary/elm_slideshow_eo.legacy.h | 46 ++++++++++++++++++++++++ src/lib/elementary/elm_slideshow_legacy.h | 2 ++ src/lib/elementary/elm_thumb_legacy.h | 53 +++++++++++++++++++++++++++- 3 files changed, 100 insertions(+), 1 deletion(-) diff --git a/src/lib/elementary/elm_slideshow_eo.legacy.h b/src/lib/elementary/elm_slideshow_eo.legacy.h index ee1d6f7..1f72a37 100644 --- a/src/lib/elementary/elm_slideshow_eo.legacy.h +++ b/src/lib/elementary/elm_slideshow_eo.legacy.h @@ -15,6 +15,8 @@ typedef Eo Elm_Slideshow; #endif /** + * @internal + * * @brief Set the number of items to cache, on a given slideshow widget, after * the current item. * @@ -29,6 +31,8 @@ typedef Eo Elm_Slideshow; EAPI void elm_slideshow_cache_after_set(Elm_Slideshow *obj, int count); /** + * @internal + * * @brief Get the number of items to cache, on a given slideshow widget, after * the current item. * @@ -41,6 +45,8 @@ EAPI void elm_slideshow_cache_after_set(Elm_Slideshow *obj, int count); EAPI int elm_slideshow_cache_after_get(const Elm_Slideshow *obj); /** + * @internal + * * @brief Set the number of items to cache, on a given slideshow widget, before * the current item. * @@ -55,6 +61,8 @@ EAPI int elm_slideshow_cache_after_get(const Elm_Slideshow *obj); EAPI void elm_slideshow_cache_before_set(Elm_Slideshow *obj, int count); /** + * @internal + * * @brief Get the number of items to cache, on a given slideshow widget, before * the current item. * @@ -67,6 +75,8 @@ EAPI void elm_slideshow_cache_before_set(Elm_Slideshow *obj, int count); EAPI int elm_slideshow_cache_before_get(const Elm_Slideshow *obj); /** + * @internal + * * @brief Set the current slide layout in use for a given slideshow widget * * If @c layout is implemented in @c obj's theme (i.e., is contained in the @@ -83,6 +93,8 @@ EAPI int elm_slideshow_cache_before_get(const Elm_Slideshow *obj); EAPI void elm_slideshow_layout_set(Elm_Slideshow *obj, const char *layout); /** + * @internal + * * @brief Get the current slide layout in use for a given slideshow widget. * * @param[in] obj The object. @@ -94,6 +106,8 @@ EAPI void elm_slideshow_layout_set(Elm_Slideshow *obj, const char *layout); EAPI const char *elm_slideshow_layout_get(const Elm_Slideshow *obj); /** + * @internal + * * @brief Set the current slide transition/effect in use for a given slideshow * widget. * @@ -109,6 +123,8 @@ EAPI const char *elm_slideshow_layout_get(const Elm_Slideshow *obj); EAPI void elm_slideshow_transition_set(Elm_Slideshow *obj, const char *transition); /** + * @internal + * * @brief Get the current slide transition/effect in use for a given slideshow * widget. * @@ -121,6 +137,8 @@ EAPI void elm_slideshow_transition_set(Elm_Slideshow *obj, const char *transitio EAPI const char *elm_slideshow_transition_get(const Elm_Slideshow *obj); /** + * @internal + * * @brief Set if the slideshow items should be displayed cyclically or not, so * when the end is reached it will restart from the first item. * @@ -136,6 +154,8 @@ EAPI const char *elm_slideshow_transition_get(const Elm_Slideshow *obj); EAPI void elm_slideshow_loop_set(Elm_Slideshow *obj, Eina_Bool loop); /** + * @internal + * * @brief Get if, after a slideshow is started, for a given slideshow widget, * its items are to be displayed cyclically or not. * @@ -149,6 +169,8 @@ EAPI void elm_slideshow_loop_set(Elm_Slideshow *obj, Eina_Bool loop); EAPI Eina_Bool elm_slideshow_loop_get(const Elm_Slideshow *obj); /** + * @internal + * * @brief Set the interval between each image transition on a given slideshow * widget and start the slideshow itself. * @@ -170,6 +192,8 @@ EAPI Eina_Bool elm_slideshow_loop_get(const Elm_Slideshow *obj); EAPI void elm_slideshow_timeout_set(Elm_Slideshow *obj, double timeout); /** + * @internal + * * @brief Get the interval set for image transitions on a given slideshow * widget. * @@ -182,6 +206,8 @@ EAPI void elm_slideshow_timeout_set(Elm_Slideshow *obj, double timeout); EAPI double elm_slideshow_timeout_get(const Elm_Slideshow *obj); /** + * @internal + * * @brief Get the internal list of items in a given slideshow widget. * * This list is not to be modified in any way and must not be freed. @@ -199,6 +225,8 @@ EAPI double elm_slideshow_timeout_get(const Elm_Slideshow *obj); EAPI const Eina_List *elm_slideshow_items_get(const Elm_Slideshow *obj); /** + * @internal + * * @brief Returns the list of sliding transition/effect names available, for a * given slideshow widget. * @@ -233,6 +261,8 @@ EAPI const Eina_List *elm_slideshow_items_get(const Elm_Slideshow *obj); EAPI const Eina_List *elm_slideshow_transitions_get(const Elm_Slideshow *obj); /** + * @internal + * * @brief Get the number of items stored in a given slideshow widget. * * @param[in] obj The object. @@ -244,6 +274,8 @@ EAPI const Eina_List *elm_slideshow_transitions_get(const Elm_Slideshow *obj); EAPI unsigned int elm_slideshow_count_get(const Elm_Slideshow *obj); /** + * @internal + * * @brief Returns the currently displayed item, in a given slideshow widget. * * @param[in] obj The object. @@ -256,6 +288,8 @@ EAPI unsigned int elm_slideshow_count_get(const Elm_Slideshow *obj); EAPI Elm_Widget_Item *elm_slideshow_item_current_get(const Elm_Slideshow *obj); /** + * @internal + * * @brief Returns the list of layout names available, for a given slideshow * widget. * @@ -286,6 +320,8 @@ EAPI Elm_Widget_Item *elm_slideshow_item_current_get(const Elm_Slideshow *obj); EAPI const Eina_List *elm_slideshow_layouts_get(const Elm_Slideshow *obj); /** + * @internal + * * @brief Slide to the previous item, in a given slideshow widget * * The sliding animation @c obj is set to use will be the transition effect @@ -300,6 +336,8 @@ EAPI const Eina_List *elm_slideshow_layouts_get(const Elm_Slideshow *obj); EAPI void elm_slideshow_previous(Elm_Slideshow *obj); /** + * @internal + * * @brief Get the the item, in a given slideshow widget, placed at position * @c nth, in its internal items list. * @@ -315,6 +353,8 @@ EAPI void elm_slideshow_previous(Elm_Slideshow *obj); EAPI Elm_Widget_Item *elm_slideshow_item_nth_get(const Elm_Slideshow *obj, unsigned int nth); /** + * @internal + * * @brief Slide to the next item, in a given slideshow widget. * * The sliding animation @c obj is set to use will be the transition effect @@ -329,6 +369,8 @@ EAPI Elm_Widget_Item *elm_slideshow_item_nth_get(const Elm_Slideshow *obj, unsig EAPI void elm_slideshow_next(Elm_Slideshow *obj); /** + * @internal + * * @brief Remove all items from a given slideshow widget. * * This removes (and deletes) all items in @c obj, leaving it empty. @@ -339,6 +381,8 @@ EAPI void elm_slideshow_next(Elm_Slideshow *obj); EAPI void elm_slideshow_clear(Elm_Slideshow *obj); /** + * @internal + * * @brief Add (append) a new item in a given slideshow widget. * * Add a new item to @c obj's internal list of items, appending it. The item's @@ -358,6 +402,8 @@ EAPI void elm_slideshow_clear(Elm_Slideshow *obj); EAPI Elm_Widget_Item *elm_slideshow_item_add(Elm_Slideshow *obj, const Elm_Slideshow_Item_Class *itc, const void *data); /** + * @internal + * * @brief Insert a new item into the given slideshow widget, using the @c func * function to sort items (by item handles). * diff --git a/src/lib/elementary/elm_slideshow_legacy.h b/src/lib/elementary/elm_slideshow_legacy.h index 95a68b6..949b81b 100644 --- a/src/lib/elementary/elm_slideshow_legacy.h +++ b/src/lib/elementary/elm_slideshow_legacy.h @@ -1,4 +1,6 @@ /** + * @internal + * * Add a new slideshow widget to the given parent Elementary * (container) object * diff --git a/src/lib/elementary/elm_thumb_legacy.h b/src/lib/elementary/elm_thumb_legacy.h index 4a89657..f58bb47 100644 --- a/src/lib/elementary/elm_thumb_legacy.h +++ b/src/lib/elementary/elm_thumb_legacy.h @@ -1,4 +1,7 @@ -/** Used to set if a video thumbnail is animating or not +/** + * @internal + * + * Used to set if a video thumbnail is animating or not * * @ingroup Elm_Thumb */ @@ -12,6 +15,8 @@ typedef enum } Elm_Thumb_Animation_Setting; /** + * @internal + * * Add a new thumb object to the parent. * * @param parent The parent object. @@ -25,6 +30,7 @@ typedef enum EAPI Evas_Object *elm_thumb_add(Evas_Object *parent); /** + * @internal * * Set the file that will be used as thumbnail @b source. * @@ -44,6 +50,7 @@ EAPI Evas_Object *elm_thumb_add(Evas_Object *parent); EAPI void elm_thumb_file_set(Eo *obj, const char *file, const char *key); /** + * @internal * * Get the image or video path and key used to generate the thumbnail. * @@ -58,6 +65,8 @@ EAPI void elm_thumb_file_set(Eo *obj, const char *file, const char *key); EAPI void elm_thumb_file_get(const Eo *obj, const char **file, const char **key); /** + * @internal + * * @brief Make the thumbnail 'editable'. * * This means the thumbnail is a valid drag target for drag and drop, and can @@ -70,6 +79,8 @@ EAPI void elm_thumb_file_get(const Eo *obj, const char **file, const char **key) EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit); /** + * @internal + * * @brief Get whether the thumbnail is editable. * * This means the thumbnail is a valid drag target for drag and drop, and can @@ -82,6 +93,8 @@ EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit); EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj); /** + * @internal + * * @brief Set the compression for the thumb object. * * @param[in] compress The compression of the thumb. @@ -93,6 +106,8 @@ EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj); EAPI void elm_thumb_compress_set(Evas_Object *obj, int compress); /** + * @internal + * * @brief Get the compression of the thumb object. * * @param[out] compress The compression of the thumb. @@ -107,6 +122,8 @@ EAPI void elm_thumb_compress_set(Evas_Object *obj, int compress); EAPI void elm_thumb_compress_get(const Evas_Object *obj, int *compress); /** + * @internal + * * @brief Set the format for the thumb object. * * @param[in] format The format setting. @@ -118,6 +135,8 @@ EAPI void elm_thumb_compress_get(const Evas_Object *obj, int *compress); EAPI void elm_thumb_format_set(Evas_Object *obj, Ethumb_Thumb_Format format); /** + * @internal + * * @brief Get the format of the thumb object. * * @return The format setting. @@ -129,6 +148,8 @@ EAPI void elm_thumb_format_set(Evas_Object *obj, Ethumb_Thumb_Format format); EAPI Ethumb_Thumb_Format elm_thumb_format_get(const Evas_Object *obj); /** + * @internal + * * @brief Set the animation state for the thumb object. * * If its content is an animated video, you may start/stop the animation or @@ -141,6 +162,8 @@ EAPI Ethumb_Thumb_Format elm_thumb_format_get(const Evas_Object *obj); EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting setting); /** + * @internal + * * @brief Get the animation state for the thumb object. * * @return The animation setting or #ELM_THUMB_ANIMATION_LAST @@ -150,6 +173,8 @@ EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting se EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj); /** + * @internal + * * @brief Set the FDO size for the thumb object. * * @param[in] size The FDO size setting. @@ -161,6 +186,8 @@ EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj); EAPI void elm_thumb_fdo_size_set(Evas_Object *obj, Ethumb_Thumb_FDO_Size size); /** + * @internal + * * @brief Get the fdo size of the thumb object. * * @return The FDO size setting. @@ -172,6 +199,8 @@ EAPI void elm_thumb_fdo_size_set(Evas_Object *obj, Ethumb_Thumb_FDO_Size size); EAPI Ethumb_Thumb_FDO_Size elm_thumb_fdo_size_get(const Evas_Object *obj); /** + * @internal + * * @brief Set the orientation for the thumb object. * * @param[in] orient The orientation setting. @@ -183,6 +212,8 @@ EAPI Ethumb_Thumb_FDO_Size elm_thumb_fdo_size_get(const Evas_Object *obj); EAPI void elm_thumb_orientation_set(Evas_Object *obj, Ethumb_Thumb_Orientation orient); /** + * @internal + * * @brief Get the orientation of the thumb object. * * @return The orientation setting. @@ -194,6 +225,8 @@ EAPI void elm_thumb_orientation_set(Evas_Object *obj, Ethumb_Thumb_Orientation o EAPI Ethumb_Thumb_Orientation elm_thumb_orientation_get(const Evas_Object *obj); /** + * @internal + * * @brief Set the aspect for the thumb object. * * @param[in] aspect The aspect setting. @@ -205,6 +238,8 @@ EAPI Ethumb_Thumb_Orientation elm_thumb_orientation_get(const Evas_Object *obj); EAPI void elm_thumb_aspect_set(Evas_Object *obj, Ethumb_Thumb_Aspect aspect); /** + * @internal + * * @brief Get the aspect of the thumb object. * * @return The aspect setting. @@ -216,6 +251,8 @@ EAPI void elm_thumb_aspect_set(Evas_Object *obj, Ethumb_Thumb_Aspect aspect); EAPI Ethumb_Thumb_Aspect elm_thumb_aspect_get(const Evas_Object *obj); /** + * @internal + * * @brief Set the quality for the thumb object. * * @param[in] quality The quality of the thumb. @@ -227,6 +264,8 @@ EAPI Ethumb_Thumb_Aspect elm_thumb_aspect_get(const Evas_Object *obj); EAPI void elm_thumb_quality_set(Evas_Object *obj, int quality); /** + * @internal + * * @brief Get the quality of the thumb object. * * @param[out] quality The quality of the thumb. @@ -238,6 +277,8 @@ EAPI void elm_thumb_quality_set(Evas_Object *obj, int quality); EAPI void elm_thumb_quality_get(const Evas_Object *obj, int *quality); /** + * @internal + * * @brief Set the size for the thumb object. * * @param[in] tw The width of the thumb. @@ -250,6 +291,8 @@ EAPI void elm_thumb_quality_get(const Evas_Object *obj, int *quality); EAPI void elm_thumb_size_set(Evas_Object *obj, int tw, int th); /** + * @internal + * * @brief Get the size of the thumb object. * * @param[out] tw The width of the thumb. @@ -262,6 +305,8 @@ EAPI void elm_thumb_size_set(Evas_Object *obj, int tw, int th); EAPI void elm_thumb_size_get(const Evas_Object *obj, int *tw, int *th); /** + * @internal + * * @brief Set the crop alignment for the thumb object. * * @param[in] cropx The x coordinate of the crop. @@ -274,6 +319,8 @@ EAPI void elm_thumb_size_get(const Evas_Object *obj, int *tw, int *th); EAPI void elm_thumb_crop_align_set(Evas_Object *obj, double cropx, double cropy); /** + * @internal + * * @brief Get the crop alignment of the thumb object. * * @param[out] cropx The x coordinate of the crop. @@ -286,6 +333,8 @@ EAPI void elm_thumb_crop_align_set(Evas_Object *obj, double cropx, double cropy) EAPI void elm_thumb_crop_align_get(const Evas_Object *obj, double *cropx, double *cropy); /** + * @internal + * * @brief Get the path and key to the image or video thumbnail generated by * ethumb. * @@ -301,6 +350,8 @@ EAPI void elm_thumb_crop_align_get(const Evas_Object *obj, double *cropx, double EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key); /** + * @internal + * * @brief Reload thumbnail if it was generated before. * * This is useful if the ethumb client configuration changed, like its size, -- 2.7.4