src/core/gtd-provider.h


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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208

/* gtd-storage.h
 *
 * Copyright (C) 2015-2020 Georges Basile Stavracas Neto <georges.stavracas@gmail.com>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef GTD_PROVIDER_H
#define GTD_PROVIDER_H

#include "gtd-object.h"
#include "gtd-types.h"

#include <gio/gio.h>
#include <glib.h>

G_BEGIN_DECLS

#define GTD_TYPE_PROVIDER (gtd_provider_get_type ())

G_DECLARE_INTERFACE (GtdProvider, gtd_provider, GTD, PROVIDER, GtdObject)

struct _GtdProviderInterface
{
  GTypeInterface parent;

  /* Information */
  const gchar*       (*get_id)                                   (GtdProvider        *provider);

  const gchar*       (*get_name)                                 (GtdProvider        *provider);

  const gchar*       (*get_provider_type)                        (GtdProvider        *provider);

  const gchar*       (*get_description)                          (GtdProvider        *provider);

  gboolean           (*get_enabled)                              (GtdProvider        *provider);

  void               (*refresh)                                  (GtdProvider        *provider);

  /* Customs */
  GIcon*             (*get_icon)                                 (GtdProvider        *provider);

  /* Tasks */
  void               (*create_task)                              (GtdProvider        *provider,
                                                                  GtdTaskList        *list,
                                                                  const gchar        *title,
                                                                  GDateTime          *due_date,
                                                                  GCancellable       *cancellable,
                                                                  GAsyncReadyCallback callback,
                                                                  gpointer            user_data);

  GtdTask*           (*create_task_finish)                       (GtdProvider        *self,
                                                                  GAsyncResult       *result,
                                                                  GError            **error);

  void               (*update_task)                              (GtdProvider        *provider,
                                                                  GtdTask            *task,
                                                                  GCancellable       *cancellable,
                                                                  GAsyncReadyCallback callback,
                                                                  gpointer            user_data);

  gboolean           (*update_task_finish)                       (GtdProvider        *self,
                                                                  GAsyncResult       *result,
                                                                  GError            **error);

  void               (*remove_task)                              (GtdProvider        *provider,
                                                                  GtdTask            *task,
                                                                  GCancellable       *cancellable,
                                                                  GAsyncReadyCallback callback,
                                                                  gpointer            user_data);

  gboolean           (*remove_task_finish)                       (GtdProvider        *self,
                                                                  GAsyncResult       *result,
                                                                  GError            **error);

  /* Task lists */
  void               (*create_task_list)                         (GtdProvider        *provider,
                                                                  const gchar        *name,
                                                                  GCancellable       *cancellable,
                                                                  GAsyncReadyCallback callback,
                                                                  gpointer            user_data);

  gboolean           (*create_task_list_finish)                  (GtdProvider        *self,
                                                                  GAsyncResult       *result,
                                                                  GError            **error);

  void               (*update_task_list)                         (GtdProvider        *provider,
                                                                  GtdTaskList        *list,
                                                                  GCancellable       *cancellable,
                                                                  GAsyncReadyCallback callback,
                                                                  gpointer            user_data);

  gboolean           (*update_task_list_finish)                  (GtdProvider        *self,
                                                                  GAsyncResult       *result,
                                                                  GError            **error);

  void               (*remove_task_list)                         (GtdProvider        *provider,
                                                                  GtdTaskList        *list,
                                                                  GCancellable       *cancellable,
                                                                  GAsyncReadyCallback callback,
                                                                  gpointer            user_data);

  gboolean           (*remove_task_list_finish)                  (GtdProvider        *self,
                                                                  GAsyncResult       *result,
                                                                  GError            **error);

  GList*             (*get_task_lists)                           (GtdProvider        *provider);

  GtdTaskList*       (*get_inbox)                                (GtdProvider        *provider);
};

const gchar*         gtd_provider_get_id                         (GtdProvider        *provider);

const gchar*         gtd_provider_get_name                       (GtdProvider        *provider);

const gchar*         gtd_provider_get_provider_type              (GtdProvider        *provider);

const gchar*         gtd_provider_get_description                (GtdProvider        *provider);

gboolean             gtd_provider_get_enabled                    (GtdProvider        *provider);

void                 gtd_provider_refresh                        (GtdProvider        *provider);

GIcon*               gtd_provider_get_icon                       (GtdProvider        *provider);

void                 gtd_provider_create_task                    (GtdProvider        *provider,
                                                                  GtdTaskList        *list,
                                                                  const gchar        *title,
                                                                  GDateTime          *due_date,
                                                                  GCancellable       *cancellable,
                                                                  GAsyncReadyCallback callback,
                                                                  gpointer            user_data);

GtdTask*             gtd_provider_create_task_finish             (GtdProvider        *self,
                                                                  GAsyncResult       *result,
                                                                  GError            **error);

void                 gtd_provider_update_task                    (GtdProvider        *provider,
                                                                  GtdTask            *task,
                                                                  GCancellable       *cancellable,
                                                                  GAsyncReadyCallback callback,
                                                                  gpointer            user_data);

gboolean             gtd_provider_update_task_finish             (GtdProvider        *self,
                                                                  GAsyncResult       *result,
                                                                  GError            **error);

void                 gtd_provider_remove_task                    (GtdProvider        *provider,
                                                                  GtdTask            *task,
                                                                  GCancellable       *cancellable,
                                                                  GAsyncReadyCallback callback,
                                                                  gpointer            user_data);

gboolean             gtd_provider_remove_task_finish             (GtdProvider        *self,
                                                                  GAsyncResult       *result,
                                                                  GError            **error);

void                 gtd_provider_create_task_list               (GtdProvider        *provider,
                                                                  const gchar        *name,
                                                                  GCancellable       *cancellable,
                                                                  GAsyncReadyCallback callback,
                                                                  gpointer            user_data);

gboolean             gtd_provider_create_task_list_finish        (GtdProvider        *self,
                                                                  GAsyncResult       *result,
                                                                  GError            **error);

void                 gtd_provider_update_task_list               (GtdProvider        *provider,
                                                                  GtdTaskList        *list,
                                                                  GCancellable       *cancellable,
                                                                  GAsyncReadyCallback callback,
                                                                  gpointer            user_data);

gboolean             gtd_provider_update_task_list_finish        (GtdProvider        *self,
                                                                  GAsyncResult       *result,
                                                                  GError            **error);

void                 gtd_provider_remove_task_list               (GtdProvider        *provider,
                                                                  GtdTaskList        *list,
                                                                  GCancellable       *cancellable,
                                                                  GAsyncReadyCallback callback,
                                                                  gpointer            user_data);

gboolean             gtd_provider_remove_task_list_finish        (GtdProvider        *self,
                                                                  GAsyncResult       *result,
                                                                  GError            **error);

GList*               gtd_provider_get_task_lists                 (GtdProvider        *provider);

GtdTaskList*         gtd_provider_get_inbox                      (GtdProvider        *provider);

gint                 gtd_provider_compare                        (GtdProvider        *a,
                                                                  GtdProvider        *b);

G_END_DECLS

#endif /* GTD_PROVIDER_H */