efl/legacy/elementary/src/lib/elm_notify_legacy.h

124 lines
3.5 KiB
C

/**
* @brief Add a new notify to the parent
*
* @param parent The parent object
* @return The new object or NULL if it cannot be created
*
* @ingroup Notify
*/
EAPI Evas_Object *elm_notify_add(Evas_Object *parent);
/**
* @brief Set the notify parent
*
* @param obj The notify object
* @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);
/**
* @brief Get the notify parent
*
* @param obj The notify object
* @return The parent
*
* @see elm_notify_parent_set()
*
* @ingroup Notify
*/
EAPI Evas_Object *elm_notify_parent_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 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
* 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.
*
* @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);
/**
* @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);
/**
* @brief Sets whether events should be passed to by a click outside
* its area.
*
* @param obj The notify object
* @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_allow_events_set(Evas_Object *obj, Eina_Bool allow);
/**
* @brief Return true if events are allowed below the notify object
* @param obj the notify object
*
* @see elm_notify_allow_events_set()
*
* @ingroup Notify
*/
EAPI Eina_Bool elm_notify_allow_events_get(const Evas_Object *obj);
/**
* @brief Set the alignment of the notify object
*
* @param obj The notify object
* @param horizontal The horizontal alignment of the notification
* @param vertical The vertical alignment of the notification
*
* 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
* @c ELM_NOTIFY_ALIGN_FILL to @p horizontal, @p vertical.
*
* @since 1.8
* @ingroup Notify
*/
EAPI void elm_notify_align_set(Evas_Object *obj, double horizontal, double vertical);
/**
* @brief Get the alignment of the notify object
* @param obj The notify object
* @param horizontal The horizontal alignment of the notification
* @param vertical The vertical alignment of the notification
*
* @see elm_notify_align_set()
*
* @since 1.8
* @ingroup Notify
*/
EAPI void elm_notify_align_get(const Evas_Object *obj, double *horizontal, double *vertical);