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 */
16 typedef struct E_Notification_Image E_Notification_Image;
17 typedef struct E_Notification E_Notification;
18 typedef struct E_Notification_Action E_Notification_Action;
19 
20 typedef enum E_Notification_Urgency E_Notification_Urgency;
21 typedef enum E_Notification_Hint_Type E_Notification_Hint_Type;
22 typedef enum E_Notification_Closed_Reason E_Notification_Closed_Reason;
23 
24 /* method returns */
25 typedef struct E_Notification_Return_Notify E_Notification_Return_Notify;
26 typedef struct E_Notification_Return_Get_Capabilities E_Notification_Return_Get_Capabilities;
27 typedef struct E_Notification_Return_Get_Server_Information E_Notification_Return_Get_Server_Information;
28 
29 
30 /* signal events */
31 typedef struct E_Notification_Event_Action_Invoked E_Notification_Event_Action_Invoked;
32 typedef struct E_Notification_Event_Notification_Closed E_Notification_Event_Notification_Closed;
33 
34 /* enums */
35 
36 enum E_Notification_Urgency
37 {
38  E_NOTIFICATION_URGENCY_LOW,
39  E_NOTIFICATION_URGENCY_NORMAL,
40  E_NOTIFICATION_URGENCY_CRITICAL
41 };
42 
43 enum E_Notification_Closed_Reason
44 {
45  E_NOTIFICATION_CLOSED_EXPIRED,
46  E_NOTIFICATION_CLOSED_DISMISSED,
47  E_NOTIFICATION_CLOSED_REQUESTED,
48  E_NOTIFICATION_CLOSED_UNDEFINED
49 };
50 
51 enum E_Notification_Hint_Type
52 {
53  E_NOTIFICATION_HINT_URGENCY = (1 << 0),
54  E_NOTIFICATION_HINT_CATEGORY = (1 << 1),
55  E_NOTIFICATION_HINT_DESKTOP = (1 << 2),
56  E_NOTIFICATION_HINT_SOUND_FILE = (1 << 3),
57  E_NOTIFICATION_HINT_TRANSIENT = (1 << 4),
58  E_NOTIFICATION_HINT_RESIDENT = (1 << 5),
59  E_NOTIFICATION_HINT_ACTION_ICONS = (1 << 6),
60  E_NOTIFICATION_HINT_SUPPRESS_SOUND = 0x10,
61  E_NOTIFICATION_HINT_XY = 0x20,
62  E_NOTIFICATION_HINT_IMAGE_DATA = 0x40
63 };
64 
65 /* client method returns */
66 struct E_Notification_Return_Notify
67 {
68  unsigned int notification_id;
69  E_Notification *notification;
70 };
71 
72 struct E_Notification_Return_Get_Capabilities
73 {
74  Eina_List *capabilities;
75 };
76 
77 struct E_Notification_Return_Get_Server_Information
78 {
79  const char *name;
80  const char *vendor;
81  const char *version;
82  const char *spec_version;
83 };
84 
85 /* signals */
86 struct E_Notification_Event_Notification_Closed
87 {
88  unsigned int notification_id;
89  E_Notification_Closed_Reason reason;
90 };
91 
92 struct E_Notification_Event_Action_Invoked
93 {
94  unsigned int notification_id;
95  char *action_id;
96 };
97 
98 #ifdef __cplusplus
99 extern "C" {
100 #endif
101 
102  EAPI int e_notification_init(void);
103  EAPI int e_notification_shutdown(void);
104 
105 /* client */
106  EAPI void e_notification_send(E_Notification *n, E_DBus_Callback_Func func, void *data);
107  EAPI void e_notification_get_capabilities(E_DBus_Callback_Func func, void *data);
108  EAPI void e_notification_get_server_information(E_DBus_Callback_Func func, void *data);
109 
110 
111 /* Notifications */
112 
113  EAPI E_Notification *e_notification_new(void);
114  EAPI void e_notification_ref(E_Notification *n);
115  EAPI void e_notification_unref(E_Notification *n);
116  EAPI void e_notification_free(E_Notification *n);
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);
137  EAPI const char *e_notification_app_name_get(E_Notification *n);
138  EAPI const char *e_notification_app_icon_get(E_Notification *n);
139  EAPI const char *e_notification_summary_get(E_Notification *n);
140  EAPI const char *e_notification_body_get(E_Notification *n);
141  EAPI int e_notification_replaces_id_get(E_Notification *note);
142  EAPI int e_notification_timeout_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);
147  EAPI Eina_List *e_notification_actions_get(E_Notification *n);
148  EAPI const char *e_notification_action_id_get(E_Notification_Action *a);
149  EAPI const char *e_notification_action_name_get(E_Notification_Action *a);
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);
156  EAPI void e_notification_hint_urgency_set(E_Notification *n, char urgency);
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);
162  EAPI void e_notification_hint_image_data_set(E_Notification *n, E_Notification_Image *image);
163 
164 /* hint accessors */
165  EAPI char e_notification_hint_urgency_get(E_Notification *n);
166  EAPI const char *e_notification_hint_category_get(E_Notification *n);
167  EAPI const char *e_notification_hint_desktop_get(E_Notification *n);
168  EAPI const char *e_notification_hint_sound_file_get(E_Notification *n);
169  EAPI const char *e_notification_hint_image_path_get(E_Notification *n);
170  EAPI char e_notification_hint_suppress_sound_get(E_Notification *n);
171  EAPI int e_notification_hint_xy_get(E_Notification *n, int *x, int *y);
172  EAPI E_Notification_Image *e_notification_hint_image_data_get(E_Notification *n);
173  /* icon_data is deprecated, we do not support setting it */
174  EAPI E_Notification_Image *e_notification_hint_icon_data_get(E_Notification *n);
175 
176 /* image hint */
177  EAPI E_Notification_Image *e_notification_image_new(void);
178  EAPI void e_notification_image_free(E_Notification_Image *img);
179  EAPI Eina_Bool e_notification_image_init(E_Notification_Image *img, Evas_Object *obj) EINA_WARN_UNUSED_RESULT;
180  EAPI Evas_Object *e_notification_image_evas_object_add(Evas *evas, E_Notification_Image *img);
181 
182 #ifdef __cplusplus
183 }
184 #endif
185 
190 #endif