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 elm-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.
Function Documentation
Add a new notify to the parent.
- Parameters:
-
- Returns:
- The new object or NULL if it cannot be created
- Since :
- 2.3
Get the alignment of the notify object.
- Since :
- 2.3
- Parameters:
-
[in] | obj | The object. |
[out] | horizontal | The horizontal alignment of the notification |
[out] | vertical | The vertical alignment of the notification |
- Since (EFL) :
- 1.8
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.
- Since :
- 2.3
- Parameters:
-
[in] | obj | The object. |
[in] | horizontal | The horizontal alignment of the notification |
[in] | vertical | The vertical alignment of the notification |
- Since (EFL) :
- 1.8
Return true if events are allowed below the notify object.
- Since :
- 2.3
- Parameters:
-
- Returns:
- true if events are allowed, otherwise false
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.
- Since :
- 2.3
- Parameters:
-
[in] | obj | The object. |
[in] | allow | true if events are allowed, otherwise false |
Dismiss a notify object.
- Since :
- 2.4
- Parameters:
-
Set the notify parent.
- Parameters:
-
obj | The notify object |
parent | The new parent |
Once the parent object is set, a previously set one will be disconnected and replaced.
- Since :
- 2.3
Return the timeout value (in seconds)
- Since :
- 2.3
- Parameters:
-
- Returns:
- The timeout in seconds
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.
- Since :
- 2.3
- Parameters:
-
[in] | obj | The object. |
[in] | timeout | The timeout in seconds |