Notify

Widget description

Display a container in a particular region of the parent.

A timeout can be set to automatically hide the notify. This is so that, after an show() on a notify object, if a timeout was set on it, it will automatically get hidden after that time.

Emitted signals

• timeout - when timeout happens on notify and it’s hidden

• block,clicked - when a click outside of the notify happens

• dismissed - When notify is closed as a result of a dismiss (since 1.17)

Layout content parts

• default - The main content of the notify

Enumerations

ELM_NOTIFY_ALIGN_FILL

efl.elementary.ELM_NOTIFY_ALIGN_FILL

Use with Notify.align

New in version 1.8.

Inheritance diagram

class efl.elementary.Notify(Object parent, *args, **kwargs)

Bases: efl.elementary.__init__.Object

This is the class that actually implement the widget.

Notify(…)

Parameters

• parent (efl.evas.Object) – The parent object

• **kwargs – All the remaining keyword arguments are interpreted as properties of the instance

align

Set the alignment of the notify object

Type

(float horizontal, float vertical)

Sets the alignment in which the notify will appear in its parent.

Note

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

New in version 1.8.

align_get()

align_set(horizontal, vertical)

allow_events

Whether events should be passed to by a click outside its area.

When True if the user clicks outside the window the events will be caught by the others widgets, else the events are blocked.

Note

The default value is True.

Type

bool

allow_events_get()

allow_events_set(repeat)

callback_block_clicked_add(func, *args, **kwargs)

When a click outside of the notify happens.

callback_block_clicked_del(func)

callback_dismissed_add(func, *args, **kwargs)

When notify is closed as a result of a dismiss.

New in version 1.17.

callback_dismissed_del(func)

callback_timeout_add(func, *args, **kwargs)

When timeout happens on notify and it’s hidden.

callback_timeout_del(func)

dismiss()

Dismiss a notify object.

New in version 1.17.

orient_get()

Deprecated since version 1.8: Use align instead.

orient_set(orient)

Deprecated since version 1.8: Use align instead.

parent

The notify parent.

Once the parent object is set, a previously set one will be disconnected and replaced.

Type

Object

parent_get()

parent_set(parent)

timeout

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

Setting this starts the timer controlling when the notify is hidden. Since calling efl.evas.Object.show() on a notify restarts the timer controlling when the notify is hidden, setting this before the notify is shown will in effect mean starting the timer when the notify is shown.

Note

Set a value <= 0.0 to disable a running timer.

Note

If the value > 0.0 and the notify is previously visible, the timer will be started with this value, canceling any running timer.

Type

float

timeout_get()

timeout_set(timeout)