nautilus/libnautilus-extension/nautilus-location-widget-provider.h
Cosimo Cecchi ff5a48d133 libnautilus-extension: add gtk-doc documentation coverage
A lot of the library was poorly documented. Make sure the output of the
documentation looks okay.
2015-05-25 20:41:19 -07:00

72 lines
2.9 KiB
C

/*
* nautilus-info-provider.h - Interface for Nautilus extensions that
* provide info about files.
*
* Copyright (C) 2003 Novell, Inc.
* Copyright (C) 2005 Red Hat, Inc.
*
* 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, see <http://www.gnu.org/licenses/>.
*
* Author: Dave Camp <dave@ximian.com>
* Alexander Larsson <alexl@redhat.com>
*
*/
/* This interface is implemented by Nautilus extensions that want to
* provide extra location widgets for a particular location.
* Extensions are called when Nautilus displays a location.
*/
#ifndef NAUTILUS_LOCATION_WIDGET_PROVIDER_H
#define NAUTILUS_LOCATION_WIDGET_PROVIDER_H
#include <glib-object.h>
#include <gtk/gtk.h>
#include "nautilus-extension-types.h"
G_BEGIN_DECLS
#define NAUTILUS_TYPE_LOCATION_WIDGET_PROVIDER (nautilus_location_widget_provider_get_type ())
#define NAUTILUS_LOCATION_WIDGET_PROVIDER(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), NAUTILUS_TYPE_LOCATION_WIDGET_PROVIDER, NautilusLocationWidgetProvider))
#define NAUTILUS_IS_LOCATION_WIDGET_PROVIDER(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), NAUTILUS_TYPE_LOCATION_WIDGET_PROVIDER))
#define NAUTILUS_LOCATION_WIDGET_PROVIDER_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), NAUTILUS_TYPE_LOCATION_WIDGET_PROVIDER, NautilusLocationWidgetProviderIface))
typedef struct _NautilusLocationWidgetProvider NautilusLocationWidgetProvider;
typedef struct _NautilusLocationWidgetProviderIface NautilusLocationWidgetProviderIface;
/**
* NautilusLocationWidgetProviderIface:
* @g_iface: The parent interface.
* @get_widget: Returns a #GtkWidget.
* See nautilus_location_widget_provider_get_widget() for details.
*
* Interface for extensions to provide additional location widgets.
*/
struct _NautilusLocationWidgetProviderIface {
GTypeInterface g_iface;
GtkWidget * (*get_widget) (NautilusLocationWidgetProvider *provider,
const char *uri,
GtkWidget *window);
};
/* Interface Functions */
GType nautilus_location_widget_provider_get_type (void);
GtkWidget * nautilus_location_widget_provider_get_widget (NautilusLocationWidgetProvider *provider,
const char *uri,
GtkWidget *window);
G_END_DECLS
#endif