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

115 lines
3.0 KiB
C

#ifndef _ELM_NOTIFY_EO_LEGACY_H_
#define _ELM_NOTIFY_EO_LEGACY_H_
#ifndef _ELM_NOTIFY_EO_CLASS_TYPE
#define _ELM_NOTIFY_EO_CLASS_TYPE
typedef Eo Elm_Notify;
#endif
#ifndef _ELM_NOTIFY_EO_TYPES
#define _ELM_NOTIFY_EO_TYPES
#endif
/**
* @brief 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.
*
* @param[in] obj The object.
* @param[in] horizontal The horizontal alignment of the notification
* @param[in] vertical The vertical alignment of the notification
*
* @since 1.8
*
* @ingroup Elm_Notify_Group
*/
EAPI void elm_notify_align_set(Elm_Notify *obj, double horizontal, double vertical);
/**
* @brief Get the alignment of the notify object
*
* @param[in] obj The object.
* @param[out] horizontal The horizontal alignment of the notification
* @param[out] vertical The vertical alignment of the notification
*
* @since 1.8
*
* @ingroup Elm_Notify_Group
*/
EAPI void elm_notify_align_get(const Elm_Notify *obj, double *horizontal, double *vertical);
/**
* @brief 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.
*
* @param[in] obj The object.
* @param[in] allow @c true if events are allowed, @c false otherwise
*
* @ingroup Elm_Notify_Group
*/
EAPI void elm_notify_allow_events_set(Elm_Notify *obj, Eina_Bool allow);
/**
* @brief Return true if events are allowed below the notify object.
*
* @param[in] obj The object.
*
* @return @c true if events are allowed, @c false otherwise
*
* @ingroup Elm_Notify_Group
*/
EAPI Eina_Bool elm_notify_allow_events_get(const Elm_Notify *obj);
/**
* @brief 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.
*
* @note If the value > 0.0 and the notify is previously visible, the timer
* will be started with this value, canceling any running timer.
*
* @param[in] obj The object.
* @param[in] timeout The timeout in seconds
*
* @ingroup Elm_Notify_Group
*/
EAPI void elm_notify_timeout_set(Elm_Notify *obj, double timeout);
/**
* @brief Return the timeout value (in seconds)
*
* @param[in] obj The object.
*
* @return The timeout in seconds
*
* @ingroup Elm_Notify_Group
*/
EAPI double elm_notify_timeout_get(const Elm_Notify *obj);
/** Dismiss a notify object.
*
* @since 1.17
*
* @ingroup Elm_Notify_Group
*/
EAPI void elm_notify_dismiss(Elm_Notify *obj);
#endif