add CajaWidgetViewProvider docs

2 files changed, 232 insertions, 0 deletions

diff --git a/libcaja-extension/caja-widget-view-provider.c b/libcaja-extension/caja-widget-view-provider.c
new file mode 100644
index 00000000..d678fb26
--- /dev/null
+++ b/libcaja-extension/caja-widget-view-provider.c
@@ -0,0 +1,153 @@
+/* vi: set sw=4 ts=4 wrap ai: */
+/*
+ * caja-widget-view-provider.c: This file is part of ____
+ *
+ * Copyright (C) 2019 yetist <yetist@yetipc>
+ *
+ *
+ * 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 2 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, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ * */
+
+#include <config.h>
+#include "caja-widget-view-provider.h"
+
+#include <glib-object.h>
+
+/**
+ * SECTION:caja-widget-view-provider
+ * @title: CajaWidgetViewProvider
+ * @short_description: Interface to provide widgets view.
+ * @include: libcaja-extension/caja-widget-view-provider.h
+ *
+ * #CajaWidgetViewProvider allows extension to provide widgets view
+ * in the file manager.
+ */
+
+static void
+caja_widget_view_provider_base_init (gpointer g_class)
+{
+}
+
+GType
+caja_widget_view_provider_get_type (void)
+{
+    static GType type = 0;
+
+    if (!type) {
+        const GTypeInfo info = {
+            sizeof (CajaWidgetViewProviderIface),
+            caja_widget_view_provider_base_init,
+            NULL,
+            NULL,
+            NULL,
+            NULL,
+            0,
+            0,
+            NULL
+        };
+
+        type = g_type_register_static (G_TYPE_INTERFACE,
+                                       "CajaWidgetViewProvider",
+                                       &info, 0);
+        g_type_interface_add_prerequisite (type, G_TYPE_OBJECT);
+    }
+
+    return type;
+}
+
+/**
+ * caja_widget_view_provider_get_widget:
+ * @provider: a #CajaWidgetViewProvider
+ *
+ *
+ * Returns:
+ **/
+GtkWidget *
+caja_widget_view_provider_get_widget (CajaWidgetViewProvider *provider)
+{
+    g_return_val_if_fail (CAJA_IS_WIDGET_VIEW_PROVIDER (provider), NULL);
+    g_return_val_if_fail (CAJA_WIDGET_VIEW_PROVIDER_GET_IFACE (provider)->get_widget != NULL, NULL);
+
+    return CAJA_WIDGET_VIEW_PROVIDER_GET_IFACE (provider)->get_widget (provider);
+}
+
+/**
+ * caja_widget_view_provider_add_file:
+ * @provider: a #CajaWidgetViewProvider
+ * @file: 
+ * @directory: 
+ *
+ *
+ **/
+void caja_widget_view_provider_add_file (CajaWidgetViewProvider *provider, CajaFile *file, CajaFile *directory)
+{
+    g_return_if_fail (CAJA_IS_WIDGET_VIEW_PROVIDER (provider));
+    g_return_if_fail (CAJA_WIDGET_VIEW_PROVIDER_GET_IFACE (provider)->add_file != NULL);
+
+    CAJA_WIDGET_VIEW_PROVIDER_GET_IFACE (provider)->add_file (provider, file, directory);
+}
+
+/**
+ * caja_widget_view_provider_set_location:
+ * @provider: a #CajaWidgetViewProvider
+ * @uri: the URI of the location
+ *
+ *
+ **/
+void caja_widget_view_provider_set_location (CajaWidgetViewProvider *provider, const char *location)
+{
+    g_return_if_fail (CAJA_IS_WIDGET_VIEW_PROVIDER (provider));
+    g_return_if_fail (CAJA_WIDGET_VIEW_PROVIDER_GET_IFACE (provider)->set_location != NULL);
+
+    CAJA_WIDGET_VIEW_PROVIDER_GET_IFACE (provider)->set_location (provider, location);
+}
+
+/**
+ * caja_widget_view_provider_set_window:
+ * @provider: a #CajaWidgetViewProvider
+ * @window: parent #GtkWindow
+ *
+ *
+ **/
+void caja_widget_view_provider_set_window (CajaWidgetViewProvider *provider, GtkWindow *window)
+{
+    g_return_if_fail (CAJA_IS_WIDGET_VIEW_PROVIDER (provider));
+    g_return_if_fail (CAJA_WIDGET_VIEW_PROVIDER_GET_IFACE (provider)->set_window != NULL);
+
+    CAJA_WIDGET_VIEW_PROVIDER_GET_IFACE (provider)->set_window (provider, window);
+}
+
+
+/**
+ * caja_widget_view_provider_supports_uri:
+ * @provider: a #CajaWidgetViewProvider
+ * @uri:
+ * @file_type:
+ * @mime_type:
+ *
+ *
+ *
+ * Return value:
+ **/
+gboolean caja_widget_view_provider_supports_uri (CajaWidgetViewProvider *provider,
+                                                 const char *uri,
+                                                 GFileType file_type,
+                                                 const char *mime_type)
+{
+    g_return_val_if_fail (CAJA_IS_WIDGET_VIEW_PROVIDER (provider), FALSE);
+    g_return_val_if_fail (CAJA_WIDGET_VIEW_PROVIDER_GET_IFACE (provider)->supports_uri!= NULL, FALSE);
+
+    return CAJA_WIDGET_VIEW_PROVIDER_GET_IFACE (provider)->supports_uri (provider, uri, file_type, mime_type);
+}
diff --git a/libcaja-extension/caja-widget-view-provider.h b/libcaja-extension/caja-widget-view-provider.h
new file mode 100644
index 00000000..1bd21a5f
--- /dev/null
+++ b/libcaja-extension/caja-widget-view-provider.h
@@ -0,0 +1,79 @@
+/* vi: set sw=4 ts=4 wrap ai: */
+/*
+ * caja-widget-view-provider.h: This file is part of ____
+ *
+ * Copyright (C) 2019 yetist <yetist@yetipc>
+ *
+ *
+ * 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 2 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, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ * */
+
+#ifndef __CAJA_WIDGET_VIEW_PROVIDER_H__
+#define __CAJA_WIDGET_VIEW_PROVIDER_H__  1
+
+#include <glib-object.h>
+#include <gtk/gtk.h>
+#include "caja-file-info.h"
+#include "caja-extension-types.h"
+
+G_BEGIN_DECLS
+
+#define CAJA_TYPE_WIDGET_VIEW_PROVIDER           (caja_widget_view_provider_get_type ())
+#define CAJA_WIDGET_VIEW_PROVIDER(obj)           (G_TYPE_CHECK_INSTANCE_CAST ((obj), CAJA_TYPE_WIDGET_VIEW_PROVIDER, CajaWidgetViewProvider))
+#define CAJA_IS_WIDGET_VIEW_PROVIDER(obj)        (G_TYPE_CHECK_INSTANCE_TYPE ((obj), CAJA_TYPE_WIDGET_VIEW_PROVIDER))
+#define CAJA_WIDGET_VIEW_PROVIDER_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), CAJA_TYPE_WIDGET_VIEW_PROVIDER, CajaWidgetViewProviderIface))
+
+typedef struct _CajaWidgetViewProvider       CajaWidgetViewProvider;
+typedef struct _CajaWidgetViewProviderIface  CajaWidgetViewProviderIface;
+
+/**
+ * CajaWidgetViewProviderIface:
+ * @g_iface: The parent interface.
+ * @get_widget: Returns a #GtkWidget.
+ * See caja_widget_view_provider_get_widget() for details.
+ *
+ * Interface for extensions to provide widgets view.
+ */
+struct _CajaWidgetViewProviderIface {
+    GTypeInterface g_iface;
+
+    gboolean  (*supports_uri) (CajaWidgetViewProvider *provider,
+                               const char *uri,
+                               GFileType file_type,
+                               const char *mime_type);
+    GtkWidget* (*get_widget)   (CajaWidgetViewProvider *provider);
+    void       (*add_file)     (CajaWidgetViewProvider *provider, CajaFile *file, CajaFile *directory);
+    void       (*set_location) (CajaWidgetViewProvider *provider, const char *location);
+    void       (*set_window)   (CajaWidgetViewProvider *provider, GtkWindow *window);
+};
+
+/* Interface Functions */
+GType      caja_widget_view_provider_get_type     (void);
+
+GtkWidget *caja_widget_view_provider_get_widget   (CajaWidgetViewProvider *provider);
+void       caja_widget_view_provider_add_file     (CajaWidgetViewProvider *provider,
+                                                   CajaFile *file,
+                                                   CajaFile *directory);
+void       caja_widget_view_provider_set_location (CajaWidgetViewProvider *provider,
+                                                   const char *location);
+void       caja_widget_view_provider_set_window   (CajaWidgetViewProvider *provider,
+                                                   GtkWindow *window);
+gboolean   caja_widget_view_provider_supports_uri (CajaWidgetViewProvider *provider,
+                                                   const char *uri,
+                                                   GFileType file_type,
+                                                   const char *mime_type);
+G_END_DECLS
+
+#endif /* __CAJA_WIDGET_VIEW_PROVIDER_H__ */