aboutsummaryrefslogtreecommitdiffstats
path: root/e-util/e-photo-source.h
diff options
context:
space:
mode:
authorMatthew Barnes <mbarnes@redhat.com>2013-04-19 20:15:03 +0800
committerMatthew Barnes <mbarnes@redhat.com>2013-04-24 08:06:01 +0800
commit5991b04ac5b48980f4d384951d619b3ec696e17f (patch)
treedebdc2e3667ccfa13af2248cc8c0f1536d907a88 /e-util/e-photo-source.h
parentc64602b39797e4d1ffdc23766b2caaf5a0be000b (diff)
downloadgsoc2013-evolution-5991b04ac5b48980f4d384951d619b3ec696e17f.tar
gsoc2013-evolution-5991b04ac5b48980f4d384951d619b3ec696e17f.tar.gz
gsoc2013-evolution-5991b04ac5b48980f4d384951d619b3ec696e17f.tar.bz2
gsoc2013-evolution-5991b04ac5b48980f4d384951d619b3ec696e17f.tar.lz
gsoc2013-evolution-5991b04ac5b48980f4d384951d619b3ec696e17f.tar.xz
gsoc2013-evolution-5991b04ac5b48980f4d384951d619b3ec696e17f.tar.zst
gsoc2013-evolution-5991b04ac5b48980f4d384951d619b3ec696e17f.zip
Add EPhotoSource interface.
EPhotoSource is an interface used to extend the functionality of EPhotoCache. You can add an object implementing EPhotoSource to an EPhotoCache with e_photo_cache_add_photo_source() and remove it with e_photo_cache_remove_photo_source(). When EPhotoCache needs a photo for an email address, it will invoke e_photo_source_get_photo() on all available EPhotoSource objects simultaneously and select one photo.
Diffstat (limited to 'e-util/e-photo-source.h')
-rw-r--r--e-util/e-photo-source.h76
1 files changed, 76 insertions, 0 deletions
diff --git a/e-util/e-photo-source.h b/e-util/e-photo-source.h
new file mode 100644
index 0000000000..dfbaf2618d
--- /dev/null
+++ b/e-util/e-photo-source.h
@@ -0,0 +1,76 @@
+/*
+ * e-photo-source.h
+ *
+ * This program 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; either
+ * version 2 of the License, or (at your option) version 3.
+ *
+ * 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
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with the program; if not, see <http://www.gnu.org/licenses/>
+ *
+ */
+
+#if !defined (__E_UTIL_H_INSIDE__) && !defined (LIBEUTIL_COMPILATION)
+#error "Only <e-util/e-util.h> should be included directly."
+#endif
+
+#ifndef E_PHOTO_SOURCE_H
+#define E_PHOTO_SOURCE_H
+
+#include <gio/gio.h>
+
+/* Standard GObject macros */
+#define E_TYPE_PHOTO_SOURCE \
+ (e_photo_source_get_type ())
+#define E_PHOTO_SOURCE(obj) \
+ (G_TYPE_CHECK_INSTANCE_CAST \
+ ((obj), E_TYPE_PHOTO_SOURCE, EPhotoSource))
+#define E_IS_PHOTO_SOURCE(obj) \
+ (G_TYPE_CHECK_INSTANCE_TYPE \
+ ((obj), E_TYPE_PHOTO_SOURCE))
+#define E_PHOTO_SOURCE_GET_INTERFACE(obj) \
+ (G_TYPE_INSTANCE_GET_INTERFACE \
+ ((obj), E_TYPE_PHOTO_SOURCE, EPhotoSourceInterface))
+
+G_BEGIN_DECLS
+
+typedef struct _EPhotoSource EPhotoSource;
+typedef struct _EPhotoSourceInterface EPhotoSourceInterface;
+
+struct _EPhotoSourceInterface {
+ GTypeInterface parent_interface;
+
+ void (*get_photo) (EPhotoSource *photo_source,
+ const gchar *email_address,
+ GCancellable *cancellable,
+ GAsyncReadyCallback callback,
+ gpointer user_data);
+ gboolean (*get_photo_finish) (EPhotoSource *photo_source,
+ GAsyncResult *result,
+ GInputStream **out_stream,
+ gint *out_priority,
+ GError **error);
+};
+
+GType e_photo_source_get_type (void) G_GNUC_CONST;
+void e_photo_source_get_photo (EPhotoSource *photo_source,
+ const gchar *email_address,
+ GCancellable *cancellable,
+ GAsyncReadyCallback callback,
+ gpointer user_data);
+gboolean e_photo_source_get_photo_finish (EPhotoSource *photo_source,
+ GAsyncResult *result,
+ GInputStream **out_stream,
+ gint *out_priority,
+ GError **error);
+
+G_END_DECLS
+
+#endif /* E_PHOTO_SOURCE_H */
+