nautilus/libnautilus-extension/nautilus-menu-provider.c
Ernestas Kulik 7e2605c681 general: refactor extension library
The changes include:

  * adding a single-include header and deprecating
    nautilus-extension-types.h and direct inclusions of individual
    headers;

  * type definition simplifications - this causes some breakages in
    nautilus-file, because NautilusFile used to be typedefed to
    NautilusFileInfo, and that is no longer possible, so the interface
    implementation was moved to static functions and the public
    NautilusFile API provides thin wrappers for them to maintain
    compatibility;

  * documentation cleanups and reorganization;

  * general build rule and code cleanups: mostly g_auto* sprinkled
    around and style changes (sorry)
2018-02-09 06:32:38 +02:00

125 lines
4.1 KiB
C

/*
* nautilus-property-page-provider.c - Interface for Nautilus extensions
* that provide context menu items
* for files.
*
* 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>
*
*/
#include <config.h>
#include "nautilus-menu-provider.h"
G_DEFINE_INTERFACE (NautilusMenuProvider, nautilus_menu_provider, G_TYPE_OBJECT)
enum
{
ITEMS_UPDATED,
LAST_SIGNAL
};
static guint signals[LAST_SIGNAL];
/**
* SECTION:nautilus-menu-provider
* @title: NautilusMenuProvider
* @short_description: Interface to provide additional menu items
*
* #NautilusMenuProvider allows extension to provide additional menu items
* in the file manager menus.
*/
static void
nautilus_menu_provider_default_init (NautilusMenuProviderInterface *klass)
{
/* This signal should be emited each time the extension modify the list of menu items */
signals[ITEMS_UPDATED] = g_signal_new ("items-updated",
NAUTILUS_TYPE_MENU_PROVIDER,
G_SIGNAL_RUN_LAST,
0,
NULL, NULL,
g_cclosure_marshal_VOID__VOID,
G_TYPE_NONE, 0);
}
/**
* nautilus_menu_provider_get_file_items:
* @provider: a #NautilusMenuProvider
* @window: the parent #GtkWidget window
* @files: (element-type NautilusFileInfo): a list of #NautilusFileInfo
*
* Returns: (element-type NautilusMenuItem) (transfer full): the provided list of #NautilusMenuItem
*/
GList *
nautilus_menu_provider_get_file_items (NautilusMenuProvider *provider,
GtkWidget *window,
GList *files)
{
NautilusMenuProviderInterface *iface;
iface = NAUTILUS_MENU_PROVIDER_GET_IFACE (provider);
g_return_val_if_fail (NAUTILUS_IS_MENU_PROVIDER (provider), NULL);
g_return_val_if_fail (GTK_IS_WIDGET (window), NULL);
if (iface->get_file_items != NULL)
{
return iface->get_file_items (provider, window, files);
}
return NULL;
}
/**
* nautilus_menu_provider_get_background_items:
* @provider: a #NautilusMenuProvider
* @window: the parent #GtkWidget window
* @current_folder: the folder for which background items are requested
*
* Returns: (element-type NautilusMenuItem) (transfer full): the provided list of #NautilusMenuItem
*/
GList *
nautilus_menu_provider_get_background_items (NautilusMenuProvider *provider,
GtkWidget *window,
NautilusFileInfo *current_folder)
{
NautilusMenuProviderInterface *iface;
iface = NAUTILUS_MENU_PROVIDER_GET_IFACE (provider);
g_return_val_if_fail (NAUTILUS_IS_MENU_PROVIDER (provider), NULL);
g_return_val_if_fail (GTK_IS_WIDGET (window), NULL);
g_return_val_if_fail (NAUTILUS_IS_FILE_INFO (current_folder), NULL);
if (iface->get_background_items != NULL)
{
return iface->get_background_items (provider, window, current_folder);
}
return NULL;
}
/* This function emit a signal to inform nautilus that its item list has changed */
void
nautilus_menu_provider_emit_items_updated_signal (NautilusMenuProvider *provider)
{
g_return_if_fail (NAUTILUS_IS_MENU_PROVIDER (provider));
g_signal_emit (provider, ITEMS_UPDATED, 0);
}