From: Woochan Lee Date: Thu, 29 Sep 2016 06:42:00 +0000 (+0900) Subject: Doxygen update. X-Git-Tag: submit/tizen/20160930.094404^2~3 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=6a3b314a1093fdf44e91370e6d2d2ea9abf7493f;p=platform%2Fcore%2Fuifw%2Fui-viewmgr.git Doxygen update. Change-Id: I913a2da8fdb69b2627889f0a251e133c5703f6eb Change-Id: I7fd5102e4cb7c4e50f2268e723b4464dc328a2b0 Conflicts: src/include/efl/mobile/c/ui_application.h src/include/efl/mobile/c/ui_view.h --- diff --git a/doc/ui_viewmgr_doc.h b/doc/ui_viewmgr_doc.h index 70b4d8f..1a13c2e 100644 --- a/doc/ui_viewmgr_doc.h +++ b/doc/ui_viewmgr_doc.h @@ -1,7 +1,7 @@ /** * @defgroup CAPI_UI_VIEWMGR_MODULE UI View Manager - * @breif This module provides functionalities for applications ui view management. * @ingroup CAPI_UI_FRAMEWORK + * @breif This module provides functionalities for applications ui view management. * @section UI_VIEWMGR_GROUP_HEADER Required Header * \#include * diff --git a/src/include/efl/mobile/c/ui_application.h b/src/include/efl/mobile/c/ui_application.h index dd77ff2..fb1e513 100644 --- a/src/include/efl/mobile/c/ui_application.h +++ b/src/include/efl/mobile/c/ui_application.h @@ -39,46 +39,50 @@ typedef struct /** * @brief Initialize ui_application. + * @details This function initializes ui_application and ui_viewmgr. + * @since_tizen 3.0 + * @remarks Before exit application, call ui_application_term(). * - * This function initializes ui_application and ui_viewmgr. - * - * @param pkg The name of package. - * @param locale_dir The path of locale directory. - * - * @return @c true if it succeeds, @c false otherwise. + * @param[in] pkg The name of package. + * @param[in] locale_dir The path of locale directory * - * @warning Before exit application, call ui_application_term() + * @return @c true if it succeeds, @c false otherwise * * @see ui_application_term() - * - * @since_tizen 3.0 + * @see ui_application_run() */ EAPI bool ui_application_init(const char *pkg, const char *locale_dir); /** * @brief Run ui_application. This triggers application main loops. + * @remarks This is wrapping ui_app_main() function. + * @since_tizen 3.0 * - * @note This is wrapping ui_app_main() function. + * @param[in] argc The argument count + * @param[in] argv The argument vector + * @param[in] events Event callback list. + * @param[in] user_data User data for event callbacks * - * @param argc The argument count. - * @param argv The argument vector. - * @param events event callback list. - * @param user_data user data for event callbacks + * @return @c true if it succeeds, @c false otherwise * - * @return @c true if it succeeds, @c false otherwise. + * @pre Call ui_application_init() before calling this function. * - * @since_tizen 3.0 + * @see ui_app_main() + * @see ui_application_init() + * @see ui_application_term() */ EAPI bool ui_application_run(int argc, char **argv, ui_application_event_s *events, void *user_data); /** * @brief This is ui_application destructor. + * @since_tizen 3.0 * - * @return @c true if it succeeds, @c false otherwise. + * @return @c true if it succeeds, @c false otherwise * - * @see ui_application_init() + * @pre Call ui_application_init() before calling this function. * - * @since_tizen 3.0 + * @see ui_application_init() + * @see ui_application_run() */ EAPI bool ui_application_term(void); diff --git a/src/include/efl/mobile/c/ui_menu.h b/src/include/efl/mobile/c/ui_menu.h index 6cae44c..cfba0de 100644 --- a/src/include/efl/mobile/c/ui_menu.h +++ b/src/include/efl/mobile/c/ui_menu.h @@ -14,120 +14,111 @@ extern "C" { /** * @brief Replace or set a content of an ui_menu. + * @since_tizen 3.0 * - * @param menu An ui_menu object - * @param ctxpopup ctxpopup object. It allows @c NULL for canceling the previous content. - * - * @return @c true if it succeeds, @c false otherwise. + * @param[in] menu An ui_menu object + * @param[in] ctxpopup ctxpopup object. It allows @c NULL for canceling the previous content * - * @see ui_menu_content_get() + * @return @c true if it succeeds, @c false otherwise * - * @since_tizen 3.0 + * @see ui_menu_get_content() + * @see ui_menu_unset_content() */ EAPI bool ui_menu_set_content(ui_menu *menu, Elm_Ctxpopup *ctxpopup); /** * @brief Return an ui_menu content. + * @since_tizen 3.0 * - * @param menu An ui_menu instance. - * - * @return A content of ui_menu. + * @param[in] menu An ui_menu instance * - * @see ui_menu_content_set() + * @return A content of ui_menu * - * @since_tizen 3.0 + * @see ui_menu_set_content() + * @see ui_menu_unset_content() */ EAPI Elm_Ctxpopup *ui_menu_get_content(ui_menu *menu); /** * @brief Unset an ui_menu content. + * @since_tizen 3.0 * - * @param menu An ui_menu instance. - * - * @return A previous content. If it wasn't, return @c NULL. + * @param[in] menu An ui_menu instance * - * @see ui_menu_content_set() + * @return A previous content. If it wasn't, return @c NULL * - * @since_tizen 3.0 + * @see ui_menu_set_content() + * @see ui_menu_get_content() */ EAPI Elm_Ctxpopup *ui_menu_unset_content(ui_menu *menu); /** * @brief Activate an ui_menu. + * @details It makes ui_menu state as show. + * @since_tizen 3.0 * - * @note It makes ui_menu state as show. - * - * @param menu An ui_menu instance. + * @param[in] menu An ui_menu instance * - * @return @c true if it succeeds, @c false otherwise. + * @return @c true if it succeeds, @c false otherwise * * @see ui_menu_deactivate() - * - * @since_tizen 3.0 */ EAPI bool ui_menu_activate(ui_menu *menu); /** * @brief Deactivate an ui_menu. + * @details It makes ui_menu state as hide. + * @since_tizen 3.0 * - * @note It makes ui_menu state as hide. - * - * @param menu An ui_menu instance. + * @param[in] menu An ui_menu instance * - * @return @c true if it succeeds, @c false otherwise. + * @return @c true if it succeeds, @c false otherwise * * @see ui_menu_activate() - * - * @since_tizen 3.0 */ EAPI bool ui_menu_deactivate(ui_menu *menu); /** * @brief Return the active status of ui_menu. + * @since_tizen 3.0 * - * @param menu An ui_menu instance. + * @param[in] menu An ui_menu instance * - * @return @c true if it succeeds, @c false otherwise. + * @return @c true if menu is activated, @c false otherwise * * @see ui_menu_activate() * @see ui_menu_deactivate() - * - * @since_tizen 3.0 */ EAPI bool ui_menu_get_activated(ui_menu *menu); /** * @brief Get a base object of an ui_menu. + * @details Normally, A base object can be used for a parent of ui_menu content. + * @since_tizen 3.0 * - * @note Normally, A base object can be used for a parent of ui_menu content. - * - * @param menu An ui_menu instance. - * - * @return base object of ui_menu. + * @param[in] menu An ui_menu instance * - * @since_tizen 3.0 + * @return base object of ui_menu */ EAPI Eo *ui_menu_get_base(ui_menu *menu); /** * @brief Get a current ui_menu's degree. + * @since_tizen 3.0 * - * @param menu An ui_menu instance. - * - * @return Current rotation degree, -1 if it fails to get degree information. + * @param[in] menu An ui_menu instance * - * @since_tizen 3.0 + * @return Current rotation degree, -1 if it fails to get degree information */ EAPI int ui_menu_get_degree(ui_menu *menu); /** * @brief Return a view which is matched with this ui_menu. + * @since_tizen 3.0 * - * @param menu An ui_menu instance. + * @param[in] menu An ui_menu instance * * @return The view which is matched with ui_menu - * - * @since_tizen 3.0 */ EAPI ui_view *ui_menu_get_view(ui_menu *menu); diff --git a/src/include/efl/mobile/c/ui_popup.h b/src/include/efl/mobile/c/ui_popup.h index 7e26a65..73bb85a 100644 --- a/src/include/efl/mobile/c/ui_popup.h +++ b/src/include/efl/mobile/c/ui_popup.h @@ -14,151 +14,139 @@ extern "C" { /** * @brief A constructor for an ui_popup. + * @since_tizen 3.0 + * @remakrs The instance of ui_popup is subordinated to the given @a ui_view. If the given @a ui_view is hidden or deactivated, this ui_popup will be also do + * same followed to its ui_view behaviors. The instance of ui_popup will be destroyed automatically when the ui_view is destroyed. * - * @param view An instance of ui_view. - * - * @note The instance of ui_popup is subordinated to the given @a ui_view. If the given @a ui_view is hidden or deactivated, this ui_popup will be also do - * same followed to its ui_view behaviors. - * - * @return An ui_popup instance. + * @param[in] view An instance of ui_view * - * @warning The instance of ui_popup will be destroyed automatically when the ui_view is destroyed. + * @return An ui_popup instance * * @see ui_popup_destroy() - * - * @since_tizen 3.0 */ EAPI ui_popup *ui_popup_create(ui_view *view); /** * @brief A destructor for an ui_popup. + * @details destroy an @a given ui_popup instance. + * @since_tizen 3.0 * - * @note destroy an @a given ui_popup instance. - * - * @param popup An ui_popup instance. + * @param[in] popup An ui_popup instance * * @see ui_popup_create() - * - * @since_tizen 3.0 */ EAPI void ui_popup_destroy(ui_popup *popup); /** * @brief Replace or set a content of an ui_popup. + * @since_tizen 3.0 * - * @param popup An ui_popup instance. - * @param content popup object. It allows @c NULL for canceling the previous content. - * - * @return @c true if it succeeds, @c false otherwise. + * @param[in] popup An ui_popup instance + * @param[in] content popup object. It allows @c NULL for canceling the previous content * - * @see ui_popup_content_get() + * @return @c true if it succeeds, @c false otherwise * - * @since_tizen 3.0 + * @see ui_popup_get_content() + * @see ui_popup_unset_content() */ EAPI bool ui_popup_set_content(ui_popup *popup, Elm_Popup *content); /** * @brief Return a content object of ui_popup. + * @since_tizen 3.0 * - * @param popup An ui_popup instance. - * - * @return A content of ui_popup. + * @param[in] popup An ui_popup instance * - * @see ui_popup_content_set() + * @return A content of ui_popup * - * @since_tizen 3.0 + * @see ui_popup_set_content() + * @see ui_popup_unset_content() */ EAPI Elm_Popup *ui_popup_get_content(ui_popup *popup); /** * @brief Unset an ui_popup content. + * @since_tizen 3.0 * - * @param popup An ui_popup instance. - * - * @return A previous content. If it wasn't, return @c NULL. + * @param[in] popup An ui_popup instance * - * @see ui_popup_content_set() + * @return A previous content. If it wasn't, return @c NULL * - * @since_tizen 3.0 + * @see ui_popup_get_content() + * @see ui_popup_set_content() */ EAPI Elm_Popup *ui_popup_unset_content(ui_popup *popup); /** * @brief Activate an ui_popup. + * @details It makes ui_popup state as show. + * @since_tizen 3.0 * - * @note It makes ui_popup state as show. - * - * @param popup An ui_popup instance. + * @param[in] popup An ui_popup instance * - * @return @c true if it succeeds, @c false otherwise. + * @return @c true if it succeeds, @c false otherwise * * @see ui_popup_deactivate() - * - * @since_tizen 3.0 + * @see ui_popup_get_activated() */ EAPI bool ui_popup_activate(ui_popup *popup); /** * @brief Deactivate an ui_popup. + * @details It makes ui_popup state as hide. + * @since_tizen 3.0 * - * @note It makes ui_popup state as hide. - * - * @param popup An ui_popup instance. + * @param[in] popup An ui_popup instance * - * @return @c true if it succeeds, @c false otherwise. + * @return @c true if it succeeds, @c false otherwise * * @see ui_popup_activate() - * - * @since_tizen 3.0 + * @see ui_popup_get_activated() */ EAPI bool ui_popup_deactivate(ui_popup *popup); /** * @brief Return the active status of ui_popup. + * @since_tizen 3.0 * - * @param popup An ui_popup instance. + * @param[in] popup An ui_popup instance * * @return @c true if ui_popup is activated, @c false otherwise * * @see ui_popup_activate() * @see ui_popup_deactivate() - * - * @since_tizen 3.0 */ EAPI bool ui_popup_get_activated(ui_popup *popup); /** * @brief Get a base object of an ui_popup. + * @details Normally, A base object can be used for a parent of ui_popup content. + * @since_tizen 3.0 * - * @note Normally, A base object can be used for a parent of ui_popup content. - * - * @param menu An ui_popup instance. - * - * @return base object of ui_popup. + * @param[in] menu An ui_popup instance * - * @since_tizen 3.0 + * @return base object of ui_popup + */ EAPI Eo *ui_popup_get_base(ui_popup *popup); /** * @brief Get current ui_popup's degree. + * @since_tizen 3.0 * - * @param popup An ui_popup instance. - * - * @return Current rotation degree, -1 if it fails to get degree information. + * @param[in] popup An ui_popup instance * - * @since_tizen 3.0 + * @return Current rotation degree, -1 if it fails to get degree information */ EAPI int ui_popup_get_degree(ui_popup *popup); /** * @brief Return a view which is matched with the ui_popup. + * @since_tizen 3.0 * - * @param popup An ui_popup instance. - * - * @return The view which is matched with ui_popup. + * @param[in] popup An ui_popup instance * - * @since_tizen 3.0 + * @return The view which is matched with ui_popup */ EAPI ui_view *ui_popup_get_view(ui_popup *popup); diff --git a/src/include/efl/mobile/c/ui_standard_view.h b/src/include/efl/mobile/c/ui_standard_view.h index fc792dd..70c0f8c 100644 --- a/src/include/efl/mobile/c/ui_standard_view.h +++ b/src/include/efl/mobile/c/ui_standard_view.h @@ -14,182 +14,185 @@ extern "C" { /** * @brief A constructor for an ui_standard_view. + * @since_tizen 3.0 + * @remarks if you don't set a view name, you could not look up the view with its name. @see ui_viewmgr_view_get_by_name(). * - * @param name view name - * @param view An ui_standard_view instance. + * @param[in] name view name * - * @warning if you don't set a view name, you could not look up the view with its name. @see ui_viewmgr_view_get_by_name(). + * @return view An ui_standard_view instance * * @see ui_view_destroy() - * - * @since_tizen 3.0 */ EAPI ui_standard_view *ui_standard_view_create(const char *name); /** * @brief Set a title text. + * @since_tizen 3.0 * - * @param view An ui_standard_view instance. - * @param text The label in the title area - * - * @return @c true if it succeeds, @c false otherwise. + * @param[in] view An ui_standard_view instance + * @param[in] text The label in the title area * - * @see ui_standard_view_title_get() + * @return @c true if it succeeds, @c false otherwise * - * @since_tizen 3.0 + * @see ui_standard_view_get_title() */ EAPI bool ui_standard_view_set_title(ui_standard_view *view, const char *text); /** * @brief Set a subtitle text. + * @since_tizen 3.0 * - * @param view An ui_standard_view instance. - * @param text The label in the subtitle area. - * - * @return @c true if it succeeds, @c false otherwise. + * @param[in] view An ui_standard_view instance + * @param[in] text The label in the subtitle area * - * @see ui_standard_view_sub_title_get() + * @return @c true if it succeeds, @c false otherwise * - * @since_tizen 3.0 + * @see ui_standard_view_get_sub_title() */ EAPI bool ui_standard_view_set_sub_title(ui_standard_view *view, const char *text); /** * @brief Set a title badge text. + * @since_tizen 3.0 * - * @param view An ui_standard_view instance. - * @param text The label in the title badge area. - * - * @return @c true if it succeeds, @c false otherwise. + * @param[in] view An ui_standard_view instance + * @param[in] text The label in the title badge area * - * @see ui_standard_view_title_badge_get() + * @return @c true if it succeeds, @c false otherwise * - * @since_tizen 3.0 + * @see ui_standard_view_get_title_badge() */ EAPI bool ui_standard_view_set_title_badge(ui_standard_view *view, const char *badge_text); /** * @brief Set a title_right_btn. + * @since_tizen 3.0 * - * @param view An ui_standard_view instance. - * @param title_right_btn The button in the right part of title area. - * - * @return @c true if it succeeds, @c false otherwise. + * @param[in] view An ui_standard_view instance + * @param[in] title_right_btn The button in the right part of title area * - * @see ui_standard_view_title_right_btn_get() + * @return @c true if it succeeds, @c false otherwise * - * @since_tizen 3.0 + * @see ui_standard_view_get_title_right_btn() + * @see ui_standard_view_unset_title_right_btn() */ EAPI bool ui_standard_view_set_title_right_btn(ui_standard_view *view, Elm_Button *title_right_btn); /** * @brief Return a title right button of the view. + * @since_tizen 3.0 * - * @param view An ui_standard_view instance. - * - * @return title right button of the view. + * @param[in] view An ui_standard_view instance * - * @see ui_standard_view_title_right_btn_set() + * @return title right button of the view * - * @since_tizen 3.0 + * @see ui_standard_view_set_title_right_btn() + * @see ui_standard_view_unset_title_right_btn() */ EAPI Elm_Button *ui_standard_view_get_title_right_btn(ui_standard_view *view); /** * @brief Unset a title right button of title area. + * @since_tizen 3.0 + * + * @param[in] view An ui_standard_view instance * - * @param view An ui_standard_view instance. * @return A previous content. If it wasn't, return @c NULL * - * @since_tizen 3.0 + * @see ui_standard_view_get_title_right_btn() + * @see ui_standard_view_set_title_right_btn() */ EAPI Elm_Button *ui_standard_view_unset_title_right_btn(ui_standard_view *view); /** * @brief Set a title_left_btn. + * @since_tizen 3.0 * - * @param view An ui_standard_view instance. - * @param title_left_btn The button in the left part of title area. - * - * @return @c true if it succeeds, @c false otherwise. + * @param[in] view An ui_standard_view instance + * @param[in] title_left_btn The button in the left part of title area * - * @see ui_standard_view_title_left_btn_get() + * @return @c true if it succeeds, @c false otherwise * - * @since_tizen 3.0 + * @see ui_standard_view_get_title_left_btn() + * @see ui_standard_view_unset_title_left_btn() */ EAPI bool ui_standard_view_set_title_left_btn(ui_standard_view *view, Elm_Button *title_left_btn); /** * @brief Return a title left button of the view. + * @since_tizen 3.0 * - * @param view An ui_standard_view instance. + * @param[in] view An ui_standard_view instance * * @return title left button of the view * - * @see ui_standard_view_title_left_btn_set() - * - * @since_tizen 3.0 + * @see ui_standard_view_set_title_left_btn() + * @see ui_standard_view_unset_title_left_btn() */ EAPI Elm_Button *ui_standard_view_get_title_left_btn(ui_standard_view *view); /** * @brief Unset a title right button of title area. + * @since_tizen 3.0 * - * @param view An ui_standard_view instance. + * @param[in] view An ui_standard_view instance * - * @return A previous content. If it wasn't, return @c NULL. + * @return A previous content. If it wasn't, return @c NULL * - * @since_tizen 3.0 + * @see ui_standard_view_get_title_left_btn() + * @see ui_standard_view_set_title_left_btn() */ EAPI Elm_Button *ui_standard_view_unset_title_left_btn(ui_standard_view *view); /** * @brief Set a toolbar below title. + * @since_tizen 3.0 * - * @param view An ui_standard_view instance. - * @param toolbar Toolbar object - * - * @return @c true if it succeeds, @c false otherwise. + * @param[in] view An ui_standard_view instance + * @param[in] toolbar Toolbar object * - * @see ui_standard_view_toolbar_get() + * @return @c true if it succeeds, @c false otherwise * - * @since_tizen 3.0 + * @see ui_standard_view_get_toolbar() + * @see ui_standard_view_unset_toolbar() */ EAPI bool ui_standard_view_set_toolbar(ui_standard_view *view, Elm_Toolbar *toolbar); /** * @brief Return a toolbar of the view. + * @since_tizen 3.0 * - * @param view An ui_standard_view instance. - * @return The toolbar of the given @a view. + * @param[in] view An ui_standard_view instance * - * @see ui_standard_view_toolbar_set() + * @return The toolbar of the given @a view * - * @since_tizen 3.0 + * @see ui_standard_view_set_toolbar() + * @see ui_standard_view_unset_toolbar() */ EAPI Elm_Toolbar *ui_standard_view_get_toolbar(ui_standard_view *view); /** * @brief Unset a toolbar. + * @since_tizen 3.0 * - * @param view An ui_standard_view instance. + * @param[in] view An ui_standard_view instance * - * @return A previous content. If it wasn't, return @c NULL. + * @return A previous content. If it wasn't, return @c NULL * - * @since_tizen 3.0 + * @see ui_standard_view_get_toolbar() + * @see ui_standard_view_set_toolbar() */ EAPI Elm_Toolbar *ui_standard_view_unset_toolbar(ui_standard_view *view); /** * @brief Control the title visible state. + * @since_tizen 3.0 * - * @param view An ui_standard_view instance. - * @param visible title state set as visible if the given param is @c true, otherwise title area set as invisible - * @param anim title area will be shown with animation if the given param is @c true, otherwise title area will be shown without animation - * - * @return @c true if it succeeds, @c false otherwise. + * @param[in] view An ui_standard_view instance + * @param[in] visible title state set as visible if the given param is @c true, otherwise title area set as invisible + * @param[in] anim title area will be shown with animation if the given param is @c true, otherwise title area will be shown without animation * - * @since_tizen 3.0 + * @return @c true if it succeeds, @c false otherwise */ EAPI bool ui_standard_view_set_title_visible(ui_standard_view *view, bool visible, bool anim); diff --git a/src/include/efl/mobile/c/ui_view.h b/src/include/efl/mobile/c/ui_view.h index 50aa348..e68fde0 100644 --- a/src/include/efl/mobile/c/ui_view.h +++ b/src/include/efl/mobile/c/ui_view.h @@ -14,16 +14,19 @@ extern "C" { /** * @brief ui_view's rotate event callback function signature. - * * @since_tizen 3.0 + * + * @param[in] view An ui_view instance + * @param[in] degree Current view's degree + * @param[in] data The user data to be passed to the given @a event_callback functions + * + * @return This is reserved + * + * @see ui_view_event_callback_s + * @see ui_view_set_event_callbacks */ typedef bool (*ui_view_event_cb)(ui_view *view, void *user_data); -/** - * @brief The Enumeration for view events. - * - * @since_tizen 3.0 - */ typedef enum { UI_VIEW_EVENT_LOAD = 0, UI_VIEW_EVENT_UNLOAD, @@ -58,265 +61,253 @@ typedef enum { /** * @brief A constructor for an ui_view. + * @since_tizen 3.0 + * @remarks if you don't set a view name, you could not look up the view with its name. @see ui_viewmgr_view_get_by_name(). * - * @param name view name. - * - * @return The ui_view instance. + * @param[in] name view name * - * @warning if you don't set a view name, you could not look up the view with its name. @see ui_viewmgr_view_get_by_name(). + * @return The ui_view instance * * @see ui_view_destroy() - * - * @since_tizen 3.0 */ EAPI ui_view *ui_view_create(const char *name); /** * @brief Replace or set a content of ui_view. + * @since_tizen 3.0 * - * @param view An ui_view instance. - * @param content A new content. It allows @c NULL for canceling the previous content. - * - * @return @c true if it succeeds, @c false otherwise. + * @param[in] view An ui_view instance + * @param[in] content A new content. It allows @c NULL for canceling the previous content * - * @see ui_view_content_get() + * @return @c true if it succeeds, @c false otherwise * - * @since_tizen 3.0 + * @see ui_view_get_content() + * @see ui_view_unset_content() */ EAPI bool ui_view_set_content(ui_view *view, Eo *content); /** - * @brief Set callback functions for handling view events. + * @brief Return a content of this view. + * @since_tizen 3.0 * - * @param view An ui_view instance. - * @param event_type ui_view event type. - * @param event_cb The set of callback functions to handle view events. - * @param user_data The user data to be passed to the given @a event_callback functions. + * @param[in] view An ui_view instance * - * @return @c true if it succeeds, @c false otherwise. + * @return content of @a view. If no contents set yet, @c NULL * - * @since_tizen 3.0 + * @see ui_view_set_content() + * @see ui_view_unset_content() */ -EAPI bool ui_view_set_event_cb(ui_view *view, ui_view_event_type_e event_type, ui_view_event_cb event_cb, void *user_data); +EAPI Eo *ui_view_get_content(ui_view *view); /** - * @brief Get a base object of ui_view. - * - * @param view An ui_view instance. + * @brief Unset a ui_view content. + * @since_tizen 3.0 * - * @note Normally, this base object can be used for a parent of a view content. + * @param[in] view An ui_view instance * - * @return The base object of ui_view. + * @return A previous content. If it wasn't, return @c NULL * - * @since_tizen 3.0 + * @see ui_view_set_content() + * @see ui_view_get_content() */ -EAPI Eo* ui_view_get_base(ui_view *view); +EAPI Eo *ui_view_unset_content(ui_view *view); /** - * @brief Unset a ui_view content. - * - * @param view An ui_view instance. + * @brief Set callback functions for handling view events. + * @since_tizen 3.0 * - * @return A previous content. If it wasn't, return @c NULL. + * @param[in] view An ui_view instance + * @param[in] event_type ui_view event tupe + * @param[in] event_cb The set of callback functions to handle view events + * @param[in] user_data The user data to be passed to the given @a event_callback functions * - * @see ui_view_content_set() + * @return @c true if it succeeds, @c false otherwise * + * @see ui_view_event_type_e + */ +EAPI bool ui_view_set_event_cb(ui_view *view, ui_view_event_type_e event_type, ui_view_event_cb event_cb, void *user_data); + +/** + * @brief Get a base object of ui_view. * @since_tizen 3.0 + * @remarks Normally, this base object can be used for a parent of a view content. + * + * @param[in] view An ui_view instance + * + * @return The base object of ui_view */ -EAPI Eo *ui_view_unset_content(ui_view *view); +EAPI Eo* ui_view_get_base(ui_view *view); /** * @brief Set the indicator mode of a ui_view. + * @since_tizen 3.0 * - * @param view An ui_view instance. - * @param indicator The mode to set, one of #ui_view_indicator - * - * @see ui_view_indicator_get() + * @param[in] view An ui_view instance + * @param[in] indicator The mode to set, one of #ui_view_indicator * - * @since_tizen 3.0 + * @see ui_view_indicator + * @see ui_view_get_indicator() */ EAPI void ui_view_set_indicator(ui_view *view, ui_view_indicator indicator); /** * @brief Return the indicator mode of this view. + * @since_tizen 3.0 * - * @param view An ui_view instance. - * - * @return indicator state of the given @a view. + * @param view An ui_view instance * - * @see ui_view_indicator_set() + * @return indicator state of the given @a view * - * @since_tizen 3.0 + * @see ui_view_get_indicator() */ EAPI ui_view_indicator ui_view_get_indicator(ui_view *view); /** * @breif Set the array of view's available rotations. + * @since_tizen 3.0 + * @remarks Set an array of rotation values. + * For instance, {0, 90, 180, 270}. These rotation values depends on the system support. * - * @note Set an array of rotation values. - * For instance, {0, 90, 180, 270}. These rotation values depends on the system support. - * - * @param rotations The array of rotation values. - * @param count The number of arrays of rotations. + * @param[in] rotations The array of rotation values + * @param[in] count The number of arrays of rotations * - * @see ui_view_get_available_rotations + * @return @c true if it succeeds, @c false otherwise * - * @since_tizen 3.0 + * @see ui_view_get_available_rotations() */ EAPI bool ui_view_set_available_rotations(ui_view *view, const int *rotations, unsigned int count); /** * @brief Get the array of view's available rotations. + * @since_tizen 3.0 * - * @param count The number of arrays of rotations. - * - * @return The array of rotation values. + * @param[in] view An ui_view instance + * @param[out] count The number of arrays of rotations * - * @see ui_view_set_available_rotations + * @return The array of rotation values * - * @since_tizen 3.0 + * @see ui_view_set_available_rotations() */ EAPI const int *ui_view_get_available_rotations(ui_view *view, unsigned int *count); /** * @brief Set content removable. + * @since_tizen 3.0 * - * @param view An ui_view instance. - * @param removable if @a removable is @c true, content of this view will be removed on unload state. @c false otherwise - * - * @warning You should not remove a view content manually on unload status if removable content is set. + * @param[in] view An ui_view instance + * @param[in] removable if @a removable is @c true, content of this view will be removed on unload state. @c false otherwise * - * @see ui_view_removable_content_get() + * @warning You should not remove a view content manually on unload status if removable content is set * - * @since_tizen 3.0 + * @see ui_view_get_removable_content() */ EAPI void ui_view_set_removable_content(ui_view *view, bool remove); /** * @brief Return a state of removable content. + * @since_tizen 3.0 * - * @param view An ui_view instance. - * - * @return @c true if the view's content is removable, otherwise @c false. + * @param[in] view An ui_view instance * - * @see ui_view_removable_content_get() + * @return @c true if the view's content is removable, otherwise @c false * - * @since_tizen 3.0 + * @see ui_view_get_removable_content() */ EAPI bool ui_view_get_removable_content(ui_view *view); /** * @brief Get the current view's degree. + * @since_tizen 3.0 * - * @param view An ui_view instance. - * - * @return Current rotation degree, -1 if it fails to get degree information. + * @param[in] view An ui_view instance * - * @since_tizen 3.0 + * @return Current rotation degree, -1 if it fails to get degree information */ EAPI int ui_view_get_degree(ui_view *view); /** * @brief Get current view's orientation mode. + * @since_tizen 3.0 * - * @param view An ui_view instance + * @param[in] view An ui_view instance * - * @return Current orientation mode, one of #ui_view_orientation_mode. + * @return Current orientation mode, one of #ui_view_orientation_mode * - * @since_tizen 3.0 + * @see ui_view_orientation_mode */ EAPI ui_view_orientation_mode ui_view_get_orientation_mode(ui_view *view); /** * @brief Set transition style of a view. + * @since_tizen 3.0 * - * @note @a style is reserved for supporting various kinds of view transition effects. - * The actual behaviors with this transition style is up to your frameworks. Default value of the style is NULL. - * and "none" represents none transition. If you don't like give any transition effects to this view, you can pass "none" as @a style. - * - * @param view An ui_view instance. - * @param style a transition style name + * @remarks @a style is reserved for supporting various kinds of view transition effects. + * The actual behaviors with this transition style is up to your frameworks. Default value of the style is NULL. + * and "none" represents none transition. If you don't like give any transition effects to this view, you can pass "none" as @a style. * - * @return @c true if the given @c style is available, otherwise @c false. + * @param[in] view An ui_view instance + * @param[in] style a transition style name * - * @see ui_view_transition_style_get() + * @return @c true if the given @c style is available, otherwise @c false * - * @since_tizen 3.0 + * @see ui_view_get_transition_style() */ EAPI bool ui_view_set_transition_style(ui_view *view, const char *style); /** * @brief Return a style name of this view. + * @since_tizen 3.0 * - * @param view An ui_view instance. - * - * @return style name of view. + * @param[in] view An ui_view instance * - * @see ui_view_transition_style_set() + * @return style name of view * - * @since_tizen 3.0 + * @see ui_view_set_transition_style() */ EAPI const char *ui_view_get_transition_style(ui_view *view); /** * @brief Get a ui_menu instance. + * @since_tizen 3.0 * - * @param view An ui_view instance. - * - * @return The ui_memnu that connected with given @a view. + * @param[in] view An ui_view instance * - * @since_tizen 3.0 + * @return The ui_memnu that connected with given @a view */ EAPI ui_menu *ui_view_get_menu(ui_view *view); /** * @brief Return a name of this view. + * @since_tizen 3.0 * - * @param view An ui_view instance. - * - * @return name of @a view. - * - * @see ui_view_name_set() + * @param[in] view An ui_view instance * - * @since_tizen 3.0 + * @return name of @a view */ EAPI const char *ui_view_get_name(ui_view *view); /** * @brief Return a state of this view. - * - * @param view An ui_view instance. - * - * @return current state of @a view. - * * @since_tizen 3.0 - */ -EAPI ui_view_state ui_view_get_state(ui_view *view); - -/** - * @brief Return a content of this view. - * - * @param view An ui_view instance. * - * @return content of @a view. If no contents set yet, @c NULL. + * @param[in] view An ui_view instance * - * @see ui_view_content_set() + * @return current state of @a view * - * @since_tizen 3.0 + * @see ui_view_state */ -EAPI Eo *ui_view_get_content(ui_view *view); +EAPI ui_view_state ui_view_get_state(ui_view *view); /** * @brief A destructor for an ui_view. + * @since_tizen 3.0 * - * @param view An ui_view instance. + * @param[in] view An ui_view instance * - * @return @c true if it succeeds, @c false otherwise. + * @return @c true if it succeeds, @c false otherwise * * @see ui_view_create() * @see ui_standard_view_create() - * - * @since_tizen 3.0 */ EAPI bool ui_view_destroy(ui_view *view); diff --git a/src/include/efl/mobile/c/ui_viewmgr.h b/src/include/efl/mobile/c/ui_viewmgr.h index 5f45a16..d936b10 100644 --- a/src/include/efl/mobile/c/ui_viewmgr.h +++ b/src/include/efl/mobile/c/ui_viewmgr.h @@ -14,13 +14,13 @@ extern "C" { /** * @brief Push a new view into ui_viewmgr. This function is used for when application switches a current view to a new one. + * @details Normally, the current view will be hidden by a new view. In default, when user calls this API, view will be switched to @a view instantly, + * only when ui_viewmgr state is activated. Otherwise, the @a view will be shown later when ui_viewmgr is activated. ui_viewmgr_view_push() is designed + * for providing view transition effect. If you want push view instantly without any transition, you could use ui_viewmgr_view_push_insert_before() or + * ui_viewmgr_view_push_insert_after(). If you want to pop the current view, the please use ui_viewmgr_view_pop(). + * @since_tizen 3.0 * - * @note Normally, the current view will be hidden by a new view. In default, when user calls this API, view will be switched to @a view instantly, - * only when ui_viewmgr state is activated. Otherwise, the @a view will be shown later when ui_viewmgr is activated. ui_viewmgr_view_push() is designed - * for providing view transition effect. If you want push view instantly without any transition, you could use ui_viewmgr_view_push_insert_before() or - * ui_viewmgr_view_push_insert_after(). If you want to pop the current view, the please use ui_viewmgr_view_pop(). - * - * @param view An ui_view to insert in the ui_viewmgr view list + * @param[in] view An ui_view to insert in the ui_viewmgr view list * * @return @a view, @c NULL when it fails to push a @a view * @@ -28,36 +28,32 @@ extern "C" { * @see ui_viewmgr_view_push_insert_before() * @see ui_viewmgr_view_push_insert_after() * @see ui_viewmgr_view_pop() - * - * @since_tizen 3.0 */ EAPI ui_view *ui_viewmgr_push_view(ui_view *view); /** * @brief Insert a view in the ui_viewmgr view list. Specifically, insert a given @a view right before of the given view, @before. + * @since_tizen 3.0 * - * @param view An ui_view to insert in the ui_viewmgr view list - * @param before An ui_view that will be just inserted after @a view. If you pass @c NULL, @a view will be inserted at the front of the view list + * @param[in] view An ui_view to insert in the ui_viewmgr view list + * @param[in] before An ui_view that will be just inserted after @a view. If you pass @c NULL, @a view will be inserted at the front of the view list * * @return @c true on success or @c false otherwise * * @see ui_viewmgr_view_push_insert_after() - * - * @since_tizen 3.0 */ EAPI bool ui_viewmgr_push_view_insert_before(ui_view *view, ui_view *before); /** * @brief Insert a view in the ui_viewmgr view list. Specifically, insert a given @a view right after of the given view, @after. + * @since_tizen 3.0 * - * @param view An ui_view to insert in the ui_viewmgr view list - * @param after An ui_view that will be just inserted before the @a view. If you pass @c NULL, @a view will be inserted at the end of the view list + * @param[in] view An ui_view to insert in the ui_viewmgr view list + * @param[in] after An ui_view that will be just inserted before the @a view. If you pass @c NULL, @a view will be inserted at the end of the view list * * @return @c true on success or @c false otherwise * * @see ui_viewmgr_view_push_insert_before() - * - * @since_tizen 3.0 */ EAPI bool ui_viewmgr_push_view_insert_after(ui_view *view, ui_view *after); @@ -65,139 +61,122 @@ EAPI bool ui_viewmgr_push_view_insert_after(ui_view *view, ui_view *after); * @brief Pop the top(last) view from the ui_viewmgr view list. * This function is used when application switches the current view back to the previous view. * The top view will be removed from the view stack and then it will be deleted by the given ui_viewmgr. - * - * @note If the view is just one left, then ui_viewmgr would be deactivated automatically since the ui application might be invalid anymore. Otherwise, - * the application will be terminated. It's up to system configuration. + * @since_tizen 3.0 + * @remarks If the view is just one left, then ui_viewmgr would be deactivated automatically since the ui application might be invalid anymore. Otherwise, + * the application will be terminated. It's up to system configuration. * * @return @c true on success or @c false otherwise * * @see ui_viewmgr_deactivate() * @see ui_viewmgr_view_push() - * - * @since_tizen 3.0 */ EAPI bool ui_viewmgr_pop_view(void); /** * @brief Activate this view manager. - * - * @note ui_viewmgr window and views will be shown once this function is called. Usually this should be called after applications set their all views - * on initialization time. + * @since_tizen 3.0 + * @remarks ui_viewmgr window and views will be shown once this function is called. Usually this should be called after applications set their all views + * on initialization time. * * @return @c true on success or @c false otherwise * * @see ui_viewmgr_deactivate() - * - * @since_tizen 3.0 */ EAPI bool ui_viewmgr_activate(void); /** * @brief Deactivate this view manager. * - * @note ui_viewmgr window and views will be hidden once this function is called. this behavior is up ui system, but usually it hides(unmap) - * current window in order that application go background. + * @remarks ui_viewmgr window and views will be hidden once this function is called. this behavior is up ui system, but usually it hides(unmap) + * current window in order that application go background. * * @return @c true success or @c false not * * @see ui_viewmgr_activate() - * - * @since_tizen 3.0 */ EAPI bool ui_viewmgr_deactivate(void); /** * @brief Get a window object of ui_viewmgr. + * @since_tizen 3.0 * * @return The window object of ui_viewmgr - * - * @since_tizen 3.0 */ EAPI Elm_Win *ui_viewmgr_get_window(void); /** * @brief Return a last(top) view. + * @since_tizen 3.0 * * @return The view which is last view of the ui_viewmgr view list - * - * @since_tizen 3.0 */ EAPI ui_view *ui_viewmgr_get_last_view(void); /** * @brief Return a view which is matched with the index @a idx. + * @since_tizen 3.0 + * @remarks You could use the index as the page numbers of the views. + * the index number of views are variable since the view list is variable. * - * @param idx A index of the view which you are looking for. - * - * @note You could use the index as the page numbers of the views. - * @warning the index number of views are variable since the view list is variable. + * @param[in] idx A index of the view which you are looking for * * @return The view which index is matched with @a idx * If there were no views with index @a idx, @c NULL will be returned * * @see ui_viewmgr_view_index_get() * @see ui_viewmgr_view_count_get() - * - * @since_tizen 3.0 */ EAPI ui_view *ui_viewmgr_get_view_by_idx(int idx); /** * @brief Return a view which is matched with the @a name. + * @since_tizen 3.0 + * @remarks Every view have their names as their own identifiers. * - * @note Every view have their names as their own identifiers. - * - * @param name The name of the view which you are looking for. - * - * @return The view which name is matched with @a name. - * If there were no views name matched, @c NULL will be returned. + * @param[in] name The name of the view which you are looking for * - * @see UiIfaceView::set_name() + * @return The view which name is matched with @a name + * If there were no views name matched, @c NULL will be returned * - * @since_tizen 3.0 + * @see ui_view_create() + * @see ui_standard_view_create() */ EAPI ui_view *ui_viewmgr_get_view_by_name(const char *name); /** * @brief Get a base object of a ui_viewmgr. - * - * @note Normally, a base object can be used for adding additional objects. - * - * @return The base object of ui_viewmgr. - * * @since_tizen 3.0 + * @remarks Normally, a base object can be used for adding additional objects. + * + * @return The base object of ui_viewmgr */ EAPI Eo *ui_viewmgr_get_base(void); /** * @brief Return a view index(page) number of the given view. * You could use this function to query the given @a view list order. + * @since_tizen 3.0 + * @remarks The index number of views are variable since the view list is variable * - * @param view An ui_view to query the index + * @param[in] view An ui_view to query the index * * @return An index of the given @a view on success, otherwise, -1 - * - * @warning The index number of views are variable since the view list is variable - * - * @since_tizen 3.0 */ EAPI int ui_viewmgr_get_view_index(const ui_view *view); /** * @brief Return the number of views which of ui_viewmgr. + * @since_tizen 3.0 * * @return the count of views - * - * @since_tizen 3.0 */ EAPI int ui_viewmgr_get_view_count(void); /** * @brief Return whether soft back key is required or not. + * @since_tizen 3.0 * * @return @c true if soft key is required, @c false otherwise - * - * @since_tizen 3.0 */ EAPI bool ui_viewmgr_get_soft_key_need(void); diff --git a/src/include/interface/UiIfaceTypes.h b/src/include/interface/UiIfaceTypes.h index fbb5cff..1976934 100644 --- a/src/include/interface/UiIfaceTypes.h +++ b/src/include/interface/UiIfaceTypes.h @@ -18,8 +18,7 @@ #define _UI_IFACE_TYPES_H_ /** - * Possible values for indicator state. - * + * @brief Possible values for indicator state. * @since_tizen 3.0 */ enum UiViewIndicator @@ -35,8 +34,7 @@ enum UiViewIndicator typedef enum UiViewIndicator ui_view_indicator; /** - * Possible values for view state. - * + * @brief Possible values for view state. * @since_tizen 3.0 */ enum UiViewState @@ -52,8 +50,7 @@ enum UiViewState typedef enum UiViewState ui_view_state; /** - * Possible values for view orientation mode. - * + * @breif Possible values for view orientation mode. * @since_tizen 3.0 */ enum UiViewOrientationMode