2 * @defgroup Notify Notify
5 * @image html img/widget/notify/preview-00.png
6 * @image latex img/widget/notify/preview-00.eps
8 * Display a container in a particular region of the parent(top, bottom,
9 * etc). A timeout can be set to automatically hide the notify. This is so
10 * that, after an evas_object_show() on a notify object, if a timeout was set
11 * on it, it will @b automatically get hidden after that time.
13 * Signals that you can add callbacks for are:
14 * @li "timeout" - when timeout happens on notify and it's hidden
15 * @li "block,clicked" - when a click outside of the notify happens
17 * Default content parts of the notify widget that you can use for are:
18 * @li "default" - A content of the notify
20 * Supported elm_object common APIs.
21 * @li @ref elm_object_part_content_set
22 * @li @ref elm_object_part_content_get
23 * @li @ref elm_object_part_content_unset
25 * @ref tutorial_notify show usage of the API.
31 * @brief Possible orient values for notify.
33 * This values should be used in conjunction to elm_notify_orient_set() to
34 * set the position in which the notify should appear(relative to its parent)
35 * and in conjunction with elm_notify_orient_get() to know where the notify
40 ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
41 ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
42 ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
43 ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
44 ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
45 ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
46 ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
47 ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
48 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
49 ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
53 * @brief Add a new notify to the parent
55 * @param parent The parent object
56 * @return The new object or NULL if it cannot be created
60 EAPI Evas_Object *elm_notify_add(Evas_Object *parent);
63 * @brief Set the notify parent
65 * @param obj The notify object
66 * @param parent The new parent
68 * Once the parent object is set, a previously set one will be disconnected
73 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent);
76 * @brief Get the notify parent
78 * @param obj The notify object
81 * @see elm_notify_parent_set()
85 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj);
88 * @brief Set the orientation
90 * @param obj The notify object
91 * @param orient The new orientation
93 * Sets the position in which the notify will appear in its parent.
95 * @see @ref Elm_Notify_Orient for possible values.
99 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient);
102 * @brief Return the orientation
103 * @param obj The notify object
104 * @return The orientation of the notification
106 * @see elm_notify_orient_set()
107 * @see Elm_Notify_Orient
111 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj);
114 * @brief Set the time interval after which the notify window is going to be
117 * @param obj The notify object
118 * @param timeout The timeout in seconds
120 * This function sets a timeout and starts the timer controlling when the
121 * notify is hidden. Since calling evas_object_show() on a notify restarts
122 * the timer controlling when the notify is hidden, setting this before the
123 * notify is shown will in effect mean starting the timer when the notify is
126 * @note Set a value <= 0.0 to disable a running timer.
128 * @note If the value > 0.0 and the notify is previously visible, the
129 * timer will be started with this value, canceling any running timer.
133 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout);
136 * @brief Return the timeout value (in seconds)
137 * @param obj the notify object
139 * @see elm_notify_timeout_set()
143 EAPI double elm_notify_timeout_get(const Evas_Object *obj);
146 * @brief Sets whether events should be passed to by a click outside
149 * @param obj The notify object
150 * @param allow EINA_TRUE If events are allowed, otherwise not
152 * When true if the user clicks outside the window the events will be caught
153 * by the others widgets, else the events are blocked.
155 * @note The default value is EINA_TRUE.
159 EAPI void elm_notify_allow_events_set(Evas_Object *obj, Eina_Bool allow);
162 * @brief Return true if events are allowed below the notify object
163 * @param obj the notify object
165 * @see elm_notify_allow_events_set()
169 EAPI Eina_Bool elm_notify_allow_events_get(const Evas_Object *obj);