2 * @defgroup Notify Notify
4 * @image html img/widget/notify/preview-00.png
5 * @image latex img/widget/notify/preview-00.eps
7 * Display a container in a particular region of the parent(top, bottom,
8 * etc). A timeout can be set to automatically hide the notify. This is so
9 * that, after an evas_object_show() on a notify object, if a timeout was set
10 * on it, it will @b automatically get hidden after that time.
12 * Signals that you can add callbacks for are:
13 * @li "timeout" - when timeout happens on notify and it's hidden
14 * @li "block,clicked" - when a click outside of the notify happens
16 * Default content parts of the notify widget that you can use for are:
17 * @li "default" - A content of the notify
19 * Supported elm_object common APIs.
20 * @li elm_object_part_content_set
21 * @li elm_object_part_content_get
22 * @li elm_object_part_content_unset
24 * @ref tutorial_notify show usage of the API.
30 * @brief Possible orient values for notify.
32 * This values should be used in conjunction to elm_notify_orient_set() to
33 * set the position in which the notify should appear(relative to its parent)
34 * and in conjunction with elm_notify_orient_get() to know where the notify
39 ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
40 ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
41 ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
42 ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
43 ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
44 ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
45 ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
46 ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
47 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
48 ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
52 * @brief Add a new notify to the parent
54 * @param parent The parent object
55 * @return The new object or NULL if it cannot be created
57 EAPI Evas_Object *elm_notify_add(Evas_Object *parent);
60 * @brief Set the notify parent
62 * @param obj The notify object
63 * @param parent The new parent
65 * Once the parent object is set, a previously set one will be disconnected
68 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent);
71 * @brief Get the notify parent
73 * @param obj The notify object
76 * @see elm_notify_parent_set()
78 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj);
81 * @brief Set the orientation
83 * @param obj The notify object
84 * @param orient The new orientation
86 * Sets the position in which the notify will appear in its parent.
88 * @see @ref Elm_Notify_Orient for possible values.
90 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient);
93 * @brief Return the orientation
94 * @param obj The notify object
95 * @return The orientation of the notification
97 * @see elm_notify_orient_set()
98 * @see Elm_Notify_Orient
100 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj);
103 * @brief Set the time interval after which the notify window is going to be
106 * @param obj The notify object
107 * @param timeout The timeout in seconds
109 * This function sets a timeout and starts the timer controlling when the
110 * notify is hidden. Since calling evas_object_show() on a notify restarts
111 * the timer controlling when the notify is hidden, setting this before the
112 * notify is shown will in effect mean starting the timer when the notify is
115 * @note Set a value <= 0.0 to disable a running timer.
117 * @note If the value > 0.0 and the notify is previously visible, the
118 * timer will be started with this value, canceling any running timer.
120 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout);
123 * @brief Return the timeout value (in seconds)
124 * @param obj the notify object
126 * @see elm_notify_timeout_set()
128 EAPI double elm_notify_timeout_get(const Evas_Object *obj);
131 * @brief Sets whether events should be passed to by a click outside
134 * @param obj The notify object
135 * @param allow EINA_TRUE If events are allowed, otherwise not
137 * When true if the user clicks outside the window the events will be caught
138 * by the others widgets, else the events are blocked.
140 * @note The default value is EINA_TRUE.
142 EAPI void elm_notify_allow_events_set(Evas_Object *obj, Eina_Bool allow);
145 * @brief Return true if events are allowed below the notify object
146 * @param obj the notify object
148 * @see elm_notify_allow_events_set()
150 EAPI Eina_Bool elm_notify_allow_events_get(const Evas_Object *obj);