1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
/*
 *  baul-property-page-provider.c - Interface for Baul 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, write to the Free
 *  Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 *  Author:  Dave Camp <dave@ximian.com>
 *
 */

#include <config.h>
#include "baul-menu-provider.h"

#include <glib-object.h>

/**
 * SECTION:baul-menu-provider
 * @title: BaulMenuProvider
 * @short_description: Interface to provide additional menu items
 * @include: libbaul-extension/baul-menu-provider.h
 *
 * #BaulMenuProvider allows extension to provide additional menu items
 * in the file manager menus.
 */

static void
baul_menu_provider_base_init (gpointer g_class G_GNUC_UNUSED)
{
    static gboolean initialized = FALSE;

    if (!initialized) {
        /* This signal should be emited each time the extension modify the list of menu items */
        g_signal_new ("items_updated",
                      BAUL_TYPE_MENU_PROVIDER,
                      G_SIGNAL_RUN_LAST,
                      0,
                      NULL, NULL,
                      g_cclosure_marshal_VOID__VOID,
                      G_TYPE_NONE, 0);
        initialized = TRUE;
    }
}

GType
baul_menu_provider_get_type (void)<--- The function 'baul_menu_provider_get_type' should have static linkage since it is not used outside of its translation unit.
{
    static GType type = 0;

    if (!type) {
        const GTypeInfo info = {
            sizeof (BaulMenuProviderIface),
            baul_menu_provider_base_init,
            NULL,
            NULL,
            NULL,
            NULL,
            0,
            0,
            NULL
        };

        type = g_type_register_static (G_TYPE_INTERFACE,
                                       "BaulMenuProvider",
                                       &info, 0);
        g_type_interface_add_prerequisite (type, G_TYPE_OBJECT);
    }

    return type;
}

/**
 * baul_menu_provider_get_file_items:
 * @provider: a #BaulMenuProvider
 * @window: the parent #CtkWidget window
 * @files: (element-type BaulFileInfo): a list of #BaulFileInfo
 *
 * Returns: (element-type BaulMenuItem) (transfer full): the provided list of #BaulMenuItem
 */
GList *
baul_menu_provider_get_file_items (BaulMenuProvider *provider,
                                   CtkWidget        *window,
                                   GList            *files)
{
    g_return_val_if_fail (BAUL_IS_MENU_PROVIDER (provider), NULL);

    if (BAUL_MENU_PROVIDER_GET_IFACE (provider)->get_file_items) {
        return BAUL_MENU_PROVIDER_GET_IFACE (provider)->get_file_items
               (provider, window, files);
    } else {
        return NULL;
    }
}

/**
 * baul_menu_provider_get_background_items:
 * @provider: a #BaulMenuProvider
 * @window: the parent #CtkWidget window
 * @current_folder: the folder for which background items are requested
 *
 * Returns: (element-type BaulMenuItem) (transfer full): the provided list of #BaulMenuItem
 */
GList *
baul_menu_provider_get_background_items (BaulMenuProvider *provider,
                                         CtkWidget        *window,
                                         BaulFileInfo     *current_folder)
{
    g_return_val_if_fail (BAUL_IS_MENU_PROVIDER (provider), NULL);
    g_return_val_if_fail (BAUL_IS_FILE_INFO (current_folder), NULL);

    if (BAUL_MENU_PROVIDER_GET_IFACE (provider)->get_background_items) {
        return BAUL_MENU_PROVIDER_GET_IFACE (provider)->get_background_items
               (provider, window, current_folder);
    } else {
        return NULL;
    }
}

/**
 * baul_menu_provider_get_toolbar_items:
 * @provider: a #BaulMenuProvider
 * @window: the parent #CtkWidget window
 * @current_folder: the folder for which toolbar items are requested
 *
 * Returns: (element-type BaulMenuItem) (transfer full): the provided list of #BaulMenuItem
 */
GList *
baul_menu_provider_get_toolbar_items (BaulMenuProvider *provider,
                                      CtkWidget        *window,
                                      BaulFileInfo     *current_folder)
{
    g_return_val_if_fail (BAUL_IS_MENU_PROVIDER (provider), NULL);
    g_return_val_if_fail (BAUL_IS_FILE_INFO (current_folder), NULL);

    if (BAUL_MENU_PROVIDER_GET_IFACE (provider)->get_toolbar_items) {
        return BAUL_MENU_PROVIDER_GET_IFACE (provider)->get_toolbar_items
               (provider, window, current_folder);
    } else {
        return NULL;
    }
}

/* This function emit a signal to inform baul that its item list has changed */
void
baul_menu_provider_emit_items_updated_signal (BaulMenuProvider* provider)
{
    g_return_if_fail (BAUL_IS_MENU_PROVIDER (provider));

    g_signal_emit_by_name (provider, "items_updated");
}