Display a container in a particular region of the parent(top, bottom, etc).

A timeout can be set to automatically hide the notify widget. This is so that, after an evas_object_show() on a notify object, if a timeout is set on it, it automatically gets hidden after that time.

Signals that you can add callbacks for are:

"timeout" - When timeout happens on a notification and it's hidden.
"block,clicked" - When a click outside of the notification happens.

The functions meant to act on it work for mapbuf objects:

The default content parts of the notify widget that you can use are:

"default" - The main content of the notify widget.

Functions
Evas_Object *	elm_notify_add (Evas_Object *parent)
	Adds a new notify widget to the parent.
void	elm_notify_parent_set (Evas_Object obj, Evas_Object parent)
	Sets the notify parent.
Evas_Object *	elm_notify_parent_get (const Evas_Object *obj)
	Gets the notify parent.
void	elm_notify_timeout_set (Evas_Object *obj, double timeout)
	Sets the time interval after which the notify window is going to be hidden.
double	elm_notify_timeout_get (const Evas_Object *obj)
	Gets the timeout value (in seconds).
void	elm_notify_allow_events_set (Evas_Object *obj, Eina_Bool allow)
	Sets whether events should be passed by a click outside its area.
Eina_Bool	elm_notify_allow_events_get (const Evas_Object *obj)
	Gets true if events are allowed below the notify object.
void	elm_notify_align_set (Evas_Object *obj, double horizontal, double vertical)
	Sets the alignment of the notify object.
void	elm_notify_align_get (const Evas_Object obj, double horizontal, double *vertical)
	Gets the alignment of the notify object.
void	elm_notify_dismiss (Evas_Object *obj)
	Dismiss a notify object.
Defines
#define	ELM_NOTIFY_ALIGN_FILL -1.0

Define Documentation

#define ELM_NOTIFY_ALIGN_FILL -1.0

Use with elm_notify_align_set()

Since (EFL) :: 1.8

Function Documentation

Evas_Object* elm_notify_add ( Evas_Object * parent )

Adds a new notify widget to the parent.

Since :: 2.3.1

Parameters:

[in] parent The parent object

Returns:: The new object, otherwise NULL if it cannot be created

void elm_notify_align_get	(	const Evas_Object *	obj,
		double *	horizontal,
		double *	vertical
	)

Gets the alignment of the notify object.

Since (EFL) :: 1.8

Since :: 2.3.1

Parameters:

[in]	obj	The notify object
[out]	horizontal	The horizontal alignment of the notification
[out]	vertical	The vertical alignment of the notification

See also:: elm_notify_align_set()

void elm_notify_align_set	(	Evas_Object *	obj,
		double	horizontal,
		double	vertical
	)

Sets the alignment of the notify object.

This sets the alignment in which the notify appears in its parent.

Since (EFL) :: 1.8

Since :: 2.3.1

Remarks:: To fill the notify box in the parent area, pass the ELM_NOTIFY_ALIGN_FILL to horizontal, vertical.

Parameters:

[in]	obj	The notify object
[in]	horizontal	The horizontal alignment of the notification
[in]	vertical	The vertical alignment of the notification

Eina_Bool elm_notify_allow_events_get ( const Evas_Object * obj )

Gets true if events are allowed below the notify object.

Since :: 2.3.1

Parameters:

[in] obj The notify object

Returns:: EINA_TRUE if events are allowed, otherwise EINA_FALSE.

See also:: elm_notify_allow_events_set()

void elm_notify_allow_events_set	(	Evas_Object *	obj,
		Eina_Bool	allow
	)

Sets whether events should be passed by a click outside its area.

Since :: 2.3.1

Remarks:: When true if the user clicks outside the window the events are caught by the other widgets, else the events are blocked.; The default value is EINA_TRUE.

Parameters:

[in]	obj	The notify object
[in]	allow	If `EINA_TRUE` events are allowed, otherwise `EINA_FALSE` if they are not

void elm_notify_dismiss ( Evas_Object * obj )

Dismiss a notify object.

Since :: 2.3.1

Parameters:

[in] obj The notify object

Use this function to dismiss the notify with hide effect. when the notify is dismissed, the "dismissed" signal will be emitted.

Evas_Object* elm_notify_parent_get ( const Evas_Object * obj )

Gets the notify parent.

Since :: 2.3.1

Parameters:

[in] obj The notify object

Returns:: The parent

See also:: elm_notify_parent_set()

void elm_notify_parent_set	(	Evas_Object *	obj,
		Evas_Object *	parent
	)

Sets the notify parent.

Since :: 2.3.1

Remarks:: Once the parent object is set, a previously set one is disconnected and replaced.

Parameters:

[in]	obj	The notify object
[in]	parent	The new parent

double elm_notify_timeout_get ( const Evas_Object * obj )

Gets the timeout value (in seconds).

Since :: 2.3.1

Parameters:

[in] obj The notify object

Returns:: The timeout in seconds

See also:: elm_notify_timeout_set()

void elm_notify_timeout_set	(	Evas_Object *	obj,
		double	timeout
	)

Sets the time interval after which the notify window is going to be hidden.

This function sets a timeout and starts the timer controlling when the notification is hidden. Since calling evas_object_show() on a notification restarts the timer controlling when the notification is hidden, setting this before the notification is shown means starting the timer when the notification is shown.

Since :: 2.3.1

Remarks:: Set a value <= 0.0 to disable a running timer.; If the value > 0.0 and the notification is previously visible, the timer is started with this value, cancelling any running timer.

Parameters:

[in]	obj	The notify object
[in]	timeout	The timeout in seconds

Functions

Defines

Define Documentation

Function Documentation