* @warning Before exit application, call ui_application_term()
*
* @see ui_application_term()
+ *
+ * @since_tizen 3.0
*/
EAPI bool ui_application_init(const char *pkg, const char *locale_dir);
* @param user_data The user data to be passed to the gieven @p life_cycle_callback functions.
*
* @return @c true if it succeeds, @c false otherwise.
+ *
+ * @since_tizen 3.0
*/
EAPI bool ui_application_run(int argc, char **argv, ui_app_lifecycle_callback_s *lifecycle_callback, void *user_data);
* @return @c true if it succeeds, @c false otherwise.
*
* @see ui_application_init()
+ *
+ * @since_tizen 3.0
*/
EAPI bool ui_application_term(void);
* @return @c true if it succeeds, @c false otherwise.
*
* @see ui_menu_content_get()
+ *
+ * @since_tizen 3.0
*/
EAPI bool ui_menu_set_content(ui_menu *menu, Elm_Ctxpopup *ctxpopup);
* @return A content of ui_menu.
*
* @see ui_menu_content_set()
+ *
+ * @since_tizen 3.0
*/
EAPI Elm_Ctxpopup *ui_menu_get_content(ui_menu *menu);
* @return A previous content. If it wasn't, return @c NULL.
*
* @see ui_menu_content_set()
+ *
+ * @since_tizen 3.0
*/
EAPI Elm_Ctxpopup *ui_menu_unset_content(ui_menu *menu);
* @return @c true if it succeeds, @c false otherwise.
*
* @see ui_menu_deactivate()
+ *
+ * @since_tizen 3.0
*/
EAPI bool ui_menu_activate(ui_menu *menu);
* @return @c true if it succeeds, @c false otherwise.
*
* @see ui_menu_activate()
+ *
+ * @since_tizen 3.0
*/
EAPI bool ui_menu_deactivate(ui_menu *menu);
*
* @see ui_menu_activate()
* @see ui_menu_deactivate()
+ *
+ * @since_tizen 3.0
*/
EAPI bool ui_menu_get_activated(ui_menu *menu);
* @param menu An ui_menu instance.
*
* @return base object of ui_menu.
+ *
+ * @since_tizen 3.0
*/
EAPI Evas_Object *ui_menu_get_base(ui_menu *menu);
* @param menu An ui_menu instance.
*
* @return Current rotation degree, -1 if it fails to get degree information.
+ *
+ * @since_tizen 3.0
*/
EAPI int ui_menu_get_degree(ui_menu *menu);
* @param menu An ui_menu instance.
*
* @return The view which is matched with ui_menu
+ *
+ * @since_tizen 3.0
*/
EAPI ui_view *ui_menu_get_view(ui_menu *menu);
* @warning The instance of ui_popup will be destroyed automatically when the ui_view is destroyed.
*
* @see ui_popup_destroy()
+ *
+ * @since_tizen 3.0
*/
EAPI ui_popup *ui_popup_create(ui_view *view);
* @param popup An ui_popup instance.
*
* @see ui_popup_create()
+ *
+ * @since_tizen 3.0
*/
EAPI void ui_popup_destroy(ui_popup *popup);
* @return @c true if it succeeds, @c false otherwise.
*
* @see ui_popup_content_get()
+ *
+ * @since_tizen 3.0
*/
EAPI bool ui_popup_set_content(ui_popup *popup, Elm_Popup *content);
* @return A content of ui_popup.
*
* @see ui_popup_content_set()
+ *
+ * @since_tizen 3.0
*/
EAPI Elm_Popup *ui_popup_get_content(ui_popup *popup);
* @return A previous content. If it wasn't, return @c NULL.
*
* @see ui_popup_content_set()
+ *
+ * @since_tizen 3.0
*/
EAPI Elm_Popup *ui_popup_unset_content(ui_popup *popup);
* @return @c true if it succeeds, @c false otherwise.
*
* @see ui_popup_deactivate()
+ *
+ * @since_tizen 3.0
*/
EAPI bool ui_popup_activate(ui_popup *popup);
* @return @c true if it succeeds, @c false otherwise.
*
* @see ui_popup_activate()
+ *
+ * @since_tizen 3.0
*/
EAPI bool ui_popup_deactivate(ui_popup *popup);
*
* @see ui_popup_activate()
* @see ui_popup_deactivate()
+ *
+ * @since_tizen 3.0
*/
EAPI bool ui_popup_get_activated(ui_popup *popup);
* @param menu An ui_popup instance.
*
* @return base object of ui_popup.
+ *
+ * @since_tizen 3.0
*/
EAPI Evas_Object *ui_popup_get_base(ui_popup *popup);
* @param popup An ui_popup instance.
*
* @return Current rotation degree, -1 if it fails to get degree information.
+ *
+ * @since_tizen 3.0
*/
EAPI int ui_popup_get_degree(ui_popup *popup);
* @param popup An ui_popup instance.
*
* @return The view which is matched with ui_popup.
+ *
+ * @since_tizen 3.0
*/
EAPI ui_view *ui_popup_get_view(ui_popup *popup);
* @warning if you don't set a view name, you could not look up the view with its name. @see ui_viewmgr_view_get_by_name().
*
* @see ui_view_destroy()
+ *
+ * @since_tizen 3.0
*/
EAPI ui_standard_view *ui_standard_view_create(const char *name);
*
* @return @c true if it succeeds, @c false otherwise.
*
- * @ui_standard_view_title_get()
+ * @see ui_standard_view_title_get()
+ *
+ * @since_tizen 3.0
*/
EAPI bool ui_standard_view_set_title(ui_standard_view *view, const char *text);
* @return @c true if it succeeds, @c false otherwise.
*
* @see ui_standard_view_sub_title_get()
+ *
+ * @since_tizen 3.0
*/
EAPI bool ui_standard_view_set_sub_title(ui_standard_view *view, const char *text);
* @return @c true if it succeeds, @c false otherwise.
*
* @see ui_standard_view_title_badge_get()
+ *
+ * @since_tizen 3.0
*/
EAPI bool ui_standard_view_set_title_badge(ui_standard_view *view, const char *badge_text);
* @return @c true if it succeeds, @c false otherwise.
*
* @see ui_standard_view_title_right_btn_get()
+ *
+ * @since_tizen 3.0
*/
EAPI bool ui_standard_view_set_title_right_btn(ui_standard_view *view, Evas_Object *title_right_btn);
* @return title right button of the view.
*
* @see ui_standard_view_title_right_btn_set()
+ *
+ * @since_tizen 3.0
*/
EAPI Elm_Button *ui_standard_view_get_title_right_btn(ui_standard_view *view);
*
* @param view An ui_standard_view instance.
* @return A previous content. If it wasn't, return @c NULL
+ *
+ * @since_tizen 3.0
*/
EAPI Elm_Button *ui_standard_view_unset_title_right_btn(ui_standard_view *view);
* @return @c true if it succeeds, @c false otherwise.
*
* @see ui_standard_view_title_left_btn_get()
+ *
+ * @since_tizen 3.0
*/
EAPI bool ui_standard_view_set_title_left_btn(ui_standard_view *view, Evas_Object *title_left_btn);
* @return title left button of the view
*
* @see ui_standard_view_title_left_btn_set()
+ *
+ * @since_tizen 3.0
*/
EAPI Elm_Button *ui_standard_view_get_title_left_btn(ui_standard_view *view);
* @param view An ui_standard_view instance.
*
* @return A previous content. If it wasn't, return @c NULL.
+ *
+ * @since_tizen 3.0
*/
EAPI Elm_Button *ui_standard_view_unset_title_left_btn(ui_standard_view *view);
* @return @c true if it succeeds, @c false otherwise.
*
* @see ui_standard_view_toolbar_get()
+ *
+ * @since_tizen 3.0
*/
EAPI bool ui_standard_view_set_toolbar(ui_standard_view *view, Elm_Toolbar *toolbar);
* @return The toolbar of the given @p view.
*
* @see ui_standard_view_toolbar_set()
+ *
+ * @since_tizen 3.0
*/
EAPI Elm_Toolbar *ui_standard_view_get_toolbar(ui_standard_view *view);
* @param view An ui_standard_view instance.
*
* @return A previous content. If it wasn't, return @c NULL.
+ *
+ * @since_tizen 3.0
*/
EAPI Elm_Toolbar *ui_standard_view_unset_toolbar(ui_standard_view *view);
* @param anim title area will be shown with animation if the given param is @c true, otherwise title area will be shown without animation
*
* @return @c true if it succeeds, @c false otherwise.
+ *
+ * @since_tizen 3.0
*/
EAPI bool ui_standard_view_set_title_visible(ui_standard_view *view, bool visible, bool anim);
/**
* @brief ui_view's lifecycle callback function signature.
+ *
+ * @since_tizen 3.0
*/
typedef bool (*ui_view_lifecycle_cb)(ui_view *view, void *data);
/**
* @brief ui_view's rotate event callback function signature.
+ *
+ * @since_tizen 3.0
*/
typedef bool (*ui_view_event_rotate_cb)(ui_view *view, int degree, void *data);
+
/**
* @brief ui_view's portrait event callback function signature.
+ *
+ * @since_tizen 3.0
*/
typedef bool (*ui_view_event_portrait_cb)(ui_view *view, void *data);
+
/**
* @brief ui_view's landscape event callback function signature.
+ *
+ * @since_tizen 3.0
*/
typedef bool (*ui_view_event_landscape_cb)(ui_view *view, void *data);
+
/**
* @brief ui_view's back event callback function signature.
+ *
+ * @since_tizen 3.0
*/
typedef bool (*ui_view_event_back_cb)(ui_view *view, void *data);
+
/**
* @brief ui_view's menu event callback function signature.
+ *
+ * @since_tizen 3.0
*/
typedef bool (*ui_view_event_menu_cb)(ui_menu *menu, void *data);
/**
* @brief The structure type containing the set of callback functions for handling view's lifecycle events.
+ *
+ * @since_tizen 3.0
*/
typedef struct
{
/**
* @brief The structure type containing the set of callback functions for handling view's events.
+ *
+ * @since_tizen 3.0
*/
typedef struct
{
* @warning if you don't set a view name, you could not look up the view with its name. @see ui_viewmgr_view_get_by_name().
*
* @see ui_view_destroy()
+ *
+ * @since_tizen 3.0
*/
EAPI ui_view *ui_view_create(const char *name);
* @return @c true if it succeeds, @c false otherwise.
*
* @see ui_view_content_get()
+ *
+ * @since_tizen 3.0
*/
EAPI bool ui_view_set_content(ui_view *view, Evas_Object *content);
* @param data The user data to be passed to the given @p lifecycle_callback functions.
*
* @return @c true if it succeeds, @c false otherwise.
+ *
+ * @since_tizen 3.0
*/
EAPI bool ui_view_set_lifecycle_callbacks(ui_view *view, ui_view_lifecycle_callback_s *lifecycle_callback, void *data);
* @param data The user data to be passed to the given @p event_callback functions.
*
* @return @c true if it succeeds, @c false otherwise.
+ *
+ * @since_tizen 3.0
*/
EAPI bool ui_view_set_event_callbacks(ui_view *view, ui_view_event_callback_s *event_callback, void *data);
* @note Normally, this base object can be used for a parent of a view content.
*
* @return The base object of ui_view.
+ *
+ * @since_tizen 3.0
*/
EAPI Evas_Object* ui_view_get_base(ui_view *view);
* @return A previous content. If it wasn't, return @c NULL.
*
* @see ui_view_content_set()
+ *
+ * @since_tizen 3.0
*/
EAPI Evas_Object *ui_view_unset_content(ui_view *view);
* @param indicator The mode to set, one of #ui_view_indicator
*
* @see ui_view_indicator_get()
+ *
+ * @since_tizen 3.0
*/
EAPI void ui_view_set_indicator(ui_view *view, ui_view_indicator indicator);
* @return indicator state of the given @p view.
*
* @see ui_view_indicator_set()
+ *
+ * @since_tizen 3.0
*/
EAPI ui_view_indicator ui_view_get_indicator(ui_view *view);
* @param count The number of arrays of rotatons.
*
* @see ui_view_get_available_rotations
+ *
+ * @since_tizen 3.0
*/
EAPI bool ui_view_set_available_rotations(ui_view *view, const int *rotations, unsigned int count);
* @return The array of rotation values.
*
* @see ui_view_set_available_rotations
+ *
+ * @since_tizen 3.0
*/
EAPI const int *ui_view_get_available_rotations(ui_view *view, unsigned int *count);
* @warning You should not remove a view content manually on unload status if removable content is set.
*
* @see ui_view_removable_content_get()
+ *
+ * @since_tizen 3.0
*/
EAPI void ui_view_set_removable_content(ui_view *view, bool remove);
* @return @c true if the view's content is removable, otherwise @c false.
*
* @see ui_view_removable_content_get()
+ *
+ * @since_tizen 3.0
*/
EAPI bool ui_view_get_removable_content(ui_view *view);
* @param view An ui_view instance.
*
* @return Current rotation degree, -1 if it fails to get degree information.
+ *
+ * @since_tizen 3.0
*/
EAPI int ui_view_get_degree(ui_view *view);
* @param view An ui_view instance
*
* @return Current orientation mode, one of #ui_view_orientation_mode.
+ *
+ * @since_tizen 3.0
*/
EAPI ui_view_orientation_mode ui_view_get_orientation_mode(ui_view *view);
* @return @c true if the given @c style is available, otherwise @c false.
*
* @see ui_view_transition_style_get()
+ *
+ * @since_tizen 3.0
*/
EAPI bool ui_view_set_transition_style(ui_view *view, const char *style);
* @return style name of view.
*
* @see ui_view_transition_style_set()
+ *
+ * @since_tizen 3.0
*/
EAPI const char *ui_view_get_transition_style(ui_view *view);
* @param view An ui_view instance.
*
* @return The ui_memnu that connected with given @p view.
+ *
+ * @since_tizen 3.0
*/
EAPI const ui_menu *ui_view_get_menu(ui_view *view);
* @return name of @p view.
*
* @see ui_view_name_set()
+ *
+ * @since_tizen 3.0
*/
EAPI const char *ui_view_get_name(ui_view *view);
* @param view An ui_view instance.
*
* @return current state of @p view.
+ *
+ * @since_tizen 3.0
*/
EAPI ui_view_state ui_view_get_state(ui_view *view);
* @return content of @p view. If no contents set yet, @c NULL.
*
* @see ui_view_content_set()
+ *
+ * @since_tizen 3.0
*/
EAPI Evas_Object *ui_view_get_content(ui_view *view);
*
* @see ui_view_create()
* @see ui_standard_view_create()
+ *
+ * @since_tizen 3.0
*/
EAPI bool ui_view_destroy(ui_view *view);
* @see ui_viewmgr_view_push_insert_before()
* @see ui_viewmgr_view_push_insert_after()
* @see ui_viewmgr_view_pop()
+ *
+ * @since_tizen 3.0
*/
EAPI ui_view *ui_viewmgr_push_view(ui_viewmgr *viewmgr, ui_view *view);
* @return @c true on success or @c false otherwise
*
* @see ui_viewmgr_view_push_insert_after()
+ *
+ * @since_tizen 3.0
*/
EAPI bool ui_viewmgr_push_view_insert_before(ui_viewmgr *viewmgr, ui_view *view, ui_view *before);
* @return @c true on success or @c false otherwise
*
* @see ui_viewmgr_view_push_insert_before()
+ *
+ * @since_tizen 3.0
*/
EAPI bool ui_viewmgr_push_view_insert_after(ui_viewmgr *viewmgr, ui_view *view, ui_view *after);
*
* @see ui_viewmgr_deactivate()
* @see ui_viewmgr_view_push()
+ *
+ * @since_tizen 3.0
*/
EAPI bool ui_viewmgr_pop_view(ui_viewmgr *viewmgr);
* @return @c true on success or @c false otherwise
*
* @see ui_viewmgr_deactivate()
+ *
+ * @since_tizen 3.0
*/
EAPI bool ui_viewmgr_activate(ui_viewmgr *viewmgr);
* @return @c true success or @c false not
*
* @see ui_viewmgr_activate()
+ *
+ * @since_tizen 3.0
*/
EAPI bool ui_viewmgr_deactivate(ui_viewmgr *viewmgr);
* @param viewmgr The ui_viewmgr instance.
*
* @return The window object of viewmgr
+ *
+ * @since_tizen 3.0
*/
EAPI Elm_Win *ui_viewmgr_get_window(ui_viewmgr *viewmgr);
* @param viewmgr The ui_viewmgr instance.
*
* @return The view which is last view of the given @p viewmgr view list
+ *
+ * @since_tizen 3.0
*/
EAPI ui_view *ui_viewmgr_get_last_view(ui_viewmgr *viewmgr);
*
* @see ui_viewmgr_view_index_get()
* @see ui_viewmgr_view_count_get()
+ *
+ * @since_tizen 3.0
*/
EAPI ui_view *ui_viewmgr_get_view_by_idx(ui_viewmgr *viewmgr, int idx);
* If there were no views name matched, @c NULL will be returned.
*
* @see UiIfaceView::set_name()
+ *
+ * @since_tizen 3.0
*/
EAPI ui_view *ui_viewmgr_get_view_by_name(ui_viewmgr *viewmgr, const char *name);
* @param viewmgr The ui_viewmgr instance.
*
* @return The base object of ui_viewmgr.
+ *
+ * @since_tizen 3.0
*/
EAPI Evas_Object *ui_viewmgr_get_base(ui_viewmgr *viewmgr);
* @return An index of the given @p view on success, otherwise, -1
*
* @warning The index number of views are variable since the view list is variable
+ *
+ * @since_tizen 3.0
*/
EAPI int ui_viewmgr_get_view_index(ui_viewmgr *viewmgr, const ui_view *view);
* @param viewmgr The ui_viewmgr instance.
*
* @return the count of views
+ *
+ * @since_tizen 3.0
*/
EAPI int ui_viewmgr_get_view_count(ui_viewmgr *viewmgr);
* @param viewmgr The ui_viewmgr instance.
*
* @return @c true if soft key is required, @c false otherwise
+ *
+ * @since_tizen 3.0
*/
EAPI bool ui_viewmgr_get_soft_key_need(ui_viewmgr *viewmgr);
* @note ui_viewmgr has a singleton instance.
*
* @return The ui_viewmgr instance.
+ *
+ * @since_tizen 3.0
*/
EAPI ui_viewmgr *ui_viewmgr_get_viewmgr();
/**
* @brief A Convenient Macro to activate the ui_viewmgr.
+ *
+ * @since_tizen 3.0
*/
#define UI_VIEWMGR_ACTIVATE() (ui_viewmgr_activate(ui_viewmgr_get_viewmgr()))
/**
* @brief A Convenient Macro function to deactivate the ui_viewmgr.
+ *
+ * @since_tizen 3.0
*/
#define UI_VIEWMGR_DEACTIVATE() (ui_viewmgr_deactivate(ui_viewmgr_get_viewmgr()))
/**
* @brief A Convenient Macro function to push a view.
+ *
+ * @since_tizen 3.0
*/
#define UI_VIEWMGR_PUSH_VIEW(X) (ui_viewmgr_push_view(ui_viewmgr_get_viewmgr(), (X)))
/**
* @brief A Convenient Macro function to pop a view.
+ *
+ * @since_tizen 3.0
*/
#define UI_VIEWMGR_POP_VIEW() (ui_viewmgr_pop_view(ui_viewmgr_get_viewmgr()))
/**
* Possible values for indicator state.
+ *
+ * @since_tizen 3.0
*/
enum UiViewIndicator
{
/**
* Possible values for view state.
+ *
+ * @since_tizen 3.0
*/
enum UiViewState
{
/**
* Possible values for view orientation mode.
+ *
+ * @since_tizen 3.0
*/
enum UiViewOrientationMode
{