UI Application

---

This module provides functionalities about ui_application.

Functions
int	ui_application_init ()
	Initializes ui_application.
int	ui_application_run (int argc, char **argv, ui_application_event_s *events, int count, void *user_data)
	Runs ui_application. This triggers application main loop.
int	ui_application_term (void)
	Deinitializes ui_application.
Typedefs
typedef bool(*	ui_application_event_cb )(void *user_data, void *event_info)
	The ui_application event callback function signature.

---

Typedef Documentation

typedef bool(* ui_application_event_cb)(void *user_data, void *event_info)

The ui_application event callback function signature.

Since :

3.0

Parameters:

[in]	user_data	The user data to be passed to the given event_callback functions
[in]	event_info	Event Information data (It can casts to app_control_h in app_control())

Returns:

This is reserved

See also:

ui_application_event_type_e

ui_application_event_s

ui_application_run()

---

Enumeration Type Documentation

enum ui_application_event_type_e

Enumeration for ui_application event type.

Remarks:

PRE events are designed for overriding the default behavior of the events. Normally, ui_application triggers ui_viewmgr actions on those event time. To ignore them, you can use PRE event callbacks.

Since :

3.0

Enumerator:

UI_APPLICATION_EVENT_CREATE	App create
UI_APPLICATION_EVENT_TERMINATE	App terminate
UI_APPLICATION_EVENT_PAUSE	App pause
UI_APPLICATION_EVENT_RESUME	App resume
UI_APPLICATION_EVENT_CONTROL	App control
UI_APPLICATION_EVENT_CREATE_PRE	Prior to App create. ui_application initializes viewmgr on App create.
UI_APPLICATION_EVENT_TERMINATE_PRE	Prior to App terminate. ui_application releases viewmgr on App terminate.
UI_APPLICATION_EVENT_PAUSE_PRE	Prior to App pause. ui_application deactivates of viewmgr on App pause.
UI_APPLICATION_EVENT_RESUME_PRE	Prior to App resume. ui_application activates of viewmgr on App resume.
UI_APPLICATION_EVENT_CONTROL_PRE	Prior to App control. ui_application activates of viewmgr on App control.

---

Function Documentation

int ui_application_init

(

)

Initializes ui_application.

This function initializes ui_application and ui_viewmgr.

Since :

3.0

Remarks:

Before exit application, call ui_application_term().

Returns:

0 on success, otherwise a negative error value

Return values:

UI_VIEWMGR_ERROR_NONE	Successful
UI_VIEWMGR_ERROR_ALREADY_IN_PROGRESS	Initialization was already done
UI_VIEWMGR_ERROR_OUT_OF_MEMORY	Fails to allocate memory

See also:

ui_application_term()

ui_application_run()

int ui_application_run	(	int	argc,
		char **	argv,
		ui_application_event_s *	events,
		int	count,
		void *	user_data
	)

Runs ui_application. This triggers application main loop.

Remarks:

This wraps ui_app_main() function. You don't need to call it manually.

Since :

3.0

Parameters:

[in]	argc	The argument count
[in]	argv	The argument vector
[in]	events	Event callback list
[in]	count	Event callback count
[in]	user_data	User data for event callbacks

Returns:

0 on success, otherwise a negative error value

Return values:

UI_VIEWMGR_ERROR_NONE	Successful
UI_VIEWMGR_ERROR_INVALID_PARAMETER	Invalid parameters
UI_VIEWMGR_ERROR_ALREADY_IN_PROGRESS	The main loop already starts
UI_VIEWMGR_ERROR_NOT_PERMITTED	If Initialization was not performed yet

Precondition:

Call ui_application_init() before calling this function.

Warning:

Don't call ui_app_main() additionally.

See also:

ui_application_event_s

ui_app_main()

ui_application_init()

ui_application_term()

int ui_application_term

(

void

)

Deinitializes ui_application.

Remarks:

This wraps ui_app_exit() function. You don't need to call it manually.

Since :

3.0

Returns:

0 on success, otherwise a negative error value

Return values:

UI_VIEWMGR_ERROR_NONE

Successful

Precondition:

Call ui_application_init() before calling this function.

Warning:

Don't call ui_app_exit() additionally.

See also:

ui_application_init()

ui_application_run()