Functions
Notify

Functions

EOAPI void elm_obj_notify_align_set (double horizontal, double vertical)
 Set the alignment of the notify object. More...
 
EOAPI void elm_obj_notify_align_get (double *horizontal, double *vertical)
 Get the alignment of the notify object. More...
 
EOAPI void elm_obj_notify_allow_events_set (Eina_Bool allow)
 Sets whether events should be passed to by a click outside its area. More...
 
EOAPI Eina_Bool elm_obj_notify_allow_events_get (void)
 Return true if events are allowed below the notify object. More...
 
EOAPI void elm_obj_notify_timeout_set (double timeout)
 Set the time interval after which the notify window is going to be hidden. More...
 
EOAPI double elm_obj_notify_timeout_get (void)
 Return the timeout value (in seconds) More...
 
EOAPI void elm_obj_notify_dismiss (void)
 Dismiss a notify object. More...
 
void elm_notify_align_set (Elm_Notify *obj, double horizontal, double vertical)
 Set the alignment of the notify object. More...
 
void elm_notify_align_get (const Elm_Notify *obj, double *horizontal, double *vertical)
 Get the alignment of the notify object. More...
 
void elm_notify_allow_events_set (Elm_Notify *obj, Eina_Bool allow)
 Sets whether events should be passed to by a click outside its area. More...
 
Eina_Bool elm_notify_allow_events_get (const Elm_Notify *obj)
 Return true if events are allowed below the notify object. More...
 
void elm_notify_timeout_set (Elm_Notify *obj, double timeout)
 Set the time interval after which the notify window is going to be hidden. More...
 
double elm_notify_timeout_get (const Elm_Notify *obj)
 Return the timeout value (in seconds) More...
 
void elm_notify_dismiss (Elm_Notify *obj)
 Dismiss a notify object. More...
 
Evas_Object * elm_notify_add (Evas_Object *parent)
 Add a new notify to the parent. More...
 
void elm_notify_parent_set (Evas_Object *obj, Evas_Object *parent)
 Set the notify parent. More...
 
Evas_Object * elm_notify_parent_get (const Evas_Object *obj)
 Get the notify parent. More...
 

Detailed Description

notify_inheritance_tree.png
preview-00.png

Display a container in a particular region of the parent(top, bottom, etc). A timeout can be set to automatically hide the notify. This is so that, after an evas_object_show() on a notify object, if a timeout was set on it, it will automatically get hidden after that time.

Signals that you can add callbacks for are:

This widget inherits from The Elementary Container Class, so that the functions meant to act on it will wor work for mapbuf objects:

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

Notify example show usage of the API.

Function Documentation

Evas_Object* elm_notify_add ( Evas_Object *  parent)

Add a new notify to the parent.

Parameters
parentThe parent object
Returns
The new object or NULL if it cannot be created
void elm_notify_align_get ( const Elm_Notify *  obj,
double *  horizontal,
double *  vertical 
)

Get the alignment of the notify object.

Parameters
[out]horizontalThe horizontal alignment of the notification
[out]verticalThe vertical alignment of the notification
Since
1.8

References elm_obj_notify_align_get().

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

Set the alignment of the notify object.

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

Note
To fill the notify box in the parent area, please pass the ELM_NOTIFY_ALIGN_FILL to horizontal and vertical.
Parameters
[in]horizontalThe horizontal alignment of the notification
[in]verticalThe vertical alignment of the notification
Since
1.8

References elm_obj_notify_align_set().

Eina_Bool elm_notify_allow_events_get ( const Elm_Notify *  obj)

Return true if events are allowed below the notify object.

Returns
true if events are allowed, otherwise false

References elm_obj_notify_allow_events_get().

void elm_notify_allow_events_set ( Elm_Notify *  obj,
Eina_Bool  allow 
)

Sets 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.
Parameters
[in]allowtrue if events are allowed, otherwise false

References elm_obj_notify_allow_events_set().

void elm_notify_dismiss ( Elm_Notify *  obj)

Dismiss a notify object.

Since
1.17

References elm_obj_notify_dismiss().

Evas_Object* elm_notify_parent_get ( const Evas_Object *  obj)

Get the notify parent.

Parameters
objThe notify object
Returns
The parent
See also
elm_notify_parent_set()
void elm_notify_parent_set ( Evas_Object *  obj,
Evas_Object *  parent 
)

Set the notify parent.

Parameters
objThe notify object
parentThe new parent

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

double elm_notify_timeout_get ( const Elm_Notify *  obj)

Return the timeout value (in seconds)

Returns
The timeout in seconds

References elm_obj_notify_timeout_get().

void elm_notify_timeout_set ( Elm_Notify *  obj,
double  timeout 
)

Set 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 notify is hidden. Since calling 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.
If the value > 0.0 and the notify is previously visible, the timer will be started with this value, canceling any running timer.
Parameters
[in]timeoutThe timeout in seconds

References elm_obj_notify_timeout_set().

EOAPI void elm_obj_notify_align_get ( double *  horizontal,
double *  vertical 
)

Get the alignment of the notify object.

Parameters
[out]horizontalThe horizontal alignment of the notification
[out]verticalThe vertical alignment of the notification
Since
1.8

Referenced by elm_notify_align_get().

EOAPI void elm_obj_notify_align_set ( double  horizontal,
double  vertical 
)

Set the alignment of the notify object.

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

Note
To fill the notify box in the parent area, please pass the ELM_NOTIFY_ALIGN_FILL to horizontal and vertical.
Parameters
[in]horizontalThe horizontal alignment of the notification
[in]verticalThe vertical alignment of the notification
Since
1.8

Referenced by elm_notify_align_set().

EOAPI Eina_Bool elm_obj_notify_allow_events_get ( void  )

Return true if events are allowed below the notify object.

Returns
true if events are allowed, otherwise false

Referenced by elm_notify_allow_events_get().

EOAPI void elm_obj_notify_allow_events_set ( Eina_Bool  allow)

Sets 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.
Parameters
[in]allowtrue if events are allowed, otherwise false

Referenced by elm_notify_allow_events_set().

EOAPI void elm_obj_notify_dismiss ( void  )

Dismiss a notify object.

Since
1.17

Referenced by elm_notify_dismiss().

EOAPI double elm_obj_notify_timeout_get ( void  )

Return the timeout value (in seconds)

Returns
The timeout in seconds

Referenced by elm_notify_timeout_get().

EOAPI void elm_obj_notify_timeout_set ( double  timeout)

Set 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 notify is hidden. Since calling 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.
If the value > 0.0 and the notify is previously visible, the timer will be started with this value, canceling any running timer.
Parameters
[in]timeoutThe timeout in seconds

Referenced by elm_notify_timeout_set().