/**
* @defgroup Notify Notify
+ * @ingroup Elementary
*
* @image html img/widget/notify/preview-00.png
* @image latex img/widget/notify/preview-00.eps
* @li "timeout" - when timeout happens on notify and it's hidden
* @li "block,clicked" - when a click outside of the notify happens
*
- * Default contents parts of the notify widget that you can use for are:
+ * Default content parts of the notify widget that you can use for are:
* @li "default" - A content of the notify
*
+ * Supported elm_object common APIs.
+ * @li @ref elm_object_part_content_set
+ * @li @ref elm_object_part_content_get
+ * @li @ref elm_object_part_content_unset
+ *
* @ref tutorial_notify show usage of the API.
*
* @{
* and in conjunction with elm_notify_orient_get() to know where the notify
* is appearing.
*/
-typedef enum _Elm_Notify_Orient
+typedef enum
{
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 */
*
* @param parent The parent object
* @return The new object or NULL if it cannot be created
- */
-EAPI Evas_Object *
- elm_notify_add(Evas_Object *parent)
-EINA_ARG_NONNULL(1);
-
-/**
- * @brief Set the content of the notify widget
- *
- * @param obj The notify object
- * @param content The content will be filled in this notify object
- *
- * Once the content object is set, a previously set one will be deleted. If
- * you want to keep that old content object, use the
- * elm_notify_content_unset() function.
- *
- * @deprecated use elm_object_content_set() instead
- *
- */
-EINA_DEPRECATED EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
-
-/**
- * @brief Unset the content of the notify widget
- *
- * @param obj The notify object
- * @return The content that was being used
- *
- * Unparent and return the content object which was set for this widget
- *
- * @see elm_notify_content_set()
- * @deprecated use elm_object_content_unset() instead
*
+ * @ingroup Notify
*/
-EINA_DEPRECATED EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
-
-/**
- * @brief Return the content of the notify widget
- *
- * @param obj The notify object
- * @return The content that is being used
- *
- * @see elm_notify_content_set()
- * @deprecated use elm_object_content_get() instead
- *
- */
-EINA_DEPRECATED EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Evas_Object *elm_notify_add(Evas_Object *parent);
/**
* @brief Set the notify parent
*
* @param obj The notify object
- * @param content The new parent
+ * @param parent The new parent
*
* Once the parent object is set, a previously set one will be disconnected
* and replaced.
+ *
+ * @ingroup Notify
*/
-EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
+EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent);
/**
* @brief Get the notify parent
* @return The parent
*
* @see elm_notify_parent_set()
+ *
+ * @ingroup Notify
*/
-EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj);
/**
* @brief Set the orientation
* Sets the position in which the notify will appear in its parent.
*
* @see @ref Elm_Notify_Orient for possible values.
+ *
+ * @ingroup Notify
*/
-EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
+EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient);
/**
* @brief Return the orientation
*
* @see elm_notify_orient_set()
* @see Elm_Notify_Orient
+ *
+ * @ingroup Notify
*/
-EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj);
/**
* @brief Set the time interval after which the notify window is going to be
* hidden.
*
* @param obj The notify object
- * @param time The timeout in seconds
+ * @param timeout The 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
*
* @note If the value > 0.0 and the notify is previously visible, the
* timer will be started with this value, canceling any running timer.
+ *
+ * @ingroup Notify
*/
-EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
+EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout);
/**
* @brief Return the timeout value (in seconds)
* @param obj the notify object
*
* @see elm_notify_timeout_set()
+ *
+ * @ingroup Notify
*/
-EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI double elm_notify_timeout_get(const Evas_Object *obj);
/**
* @brief Sets whether events should be passed to by a click outside
* its area.
*
* @param obj The notify object
- * @param repeats EINA_TRUE Events are repeats, else no
+ * @param allow EINA_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.
+ *
+ * @ingroup Notify
*/
-EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
+EAPI void elm_notify_allow_events_set(Evas_Object *obj, Eina_Bool allow);
/**
- * @brief Return true if events are repeat below the notify object
+ * @brief Return true if events are allowed below the notify object
* @param obj the notify object
*
- * @see elm_notify_repeat_events_set()
+ * @see elm_notify_allow_events_set()
+ *
+ * @ingroup Notify
*/
-EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Eina_Bool elm_notify_allow_events_get(const Evas_Object *obj);
/**
* @}
projects / framework / uifw / elementary.git / blobdiff