Enumerations

enum  Elm_Notify_Orient {
  ELM_NOTIFY_ORIENT_TOP,
  ELM_NOTIFY_ORIENT_CENTER,
  ELM_NOTIFY_ORIENT_BOTTOM,
  ELM_NOTIFY_ORIENT_LEFT,
  ELM_NOTIFY_ORIENT_RIGHT,
  ELM_NOTIFY_ORIENT_TOP_LEFT,
  ELM_NOTIFY_ORIENT_TOP_RIGHT,
  ELM_NOTIFY_ORIENT_BOTTOM_LEFT,
  ELM_NOTIFY_ORIENT_BOTTOM_RIGHT,
  ELM_NOTIFY_ORIENT_LAST
}
 Possible orient values for notify. More...

Functions

Evas_Object * elm_notify_add (Evas_Object *parent)
 Add a new notify to the parent.
void elm_notify_parent_set (Evas_Object *obj, Evas_Object *parent)
 Set the notify parent.
Evas_Object * elm_notify_parent_get (const Evas_Object *obj)
 Get the notify parent.
void elm_notify_orient_set (Evas_Object *obj, Elm_Notify_Orient orient)
 Set the orientation.
Elm_Notify_Orient elm_notify_orient_get (const Evas_Object *obj)
 Return the orientation.
void elm_notify_timeout_set (Evas_Object *obj, double timeout)
 Set the time interval after which the notify window is going to be hidden.
double elm_notify_timeout_get (const Evas_Object *obj)
 Return the timeout value (in seconds)
void elm_notify_allow_events_set (Evas_Object *obj, Eina_Bool allow)
 Sets whether events should be passed to by a click outside its area.
Eina_Bool elm_notify_allow_events_get (const Evas_Object *obj)
 Return true if events are allowed below the notify object.

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:

  • "timeout" - when timeout happens on notify and it's hidden
  • "block,clicked" - when a click outside of the notify happens

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:

  • "default" - The main content of the notify

Notify example show usage of the API.


Enumeration Type Documentation

Possible orient values for notify.

This values should be used in conjunction to elm_notify_orient_set() to set the position in which the notify should appear(relative to its parent) and in conjunction with elm_notify_orient_get() to know where the notify is appearing.

Enumerator:
ELM_NOTIFY_ORIENT_TOP 

Notify should appear in the top of parent, default.

ELM_NOTIFY_ORIENT_CENTER 

Notify should appear in the center of parent.

ELM_NOTIFY_ORIENT_BOTTOM 

Notify should appear in the bottom of parent.

ELM_NOTIFY_ORIENT_LEFT 

Notify should appear in the left of parent.

ELM_NOTIFY_ORIENT_RIGHT 

Notify should appear in the right of parent.

ELM_NOTIFY_ORIENT_TOP_LEFT 

Notify should appear in the top left of parent.

ELM_NOTIFY_ORIENT_TOP_RIGHT 

Notify should appear in the top right of parent.

ELM_NOTIFY_ORIENT_BOTTOM_LEFT 

Notify should appear in the bottom left of parent.

ELM_NOTIFY_ORIENT_BOTTOM_RIGHT 

Notify should appear in the bottom right of parent.

ELM_NOTIFY_ORIENT_LAST 

Sentinel value, don't use.


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

Referenced by elm_popup_add().

Eina_Bool elm_notify_allow_events_get ( const Evas_Object *  obj)

Return true if events are allowed below the notify object.

Parameters:
objthe notify object
See also:
elm_notify_allow_events_set()

Referenced by elm_popup_allow_events_get().

void elm_notify_allow_events_set ( Evas_Object *  obj,
Eina_Bool  allow 
)

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

Parameters:
objThe notify object
allowEINA_TRUE If events are allowed, otherwise not

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 EINA_TRUE.

References elm_layout_add(), and elm_layout_signal_callback_add().

Referenced by elm_popup_add(), and elm_popup_allow_events_set().

Elm_Notify_Orient elm_notify_orient_get ( const Evas_Object *  obj)

Return the orientation.

Parameters:
objThe notify object
Returns:
The orientation of the notification
See also:
elm_notify_orient_set()
Elm_Notify_Orient

Referenced by elm_popup_orient_get().

void elm_notify_orient_set ( Evas_Object *  obj,
Elm_Notify_Orient  orient 
)

Set the orientation.

Parameters:
objThe notify object
orientThe new orientation

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

See also:
Elm_Notify_Orient for possible values.

Referenced by elm_popup_add(), and elm_popup_orient_set().

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.

Referenced by elm_popup_add().

double elm_notify_timeout_get ( const Evas_Object *  obj)

Return the timeout value (in seconds)

Parameters:
objthe notify object
See also:
elm_notify_timeout_set()

Referenced by elm_popup_timeout_get().

void elm_notify_timeout_set ( Evas_Object *  obj,
double  timeout 
)

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

Parameters:
objThe notify object
timeoutThe timeout in seconds

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.

Referenced by elm_popup_timeout_set().