Required Header

#include <efl_util.h>

Overview

The EFL UTIL API provides functions to get the level of given notification windows and to change the notification window levels with the given values.

The notification window level is used in ordering the notification windows. The notification window which is set to EFL_UTIL_NOTIFICATION_LEVEL_2 will be placed above the window which is set to EFL_UTIL_NOTIFICATION_LEVEL_1. If there are notification windows that have the same levels, the latest created notification window is placed on top of the other window.

Functions
int	efl_util_set_notification_window_level (Evas_Object *window, efl_util_notification_level_e level)
	Sets the priority level for the specified notification window, asynchronously.
int	efl_util_get_notification_window_level (Evas_Object window, efl_util_notification_level_e level)
	Gets the priority level for the specified notification window, asynchronously.
int	efl_util_set_notification_window_level_error_cb (Evas_Object window, efl_util_notification_window_level_error_cb callback, void user_data)
	Registers a callback function to be invoked when an error which set the notification level occurs.
int	efl_util_unset_notification_window_level_error_cb (Evas_Object *window)
	Unregisters the callback function.
Typedefs
typedef void(*	efl_util_notification_window_level_error_cb )(Evas_Object window, int error_code, void user_data)
	Called when an error occurs for setting notification window level.

Typedef Documentation

typedef void(* efl_util_notification_window_level_error_cb)(Evas_Object *window, int error_code, void *user_data)

Called when an error occurs for setting notification window level.

Since :: 2.3.1

Parameters:

[in]	window	The EFL window
[in]	error_code	The error code (EFL_UTIL_ERROR_PERMISSION_DENIED)
[in]	user_data	The user data passed from the callback registration function

See also:: efl_util_set_notification_window_level_error_cb(); efl_util_unset_notification_window_level_error_cb()

Enumeration Type Documentation

enum efl_util_error_e

Enumeration for EFL UTIL ERROR.

Since :: 2.3.1

Enumerator:

EFL_UTIL_ERROR_NONE	Successful
EFL_UTIL_ERROR_INVALID_PARAMETER	Invalid parameter
EFL_UTIL_ERROR_OUT_OF_MEMORY	Out of memory
EFL_UTIL_ERROR_PERMISSION_DENIED	Permisson denied
EFL_UTIL_ERROR_NOT_SUPPORTED_WINDOW_TYPE	Window type not supported

enum efl_util_notification_level_e

Enumeration of notification window's priority level.

Since :: 2.3.1

Enumerator:

EFL_UTIL_NOTIFICATION_LEVEL_1	Default notification level
EFL_UTIL_NOTIFICATION_LEVEL_2	Higher notification level than default
EFL_UTIL_NOTIFICATION_LEVEL_3	The highest notification level

Function Documentation

int efl_util_get_notification_window_level	(	Evas_Object *	window,
		efl_util_notification_level_e *	level
	)

Gets the priority level for the specified notification window, asynchronously.

Since :: 2.3.1

Remarks:: This API can be used for a notification type window only.

Parameters:

[in]	window	The EFL window
[out]	level	The notification window level

Returns:: 0 on success, otherwise a negative error value

Return values:

EFL_UTIL_ERROR_NONE	Successful
EFL_UTIL_ERROR_INVALID_PARAMETER	Invalid parameter
EFL_UTIL_ERROR_NOT_SUPPORTED_WINDOW_TYPE	Window type not supported

int efl_util_set_notification_window_level	(	Evas_Object *	window,
		efl_util_notification_level_e	level
	)

Sets the priority level for the specified notification window, asynchronously.

Since :: 2.3.1

Privilege Level:: public

Privilege:: http://tizen.org/privilege/window.priority.set

Remarks:: This API can be used for a notification type window only.

Parameters:

[in]	window	The EFL window
[in]	level	The notification window level

Returns:: 0 on success, otherwise a negative error value

Return values:

EFL_UTIL_ERROR_NONE	Successful
EFL_UTIL_ERROR_INVALID_PARAMETER	Invalid parameter
EFL_UTIL_ERROR_NOT_SUPPORTED_WINDOW_TYPE	Window type not supported

int efl_util_set_notification_window_level_error_cb	(	Evas_Object *	window,
		efl_util_notification_window_level_error_cb	callback,
		void *	user_data
	)

Registers a callback function to be invoked when an error which set the notification level occurs.

Since :: 2.3.1

Parameters:

[in]	window	The EFL window
[in]	callback	The callback function to register
[in]	user_data	The user data to be passed to the callback function

Returns:: 0 on success, otherwise a negative error value

Return values:

EFL_UTIL_ERROR_NONE	Successful
EFL_UTIL_ERROR_INVALID_PARAMETER	Invalid parameter
EFL_UTIL_ERROR_OUT_OF_MEMORY	Out of memory

Postcondition:: efl_util_notification_window_level_error_cb() will be invoked.

See also:: efl_util_unset_notification_window_level_error_cb(); efl_util_notification_window_level_error_cb()

int efl_util_unset_notification_window_level_error_cb ( Evas_Object * window )

Unregisters the callback function.

Since :: 2.3.1

Parameters:

[in] window The EFL window

Returns:: 0 on success, otherwise a negative error value

Return values:

EFL_UTIL_ERROR_NONE	Successful
EFL_UTIL_ERROR_INVALID_PARAMETER	Invalid parameter

See also:: efl_util_set_notification_window_level_error_cb()

Required Header

Overview

Functions

Typedefs

Typedef Documentation

Enumeration Type Documentation

Function Documentation