summaryrefslogtreecommitdiff
path: root/src/lib/elementary/elm_sys_notify_interface.eo
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/elementary/elm_sys_notify_interface.eo')
-rw-r--r--src/lib/elementary/elm_sys_notify_interface.eo66
1 files changed, 66 insertions, 0 deletions
diff --git a/src/lib/elementary/elm_sys_notify_interface.eo b/src/lib/elementary/elm_sys_notify_interface.eo
new file mode 100644
index 0000000..627586b
--- /dev/null
+++ b/src/lib/elementary/elm_sys_notify_interface.eo
@@ -0,0 +1,66 @@
1enum Elm.Sys_Notify.Urgency
2{
3 [[Urgency levels of a notification
4
5 @since 1.8
6 ]]
7 low, [[Low urgency]]
8 normal, [[Normal urgency]]
9 critical [[Critical urgency]]
10}
11
12interface Elm.Sys_Notify_Interface
13{
14 eo_prefix: elm_obj_sys_notify_interface;
15 legacy_prefix: elm_sys_notify_interface;
16
17 methods {
18 send @const {
19 [[Causes a notification to be forcefully closed and removed from the
20 user's view. It can be used, for example, in the event that what the
21 notification pertains to is no longer relevant, or to cancel a
22 notification with no expiration time.
23
24 @since 1.8
25 ]]
26 params {
27 @in replaces_id: uint; [[Notification ID that this notification replaces.
28 The value 0 means a new notification.]]
29 @in icon: const(char) *; [[The optional program icon of the calling application]]
30 @in summary: const(char) *; [[The summary text briefly describing the notification]]
31 @in body: const(char) * @optional; [[The optional detailed body text. Can be empty]]
32 @in urgency: Elm.Sys_Notify.Urgency; [[The urgency level]]
33 @in timeout: int; [[Timeout display in milliseconds]]
34 @in cb: Elm_Sys_Notify_Send_Cb; [[Callback used to retrieve the notification id
35 returned by the Notification Server]]
36 @in cb_data: const(void) * @optional; [[Optional context data]]
37 }
38 }
39 simple_send @const {
40 [[Create a new notification just with Icon, Body and Summary.
41 It is a helper that wraps the send method
42
43 @since 1.16
44 ]]
45
46 params {
47 @in icon: const(char) *; [[The optional program icon of the calling application]]
48 @in summary: const(char) *; [[The summary text briefly describing the notification]]
49 @in body: const(char) *; [[The optional detailed body text. Can be empty]]
50 }
51 }
52 close @const {
53 [[Causes a notification to be forcefully closed and removed from the
54 user's view. It can be used, for example, in the event that what the
55 notification pertains to is no longer relevant, or to cancel a
56 notification with no expiration time.
57
58 @since 1.8
59 ]]
60 params {
61 @in id: uint; [[Notification ID]]
62 }
63 }
64 }
65}
66