1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
|
/**
* @defgroup Notify Notify
* @ingroup Elementary
*
* @image html img/widget/notify/preview-00.png
* @image latex img/widget/notify/preview-00.eps
*
* Display a container in a particular region of the parent(top, bottom,
* etc). A timeout can be set to automatically hide the notify. This is so
* that, after an evas_object_show() on a notify object, if a timeout was set
* on it, it will @b automatically get hidden after that time.
*
* Signals that you can add callbacks for are:
* @li "timeout" - when timeout happens on notify and it's hidden
* @li "block,clicked" - when a click outside of the notify happens
*
* 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.
*
* @{
*/
/**
* @brief Possible orient values for notify.
*
* This values should be used in conjunction to elm_notify_orient_set() to
* set the position in which the notify should appear(relative to its parent)
* and in conjunction with elm_notify_orient_get() to know where the notify
* is appearing.
*/
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 */
ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
} Elm_Notify_Orient;
/**
* @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 orientation
*
* @param obj The notify object
* @param orient The new 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);
/**
* @brief Return the orientation
* @param obj The notify object
* @return The orientation of the notification
*
* @see elm_notify_orient_set()
* @see Elm_Notify_Orient
*
* @ingroup Notify
*/
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 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);
/**
* @}
*/
|
