summaryrefslogtreecommitdiff
path: root/tumbler/tumbler-thumbnailer.h
diff options
context:
space:
mode:
authorJannis Pohlmann <jannis@xfce.org>2009-06-08 20:31:41 +0200
committerJannis Pohlmann <jannis@xfce.org>2009-06-08 20:31:41 +0200
commit9d5f1b7b03bd0ad50365fa8186a0d9bce690f31d (patch)
tree9aed893b732fd3266c52fdbed77a1ac754199879 /tumbler/tumbler-thumbnailer.h
parent04bb883f2b53aea6f848672ee7dea42cf7a6af86 (diff)
downloadtumbler-9d5f1b7b03bd0ad50365fa8186a0d9bce690f31d.tar.gz
Add plugin interface for cache and thumbnailer implementations.
This is a major refactoring of the source code. Amongst others, the classes TumblerProviderFactory, TumblerThumbnailer, TumblerAbstractThumbnailer, TumblerThumbnailerProvider, TumblerCache, TumblerCacheProvider and TumblerFileInfo have been added. From now on tumbler supports different storage backends and thumbnailers as plugins. Storage backends have to implement TumblerCache, thumbnailers have to implement TumblerThumbnailer. Plugins have to implement three methods: tumbler_plugin_initialize(), tumbler_plugin_shutdown() and tumbler_plugin_get_types(). The latter is expected to return a list of provider types for cache or thumbnailer implementations. Two example plugins have been added, one for the XDG thumbnail cache and one for a GdkPixbuf based thumbnailer. The code of tumblerd was updated to reflect these changes in libtumbler.
Diffstat (limited to 'tumbler/tumbler-thumbnailer.h')
-rw-r--r--tumbler/tumbler-thumbnailer.h76
1 files changed, 76 insertions, 0 deletions
diff --git a/tumbler/tumbler-thumbnailer.h b/tumbler/tumbler-thumbnailer.h
new file mode 100644
index 0000000..e283a1d
--- /dev/null
+++ b/tumbler/tumbler-thumbnailer.h
@@ -0,0 +1,76 @@
+/* vi:set et ai sw=2 sts=2 ts=2: */
+/*-
+ * Copyright (c) 2009 Jannis Pohlmann <jannis@xfce.org>
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Library General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * 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 Library General Public License for more details.
+ *
+ * You should have received a copy of the GNU Library General
+ * Public License along with this library; if not, write to the
+ * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
+ */
+
+#if !defined (TUMBLER_INSIDE_TUMBLER_H) && !defined (TUMBLER_COMPILATION)
+#error "Only <tumbler/tumbler.h> may be included directly. This file might disappear or change contents."
+#endif
+
+#ifndef __TUMBLER_THUMBNAILER_H__
+#define __TUMBLER_THUMBNAILER_H__
+
+#include <glib-object.h>
+
+G_BEGIN_DECLS
+
+#define TUMBLER_TYPE_THUMBNAILER (tumbler_thumbnailer_get_type ())
+#define TUMBLER_THUMBNAILER(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), TUMBLER_TYPE_THUMBNAILER, TumblerThumbnailer))
+#define TUMBLER_IS_THUMBNAILER(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), TUMBLER_TYPE_THUMBNAILER))
+#define TUMBLER_THUMBNAILER_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), TUMBLER_TYPE_THUMBNAILER, TumblerThumbnailerIface))
+
+typedef struct _TumblerThumbnailer TumblerThumbnailer;
+typedef struct _TumblerThumbnailerIface TumblerThumbnailerIface;
+
+struct _TumblerThumbnailerIface
+{
+ GTypeInterface __parent__;
+
+ /* signals */
+ void (*ready) (TumblerThumbnailer *thumbnailer,
+ const gchar *uri);
+ void (*error) (TumblerThumbnailer *thumbnailer,
+ const gchar *failed_uri,
+ gint error_code,
+ const gchar *message);
+ void (*unregister) (TumblerThumbnailer *thumbnailer);
+
+ /* virtual methods */
+ void (*create) (TumblerThumbnailer *thumbnailer,
+ const gchar *uri,
+ const gchar *mime_hint);
+};
+
+GType tumbler_thumbnailer_get_type (void) G_GNUC_CONST;
+
+void tumbler_thumbnailer_create (TumblerThumbnailer *thumbnailer,
+ const gchar *uri,
+ const gchar *mime_hint);
+
+GStrv tumbler_thumbnailer_get_hash_keys (TumblerThumbnailer *thumbnailer);
+GStrv tumbler_thumbnailer_get_mime_types (TumblerThumbnailer *thumbnailer);
+GStrv tumbler_thumbnailer_get_uri_schemes (TumblerThumbnailer *thumbnailer);
+
+TumblerThumbnailer **tumbler_thumbnailer_array_copy (TumblerThumbnailer **thumbnailers,
+ gint length);
+void tumbler_thumbnailer_array_free (TumblerThumbnailer **thumbnailers,
+ gint length);
+
+G_END_DECLS
+
+#endif /* !__TUMBLER_THUMBNAILER_H__ */