src/lib/elm_notify.h

   1 /**
   2  * @defgroup Notify Notify
   3  *
   4  * @image html img/widget/notify/preview-00.png
   5  * @image latex img/widget/notify/preview-00.eps
   6  *
   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.
  11  *
  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
  15  *
  16  * Default contents parts of the notify widget that you can use for are:
  17  * @li "default" - A content of the notify
  18  *
  19  * @ref tutorial_notify show usage of the API.
  20  *
  21  * @{
  22  */
  23
  24 /**
  25  * @brief Possible orient values for notify.
  26  *
  27  * This values should be used in conjunction to elm_notify_orient_set() to
  28  * set the position in which the notify should appear(relative to its parent)
  29  * and in conjunction with elm_notify_orient_get() to know where the notify
  30  * is appearing.
  31  */
  32 typedef enum
  33 {
  34    ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
  35    ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
  36    ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
  37    ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
  38    ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
  39    ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
  40    ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
  41    ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
  42    ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
  43    ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
  44 } Elm_Notify_Orient;
  45
  46 /**
  47  * @brief Add a new notify to the parent
  48  *
  49  * @param parent The parent object
  50  * @return The new object or NULL if it cannot be created
  51  */
  52 EAPI Evas_Object                 *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
  53
  54 /**
  55  * @brief Set the notify parent
  56  *
  57  * @param obj The notify object
  58  * @param content The new parent
  59  *
  60  * Once the parent object is set, a previously set one will be disconnected
  61  * and replaced.
  62  */
  63 EAPI void                         elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
  64
  65 /**
  66  * @brief Get the notify parent
  67  *
  68  * @param obj The notify object
  69  * @return The parent
  70  *
  71  * @see elm_notify_parent_set()
  72  */
  73 EAPI Evas_Object                 *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
  74
  75 /**
  76  * @brief Set the orientation
  77  *
  78  * @param obj The notify object
  79  * @param orient The new orientation
  80  *
  81  * Sets the position in which the notify will appear in its parent.
  82  *
  83  * @see @ref Elm_Notify_Orient for possible values.
  84  */
  85 EAPI void                         elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
  86
  87 /**
  88  * @brief Return the orientation
  89  * @param obj The notify object
  90  * @return The orientation of the notification
  91  *
  92  * @see elm_notify_orient_set()
  93  * @see Elm_Notify_Orient
  94  */
  95 EAPI Elm_Notify_Orient            elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
  96
  97 /**
  98  * @brief Set the time interval after which the notify window is going to be
  99  * hidden.
 100  *
 101  * @param obj The notify object
 102  * @param time The timeout in seconds
 103  *
 104  * This function sets a timeout and starts the timer controlling when the
 105  * notify is hidden. Since calling evas_object_show() on a notify restarts
 106  * the timer controlling when the notify is hidden, setting this before the
 107  * notify is shown will in effect mean starting the timer when the notify is
 108  * shown.
 109  *
 110  * @note Set a value <= 0.0 to disable a running timer.
 111  *
 112  * @note If the value > 0.0 and the notify is previously visible, the
 113  * timer will be started with this value, canceling any running timer.
 114  */
 115 EAPI void                         elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
 116
 117 /**
 118  * @brief Return the timeout value (in seconds)
 119  * @param obj the notify object
 120  *
 121  * @see elm_notify_timeout_set()
 122  */
 123 EAPI double                       elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
 124
 125 /**
 126  * @brief Sets whether events should be passed to by a click outside
 127  * its area.
 128  *
 129  * @param obj The notify object
 130  * @param repeats EINA_TRUE Events are repeats, else no
 131  *
 132  * When true if the user clicks outside the window the events will be caught
 133  * by the others widgets, else the events are blocked.
 134  *
 135  * @note The default value is EINA_TRUE.
 136  */
 137 EAPI void                         elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
 138
 139 /**
 140  * @brief Return true if events are repeat below the notify object
 141  * @param obj the notify object
 142  *
 143  * @see elm_notify_repeat_events_set()
 144  */
 145 EAPI Eina_Bool                    elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
 146
 147 /**
 148  * @}
 149  */