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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
|
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/*
* Copyright (C) 2018 Red Hat, Inc. (www.redhat.com)
*
* This library is free software: you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
* for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
#if !defined (__LIBECAL_H_INSIDE__) && !defined (LIBECAL_COMPILATION)
#error "Only <libecal/libecal.h> should be included directly."
#endif
#ifndef E_REMINDER_WATCHER_H
#define E_REMINDER_WATCHER_H
#include <libedataserver/libedataserver.h>
#include <libecal/e-cal-client.h>
/* Standard GObject macros */
#define E_TYPE_REMINDER_WATCHER \
(e_reminder_watcher_get_type ())
#define E_REMINDER_WATCHER(obj) \
(G_TYPE_CHECK_INSTANCE_CAST \
((obj), E_TYPE_REMINDER_WATCHER, EReminderWatcher))
#define E_REMINDER_WATCHER_CLASS(cls) \
(G_TYPE_CHECK_CLASS_CAST \
((cls), E_TYPE_REMINDER_WATCHER, EReminderWatcherClass))
#define E_IS_REMINDER_WATCHER(obj) \
(G_TYPE_CHECK_INSTANCE_TYPE \
((obj), E_TYPE_REMINDER_WATCHER))
#define E_IS_REMINDER_WATCHER_CLASS(cls) \
(G_TYPE_CHECK_CLASS_TYPE \
((cls), E_TYPE_REMINDER_WATCHER))
#define E_REMINDER_WATCHER_GET_CLASS(obj) \
(G_TYPE_INSTANCE_GET_CLASS \
((obj), E_TYPE_REMINDER_WATCHER, EReminderWatcherClass))
#define E_TYPE_REMINDER_DATA (e_reminder_data_get_type ())
#define E_TYPE_REMINDER_WATCHER_ZONE (e_reminder_watcher_zone_get_type ())
G_BEGIN_DECLS
/**
* EReminderData:
*
* Contains data related to single reminder occurrence.
*
* Since: 3.30
**/
typedef struct _EReminderData {
gchar *source_uid;
ECalComponent *component;
ECalComponentAlarmInstance instance;
} EReminderData;
GType e_reminder_data_get_type (void) G_GNUC_CONST;
EReminderData * e_reminder_data_new (const gchar *source_uid,
const ECalComponent *component,
const ECalComponentAlarmInstance *instance);
EReminderData * e_reminder_data_copy (const EReminderData *rd);
void e_reminder_data_free (gpointer rd); /* EReminderData * */
/**
* EReminderWatcherZone:
*
* A libical's icaltimezone encapsulated as a GBoxed type.
* It can be retyped into icaltimezone directly.
*
* Since: 3.30
**/
typedef icaltimezone EReminderWatcherZone;
GType e_reminder_watcher_zone_get_type(void) G_GNUC_CONST;
EReminderWatcherZone *
e_reminder_watcher_zone_copy (const EReminderWatcherZone *watcher_zone);
void e_reminder_watcher_zone_free (EReminderWatcherZone *watcher_zone);
typedef struct _EReminderWatcher EReminderWatcher;
typedef struct _EReminderWatcherClass EReminderWatcherClass;
typedef struct _EReminderWatcherPrivate EReminderWatcherPrivate;
/**
* EReminderWatcherDescribeFlags:
* @E_REMINDER_WATCHER_DESCRIBE_FLAG_NONE: None flags
* @E_REMINDER_WATCHER_DESCRIBE_FLAG_MARKUP: Returned description will contain
* also markup. Without it it'll be a plain text.
*
* Flags modifying behaviour of e_reminder_watcher_describe_data().
*
* Since: 3.30
**/
typedef enum { /*< flags >*/
E_REMINDER_WATCHER_DESCRIBE_FLAG_NONE = 0,
E_REMINDER_WATCHER_DESCRIBE_FLAG_MARKUP = (1 << 1)
} EReminderWatcherDescribeFlags;
/**
* EReminderWatcher:
*
* Contains only private data that should be read and manipulated using the
* functions below.
*
* Since: 3.30
**/
struct _EReminderWatcher {
/*< private >*/
GObject parent;
EReminderWatcherPrivate *priv;
};
struct _EReminderWatcherClass {
GObjectClass parent_class;
/* Virtual methods and signals */
void (* schedule_timer) (EReminderWatcher *watcher,
gint64 at_time);
void (* format_time) (EReminderWatcher *watcher,
const EReminderData *rd,
struct icaltimetype *itt,
gchar **inout_buffer,
gint buffer_size);
void (* triggered) (EReminderWatcher *watcher,
const GSList *reminders, /* EReminderData * */
gboolean snoozed);
void (* changed) (EReminderWatcher *watcher);
/* Padding for future expansion */
gpointer reserved[10];
};
GType e_reminder_watcher_get_type (void) G_GNUC_CONST;
EReminderWatcher *
e_reminder_watcher_new (ESourceRegistry *registry);
ESourceRegistry *
e_reminder_watcher_get_registry (EReminderWatcher *watcher);
ECalClient * e_reminder_watcher_ref_opened_client (EReminderWatcher *watcher,
const gchar *source_uid);
void e_reminder_watcher_set_default_zone (EReminderWatcher *watcher,
const icaltimezone *zone);
icaltimezone * e_reminder_watcher_dup_default_zone (EReminderWatcher *watcher);
gboolean e_reminder_watcher_get_timers_enabled (EReminderWatcher *watcher);
void e_reminder_watcher_set_timers_enabled (EReminderWatcher *watcher,
gboolean enabled);
gchar * e_reminder_watcher_describe_data (EReminderWatcher *watcher,
const EReminderData *rd,
guint32 flags); /* bit-or of EReminderWatcherDescribeFlags */
void e_reminder_watcher_timer_elapsed (EReminderWatcher *watcher);
GSList * e_reminder_watcher_dup_past (EReminderWatcher *watcher); /* EReminderData * */
GSList * e_reminder_watcher_dup_snoozed (EReminderWatcher *watcher); /* EReminderData * */
void e_reminder_watcher_snooze (EReminderWatcher *watcher,
const EReminderData *rd,
gint64 until);
void e_reminder_watcher_dismiss (EReminderWatcher *watcher,
const EReminderData *rd,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
gboolean e_reminder_watcher_dismiss_finish (EReminderWatcher *watcher,
GAsyncResult *result,
GError **error);
gboolean e_reminder_watcher_dismiss_sync (EReminderWatcher *watcher,
const EReminderData *rd,
GCancellable *cancellable,
GError **error);
void e_reminder_watcher_dismiss_all (EReminderWatcher *watcher,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
gboolean e_reminder_watcher_dismiss_all_finish (EReminderWatcher *watcher,
GAsyncResult *result,
GError **error);
gboolean e_reminder_watcher_dismiss_all_sync (EReminderWatcher *watcher,
GCancellable *cancellable,
GError **error);
G_END_DECLS
#endif /* E_REMINDER_WATCHER_H */
|
