summaryrefslogtreecommitdiff
path: root/libnautilus-extension/nautilus-location-widget-provider.h
diff options
context:
space:
mode:
Diffstat (limited to 'libnautilus-extension/nautilus-location-widget-provider.h')
-rw-r--r--libnautilus-extension/nautilus-location-widget-provider.h20
1 files changed, 18 insertions, 2 deletions
diff --git a/libnautilus-extension/nautilus-location-widget-provider.h b/libnautilus-extension/nautilus-location-widget-provider.h
index a6f656cce..f3573828f 100644
--- a/libnautilus-extension/nautilus-location-widget-provider.h
+++ b/libnautilus-extension/nautilus-location-widget-provider.h
@@ -51,6 +51,15 @@ G_DECLARE_INTERFACE (NautilusLocationWidgetProvider, nautilus_location_widget_pr
typedef NautilusLocationWidgetProviderInterface NautilusLocationWidgetProviderIface;
/**
+ * SECTION:nautilus-location-widget-provider
+ * @title: NautilusLocationWidgetProvider
+ * @short_description: Interface to provide additional location widgets
+ *
+ * #NautilusLocationWidgetProvider allows extension to provide additional location
+ * widgets in the file manager views.
+ */
+
+/**
* NautilusLocationWidgetProviderInterface:
* @g_iface: The parent interface.
* @get_widget: Returns a #GtkWidget.
@@ -67,9 +76,16 @@ struct _NautilusLocationWidgetProviderInterface
GtkWidget *window);
};
-/* Interface Functions */
+/**
+ * nautilus_location_widget_provider_get_widget:
+ * @provider: a #NautilusLocationWidgetProvider
+ * @uri: the URI of the location
+ * @window: parent #GtkWindow
+ *
+ * Returns: (transfer none): the location widget for @provider at @uri
+ */
GtkWidget *nautilus_location_widget_provider_get_widget (NautilusLocationWidgetProvider *provider,
const char *uri,
GtkWidget *window);
-G_END_DECLS \ No newline at end of file
+G_END_DECLS