/**
* @brief Push a new view into this viewmgr. This function is used for when application switches a current view to a new one.
*
- * @note Normally, the current view will be hidden by a new view. In default, when user calls this API, view will be switched to @p view instantly,
- * only when viewmgr state is activated. Otherwise, the @p view will be shown later when viewmgr is activated. push_view() is designed for providing
+ * @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 viewmgr state is activated. Otherwise, the @a view will be shown later when viewmgr is activated. push_view() is designed for providing
* view transition effect. If you want push view instantly without any transition, you could use insert_view_before() or insert_view_after().
* If you want to pop the current view, the please use pop_view().
*
* @param view A view to insert in the viewmgr view list.
*
- * @return @p view, @c nullptr when it fails to push a @p view.
+ * @return @a view, @c nullptr when it fails to push a @a view.
*
* @see activated()
* @see insertViewBefore()
virtual bool popView() override;
/**
- * @brief Insert a view in this viewmgr view list. Specifically, insert a given @p view right before of the given view, @before.
+ * @brief Insert a view in this viewmgr view list. Specifically, insert a given @a view right before of the given view, @before.
*
* @param view A view to insert in the viewmgr view list.
- * @param before A view that will be just inserted after @p view. If you pass @c nullptr, @p view will be inserted at the front of the view list.
+ * @param before A view that will be just inserted after @a view. If you pass @c nullptr, @a view will be inserted at the front of the view list.
*
* @return @c true on success or @c false otherwise.
*/
virtual bool insertViewBefore(UiBaseView *view, UiBaseView *before);
/**
- * @brief Insert a view in this viewmgr view list. Specifically, insert a given @p view right after of the given view, @after.
+ * @brief Insert a view in this viewmgr view list. Specifically, insert a given @a view right after of the given view, @after.
*
* @param view A view to insert in the viewmgr view list.
- * @param after A view that will be just inserted before the @p view. If you pass @c nullptr, @p view will be inserted at the end of the view list.
+ * @param after A view that will be just inserted before the @a view. If you pass @c nullptr, @a view will be inserted at the end of the view list.
*
* @return @c true on success or @c false otherwise.
*/
UiBaseView *getLastView();
/**
- * @brief Return a view which is matched with the index @p idx.
+ * @brief Return a view which is matched with the index @a idx.
*
* @param idx A index of the view which you are looking for.
*
- * @return The view which index is matched with @p idx.
- * If there were no views with index @p idx, @c nullptr will be returned.
+ * @return The view which index is matched with @a idx.
+ * If there were no views with index @a idx, @c nullptr will be returned.
*
* @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.
UiBaseView *getView(unsigned int idx);
/**
- * @brief Return a view which is matched with the @p name.
+ * @brief Return a view which is matched with the @a name.
*
* @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 @p name.
+ * @return The view which name is matched with @a name.
* If there were no views name matched, @c nullptr will be returned.
*
* @see UiIfaceView::setName()
* @param argc The argument count.
* @param argv The argument vector.
* @param lifecycle_callback The set of callback functions to handle application lifecycle events.
- * @param user_data The user data to be passed to the gieven @p life_cycle_callback functions.
+ * @param user_data The user data to be passed to the gieven @a life_cycle_callback functions.
*
* @return @c true if it succeeds, @c false otherwise.
*
*
* @param view An instance of ui_view.
*
- * @note The instance of ui_popup is subordinated to the given @p ui_view. If the given @p ui_view is hidden or deactivated, this ui_popup will be also do
+ * @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.
/**
* @brief A destructor for an ui_popup.
*
- * @note destroy an @p given ui_popup instance.
+ * @note destroy an @a given ui_popup instance.
*
* @param popup An ui_popup instance.
*
* @brief Return a toolbar of the view.
*
* @param view An ui_standard_view instance.
- * @return The toolbar of the given @p view.
+ * @return The toolbar of the given @a view.
*
* @see ui_standard_view_toolbar_set()
*
*
* @param view An ui_view instance.
* @param lifecycle_callback The set of callback functions to handle application lifecycle events.
- * @param data The user data to be passed to the given @p lifecycle_callback functions.
+ * @param data The user data to be passed to the given @a lifecycle_callback functions.
*
* @return @c true if it succeeds, @c false otherwise.
*
*
* @param view An ui_view instance.
* @param event_callback The set of callback functions to handle view events.
- * @param data The user data to be passed to the given @p event_callback functions.
+ * @param data The user data to be passed to the given @a event_callback functions.
*
* @return @c true if it succeeds, @c false otherwise.
*
*
* @param view An ui_view instance.
*
- * @return indicator state of the given @p view.
+ * @return indicator state of the given @a view.
*
* @see ui_view_indicator_set()
*
* @brief Set content removable.
*
* @param view An ui_view instance.
- * @param removable if @p removable is @c true, content of this view will be removed on unload state. @c false otherwise
+ * @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.
*
/**
* @brief Set transition style of a view.
*
- * @note @p style is reserved for supporting various kinds of view transition effects.
+ * @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 @p style.
+ * 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
*
* @param view An ui_view instance.
*
- * @return The ui_memnu that connected with given @p view.
+ * @return The ui_memnu that connected with given @a view.
*
* @since_tizen 3.0
*/
*
* @param view An ui_view instance.
*
- * @return name of @p view.
+ * @return name of @a view.
*
* @see ui_view_name_set()
*
*
* @param view An ui_view instance.
*
- * @return current state of @p view.
+ * @return current state of @a view.
*
* @since_tizen 3.0
*/
*
* @param view An ui_view instance.
*
- * @return content of @p view. If no contents set yet, @c NULL.
+ * @return content of @a view. If no contents set yet, @c NULL.
*
* @see ui_view_content_set()
*
*/
/**
- * @brief Push a new view into given @p viewmgr. This function is used for when application switches a current view to a new one.
+ * @brief Push a new view into given @a viewmgr. This function is used for when application switches a current view to a new one.
*
- * @note Normally, the current view will be hidden by a new view. In default, when user calls this API, view will be switched to @p view instantly,
- * only when ui_viewmgr state is activated. Otherwise, the @p view will be shown later when ui_viewmgr is activated. ui_viewmgr_view_push() is designed
+ * @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 viewmgr The ui_viewmgr instance.
- * @param view An ui_view to insert in the given @p viewmgr view list
+ * @param view An ui_view to insert in the given @a viewmgr view list
*
- * @return @p view, @c NULL when it fails to push a @p view
+ * @return @a view, @c NULL when it fails to push a @a view
*
* @see ui_viewmgr_activate()
* @see ui_viewmgr_view_push_insert_before()
EAPI ui_view *ui_viewmgr_push_view(ui_viewmgr *viewmgr, ui_view *view);
/**
- * @brief Insert a view in this given @p viewmgr view list. Specifically, insert a given @p view right before of the given view, @before.
+ * @brief Insert a view in this given @a viewmgr view list. Specifically, insert a given @a view right before of the given view, @before.
*
* @param viewmgr The ui_viewmgr instance.
- * @param view An ui_view to insert in the @p viewmgr view list
- * @param before An ui_view that will be just inserted after @p view. If you pass @c NULL, @p view will be inserted at the front of the view list
+ * @param view An ui_view to insert in the @a 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
*
* @return @c true on success or @c false otherwise
*
EAPI bool ui_viewmgr_push_view_insert_before(ui_viewmgr *viewmgr, ui_view *view, ui_view *before);
/**
- * @brief Insert a view in this given @p viewmgr view list. Specifically, insert a given @p view right after of the given view, @after.
+ * @brief Insert a view in this given @a viewmgr view list. Specifically, insert a given @a view right after of the given view, @after.
*
* @param viewmgr The ui_viewmgr instance.
- * @param view An ui_view to insert in the @p viewmgr view list
- * @param after An ui_view that will be just inserted before the @p view. If you pass @c NULL, @p view will be inserted at the end of the view list
+ * @param view An ui_view to insert in the @a 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
*
* @return @c true on success or @c false otherwise
*
EAPI bool ui_viewmgr_push_view_insert_after(ui_viewmgr *viewmgr, ui_view *view, ui_view *after);
/**
- * @brief Pop the top(last) view from this given @p viewmgr view list.
+ * @brief Pop the top(last) view from this given @a 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 @p viewmgr.
+ * The top view will be removed from the view stack and then it will be deleted by the given @a 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.
*
* @param viewmgr The ui_viewmgr instance.
*
- * @return The view which is last view of the given @p viewmgr view list
+ * @return The view which is last view of the given @a viewmgr view list
*
* @since_tizen 3.0
*/
EAPI ui_view *ui_viewmgr_get_last_view(ui_viewmgr *viewmgr);
/**
- * @brief Return a view which is matched with the index @p idx.
+ * @brief Return a view which is matched with the index @a idx.
*
* @param viewmgr The ui_viewmgr instance.
* @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.
*
- * @return The view which index is matched with @p idx
- * If there were no views with index @p 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_view_index_get()
* @see ui_viewmgr_view_count_get()
EAPI ui_view *ui_viewmgr_get_view_by_idx(ui_viewmgr *viewmgr, int idx);
/**
- * @brief Return a view which is matched with the @p name.
+ * @brief Return a view which is matched with the @a name.
*
* @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 @p name.
+ * @return The view which name is matched with @a name.
* If there were no views name matched, @c NULL will be returned.
*
* @see UiIfaceView::set_name()
/**
* @brief Return a view index(page) number of the given view.
- * You could use this function to query the given @p view list order.
+ * You could use this function to query the given @a view list order.
*
* @param viewmgr The ui_viewmgr instance.
* @param view An ui_view to query the index
*
- * @return An index of the given @p view on success, otherwise, -1
+ * @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
*
EAPI int ui_viewmgr_get_view_index(ui_viewmgr *viewmgr, const ui_view *view);
/**
- * @brief Return the number of views which this @p given viewmgr has.
+ * @brief Return the number of views which this @a given viewmgr has.
*
* @param viewmgr The ui_viewmgr instance.
*
/**
* @brief This is for replacing or setting a content of the view.
*
- * @note @p content is a logical object that represents a view in your framework. The actual type of the content could be translated to any certain types.
+ * @note @a content is a logical object that represents a view in your framework. The actual type of the content could be translated to any certain types.
* For instance, the type could be Eo * in EFL and Layer * in Dali.
*
* @param content a new content. It allows @c nullptr for canceling the previous content.
/**
* @brief Set transition style of a view.
*
- * @note @p style is reserved for supporting various kinds of view transition effects.
+ * @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 nullptr.
- * and "none" represents none transition. If you don't like give any transition effects to this view, you can pass "none" as @p style.
+ * 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 style a transition style name.
*
/**
* @brief Set content removable.
*
- * @param removable if @p removable is @c true, content of this view will be removed on unload state. @c false otherwise.
+ * @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.
*/
/**
* @brief Replace or set a content of the view.
*
- * @note @p content is a logical object that represents a view in your framework. The actual type of the content could be translated to any certain types.
+ * @note @a content is a logical object that represents a view in your framework. The actual type of the content could be translated to any certain types.
* For instance, the type could be Eo * in EFL and Layer * in Dali.
*
* @param content a new content. It allows @c nullptr for canceling the previous content.
#if UI_EFL
#include <Elementary.h>
using T = Eo*;
-#elif UI_DALI
#endif
#ifdef LOG_TAG
/**
* @brief Return a view index(page) number of the given view.
- * You could use this function to query the given @p view list order.
+ * You could use this function to query the given @a view list order.
*
* @param view A view to query the index.
*
- * @return An index of the given @p view on success, otherwise, -1.
+ * @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.
*/
/**
* @brief Push a new view into this viewmgr. This function is used for when application switches a current view to a new one.
*
- * @note Normally, the current view will be hidden by a new view. In default, when user calls this API, view will be switched to @p view instantly,
- * only when viewmgr state is activated. Otherwise, the @p view will be shown later when viewmgr is activated. push_view() is designed for providing
+ * @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 viewmgr state is activated. Otherwise, the @a view will be shown later when viewmgr is activated. push_view() is designed for providing
* view transition effect. If you want push view instantly without any transition, you could use insert_view_before() or insert_view_after().
* or use the view transition style function.
* If you want to pop the current view, the please use pop_view().
*
* @param view A view to insert at the end of viewmgr view list.
*
- * @return @p view, @c nullptr when it fails to push a @p view.
+ * @return @a view, @c nullptr when it fails to push a @a view.
*
* @see activated()
* @see insertViewBefore()
virtual bool popView();
/**
- * @brief Insert a view in this viewmgr view list. Specifically, insert a given @p view right before of the given view, @before.
+ * @brief Insert a view in this viewmgr view list. Specifically, insert a given @a view right before of the given view, @before.
*
* @param view A view to insert in the viewmgr view list.
- * @param before A view that will be just inserted after @p view. If you pass @c nullptr, @p view will be inserted at the front of the view list.
+ * @param before A view that will be just inserted after @a view. If you pass @c nullptr, @a view will be inserted at the front of the view list.
*
* @return @c true on success or @c false otherwise.
*/
bool insertViewBefore(UiIfaceView *view, UiIfaceView *before);
/**
- * @brief Insert a view in this viewmgr view list. Specifically, insert a given @p view right after of the given view, @after.
+ * @brief Insert a view in this viewmgr view list. Specifically, insert a given @a view right after of the given view, @after.
*
* @param view A view to insert in the viewmgr view list.
- * @param after A view that will be just inserted before the @p view. If you pass @c nullptr, @p view will be inserted at the end of the view list.
+ * @param after A view that will be just inserted before the @a view. If you pass @c nullptr, @a view will be inserted at the end of the view list.
*
* @return @c true on success or @c false otherwise.
*/
bool removeView(UiIfaceView *view);
/**
- * @brief Return a view which is matched with the index @p idx.
+ * @brief Return a view which is matched with the index @a idx.
*
* @param idx A index of the view which you are looking for.
*
- * @return The view which index is matched with @p idx.
- * If there were no views with index @p idx, @c nullptr will be returned.
+ * @return The view which index is matched with @a idx.
+ * If there were no views with index @a idx, @c nullptr will be returned.
*
* @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.
UiIfaceView* getView(unsigned int idx);
/**
- * @brief Return a view which is matched with the @p name.
+ * @brief Return a view which is matched with the @a name.
*
* @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 @p name.
+ * @return The view which name is matched with @a name.
* If there were no views name matched, @c nullptr will be returned.
*
* @see UiIfaceView::getName().
projects / platform / core / uifw / ui-viewmgr.git / commitdiff