summaryrefslogtreecommitdiff
path: root/libcaja-extension/caja-info-provider.c
blob: 56759fa3bf888872ac26ae579acb79f36db281ca (plain)
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
/*
 *  caja-info-provider.c - Interface for Caja extensions that
 *                             provide info about 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 "caja-info-provider.h"

#include <glib-object.h>

/**
 * SECTION:caja-info-provider
 * @title: CajaInfoProvider
 * @short_description: Interface to provide additional information about files
 * @include: libcaja-extension/caja-column-provider.h
 *
 * #CajaInfoProvider allows extension to provide additional information about
 * files. When caja_info_provider_update_file_info() is called by the application,
 * extensions will know that it's time to add extra information to the provided
 * #CajaFileInfo.
 */

static void
caja_info_provider_base_init (gpointer g_class)
{
}

GType
caja_info_provider_get_type (void)
{
    static GType type = 0;

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

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

    return type;
}

CajaOperationResult
caja_info_provider_update_file_info (CajaInfoProvider     *provider,
                                     CajaFileInfo         *file,
                                     GClosure             *update_complete,
                                     CajaOperationHandle **handle)
{
    g_return_val_if_fail (CAJA_IS_INFO_PROVIDER (provider),
                          CAJA_OPERATION_FAILED);
    g_return_val_if_fail (CAJA_INFO_PROVIDER_GET_IFACE (provider)->update_file_info != NULL,
                          CAJA_OPERATION_FAILED);
    g_return_val_if_fail (update_complete != NULL,
                          CAJA_OPERATION_FAILED);
    g_return_val_if_fail (handle != NULL, CAJA_OPERATION_FAILED);

    return CAJA_INFO_PROVIDER_GET_IFACE (provider)->update_file_info
           (provider, file, update_complete, handle);
}

void
caja_info_provider_cancel_update (CajaInfoProvider    *provider,
                                  CajaOperationHandle *handle)
{
    g_return_if_fail (CAJA_IS_INFO_PROVIDER (provider));
    g_return_if_fail (CAJA_INFO_PROVIDER_GET_IFACE (provider)->cancel_update != NULL);
    g_return_if_fail (handle != NULL);

    CAJA_INFO_PROVIDER_GET_IFACE (provider)->cancel_update (provider,
            handle);
}

void
caja_info_provider_update_complete_invoke (GClosure            *update_complete,
                                           CajaInfoProvider    *provider,
                                           CajaOperationHandle *handle,
                                           CajaOperationResult  result)
{
    GValue args[3] = { { 0, } };
    GValue return_val = { 0, };

    g_return_if_fail (update_complete != NULL);
    g_return_if_fail (CAJA_IS_INFO_PROVIDER (provider));

    g_value_init (&args[0], CAJA_TYPE_INFO_PROVIDER);
    g_value_init (&args[1], G_TYPE_POINTER);
    g_value_init (&args[2], CAJA_TYPE_OPERATION_RESULT);

    g_value_set_object (&args[0], provider);
    g_value_set_pointer (&args[1], handle);
    g_value_set_enum (&args[2], result);

    g_closure_invoke (update_complete, &return_val, 3, args, NULL);

    g_value_unset (&args[0]);
    g_value_unset (&args[1]);
    g_value_unset (&args[2]);
}