E_Notify.h
Go to the documentation of this file.
1#ifndef E_NOTIFY_H
2#define E_NOTIFY_H
3
4#include <Eina.h>
5#include <Evas.h>
6#include <E_DBus.h>
7
15/* notifications */
19
23
24/* method returns */
28
29
30/* signal events */
33
34/* enums */
35
37{
41};
42
44{
49};
50
52{
63};
64
65/* client method returns */
67{
68 unsigned int notification_id;
70};
71
73{
74 Eina_List *capabilities;
75};
76
78{
79 const char *name;
80 const char *vendor;
81 const char *version;
82 const char *spec_version;
83};
84
85/* signals */
87{
88 unsigned int notification_id;
90};
91
93{
94 unsigned int notification_id;
95 char *action_id;
96};
97
98#ifdef __cplusplus
99extern "C" {
100#endif
101
102 EAPI int e_notification_init(void);
104
105/* client */
109
110
111/* Notifications */
112
117
118 EAPI E_Notification *e_notification_full_new(const char *app_name,
119 unsigned int replaces_id,
120 const char *app_icon,
121 const char *summary,
122 const char *body,
123 int expire_timeout);
124
125/* notification mutators */
126 EAPI void e_notification_id_set(E_Notification *note, unsigned int id);
127 EAPI void e_notification_app_name_set(E_Notification *n, const char *app_name);
128 EAPI void e_notification_app_icon_set(E_Notification *n, const char *app_icon);
129 EAPI void e_notification_summary_set(E_Notification *n, const char *summary);
130 EAPI void e_notification_body_set(E_Notification *n, const char *body);
131 EAPI void e_notification_replaces_id_set(E_Notification *n, int replaces_id);
132 EAPI void e_notification_timeout_set(E_Notification *n, int timeout);
133 EAPI void e_notification_closed_set(E_Notification *note, unsigned char closed);
134
135/* notification accessors */
136 EAPI unsigned int e_notification_id_get(E_Notification *note);
143 EAPI unsigned char e_notification_closed_get(E_Notification *note);
144
145/* actions */
146 EAPI void e_notification_action_add(E_Notification *n, const char *action_id, const char *action_name);
150
151/* hint mutators */
152 EAPI void e_notification_hint_transient_set(E_Notification *n, Eina_Bool transient);
153 EAPI void e_notification_hint_resident_set(E_Notification *n, Eina_Bool resident);
154 EAPI void e_notification_hint_action_icons_set(E_Notification *n, Eina_Bool action_icons);
155 EAPI void e_notification_hint_image_path_set(E_Notification *n, const char *path);
157 EAPI void e_notification_hint_category_set(E_Notification *n, const char *category);
158 EAPI void e_notification_hint_desktop_set(E_Notification *n, const char *desktop);
159 EAPI void e_notification_hint_sound_file_set(E_Notification *n, const char *sound_file);
160 EAPI void e_notification_hint_suppress_sound_set(E_Notification *n, char suppress_sound);
161 EAPI void e_notification_hint_xy_set(E_Notification *n, int x, int y);
163
164/* hint accessors */
171 EAPI int e_notification_hint_xy_get(E_Notification *n, int *x, int *y);
173 /* icon_data is deprecated, we do not support setting it */
175
176/* image hint */
181
182#ifdef __cplusplus
183}
184#endif
185
190#endif
#define EAPI
Definition: E_DBus.h:44
EAPI Eina_Bool EINA_WARN_UNUSED_RESULT
Definition: E_Bluez.h:85
void(* E_DBus_Callback_Func)(void *user_data, void *method_return, DBusError *error)
Definition: E_DBus.h:135
EAPI E_Notification_Image * e_notification_hint_image_data_get(E_Notification *n)
Definition: notification.c:413
EAPI void e_notification_hint_image_path_set(E_Notification *n, const char *path)
Definition: notification.c:306
EAPI Eina_Bool e_notification_image_init(E_Notification_Image *img, Evas_Object *obj) EINA_WARN_UNUSED_RESULT
Definition: notification.c:438
EAPI void e_notification_free(E_Notification *n)
Definition: notification.c:72
EAPI void e_notification_replaces_id_set(E_Notification *n, int replaces_id)
Definition: notification.c:142
EAPI unsigned int e_notification_id_get(E_Notification *note)
Definition: notification.c:164
EAPI void e_notification_id_set(E_Notification *note, unsigned int id)
Definition: notification.c:94
EAPI const char * e_notification_action_id_get(E_Notification_Action *a)
Definition: notification.c:251
E_Notification_Hint_Type
Definition: E_Notify.h:52
EAPI const char * e_notification_body_get(E_Notification *n)
Definition: notification.c:192
EAPI int e_notification_replaces_id_get(E_Notification *note)
Definition: notification.c:206
EAPI void e_notification_image_free(E_Notification_Image *img)
Definition: notification.c:487
EAPI void e_notification_ref(E_Notification *n)
Definition: notification.c:58
EAPI const char * e_notification_summary_get(E_Notification *n)
Definition: notification.c:185
EAPI E_Notification_Image * e_notification_image_new(void)
Definition: notification.c:427
EAPI const char * e_notification_app_icon_get(E_Notification *n)
Definition: notification.c:178
EAPI int e_notification_shutdown(void)
Definition: client.c:24
E_Notification_Urgency
Definition: E_Notify.h:37
E_Notification_Closed_Reason
Definition: E_Notify.h:44
EAPI void e_notification_hint_urgency_set(E_Notification *n, char urgency)
Definition: notification.c:298
EAPI void e_notification_body_set(E_Notification *n, const char *body)
Definition: notification.c:122
EAPI const char * e_notification_action_name_get(E_Notification_Action *a)
Definition: notification.c:259
EAPI void e_notification_unref(E_Notification *n)
Definition: notification.c:65
EAPI void e_notification_hint_desktop_set(E_Notification *n, const char *desktop)
Definition: notification.c:321
EAPI void e_notification_get_capabilities(E_DBus_Callback_Func func, void *data)
Definition: client.c:45
EAPI unsigned char e_notification_closed_get(E_Notification *note)
Definition: notification.c:220
EAPI void e_notification_summary_set(E_Notification *n, const char *summary)
Definition: notification.c:115
EAPI const char * e_notification_hint_desktop_get(E_Notification *n)
Definition: notification.c:375
EAPI void e_notification_app_name_set(E_Notification *n, const char *app_name)
Definition: notification.c:101
EAPI char e_notification_hint_urgency_get(E_Notification *n)
Definition: notification.c:361
EAPI void e_notification_get_server_information(E_DBus_Callback_Func func, void *data)
Definition: client.c:55
EAPI void e_notification_hint_action_icons_set(E_Notification *n, Eina_Bool action_icons)
Definition: notification.c:288
EAPI void e_notification_hint_image_data_set(E_Notification *n, E_Notification_Image *image)
Definition: notification.c:354
EAPI Evas_Object * e_notification_image_evas_object_add(Evas *evas, E_Notification_Image *img)
Definition: notification.c:542
EAPI void e_notification_hint_transient_set(E_Notification *n, Eina_Bool transient)
Definition: notification.c:268
EAPI E_Notification_Image * e_notification_hint_icon_data_get(E_Notification *n)
Definition: notification.c:420
EAPI void e_notification_action_add(E_Notification *n, const char *action_id, const char *action_name)
Definition: notification.c:129
EAPI const char * e_notification_hint_sound_file_get(E_Notification *n)
Definition: notification.c:389
EAPI E_Notification * e_notification_full_new(const char *app_name, unsigned int replaces_id, const char *app_icon, const char *summary, const char *body, int expire_timeout)
Definition: notification.c:25
EAPI void e_notification_app_icon_set(E_Notification *n, const char *app_icon)
Definition: notification.c:108
EAPI const char * e_notification_hint_category_get(E_Notification *n)
Definition: notification.c:368
EAPI char e_notification_hint_suppress_sound_get(E_Notification *n)
Definition: notification.c:396
EAPI void e_notification_hint_sound_file_set(E_Notification *n, const char *sound_file)
Definition: notification.c:329
EAPI void e_notification_hint_category_set(E_Notification *n, const char *category)
Definition: notification.c:313
EAPI int e_notification_hint_xy_get(E_Notification *n, int *x, int *y)
Definition: notification.c:403
EAPI int e_notification_init(void)
Definition: client.c:8
EAPI const char * e_notification_app_name_get(E_Notification *n)
Definition: notification.c:171
EAPI void e_notification_hint_suppress_sound_set(E_Notification *n, char suppress_sound)
Definition: notification.c:337
EAPI int e_notification_timeout_get(E_Notification *note)
Definition: notification.c:213
EAPI const char * e_notification_hint_image_path_get(E_Notification *n)
Definition: notification.c:382
EAPI void e_notification_timeout_set(E_Notification *n, int timeout)
Definition: notification.c:149
EAPI void e_notification_send(E_Notification *n, E_DBus_Callback_Func func, void *data)
Definition: client.c:35
EAPI void e_notification_closed_set(E_Notification *note, unsigned char closed)
Definition: notification.c:156
EAPI void e_notification_hint_xy_set(E_Notification *n, int x, int y)
Definition: notification.c:345
EAPI void e_notification_hint_resident_set(E_Notification *n, Eina_Bool resident)
Definition: notification.c:278
EAPI Eina_List * e_notification_actions_get(E_Notification *n)
Definition: notification.c:199
EAPI E_Notification * e_notification_new(void)
Definition: notification.c:45
@ E_NOTIFICATION_HINT_XY
Definition: E_Notify.h:61
@ E_NOTIFICATION_HINT_SOUND_FILE
Definition: E_Notify.h:56
@ E_NOTIFICATION_HINT_ACTION_ICONS
Definition: E_Notify.h:59
@ E_NOTIFICATION_HINT_URGENCY
Definition: E_Notify.h:53
@ E_NOTIFICATION_HINT_RESIDENT
Definition: E_Notify.h:58
@ E_NOTIFICATION_HINT_TRANSIENT
Definition: E_Notify.h:57
@ E_NOTIFICATION_HINT_DESKTOP
Definition: E_Notify.h:55
@ E_NOTIFICATION_HINT_IMAGE_DATA
Definition: E_Notify.h:62
@ E_NOTIFICATION_HINT_SUPPRESS_SOUND
Definition: E_Notify.h:60
@ E_NOTIFICATION_HINT_CATEGORY
Definition: E_Notify.h:54
@ E_NOTIFICATION_URGENCY_LOW
Definition: E_Notify.h:38
@ E_NOTIFICATION_URGENCY_NORMAL
Definition: E_Notify.h:39
@ E_NOTIFICATION_URGENCY_CRITICAL
Definition: E_Notify.h:40
@ E_NOTIFICATION_CLOSED_UNDEFINED
Definition: E_Notify.h:48
@ E_NOTIFICATION_CLOSED_EXPIRED
Definition: E_Notify.h:45
@ E_NOTIFICATION_CLOSED_DISMISSED
Definition: E_Notify.h:46
@ E_NOTIFICATION_CLOSED_REQUESTED
Definition: E_Notify.h:47
Definition: e_notify_private.h:104
Definition: E_Notify.h:93
char * action_id
Definition: E_Notify.h:95
unsigned int notification_id
Definition: E_Notify.h:94
E_Notification_Closed_Reason reason
Definition: E_Notify.h:89
unsigned int notification_id
Definition: E_Notify.h:88
Definition: e_notify_private.h:62
Eina_List * capabilities
Definition: E_Notify.h:74
const char * spec_version
Definition: E_Notify.h:82
const char * name
Definition: E_Notify.h:79
const char * vendor
Definition: E_Notify.h:80
const char * version
Definition: E_Notify.h:81
Definition: E_Notify.h:67
unsigned int notification_id
Definition: E_Notify.h:68
E_Notification * notification
Definition: E_Notify.h:69
Definition: e_notify_private.h:73