summaryrefslogtreecommitdiff
path: root/src/lib/elementary/elm_sys_notify_interface_eo.h
blob: 0c91b0135d3cc719fbf9ef055c62ccd9d5ac97c8 (plain)
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
#ifndef _ELM_SYS_NOTIFY_INTERFACE_EO_H_
#define _ELM_SYS_NOTIFY_INTERFACE_EO_H_

#ifndef _ELM_SYS_NOTIFY_INTERFACE_EO_CLASS_TYPE
#define _ELM_SYS_NOTIFY_INTERFACE_EO_CLASS_TYPE

typedef Eo Elm_Sys_Notify_Interface;

#endif

#ifndef _ELM_SYS_NOTIFY_INTERFACE_EO_TYPES
#define _ELM_SYS_NOTIFY_INTERFACE_EO_TYPES

/** Urgency levels of a notification
 *
 * @since 1.8
 *
 * @ingroup Elm_Sys_Notify
 */
typedef enum
{
  ELM_SYS_NOTIFY_URGENCY_LOW = 0, /**< Low urgency */
  ELM_SYS_NOTIFY_URGENCY_NORMAL, /**< Normal urgency */
  ELM_SYS_NOTIFY_URGENCY_CRITICAL /**< Critical urgency */
} Elm_Sys_Notify_Urgency;


#endif
/** Elementary system notify interface
 *
 * @ingroup Elm_Sys_Notify_Interface
 */
#define ELM_SYS_NOTIFY_INTERFACE_INTERFACE elm_sys_notify_interface_interface_get()

EWAPI const Efl_Class *elm_sys_notify_interface_interface_get(void);

/**
 * @brief Causes a notification to be forcefully closed and removed from the
 * user's view. It can be used, for example, in the event that what the
 * notification pertains to is no longer relevant, or to cancel a notification
 * with no expiration time.
 *
 * @param[in] obj The object.
 * @param[in] replaces_id Notification ID that this notification replaces. The
 * value 0 means a new notification.
 * @param[in] icon The optional program icon of the calling application
 * @param[in] summary The summary text briefly describing the notification
 * @param[in] body The optional detailed body text. Can be empty
 * @param[in] urgency The urgency level
 * @param[in] timeout Timeout display in milliseconds
 * @param[in] cb Callback used to retrieve the notification id returned by the
 * Notification Server
 * @param[in] cb_data Optional context data
 *
 * @since 1.8
 *
 * @ingroup Elm_Sys_Notify_Interface
 */
EOAPI void elm_obj_sys_notify_interface_send(const Eo *obj, unsigned int replaces_id, const char *icon, const char *summary, const char *body, Elm_Sys_Notify_Urgency urgency, int timeout, Elm_Sys_Notify_Send_Cb cb, const void *cb_data);

/**
 * @brief Create a new notification just with Icon, Body and Summary. It is a
 * helper that wraps the send method
 *
 * @param[in] obj The object.
 * @param[in] icon The optional program icon of the calling application
 * @param[in] summary The summary text briefly describing the notification
 * @param[in] body The optional detailed body text. Can be empty
 *
 * @since 1.16
 *
 * @ingroup Elm_Sys_Notify_Interface
 */
EOAPI void elm_obj_sys_notify_interface_simple_send(const Eo *obj, const char *icon, const char *summary, const char *body);

/**
 * @brief Causes a notification to be forcefully closed and removed from the
 * user's view. It can be used, for example, in the event that what the
 * notification  pertains to is no longer relevant, or to cancel a notification
 * with no expiration time.
 *
 * @param[in] obj The object.
 * @param[in] id Notification ID
 *
 * @since 1.8
 *
 * @ingroup Elm_Sys_Notify_Interface
 */
EOAPI void elm_obj_sys_notify_interface_close(const Eo *obj, unsigned int id);

#endif