nautilus/libnautilus-extension/nautilus-column-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

68 lines
2.6 KiB
C

/*
* nautilus-column-provider.h - Interface for Nautilus extensions that
* provide column descriptions.
*
* Copyright (C) 2003 Novell, 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>
*
*/
/* This interface is implemented by Nautilus extensions that want to
* add columns to the list view and details to the icon view.
* Extensions are asked for a list of columns to display. Each
* returned column refers to a string attribute which can be filled in
* by NautilusInfoProvider */
#ifndef NAUTILUS_COLUMN_PROVIDER_H
#define NAUTILUS_COLUMN_PROVIDER_H
#include <glib-object.h>
#include "nautilus-extension-types.h"
#include "nautilus-column.h"
G_BEGIN_DECLS
#define NAUTILUS_TYPE_COLUMN_PROVIDER (nautilus_column_provider_get_type ())
#define NAUTILUS_COLUMN_PROVIDER(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), NAUTILUS_TYPE_COLUMN_PROVIDER, NautilusColumnProvider))
#define NAUTILUS_IS_COLUMN_PROVIDER(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), NAUTILUS_TYPE_COLUMN_PROVIDER))
#define NAUTILUS_COLUMN_PROVIDER_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), NAUTILUS_TYPE_COLUMN_PROVIDER, NautilusColumnProviderIface))
typedef struct _NautilusColumnProvider NautilusColumnProvider;
typedef struct _NautilusColumnProviderIface NautilusColumnProviderIface;
/**
* NautilusColumnProviderIface:
* @g_iface: The parent interface.
* @get_columns: Returns a #GList of #NautilusColumn.
* See nautilus_column_provider_get_columns() for details.
*
* Interface for extensions to provide additional list view columns.
*/
struct _NautilusColumnProviderIface {
GTypeInterface g_iface;
GList *(*get_columns) (NautilusColumnProvider *provider);
};
/* Interface Functions */
GType nautilus_column_provider_get_type (void);
GList *nautilus_column_provider_get_columns (NautilusColumnProvider *provider);
G_END_DECLS
#endif