*/
/**
- * @brief The ui_application event callback function signature.
+ * @brief Called when the each application event occured.
* @since_tizen 3.0
*
* @param[in] user_data The user data to be passed to the given @a event_callback functions
* @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.
+ * @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.
+ * @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()
* @param[in] count The number of event count
* @param[in] user_data User data for event callbacks
*
- * @return @c 0 on success, otherwise a negative error value.
+ * @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.
+ * @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.
*
* @brief Deinitializes ui_application.
* @since_tizen 3.0
*
- * @return @c 0 on success, otherwise a negative error value.
+ * @return @c 0 on success, otherwise a negative error value
* @retval #TIZEN_ERROR_NONE Successful
*
* @pre Call ui_application_init() before calling this function.
* @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.
+ * @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.
+ * @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()
*
* @param[in] menu An ui_menu instance
*
- * @return @c 0 on success, otherwise a negative error value.
+ * @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.
+ * @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()
*/
*
* @param[in] menu An ui_menu instance
*
- * @return @c 0 on success, otherwise a negative error value.
+ * @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.
+ * @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()
*/
*
* @param[in] popup An ui_popup instance
*
- * @return @c 0 on success, otherwise a negative error value.
+ * @return @c 0 on success, otherwise a negative error value
* @retval #TIZEN_ERROR_NONE Successful
- * @retval #TIZEN_ERROR_INVALID_PARAMETER @a popup is invalid.
+ * @retval #TIZEN_ERROR_INVALID_PARAMETER @a popup is invalid
*
* @see ui_popup_create()
*/
* @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.
+ * @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.
+ * @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()
*
* @param[in] popup An ui_popup instance
*
- * @return @c 0 on success, otherwise a negative error value.
+ * @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.
+ * @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()
*
* @param[in] popup An ui_popup instance
*
- * @return @c 0 on success, otherwise a negative error value.
+ * @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.
+ * @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()
* @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.
+ * @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.
+ * @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()
*/
* @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.
+ * @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.
+ * @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()
*/
* @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.
+ * @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.
+ * @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()
*/
* @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.
+ * @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.
+ * @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()
* @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.
+ * @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.
+ * @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()
* @param[in] view An ui_standard_view instance
* @param[in] toolbar Toolbar object
*
- * @return @c 0 on success, otherwise a negative error value.
+ * @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.
+ * @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()
* @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.
+ * @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.
+ * @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);
*/
/**
- * @brief The ui_view event callback function signature.
+ * @brief Called when the each view event occured.
* @since_tizen 3.0
*
* @param[in] view An ui_view instance
*
* @param[in] name view name
*
- * @return The ui_view instance.
+ * @return The ui_view instance
*
* @see ui_view_destroy()
*/
* @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.
+ * @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_INVALID_PARAMETER if @a view is invalid
*
* @see ui_view_get_content()
* @see ui_view_unset_content()
* @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.
+ * @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_INVALID_PARAMETER if @a view is invalid
*
* @see ui_view_event_type_e
*/
* @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.
+ * @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.
+ * @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()
* @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.
+ * @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_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.
+ * @retval #TIZEN_ERROR_NOT_PERMITTED Current view manager system is not set up
*
* @see ui_view_get_available_rotations()
*/
*
* @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()
*/
*
* @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.
+ * @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_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()
*/
* @param[in] view An ui_view instance
* @param[in] style a transition style name
*
- * @return @c 0 on success, otherwise a negative error value.
+ * @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.
+ * @retval #TIZEN_ERROR_INVALID_PARAMETER @a view is invalid or @a style is not supported
*
* @see ui_view_get_transition_style()
*/
*
* @param[in] view An ui_view instance
*
- * @return @c 0 on success, otherwise a negative error value.
+ * @return @c 0 on success, otherwise a negative error value
* @retval #TIZEN_ERROR_NONE Successful
- * @retval #TIZEN_ERROR_INVALID_PARAMETER @a view is invalid.
+ * @retval #TIZEN_ERROR_INVALID_PARAMETER @a view is invalid
*
* @see ui_view_create()
* @see ui_standard_view_create()
*
* @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()
* @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.
+ * @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.
+ * @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()
*/
* @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.
+ * @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.
+ * @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()
*/
* @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.
+ * @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.
+ * @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()
* @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.
+ * @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.)
+ * @retval #TIZEN_ERROR_NOT_PERMITTED Can't be activated (ie, view manager has zero views.)
*
* @see ui_viewmgr_deactivate()
*/
* @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.
+ * @return @c 0 on success, otherwise a negative error value
* @retval #TIZEN_ERROR_NONE Successful
* @retval #TIZEN_ERROR_ALREADY_IN_PROGRESS Already deactivated
*
* @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
*/