summaryrefslogtreecommitdiff
path: root/libnautilus-extension/nautilus-property-page-model-provider.c
blob: 12b0fe7116409f835924a823b039f2d5bdc6bf22 (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
/*
 *  nautilus-property-page-model-provider.c - Interface for Nautilus extensions
 * *                                      that provide property pages for
 * *                                      files.
 *
 *  Copyright (C) 2003 Novell, Inc.
 *  Copyright (C) 2018 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>
 *           Carlos Soriano <csoriano@redhat.com>
 *
 */
#include "config.h"

#include "nautilus-property-page-model-provider.h"
#include "nautilus-property-page-model.h"

G_DEFINE_INTERFACE (NautilusPropertyPageModelProvider, nautilus_property_page_model_provider,
                    G_TYPE_OBJECT)

/**
 * SECTION:nautilus-property-page-model-provider-interface
 * @title: NautilusPropertyPageModelProvider
 * @short_description: Interface to provide a property page
 *
 * #NautilusPropertyPageModelProvider allows extension to provide an additional
 * page for the file properties dialog.
 */

static void
nautilus_property_page_model_provider_default_init (NautilusPropertyPageModelProviderInterface *klass)
{
    /**
     * NautilusView::page-model:
     *
     * The page model associated with the provider.
     */
    g_object_interface_install_property (klass,
                                         g_param_spec_object ("page-model",
                                                              "Page model",
                                                              "The page model associated with the provider",
                                                              NAUTILUS_TYPE_PROPERTY_PAGE_MODEL,
                                                              G_PARAM_READWRITE));
    g_object_interface_install_property (klass,
                                         g_param_spec_pointer ("files",
                                                               "Files",
                                                               "Files to get info from",
                                                              G_PARAM_READWRITE));
}

/**
 * nautilus_property_page_model_provider_get_model:
 * @provider: a #NautilusPropertyPageModelProvider
 * @files: (element-type NautilusFileInfo): a #GList of #NautilusFileInfo
 *
 * This function is called by Nautilus when it wants property page
 * items from the extension.
 *
 * This function is called in the main thread before a property page
 * is shown, so it should return quickly.
 *
 * Returns: (element-type NautilusPropertyItem) (transfer full): A #GList of allocated #NautilusPropertyItem.
 */
NautilusPropertyPageModel *
nautilus_property_page_model_provider_get_model (NautilusPropertyPageModelProvider *self)
{
    NautilusPropertyPageModelProviderInterface *iface;

    g_return_val_if_fail (NAUTILUS_IS_PROPERTY_PAGE_MODEL_PROVIDER (self), NULL);

    iface = NAUTILUS_PROPERTY_PAGE_MODEL_PROVIDER_GET_IFACE (self);

    g_return_val_if_fail (iface->get_model != NULL, NULL);

    return iface->get_model (self);
}

void
nautilus_property_page_model_provider_set_files (NautilusPropertyPageModelProvider *self,
                                                 GList                             *files)
{
    NautilusPropertyPageModelProviderInterface *iface;

    g_return_if_fail (NAUTILUS_IS_PROPERTY_PAGE_MODEL_PROVIDER (self));

    iface = NAUTILUS_PROPERTY_PAGE_MODEL_PROVIDER_GET_IFACE (self);

    g_return_if_fail (iface->set_files != NULL);

    iface->set_files (self, files);
}

gboolean
nautilus_property_page_model_provider_supports_files (NautilusPropertyPageModelProvider *self)
{
    NautilusPropertyPageModelProviderInterface *iface;

    g_return_val_if_fail (NAUTILUS_IS_PROPERTY_PAGE_MODEL_PROVIDER (self), FALSE);

    iface = NAUTILUS_PROPERTY_PAGE_MODEL_PROVIDER_GET_IFACE (self);

    g_return_val_if_fail (iface->supports_files != NULL, FALSE);

    return iface->supports_files (self);
}