diff options
Diffstat (limited to 'src/lib/elementary/elm_notify_eo.h')
-rw-r--r-- | src/lib/elementary/elm_notify_eo.h | 145 |
1 files changed, 145 insertions, 0 deletions
diff --git a/src/lib/elementary/elm_notify_eo.h b/src/lib/elementary/elm_notify_eo.h new file mode 100644 index 0000000..37b0598 --- /dev/null +++ b/src/lib/elementary/elm_notify_eo.h | |||
@@ -0,0 +1,145 @@ | |||
1 | #ifndef _ELM_NOTIFY_EO_H_ | ||
2 | #define _ELM_NOTIFY_EO_H_ | ||
3 | |||
4 | #ifndef _ELM_NOTIFY_EO_CLASS_TYPE | ||
5 | #define _ELM_NOTIFY_EO_CLASS_TYPE | ||
6 | |||
7 | typedef Eo Elm_Notify; | ||
8 | |||
9 | #endif | ||
10 | |||
11 | #ifndef _ELM_NOTIFY_EO_TYPES | ||
12 | #define _ELM_NOTIFY_EO_TYPES | ||
13 | |||
14 | |||
15 | #endif | ||
16 | /** Elementary notification class | ||
17 | * | ||
18 | * @ingroup Elm_Notify | ||
19 | */ | ||
20 | #define ELM_NOTIFY_CLASS elm_notify_class_get() | ||
21 | |||
22 | EWAPI const Efl_Class *elm_notify_class_get(void); | ||
23 | |||
24 | /** | ||
25 | * @brief Set the alignment of the notify object | ||
26 | * | ||
27 | * Sets the alignment in which the notify will appear in its parent. | ||
28 | * | ||
29 | * @note To fill the notify box in the parent area, please pass the | ||
30 | * ELM_NOTIFY_ALIGN_FILL to horizontal and vertical. | ||
31 | * | ||
32 | * @param[in] obj The object. | ||
33 | * @param[in] horizontal The horizontal alignment of the notification | ||
34 | * @param[in] vertical The vertical alignment of the notification | ||
35 | * | ||
36 | * @since 1.8 | ||
37 | * | ||
38 | * @ingroup Elm_Notify | ||
39 | */ | ||
40 | EOAPI void elm_obj_notify_align_set(Eo *obj, double horizontal, double vertical); | ||
41 | |||
42 | /** | ||
43 | * @brief Get the alignment of the notify object | ||
44 | * | ||
45 | * @param[in] obj The object. | ||
46 | * @param[out] horizontal The horizontal alignment of the notification | ||
47 | * @param[out] vertical The vertical alignment of the notification | ||
48 | * | ||
49 | * @since 1.8 | ||
50 | * | ||
51 | * @ingroup Elm_Notify | ||
52 | */ | ||
53 | EOAPI void elm_obj_notify_align_get(const Eo *obj, double *horizontal, double *vertical); | ||
54 | |||
55 | /** | ||
56 | * @brief Sets whether events should be passed to by a click outside its area. | ||
57 | * | ||
58 | * When true if the user clicks outside the window the events will be caught by | ||
59 | * the others widgets, else the events are blocked. | ||
60 | * | ||
61 | * @note The default value is true. | ||
62 | * | ||
63 | * @param[in] obj The object. | ||
64 | * @param[in] allow @c true if events are allowed, @c false otherwise | ||
65 | * | ||
66 | * @ingroup Elm_Notify | ||
67 | */ | ||
68 | EOAPI void elm_obj_notify_allow_events_set(Eo *obj, Eina_Bool allow); | ||
69 | |||
70 | /** | ||
71 | * @brief Return true if events are allowed below the notify object. | ||
72 | * | ||
73 | * @param[in] obj The object. | ||
74 | * | ||
75 | * @return @c true if events are allowed, @c false otherwise | ||
76 | * | ||
77 | * @ingroup Elm_Notify | ||
78 | */ | ||
79 | EOAPI Eina_Bool elm_obj_notify_allow_events_get(const Eo *obj); | ||
80 | |||
81 | /** | ||
82 | * @brief Set the time interval after which the notify window is going to be | ||
83 | * hidden. | ||
84 | * | ||
85 | * This function sets a timeout and starts the timer controlling when the | ||
86 | * notify is hidden. Since calling evas_object_show() on a notify restarts the | ||
87 | * timer controlling when the notify is hidden, setting this before the notify | ||
88 | * is shown will in effect mean starting the timer when the notify is shown. | ||
89 | * | ||
90 | * @note Set a value <= 0.0 to disable a running timer. | ||
91 | * | ||
92 | * @note If the value > 0.0 and the notify is previously visible, the timer | ||
93 | * will be started with this value, canceling any running timer. | ||
94 | * | ||
95 | * @param[in] obj The object. | ||
96 | * @param[in] timeout The timeout in seconds | ||
97 | * | ||
98 | * @ingroup Elm_Notify | ||
99 | */ | ||
100 | EOAPI void elm_obj_notify_timeout_set(Eo *obj, double timeout); | ||
101 | |||
102 | /** | ||
103 | * @brief Return the timeout value (in seconds) | ||
104 | * | ||
105 | * @param[in] obj The object. | ||
106 | * | ||
107 | * @return The timeout in seconds | ||
108 | * | ||
109 | * @ingroup Elm_Notify | ||
110 | */ | ||
111 | EOAPI double elm_obj_notify_timeout_get(const Eo *obj); | ||
112 | |||
113 | /** Dismiss a notify object. | ||
114 | * | ||
115 | * @since 1.17 | ||
116 | * | ||
117 | * @ingroup Elm_Notify | ||
118 | */ | ||
119 | EOAPI void elm_obj_notify_dismiss(Eo *obj); | ||
120 | |||
121 | EWAPI extern const Efl_Event_Description _ELM_NOTIFY_EVENT_BLOCK_CLICKED; | ||
122 | |||
123 | /** Called when block was clicked | ||
124 | * | ||
125 | * @ingroup Elm_Notify | ||
126 | */ | ||
127 | #define ELM_NOTIFY_EVENT_BLOCK_CLICKED (&(_ELM_NOTIFY_EVENT_BLOCK_CLICKED)) | ||
128 | |||
129 | EWAPI extern const Efl_Event_Description _ELM_NOTIFY_EVENT_TIMEOUT; | ||
130 | |||
131 | /** Called when notify timed out | ||
132 | * | ||
133 | * @ingroup Elm_Notify | ||
134 | */ | ||
135 | #define ELM_NOTIFY_EVENT_TIMEOUT (&(_ELM_NOTIFY_EVENT_TIMEOUT)) | ||
136 | |||
137 | EWAPI extern const Efl_Event_Description _ELM_NOTIFY_EVENT_DISMISSED; | ||
138 | |||
139 | /** Called when notify was dismissed | ||
140 | * | ||
141 | * @ingroup Elm_Notify | ||
142 | */ | ||
143 | #define ELM_NOTIFY_EVENT_DISMISSED (&(_ELM_NOTIFY_EVENT_DISMISSED)) | ||
144 | |||
145 | #endif | ||