From e5cfac74716d46ba7e243b3f317407231da85bdc Mon Sep 17 00:00:00 2001 From: Woochan Lee Date: Tue, 1 Nov 2016 19:18:07 +0900 Subject: [PATCH] Doxygen update. Change-Id: I43b679ae34e8bea92db72af29d644e39f795dc9d --- src/include/efl/mobile/c/ui_application.h | 99 +++++----- src/include/efl/mobile/c/ui_menu.h | 116 +++++------ src/include/efl/mobile/c/ui_popup.h | 150 +++++++------- src/include/efl/mobile/c/ui_standard_view.h | 222 ++++++++++----------- src/include/efl/mobile/c/ui_view.h | 292 ++++++++++++++-------------- src/include/efl/mobile/c/ui_viewmgr.h | 199 +++++++++---------- src/include/interface/UiIfaceTypes.h | 22 ++- 7 files changed, 555 insertions(+), 545 deletions(-) diff --git a/src/include/efl/mobile/c/ui_application.h b/src/include/efl/mobile/c/ui_application.h index b82d3e5..3c11739 100644 --- a/src/include/efl/mobile/c/ui_application.h +++ b/src/include/efl/mobile/c/ui_application.h @@ -13,23 +13,23 @@ extern "C" { */ /** - * @brief Called when the each application event occured. - * @since_tizen 3.0 + * @brief The ui_application event callback function signature. + * @since_tizen 3.0 * - * @param[in] user_data The user data to be passed to the given @a event_callback functions - * @param[in] event_info Event Information data. (It can casts to app_control_h in app_control()) + * @param[in] user_data The user data to be passed to the given @a event_callback functions + * @param[in] event_info Event Information data. (It can casts to app_control_h in app_control()) * - * @return This is reserved + * @return This is reserved * - * @see ui_application_event_type_e - * @see ui_application_event_s - * @see ui_application_run() + * @see ui_application_event_type_e + * @see ui_application_event_s + * @see ui_application_run() */ typedef bool (*ui_application_event_cb)(void *user_data, void *event_info); /** - * @brief Enumeration for ui_application event type. - * @since_tizen 3.0 + * @brief Enumeration for ui_application event type. + * @since_tizen 3.0 */ typedef enum { UI_APPLICATION_EVENT_CREATE = 0, /**< App create */ @@ -46,8 +46,8 @@ typedef enum { } ui_application_event_type_e; /** - * @brief Struct for ui_application event. - * @since_tizen 3.0 + * @brief Struct for ui_application event. + * @since_tizen 3.0 */ typedef struct { @@ -56,62 +56,61 @@ typedef struct } ui_application_event_s; /** - * @brief Initializes ui_application. - * @details This function initializes ui_application and ui_viewmgr. - * @since_tizen 3.0 - * @remarks Before exit application, call ui_application_term(). + * @brief Initializes ui_application. + * @details This function initializes ui_application and ui_viewmgr. + * @since_tizen 3.0 + * @remarks Before exit application, call ui_application_term(). * - * @param[in] pkg The name of package - * @param[in] locale_dir The path of locale directory + * @param[in] pkg The name of package + * @param[in] locale_dir The path of locale directory * - * @return @c 0 on success, otherwise a negative error value - * @retval #TIZEN_ERROR_NONE Successful - * @retval #TIZEN_ERROR_ALREADY_IN_PROGRESS Initialization was already done - * @retval #TIZEN_ERROR_OUT_OF_MEMORY Fails to allocate memory + * @return @c 0 on success, otherwise a negative error value. + * @retval #TIZEN_ERROR_NONE Successful + * @retval #TIZEN_ERROR_ALREADY_IN_PROGRESS Initialization was already done. + * @retval #TIZEN_ERROR_OUT_OF_MEMORY Fails to allocate memory. * - * @see ui_application_term() - * @see ui_application_run() + * @see ui_application_term() + * @see ui_application_run() */ EAPI int ui_application_init(const char *pkg, const char *locale_dir); /** - * @brief Runs ui_application. This triggers application main loop. - * @remarks This is wrapping ui_app_main() function. - * @since_tizen 3.0 + * @brief Runs ui_application. This triggers application main loop. + * @remarks This is wrapping ui_app_main() function. + * @since_tizen 3.0 * - * @param[in] argc The argument count - * @param[in] argv The argument vector - * @param[in] events Event callback list - * @param[in] count The number of event count - * @param[in] user_data User data for event callbacks + * @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 * - * @return @c 0 on success, otherwise a negative error value - * @retval #TIZEN_ERROR_NONE Successful - * @retval #TIZEN_ERROR_INVALID_PARAMETER Invalid parameters - * @retval #TIZEN_ERROR_APPLICATION The application is illegally launched, not launched by the launch system - * @retval #TIZEN_ERROR_ALREADY_IN_PROGRESS The main loop already starts - * @retval #TIZEN_ERROR_NOT_PERMITTED If Initialization was not performed yet + * @return @c 0 on success, otherwise a negative error value. + * @retval #TIZEN_ERROR_NONE Successful + * @retval #TIZEN_ERROR_INVALID_PARAMETER Invalid parameters + * @retval #TIZEN_ERROR_APPLICATION The application is illegally launched, not launched by the launch system. + * @retval #TIZEN_ERROR_ALREADY_IN_PROGRESS The main loop already starts. + * @retval #TIZEN_ERROR_NOT_PERMITTED If Initialization was not performed yet. * - * @pre Call ui_application_init() before calling this function. + * @pre Call ui_application_init() before calling this function. * - * @see ui_application_event_s - * @see ui_app_main() - * @see ui_application_init() - * @see ui_application_term() + * @see ui_application_event_s + * @see ui_app_main() + * @see ui_application_init() + * @see ui_application_term() */ EAPI int ui_application_run(int argc, char **argv, ui_application_event_s *events, int count, void *user_data); /** - * @brief Deinitializes ui_application. - * @since_tizen 3.0 + * @brief Deinitializes ui_application. + * @since_tizen 3.0 * - * @return @c 0 on success, otherwise a negative error value - * @retval #TIZEN_ERROR_NONE Successful + * @return @c 0 on success, otherwise a negative error value. + * @retval #TIZEN_ERROR_NONE Successful * - * @pre Call ui_application_init() before calling this function. + * @pre Call ui_application_init() before calling this function. * - * @see ui_application_init() - * @see ui_application_run() + * @see ui_application_init() + * @see ui_application_run() */ EAPI int 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 92cde8f..519cfa9 100644 --- a/src/include/efl/mobile/c/ui_menu.h +++ b/src/include/efl/mobile/c/ui_menu.h @@ -13,120 +13,120 @@ extern "C" { */ /** - * @brief Replaces or set a content of an ui_menu. - * @since_tizen 3.0 + * @brief Replaces or set a content of an ui_menu. + * @since_tizen 3.0 * - * @param[in] menu An ui_menu object - * @param[in] ctxpopup ctxpopup object. It allows @c NULL for canceling the previous content + * @param[in] menu An ui_menu object + * @param[in] ctxpopup ctxpopup object. It allows @c NULL for canceling the previous content * - * @return @c 0 on success, otherwise a negative error value - * @retval #TIZEN_ERROR_NONE Successful - * @retval #TIZEN_ERROR_INVALID_PARAMETER @a menu is invalid or @a content is not a type of Elm_Ctxpopup + * @return @c 0 on success, otherwise a negative error value. + * @retval #TIZEN_ERROR_NONE Successful + * @retval #TIZEN_ERROR_INVALID_PARAMETER @a menu is invalid or @a content is not a type of Elm_Ctxpopup. * - * @see ui_menu_get_content() - * @see ui_menu_unset_content() + * @see ui_menu_get_content() + * @see ui_menu_unset_content() */ EAPI int ui_menu_set_content(ui_menu *menu, Elm_Ctxpopup *content); /** - * @brief Returns an ui_menu content. - * @since_tizen 3.0 + * @brief Returns an ui_menu content. + * @since_tizen 3.0 * - * @param[in] menu An ui_menu instance + * @param[in] menu An ui_menu instance * - * @return A content of ui_menu + * @return A content of ui_menu * - * @see ui_menu_set_content() - * @see ui_menu_unset_content() + * @see ui_menu_set_content() + * @see ui_menu_unset_content() */ EAPI Elm_Ctxpopup *ui_menu_get_content(ui_menu *menu); /** - * @brief Unsets an ui_menu content. - * @since_tizen 3.0 + * @brief Unsets an ui_menu content. + * @since_tizen 3.0 * - * @param[in] menu An ui_menu instance + * @param[in] menu An ui_menu instance * - * @return A previous content. If it wasn't, return @c NULL + * @return A previous content. If it wasn't, return @c NULL * - * @see ui_menu_set_content() - * @see ui_menu_get_content() + * @see ui_menu_set_content() + * @see ui_menu_get_content() */ EAPI Elm_Ctxpopup *ui_menu_unset_content(ui_menu *menu); /** - * @brief Activates an ui_menu. - * @details It makes ui_menu state as show. - * @since_tizen 3.0 + * @brief Activates an ui_menu. + * @details It makes ui_menu state as show. + * @since_tizen 3.0 * - * @param[in] menu An ui_menu instance + * @param[in] menu An ui_menu instance * - * @return @c 0 on success, otherwise a negative error value - * @retval #TIZEN_ERROR_NONE Successful - * @retval #TIZEN_ERROR_NOT_PERMITTED menu instance is not set up yet - * @retval #TIZEN_ERROR_INVALID_PARAMETER @a menu is invalid + * @return @c 0 on success, otherwise a negative error value. + * @retval #TIZEN_ERROR_NONE Successful + * @retval #TIZEN_ERROR_NOT_PERMITTED menu instance is not set up yet. + * @retval #TIZEN_ERROR_INVALID_PARAMETER @a menu is invalid. * - * @see ui_menu_deactivate() + * @see ui_menu_deactivate() */ EAPI int ui_menu_activate(ui_menu *menu); /** - * @brief Deactivates an ui_menu. - * @details It makes ui_menu state as hide. - * @since_tizen 3.0 + * @brief Deactivates an ui_menu. + * @details It makes ui_menu state as hide. + * @since_tizen 3.0 * - * @param[in] menu An ui_menu instance + * @param[in] menu An ui_menu instance * - * @return @c 0 on success, otherwise a negative error value - * @retval #TIZEN_ERROR_NONE Successful - * @retval #TIZEN_ERROR_NOT_PERMITTED menu instance is not set up yet - * @retval #TIZEN_ERROR_INVALID_PARAMETER @a menu is invalid + * @return @c 0 on success, otherwise a negative error value. + * @retval #TIZEN_ERROR_NONE Successful + * @retval #TIZEN_ERROR_NOT_PERMITTED menu instance is not set up yet. + * @retval #TIZEN_ERROR_INVALID_PARAMETER @a menu is invalid. * - * @see ui_menu_activate() + * @see ui_menu_activate() */ EAPI int ui_menu_deactivate(ui_menu *menu); /** - * @brief Returns the active status of ui_menu. - * @since_tizen 3.0 + * @brief Returns the active status of ui_menu. + * @since_tizen 3.0 * - * @param[in] menu An ui_menu instance + * @param[in] menu An ui_menu instance * - * @return @c true if menu is activated, @c false otherwise + * @return @c true if menu is activated, @c false otherwise * - * @see ui_menu_activate() - * @see ui_menu_deactivate() + * @see ui_menu_activate() + * @see ui_menu_deactivate() */ EAPI bool ui_menu_get_activated(ui_menu *menu); /** - * @brief Gets 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 + * @brief Gets 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 * - * @param[in] menu An ui_menu instance + * @param[in] menu An ui_menu instance * - * @return base object of ui_menu + * @return base object of ui_menu */ EAPI Eo *ui_menu_get_base(ui_menu *menu); /** - * @brief Gets a current ui_menu's degree. - * @since_tizen 3.0 + * @brief Gets a current ui_menu's degree. + * @since_tizen 3.0 * - * @param[in] menu An ui_menu instance + * @param[in] menu An ui_menu instance * - * @return Current rotation degree, -1 if it fails to get degree information + * @return Current rotation degree, -1 if it fails to get degree information */ EAPI int ui_menu_get_degree(ui_menu *menu); /** - * @brief Returns a view which is matched with this ui_menu. - * @since_tizen 3.0 + * @brief Returns a view which is matched with this ui_menu. + * @since_tizen 3.0 * - * @param[in] menu An ui_menu instance + * @param[in] menu An ui_menu instance * - * @return The view which is matched with ui_menu + * @return The view which is matched with ui_menu */ 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 a07c514..f6dbb91 100644 --- a/src/include/efl/mobile/c/ui_popup.h +++ b/src/include/efl/mobile/c/ui_popup.h @@ -13,152 +13,152 @@ extern "C" { */ /** - * @brief Creates an ui_popup. - * @since_tizen 3.0 - * @remarks 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. + * @brief Creates an ui_popup. + * @since_tizen 3.0 + * @remarks 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[in] view An instance of ui_view + * @param[in] view An instance of ui_view * - * @return An ui_popup instance + * @return An ui_popup instance * - * @see ui_popup_destroy() + * @see ui_popup_destroy() */ EAPI ui_popup *ui_popup_create(ui_view *view); /** - * @brief Destroys an ui_popup. - * @details destroy an @a given ui_popup instance. - * @since_tizen 3.0 + * @brief Destroys an ui_popup. + * @details destroy an @a given ui_popup instance. + * @since_tizen 3.0 * - * @param[in] popup An ui_popup instance + * @param[in] popup An ui_popup instance * - * @return @c 0 on success, otherwise a negative error value - * @retval #TIZEN_ERROR_NONE Successful - * @retval #TIZEN_ERROR_INVALID_PARAMETER @a popup is invalid + * @return @c 0 on success, otherwise a negative error value. + * @retval #TIZEN_ERROR_NONE Successful + * @retval #TIZEN_ERROR_INVALID_PARAMETER @a popup is invalid. * - * @see ui_popup_create() + * @see ui_popup_create() */ EAPI int ui_popup_destroy(ui_popup *popup); /** - * @brief Replaces or set a content of an ui_popup. - * @since_tizen 3.0 + * @brief Replaces or set a content of an ui_popup. + * @since_tizen 3.0 * - * @param[in] popup An ui_popup instance - * @param[in] content popup object. It allows @c NULL for canceling the previous content + * @param[in] popup An ui_popup instance + * @param[in] content popup object. It allows @c NULL for canceling the previous content * - * @return @c 0 on success, otherwise a negative error value - * @retval #TIZEN_ERROR_NONE Successful - * @retval #TIZEN_ERROR_INVALID_PARAMETER @a popup is invalid or @a content is not a type of Elm_Popup + * @return @c 0 on success, otherwise a negative error value. + * @retval #TIZEN_ERROR_NONE Successful + * @retval #TIZEN_ERROR_INVALID_PARAMETER @a popup is invalid or @a content is not a type of Elm_Popup. * - * @see ui_popup_get_content() - * @see ui_popup_unset_content() + * @see ui_popup_get_content() + * @see ui_popup_unset_content() */ EAPI int ui_popup_set_content(ui_popup *popup, Elm_Popup *content); /** - * @brief Returns a content object of ui_popup. - * @since_tizen 3.0 + * @brief Returns a content object of ui_popup. + * @since_tizen 3.0 * - * @param[in] popup An ui_popup instance + * @param[in] popup An ui_popup instance * - * @return A content of ui_popup + * @return A content of ui_popup * - * @see ui_popup_set_content() - * @see ui_popup_unset_content() + * @see ui_popup_set_content() + * @see ui_popup_unset_content() */ EAPI Elm_Popup *ui_popup_get_content(ui_popup *popup); /** - * @brief Unsets an ui_popup content. - * @since_tizen 3.0 + * @brief Unsets an ui_popup content. + * @since_tizen 3.0 * - * @param[in] popup An ui_popup instance + * @param[in] popup An ui_popup instance * - * @return A previous content. If it wasn't, return @c NULL + * @return A previous content. If it wasn't, return @c NULL * - * @see ui_popup_get_content() - * @see ui_popup_set_content() + * @see ui_popup_get_content() + * @see ui_popup_set_content() */ EAPI Elm_Popup *ui_popup_unset_content(ui_popup *popup); /** - * @brief Activates an ui_popup. - * @details It makes ui_popup state as show. - * @since_tizen 3.0 + * @brief Activates an ui_popup. + * @details It makes ui_popup state as show. + * @since_tizen 3.0 * - * @param[in] popup An ui_popup instance + * @param[in] popup An ui_popup instance * - * @return @c 0 on success, otherwise a negative error value - * @retval #TIZEN_ERROR_NONE Successful - * @retval #TIZEN_ERROR_NOT_PERMITTED popup instance is not set up yet - * @retval #TIZEN_ERROR_INVALID_PARAMETER @a popup is invalid + * @return @c 0 on success, otherwise a negative error value. + * @retval #TIZEN_ERROR_NONE Successful + * @retval #TIZEN_ERROR_NOT_PERMITTED popup instance is not set up yet. + * @retval #TIZEN_ERROR_INVALID_PARAMETER @a popup is invalid. * - * @see ui_popup_deactivate() - * @see ui_popup_get_activated() + * @see ui_popup_deactivate() + * @see ui_popup_get_activated() */ EAPI int ui_popup_activate(ui_popup *popup); /** - * @brief Deactivates an ui_popup. - * @details It makes ui_popup state as hide. - * @since_tizen 3.0 + * @brief Deactivates an ui_popup. + * @details It makes ui_popup state as hide. + * @since_tizen 3.0 * - * @param[in] popup An ui_popup instance + * @param[in] popup An ui_popup instance * - * @return @c 0 on success, otherwise a negative error value - * @retval #TIZEN_ERROR_NONE Successful - * @retval #TIZEN_ERROR_NOT_PERMITTED popup instance is not set up yet - * @retval #TIZEN_ERROR_INVALID_PARAMETER @a popup is invalid + * @return @c 0 on success, otherwise a negative error value. + * @retval #TIZEN_ERROR_NONE Successful + * @retval #TIZEN_ERROR_NOT_PERMITTED popup instance is not set up yet. + * @retval #TIZEN_ERROR_INVALID_PARAMETER @a popup is invalid. * - * @see ui_popup_activate() - * @see ui_popup_get_activated() + * @see ui_popup_activate() + * @see ui_popup_get_activated() */ EAPI int ui_popup_deactivate(ui_popup *popup); /** - * @brief Returns the active status of ui_popup. - * @since_tizen 3.0 + * @brief Returns the active status of ui_popup. + * @since_tizen 3.0 * - * @param[in] popup An ui_popup instance + * @param[in] popup An ui_popup instance * - * @return @c true if ui_popup is activated, @c false otherwise + * @return @c true if ui_popup is activated, @c false otherwise * - * @see ui_popup_activate() - * @see ui_popup_deactivate() + * @see ui_popup_activate() + * @see ui_popup_deactivate() */ EAPI bool ui_popup_get_activated(ui_popup *popup); /** - * @brief Gets 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 + * @brief Gets 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 * - * @param[in] menu An ui_popup instance + * @param[in] menu An ui_popup instance * - * @return base object of ui_popup + * @return base object of ui_popup */ EAPI Eo *ui_popup_get_base(ui_popup *popup); /** - * @brief Gets current ui_popup's degree. - * @since_tizen 3.0 + * @brief Gets current ui_popup's degree. + * @since_tizen 3.0 * - * @param[in] popup An ui_popup instance + * @param[in] popup An ui_popup instance * - * @return Current rotation degree, -1 if it fails to get degree information + * @return Current rotation degree, -1 if it fails to get degree information */ EAPI int ui_popup_get_degree(ui_popup *popup); /** - * @brief Returns a view which is matched with the ui_popup. - * @since_tizen 3.0 + * @brief Returns a view which is matched with the ui_popup. + * @since_tizen 3.0 * - * @param[in] popup An ui_popup instance + * @param[in] popup An ui_popup instance * - * @return The view which is matched with ui_popup + * @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 aa931bb..72e9f5a 100644 --- a/src/include/efl/mobile/c/ui_standard_view.h +++ b/src/include/efl/mobile/c/ui_standard_view.h @@ -13,210 +13,210 @@ extern "C" { */ /** - * @brief Creates 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_get_view_by_name(). + * @brief Creates 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_get_view_by_name(). * - * @param[in] name view name + * @param[in] name view name * - * @return view An ui_standard_view instance + * @return view An ui_standard_view instance * - * @see ui_view_destroy() + * @see ui_view_destroy() */ EAPI ui_standard_view *ui_standard_view_create(const char *name); /** - * @brief Sets a title text. - * @since_tizen 3.0 + * @brief Sets a title text. + * @since_tizen 3.0 * - * @param[in] view An ui_standard_view instance - * @param[in] text The label in the title area + * @param[in] view An ui_standard_view instance + * @param[in] text The label in the title area * - * @return @c 0 on success, otherwise a negative error value - * @retval #TIZEN_ERROR_NONE Successful - * @retval #TIZEN_ERROR_INVALID_PARAMETER if @a view is invalid - * @retval #TIZEN_ERROR_RESULT_OUT_OF_RANGE Instance is corrupted. Maybe base object is broken + * @return @c 0 on success, otherwise a negative error value. + * @retval #TIZEN_ERROR_NONE Successful + * @retval #TIZEN_ERROR_INVALID_PARAMETER if @a view is invalid. + * @retval #TIZEN_ERROR_RESULT_OUT_OF_RANGE Instance is corrupted. Maybe base object is broken. * - * @see ui_standard_view_get_title() + * @see ui_standard_view_get_title() */ EAPI int ui_standard_view_set_title(ui_standard_view *view, const char *text); /** - * @brief Sets a subtitle text. - * @since_tizen 3.0 + * @brief Sets a subtitle text. + * @since_tizen 3.0 * - * @param[in] view An ui_standard_view instance - * @param[in] text The label in the subtitle area + * @param[in] view An ui_standard_view instance + * @param[in] text The label in the subtitle area * - * @return @c 0 on success, otherwise a negative error value - * @retval #TIZEN_ERROR_NONE Successful - * @retval #TIZEN_ERROR_INVALID_PARAMETER if @a view is invalid - * @retval #TIZEN_ERROR_RESULT_OUT_OF_RANGE Instance is corrupted. Maybe base object is broken + * @return @c 0 on success, otherwise a negative error value. + * @retval #TIZEN_ERROR_NONE Successful + * @retval #TIZEN_ERROR_INVALID_PARAMETER if @a view is invalid. + * @retval #TIZEN_ERROR_RESULT_OUT_OF_RANGE Instance is corrupted. Maybe base object is broken. * - * @see ui_standard_view_get_sub_title() + * @see ui_standard_view_get_sub_title() */ EAPI int ui_standard_view_set_sub_title(ui_standard_view *view, const char *text); /** - * @brief Sets a title badge text. - * @since_tizen 3.0 + * @brief Sets a title badge text. + * @since_tizen 3.0 * - * @param[in] view An ui_standard_view instance - * @param[in] text The label in the title badge area + * @param[in] view An ui_standard_view instance + * @param[in] text The label in the title badge area * - * @return @c 0 on success, otherwise a negative error value - * @retval #TIZEN_ERROR_NONE Successful - * @retval #TIZEN_ERROR_INVALID_PARAMETER if @a view is invalid - * @retval #TIZEN_ERROR_RESULT_OUT_OF_RANGE Instance is corrupted. Maybe base object is broken + * @return @c 0 on success, otherwise a negative error value. + * @retval #TIZEN_ERROR_NONE Successful + * @retval #TIZEN_ERROR_INVALID_PARAMETER if @a view is invalid. + * @retval #TIZEN_ERROR_RESULT_OUT_OF_RANGE Instance is corrupted. Maybe base object is broken. * - * @see ui_standard_view_get_title_badge() + * @see ui_standard_view_get_title_badge() */ EAPI int ui_standard_view_set_title_badge(ui_standard_view *view, const char *badge_text); /** - * @brief Sets a title_right_btn. - * @since_tizen 3.0 + * @brief Sets a title_right_btn. + * @since_tizen 3.0 * - * @param[in] view An ui_standard_view instance - * @param[in] title_right_btn The button in the right part of title area + * @param[in] view An ui_standard_view instance + * @param[in] title_right_btn The button in the right part of title area * - * @return @c 0 on success, otherwise a negative error value - * @retval #TIZEN_ERROR_NONE Successful - * @retval #TIZEN_ERROR_INVALID_PARAMETER if @a view is invalid - * @retval #TIZEN_ERROR_ALREADY_IN_PROGRESS if @a title_right_btn is same with the existing one - * @retval #TIZEN_ERROR_RESULT_OUT_OF_RANGE Instance is corrupted. Maybe base object is broken + * @return @c 0 on success, otherwise a negative error value. + * @retval #TIZEN_ERROR_NONE Successful + * @retval #TIZEN_ERROR_INVALID_PARAMETER if @a view is invalid. + * @retval #TIZEN_ERROR_ALREADY_IN_PROGRESS if @a title_right_btn is same with the existing one. + * @retval #TIZEN_ERROR_RESULT_OUT_OF_RANGE Instance is corrupted. Maybe base object is broken. * - * @see ui_standard_view_get_title_right_btn() - * @see ui_standard_view_unset_title_right_btn() + * @see ui_standard_view_get_title_right_btn() + * @see ui_standard_view_unset_title_right_btn() */ EAPI int ui_standard_view_set_title_right_btn(ui_standard_view *view, Elm_Button *title_right_btn); /** - * @brief Returns a title right button of the view. - * @since_tizen 3.0 + * @brief Returns a title right button of the view. + * @since_tizen 3.0 * - * @param[in] view An ui_standard_view instance + * @param[in] view An ui_standard_view instance * - * @return title right button of the view + * @return title right button of the view * - * @see ui_standard_view_set_title_right_btn() - * @see ui_standard_view_unset_title_right_btn() + * @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 Unsets a title right button of title area. - * @since_tizen 3.0 + * @brief Unsets a title right button of title area. + * @since_tizen 3.0 * - * @param[in] 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 * - * @see ui_standard_view_get_title_right_btn() - * @see ui_standard_view_set_title_right_btn() + * @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 Sets a title_left_btn. - * @since_tizen 3.0 + * @brief Sets a title_left_btn. + * @since_tizen 3.0 * - * @param[in] view An ui_standard_view instance - * @param[in] title_left_btn The button in the left part of title area + * @param[in] view An ui_standard_view instance + * @param[in] title_left_btn The button in the left part of title area * - * @return @c 0 on success, otherwise a negative error value - * @retval #TIZEN_ERROR_NONE Successful - * @retval #TIZEN_ERROR_INVALID_PARAMETER if @a view is invalid - * @retval #TIZEN_ERROR_ALREADY_IN_PROGRESS if @a title_left_btn is same with the existing one - * @retval #TIZEN_ERROR_RESULT_OUT_OF_RANGE Instance is corrupted. Maybe base object is broken + * @return @c 0 on success, otherwise a negative error value. + * @retval #TIZEN_ERROR_NONE Successful + * @retval #TIZEN_ERROR_INVALID_PARAMETER if @a view is invalid. + * @retval #TIZEN_ERROR_ALREADY_IN_PROGRESS if @a title_left_btn is same with the existing one. + * @retval #TIZEN_ERROR_RESULT_OUT_OF_RANGE Instance is corrupted. Maybe base object is broken. * - * @see ui_standard_view_get_title_left_btn() - * @see ui_standard_view_unset_title_left_btn() + * @see ui_standard_view_get_title_left_btn() + * @see ui_standard_view_unset_title_left_btn() */ EAPI int ui_standard_view_set_title_left_btn(ui_standard_view *view, Elm_Button *title_left_btn); /** - * @brief Returns a title left button of the view. - * @since_tizen 3.0 + * @brief Returns a title left button of the view. + * @since_tizen 3.0 * - * @param[in] view An ui_standard_view instance + * @param[in] view An ui_standard_view instance * - * @return title left button of the view + * @return title left button of the view * - * @see ui_standard_view_set_title_left_btn() - * @see ui_standard_view_unset_title_left_btn() + * @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 Unsets a title right button of title area. - * @since_tizen 3.0 + * @brief Unsets a title right button of title area. + * @since_tizen 3.0 * - * @param[in] 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 * - * @see ui_standard_view_get_title_left_btn() - * @see ui_standard_view_set_title_left_btn() + * @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 Sets a toolbar below title. - * @since_tizen 3.0 + * @brief Sets a toolbar below title. + * @since_tizen 3.0 * - * @param[in] view An ui_standard_view instance - * @param[in] toolbar Toolbar object + * @param[in] view An ui_standard_view instance + * @param[in] toolbar Toolbar object * - * @return @c 0 on success, otherwise a negative error value - * @retval #TIZEN_ERROR_NONE Successful - * @retval #TIZEN_ERROR_INVALID_PARAMETER if @a view is invalid - * @retval #TIZEN_ERROR_ALREADY_IN_PROGRESS if @a toolbar is already existing - * @retval #TIZEN_ERROR_RESULT_OUT_OF_RANGE Instance is corrupted. Maybe base object is broken + * @return @c 0 on success, otherwise a negative error value. + * @retval #TIZEN_ERROR_NONE Successful + * @retval #TIZEN_ERROR_INVALID_PARAMETER if @a view is invalid. + * @retval #TIZEN_ERROR_ALREADY_IN_PROGRESS if @a toolbar is already existing. + * @retval #TIZEN_ERROR_RESULT_OUT_OF_RANGE Instance is corrupted. Maybe base object is broken. * - * @see ui_standard_view_get_toolbar() - * @see ui_standard_view_unset_toolbar() + * @see ui_standard_view_get_toolbar() + * @see ui_standard_view_unset_toolbar() */ EAPI int ui_standard_view_set_toolbar(ui_standard_view *view, Elm_Toolbar *toolbar); /** - * @brief Returns a toolbar of the view. - * @since_tizen 3.0 + * @brief Returns a toolbar of the view. + * @since_tizen 3.0 * - * @param[in] view An ui_standard_view instance + * @param[in] view An ui_standard_view instance * - * @return The toolbar of the given @a view + * @return The toolbar of the given @a view * - * @see ui_standard_view_set_toolbar() - * @see ui_standard_view_unset_toolbar() + * @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 Unsets a toolbar. - * @since_tizen 3.0 + * @brief Unsets a toolbar. + * @since_tizen 3.0 * - * @param[in] 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 * - * @see ui_standard_view_get_toolbar() - * @see ui_standard_view_set_toolbar() + * @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 Controls the title visible state. - * @since_tizen 3.0 + * @brief Controls the title visible state. + * @since_tizen 3.0 * - * @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 + * @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 * - * @return @c 0 on success, otherwise a negative error value - * @retval #TIZEN_ERROR_NONE Successful - * @retval #TIZEN_ERROR_INVALID_PARAMETER if @a view is invalid - * @retval #TIZEN_ERROR_RESULT_OUT_OF_RANGE Instance is corrupted. Maybe base object is broken + * @return @c 0 on success, otherwise a negative error value. + * @retval #TIZEN_ERROR_NONE Successful + * @retval #TIZEN_ERROR_INVALID_PARAMETER if @a view is invalid. + * @retval #TIZEN_ERROR_RESULT_OUT_OF_RANGE Instance is corrupted. Maybe base object is broken. */ EAPI int 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 429223c..9e29b89 100644 --- a/src/include/efl/mobile/c/ui_view.h +++ b/src/include/efl/mobile/c/ui_view.h @@ -13,23 +13,23 @@ extern "C" { */ /** - * @brief Called when the each view event occured. - * @since_tizen 3.0 + * @brief The ui_view 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 + * @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 + * @return This is reserved * - * @see ui_view_event_type_e - * @see ui_view_set_event_cb + * @see ui_view_event_type_e + * @see ui_view_set_event_cb */ typedef bool (*ui_view_event_cb)(ui_view *view, void *user_data); /** - * @brief Enumeration for ui_view event type. - * @since_tizen 3.0 + * @brief Enumeration for ui_view event type. + * @since_tizen 3.0 */ typedef enum { @@ -63,277 +63,277 @@ typedef enum } ui_view_event_type_e; /** - * @brief Creates an ui_view. - * @since_tizen 3.0 - * @remarks if you don't set a view name, you could not look up the view with it's name. @see ui_viewmgr_get_view_by_name(). + * @brief Creates an ui_view. + * @since_tizen 3.0 + * @remarks if you don't set a view name, you could not look up the view with it's name. @see ui_viewmgr_get_view_by_name(). * - * @param[in] name view name + * @param[in] name view name * - * @return The ui_view instance + * @return The ui_view instance. * - * @see ui_view_destroy() + * @see ui_view_destroy() */ EAPI ui_view *ui_view_create(const char *name); /** - * @brief Replaces or set a content of ui_view. - * @since_tizen 3.0 + * @brief Replaces or set a content of ui_view. + * @since_tizen 3.0 * - * @param[in] view An ui_view instance - * @param[in] content A new content. It allows @c NULL for canceling the previous content + * @param[in] view An ui_view instance + * @param[in] content A new content. It allows @c NULL for canceling the previous content * - * @return @c 0 on success, otherwise a negative error value - * @retval #TIZEN_ERROR_NONE Successful - * @retval #TIZEN_ERROR_INVALID_PARAMETER if @a view is invalid + * @return @c 0 on success, otherwise a negative error value. + * @retval #TIZEN_ERROR_NONE Successful + * @retval #TIZEN_ERROR_INVALID_PARAMETER if @a view is invalid. * - * @see ui_view_get_content() - * @see ui_view_unset_content() + * @see ui_view_get_content() + * @see ui_view_unset_content() */ EAPI int ui_view_set_content(ui_view *view, Eo *content); /** - * @brief Returns a content of this view. - * @since_tizen 3.0 + * @brief Returns a content of this view. + * @since_tizen 3.0 * - * @param[in] view An ui_view instance + * @param[in] view An ui_view instance * - * @return content of @a view. If no contents set yet, @c NULL + * @return content of @a view. If no contents set yet, @c NULL * - * @see ui_view_set_content() - * @see ui_view_unset_content() + * @see ui_view_set_content() + * @see ui_view_unset_content() */ EAPI Eo *ui_view_get_content(ui_view *view); /** - * @brief Unsets a ui_view content. - * @since_tizen 3.0 + * @brief Unsets a ui_view content. + * @since_tizen 3.0 * - * @param[in] view An ui_view instance + * @param[in] view An ui_view instance * - * @return A previous content. If it wasn't, return @c NULL + * @return A previous content. If it wasn't, return @c NULL * - * @see ui_view_set_content() - * @see ui_view_get_content() + * @see ui_view_set_content() + * @see ui_view_get_content() */ EAPI Eo *ui_view_unset_content(ui_view *view); /** - * @brief Sets callback functions for handling view events. - * @since_tizen 3.0 + * @brief Sets callback functions for handling view events. + * @since_tizen 3.0 * - * @param[in] view An ui_view instance - * @param[in] event_type ui_view event type - * @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 + * @param[in] view An ui_view instance + * @param[in] event_type ui_view event type + * @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 * - * @return @c 0 on success, otherwise a negative error value - * @retval #TIZEN_ERROR_NONE Successful - * @retval #TIZEN_ERROR_INVALID_PARAMETER if @a view is invalid + * @return @c 0 on success, otherwise a negative error value. + * @retval #TIZEN_ERROR_NONE Successful + * @retval #TIZEN_ERROR_INVALID_PARAMETER if @a view is invalid. * - * @see ui_view_event_type_e + * @see ui_view_event_type_e */ EAPI int 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 Gets 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. + * @brief Gets 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 + * @param[in] view An ui_view instance * - * @return The base object of ui_view + * @return The base object of ui_view */ EAPI Eo* ui_view_get_base(ui_view *view); /** - * @brief Sets the indicator mode of a ui_view. - * @since_tizen 3.0 + * @brief Sets the indicator mode of a ui_view. + * @since_tizen 3.0 * - * @param[in] view An ui_view instance - * @param[in] indicator The mode to set, one of #ui_view_indicator + * @param[in] view An ui_view instance + * @param[in] indicator The mode to set, one of #ui_view_indicator * - * @return @c 0 on success, otherwise a negative error value - * @retval #TIZEN_ERROR_NONE Successful - * @retval #TIZEN_ERROR_INVALID_PARAMETER Invalid Parameters - * @retval #TIZEN_ERROR_NOT_PERMITTED Current view manager system is not set up + * @return @c 0 on success, otherwise a negative error value. + * @retval #TIZEN_ERROR_NONE Successful + * @retval #TIZEN_ERROR_INVALID_PARAMETER Invalid Parameters. + * @retval #TIZEN_ERROR_NOT_PERMITTED Current view manager system is not set up. * - * @see ui_view_indicator - * @see ui_view_get_indicator() + * @see ui_view_indicator + * @see ui_view_get_indicator() */ EAPI int ui_view_set_indicator(ui_view *view, ui_view_indicator indicator); /** - * @brief Returns the indicator mode of this view. - * @since_tizen 3.0 + * @brief Returns the indicator mode of this view. + * @since_tizen 3.0 * - * @param view An ui_view instance + * @param view An ui_view instance * - * @return indicator state of the given @a view + * @return indicator state of the given @a view * - * @see ui_view_get_indicator() + * @see ui_view_get_indicator() */ EAPI ui_view_indicator ui_view_get_indicator(ui_view *view); /** - * @brief Sets 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. + * @brief Sets 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. * - * @param[in] rotations The array of rotation values - * @param[in] count The number of arrays of rotations + * @param[in] rotations The array of rotation values + * @param[in] count The number of arrays of rotations * - * @return @c 0 on success, otherwise a negative error value - * @retval #TIZEN_ERROR_NONE Successful - * @retval #TIZEN_ERROR_INVALID_PARAMETER If @a view is invalid or @a count is less than 1 or @a rotations is invalid pointer - * @retval #TIZEN_ERROR_OUT_OF_MEMORY Out of Memory - * @retval #TIZEN_ERROR_NOT_PERMITTED Current view manager system is not set up + * @return @c 0 on success, otherwise a negative error value. + * @retval #TIZEN_ERROR_NONE Successful + * @retval #TIZEN_ERROR_INVALID_PARAMETER If @a view is invalid or @a count is less than 1 or @a rotations is invalid pointer. + * @retval #TIZEN_ERROR_OUT_OF_MEMORY Out of Memory + * @retval #TIZEN_ERROR_NOT_PERMITTED Current view manager system is not set up. * - * @see ui_view_get_available_rotations() + * @see ui_view_get_available_rotations() */ EAPI int ui_view_set_available_rotations(ui_view *view, const int *rotations, unsigned int count); /** - * @brief Gets the array of view's available rotations. - * @since_tizen 3.0 + * @brief Gets the array of view's available rotations. + * @since_tizen 3.0 * - * @param[in] view An ui_view instance - * @param[out] count The number of arrays of rotations + * @param[in] view An ui_view instance + * @param[out] count The number of arrays of rotations * - * @return The array of rotation values + * @return The array of rotation values * - * @warning @c NULL will be returned if @a view or @a count is invalid + * @warning @c NULL will be returned if @a view or @a count is invalid. * - * @see ui_view_set_available_rotations() + * @see ui_view_set_available_rotations() */ EAPI const int *ui_view_get_available_rotations(ui_view *view, unsigned int *count); /** - * @brief Sets content removable. - * @since_tizen 3.0 + * @brief Sets content removable. + * @since_tizen 3.0 * - * @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 + * @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 * - * @warning You should not remove a view content manually on unload status if removable content is set + * @warning You should not remove a view content manually on unload status if removable content is set * - * @return @c 0 on success, otherwise a negative error value - * @retval #TIZEN_ERROR_NONE Successful - * @retval #TIZEN_ERROR_INVALID_PARAMETER If @a view is invalid or @a count is less than 1 or @a rotations is invalid pointer + * @return @c 0 on success, otherwise a negative error value. + * @retval #TIZEN_ERROR_NONE Successful + * @retval #TIZEN_ERROR_INVALID_PARAMETER If @a view is invalid or @a count is less than 1 or @a rotations is invalid pointer. * - * @see ui_view_get_removable_content() + * @see ui_view_get_removable_content() */ EAPI int ui_view_set_removable_content(ui_view *view, bool remove); /** - * @brief Returns a state of removable content. - * @since_tizen 3.0 + * @brief Returns a state of removable content. + * @since_tizen 3.0 * - * @param[in] view An ui_view instance + * @param[in] view An ui_view instance * - * @return @c true if the view's content is removable, otherwise @c false + * @return @c true if the view's content is removable, otherwise @c false * - * @see ui_view_get_removable_content() + * @see ui_view_get_removable_content() */ EAPI bool ui_view_get_removable_content(ui_view *view); /** - * @brief Gets the current view's degree. - * @since_tizen 3.0 + * @brief Gets the current view's degree. + * @since_tizen 3.0 * - * @param[in] view An ui_view instance + * @param[in] view An ui_view instance * - * @return Current rotation degree, -1 if it fails to get degree information + * @return Current rotation degree, -1 if it fails to get degree information */ EAPI int ui_view_get_degree(ui_view *view); /** - * @brief Gets current view's orientation mode. - * @since_tizen 3.0 + * @brief Gets current view's orientation mode. + * @since_tizen 3.0 * - * @param[in] 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 * - * @see ui_view_orientation_mode + * @see ui_view_orientation_mode */ EAPI ui_view_orientation_mode ui_view_get_orientation_mode(ui_view *view); /** - * @brief Sets transition style of a view. - * @since_tizen 3.0 + * @brief Sets transition style of a view. + * @since_tizen 3.0 * - * @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. + * @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. * - * @param[in] view An ui_view instance - * @param[in] style a transition style name + * @param[in] view An ui_view instance + * @param[in] style a transition style name * - * @return @c 0 on success, otherwise a negative error value - * @retval #TIZEN_ERROR_NONE Successful - * @retval #TIZEN_ERROR_INVALID_PARAMETER @a view is invalid or @a style is not supported + * @return @c 0 on success, otherwise a negative error value. + * @retval #TIZEN_ERROR_NONE Successful + * @retval #TIZEN_ERROR_INVALID_PARAMETER @a view is invalid or @a style is not supported. * - * @see ui_view_get_transition_style() + * @see ui_view_get_transition_style() */ EAPI int ui_view_set_transition_style(ui_view *view, const char *style); /** - * @brief Returns a style name of this view. - * @since_tizen 3.0 + * @brief Returns a style name of this view. + * @since_tizen 3.0 * - * @param[in] view An ui_view instance + * @param[in] view An ui_view instance * - * @return style name of view + * @return style name of view * - * @see ui_view_set_transition_style() + * @see ui_view_set_transition_style() */ EAPI const char *ui_view_get_transition_style(ui_view *view); /** - * @brief Gets a ui_menu instance. - * @since_tizen 3.0 + * @brief Gets a ui_menu instance. + * @since_tizen 3.0 * - * @param[in] view An ui_view instance + * @param[in] view An ui_view instance * - * @return The ui_menu that connected with given @a view + * @return The ui_menu that connected with given @a view */ EAPI ui_menu *ui_view_get_menu(ui_view *view); /** - * @brief Returns a name of this view. - * @since_tizen 3.0 + * @brief Returns a name of this view. + * @since_tizen 3.0 * - * @param[in] view An ui_view instance + * @param[in] view An ui_view instance * - * @return name of @a view + * @return name of @a view */ EAPI const char *ui_view_get_name(ui_view *view); /** - * @brief Returns a state of this view. - * @since_tizen 3.0 + * @brief Returns a state of this view. + * @since_tizen 3.0 * - * @param[in] view An ui_view instance + * @param[in] view An ui_view instance * - * @return current state of @a view + * @return current state of @a view * - * @see ui_view_state + * @see ui_view_state */ EAPI ui_view_state ui_view_get_state(ui_view *view); /** - * @brief Destroys an ui_view. - * @since_tizen 3.0 + * @brief Destroys an ui_view. + * @since_tizen 3.0 * - * @param[in] view An ui_view instance + * @param[in] view An ui_view instance * - * @return @c 0 on success, otherwise a negative error value - * @retval #TIZEN_ERROR_NONE Successful - * @retval #TIZEN_ERROR_INVALID_PARAMETER @a view is invalid + * @return @c 0 on success, otherwise a negative error value. + * @retval #TIZEN_ERROR_NONE Successful + * @retval #TIZEN_ERROR_INVALID_PARAMETER @a view is invalid. * - * @see ui_view_create() - * @see ui_standard_view_create() + * @see ui_view_create() + * @see ui_standard_view_create() */ EAPI int 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 9c5b7b2..d30dbd6 100644 --- a/src/include/efl/mobile/c/ui_viewmgr.h +++ b/src/include/efl/mobile/c/ui_viewmgr.h @@ -13,186 +13,187 @@ extern "C" { */ /** - * @brief Pushs 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 + * @brief Pushs 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 * - * @param[in] 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 @c 0 on success, otherwise a negative error value - * @retval #TIZEN_ERROR_INVALID_PARAMETER @a view is not valid - * @retval #TIZEN_ERROR_NOT_PERMITTED @a view was already inserted + * @return @c 0 on success, otherwise a negative error value. + * @retval #TIZEN_ERROR_INVALID_PARAMETER @a view is not valid. + * @retval #TIZEN_ERROR_NOT_PERMITTED @a view was already inserted. * - * @see ui_viewmgr_activate() - * @see ui_viewmgr_insert_view_before() - * @see ui_viewmgr_insert_view_after() - * @see ui_viewmgr_pop_view() + * @see ui_viewmgr_activate() + * @see ui_viewmgr_insert_view_before() + * @see ui_viewmgr_insert_view_after() + * @see ui_viewmgr_pop_view() */ EAPI int ui_viewmgr_push_view(ui_view *view); /** - * @brief Inserts 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 + * @brief Inserts 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[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 + * @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 0 on success, otherwise a negative error value - * @retval #TIZEN_ERROR_NONE Successful - * @retval #TIZEN_ERROR_NOT_PERMITTED @a view was already inserted - * @retval #TIZEN_ERROR_INVALID_PARAMETER @a view is not valid + * @return @c 0 on success, otherwise a negative error value. + * @retval #TIZEN_ERROR_NONE Successful + * @retval #TIZEN_ERROR_NOT_PERMITTED @a view was already inserted. + * @retval #TIZEN_ERROR_INVALID_PARAMETER @a view is not valid. * - * @see ui_viewmgr_insert_view_after() + * @see ui_viewmgr_insert_view_after() */ EAPI int ui_viewmgr_insert_view_before(ui_view *view, ui_view *before); /** - * @brief Inserts 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 + * @brief Inserts 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[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 + * @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 0 on success, otherwise a negative error value - * @retval #TIZEN_ERROR_NONE Successful - * @retval #TIZEN_ERROR_NOT_PERMITTED @a view was already inserted - * @retval #TIZEN_ERROR_INVALID_PARAMETER @a view is not valid + * @return @c 0 on success, otherwise a negative error value. + * @retval #TIZEN_ERROR_NONE Successful + * @retval #TIZEN_ERROR_NOT_PERMITTED @a view was already inserted. + * @retval #TIZEN_ERROR_INVALID_PARAMETER @a view is not valid. * - * @see ui_viewmgr_insert_view_before() + * @see ui_viewmgr_insert_view_before() */ EAPI int ui_viewmgr_insert_view_after(ui_view *view, ui_view *after); /** - * @brief Pops 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. - * @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. + * @brief Pops 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. + * @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 0 on success, otherwise a negative error value - * @retval #TIZEN_ERROR_NONE Successful - * @retval #TIZEN_ERROR_NOT_PERMITTED No more views to pop - * @retval #TIZEN_ERROR_ALREADY_IN_PROGRESS On a certain profile, it may not allow to pop multiple views at the same time + * @return @c 0 on success, otherwise a negative error value. + * @retval #TIZEN_ERROR_NONE Successful + * @retval #TIZEN_ERROR_NOT_PERMITTED No more views to pop. + * @retval #TIZEN_ERROR_ALREADY_IN_PROGRESS On a certain profile, it may not allow to pop multiple views at the same time. * - * @see ui_viewmgr_deactivate() - * @see ui_viewmgr_push_view() + * @see ui_viewmgr_deactivate() + * @see ui_viewmgr_push_view() */ EAPI int ui_viewmgr_pop_view(void); /** - * @brief Activates this view manager. - * @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. + * @brief Activates this view manager. + * @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 0 on success, otherwise a negative error value - * @retval #TIZEN_ERROR_NONE Successful - * @retval #TIZEN_ERROR_ALREADY_IN_PROGRESS Already activated - * @retval #TIZEN_ERROR_NOT_PERMITTED Can't be activated (ie, view manager has zero views.) + * @return @c 0 on success, otherwise a negative error value. + * @retval #TIZEN_ERROR_NONE Successful + * @retval #TIZEN_ERROR_ALREADY_IN_PROGRESS Already activated + * @retval #TIZEN_ERROR_NOT_PERMITTED Can't be activated. (ie, view manager has zero views.) * - * @see ui_viewmgr_deactivate() + * @see ui_viewmgr_deactivate() */ EAPI int ui_viewmgr_activate(void); /** - * @brief Deactivates this view manager. + * @brief Deactivates this view manager. * - * @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. + * @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 0 on success, otherwise a negative error value - * @retval #TIZEN_ERROR_NONE Successful - * @retval #TIZEN_ERROR_ALREADY_IN_PROGRESS Already deactivated + * @return @c 0 on success, otherwise a negative error value. + * @retval #TIZEN_ERROR_NONE Successful + * @retval #TIZEN_ERROR_ALREADY_IN_PROGRESS Already deactivated * - * @see ui_viewmgr_activate() + * @see ui_viewmgr_activate() */ EAPI int ui_viewmgr_deactivate(void); /** - * @brief Gets a window object of ui_viewmgr. - * @since_tizen 3.0 + * @brief Gets a window object of ui_viewmgr. + * @since_tizen 3.0 * - * @return The window object of ui_viewmgr + * @return The window object of ui_viewmgr */ EAPI Elm_Win *ui_viewmgr_get_window(void); /** - * @brief Returns a last(top) view. - * @since_tizen 3.0 + * @brief Returns a last(top) view. + * @since_tizen 3.0 * - * @return The view which is last view of the ui_viewmgr view list + * @return The view which is last view of the ui_viewmgr view list */ EAPI ui_view *ui_viewmgr_get_last_view(void); /** - * @brief Returns 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. + * @brief Returns 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[in] idx A index of the view which you are looking for + * @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 + * @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_get_view_index() - * @see ui_viewmgr_get_view_count() + * @see ui_viewmgr_get_view_index() + * @see ui_viewmgr_get_view_count() */ EAPI ui_view *ui_viewmgr_get_view_by_idx(int idx); /** - * @brief Returns a view which is matched with the @a name. - * @since_tizen 3.0 - * @remarks Every view have their names as their own identifiers. + * @brief Returns a view which is matched with the @a name. + * @since_tizen 3.0 + * @remarks Every view have their names as their own identifiers. * - * @param[in] name The name of the view which you are looking for + * @param[in] 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 + * @return The view which name is matched with @a name + * If there were no views name matched, @c NULL will be returned * - * @see ui_view_create() - * @see ui_standard_view_create() + * @see ui_view_create() + * @see ui_standard_view_create() */ EAPI ui_view *ui_viewmgr_get_view_by_name(const char *name); /** - * @brief Gets a base object of a ui_viewmgr. - * @since_tizen 3.0 - * @remarks Normally, a base object can be used for adding additional objects. + * @brief Gets a base object of a 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 + * @return The base object of ui_viewmgr */ EAPI Eo *ui_viewmgr_get_base(void); /** - * @brief Returns 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 + * @brief Returns 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[in] 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 + * @return An index of the given @a view on success, otherwise, -1 */ EAPI int ui_viewmgr_get_view_index(const ui_view *view); /** - * @brief Returns the number of views which of ui_viewmgr. - * @since_tizen 3.0 + * @brief Returns the number of views which of ui_viewmgr. + * @since_tizen 3.0 * - * @return the count of views + * @return the count of views */ EAPI int ui_viewmgr_get_view_count(void); /** - * @brief Returns whether soft back key is required or not. - * @since_tizen 3.0 + * @brief Returns whether soft back key is required or not. + * @since_tizen 3.0 * - * @return @c true if soft key is required, @c false otherwise + * @return @c true if soft key is required, @c false otherwise */ EAPI bool ui_viewmgr_get_soft_key_need(void); diff --git a/src/include/interface/UiIfaceTypes.h b/src/include/interface/UiIfaceTypes.h index 05c8cd4..6b0f6c4 100644 --- a/src/include/interface/UiIfaceTypes.h +++ b/src/include/interface/UiIfaceTypes.h @@ -18,8 +18,13 @@ #define _UI_IFACE_TYPES_H_ /** - * @brief Possible values for indicator state. - * @since_tizen 3.0 + * @addtogroup CAPI_UI_VIEWMGR_MODULE + * @{ + */ + +/** + * @brief Possible values for indicator state. + * @since_tizen 3.0 */ typedef enum UiViewIndicator { @@ -32,8 +37,8 @@ typedef enum UiViewIndicator } ui_view_indicator; /** - * @brief Possible values for view state. - * @since_tizen 3.0 + * @brief Possible values for view state. + * @since_tizen 3.0 */ typedef enum UiViewState { @@ -46,8 +51,8 @@ typedef enum UiViewState } ui_view_state; /** - * @brief Possible values for view orientation mode. - * @since_tizen 3.0 + * @brief Possible values for view orientation mode. + * @since_tizen 3.0 */ typedef enum UiViewOrientationMode { @@ -56,4 +61,9 @@ typedef enum UiViewOrientationMode UI_VIEW_ORIENTATION_MODE_LANDSCAPE /**< Landscape state */ } ui_view_orientation_mode; +/** + * @} + */ + + #endif /* _UI_IFACE_TYPES_H_ */ -- 2.7.4