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
|
/* vi:set et ai sw=2 sts=2 ts=2: */
/*-
* Copyright (c) 2005-2006 Benedikt Meurer <benny@xfce.org>
*
* 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., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*/
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include <libxfce4util/libxfce4util.h>
#include <thunarx/thunarx-private.h>
#include <thunarx/thunarx-property-page-provider.h>
/**
* SECTION: thunarx-property-page-provider
* @short_description: The interface to extensions that provide additional property pages
* @title: ThunarxPropertyPageProvider
* @include: thunarx/thunarx.h
*
* To add a property page to the file properties dialog, extensions must implement the
* <type>ThunarxPropertyPageProvider</type> interface. This interface has only one virtual
* method, <function>get_pages</function>, that is passed a list of <link
* linkend="ThunarxFileInfo"><type>ThunarxFileInfo</type></link> objects and returns a list
* of <link linkend="ThunarxPropertyPage"><type>ThunarxPropertyPage</type></link> objects.
*/
GType
thunarx_property_page_provider_get_type (void)
{
static gsize type__static = 0;
GType type;
if (g_once_init_enter (&type__static))
{
type = g_type_register_static_simple (G_TYPE_INTERFACE,
I_("ThunarxPropertyPageProvider"),
sizeof (ThunarxPropertyPageProviderIface),
NULL,
0,
NULL,
0);
g_type_interface_add_prerequisite (type, G_TYPE_OBJECT);
g_once_init_leave (&type__static, type);
}
return type__static;
}
/**
* thunarx_property_page_provider_get_pages: (skip)
* @provider: a #ThunarxPropertyPageProvider.
* @files: (element-type ThunarxFileInfo): the list of #ThunarxFileInfo<!---->s
* for which a properties dialog will be displayed.
*
* Returns the list of #ThunarxPropertyPage<!---->s that @provider has to offer for @files.
*
* Extensions that implement this interface, must first check whether they support all the
* #ThunarxFileInfo<!---->s in the list of @files. Most extensions will probably only support
* #ThunarxPropertyPage<!---->s for exactly one file of a certain type. For example an MP3-Tag
* editor property page will most probably support only a single audio file, and so the method
* would be implemented like this
* <informalexample><programlisting>
* GList*
* tag_provider_get_pages (ThunarxPropertyPageProvider *property_page_provider,
* GList *files)
* {
* if (g_list_length (files) != 1)
* return NULL;
* else if (!thunarx_file_info_has_mime_type (files->data, "audio/mp3"))
* return NULL;
* else
* return g_list_append (NULL, tag_page_new (files->data));
* }
* </programlisting></informalexample>
* where tag_page_new() allocates a new #TagPage instance for a #ThunarxFileInfo object
* passed to it. See the description of the #ThunarxPropertyPage class for additional
* information about the #TagPage example class.
*
* As a special note, this method automatically takes a reference on the
* @provider for every #ThunarxPropertyPage object returned from the real implementation
* of this method in @provider. This is to make sure that the extension stays
* in memory for atleast the time that the pages are used. If the extension
* wants to stay in memory for a longer time, it'll need to take care of this
* itself (e.g. by taking an additional reference on the @provider itself,
* that's released at a later time).
*
* The caller is responsible to free the returned list of pages using
* something like this when no longer needed:
* <informalexample><programlisting>
* g_list_foreach (list, (GFunc) g_object_ref_sink, NULL);
* g_list_free_full (list, g_object_unref);
* </programlisting></informalexample>
*
* Returns: (transfer full) (element-type ThunarxPropertyPage): the list of
* #ThunarxPropertyPage<!---->s that @provider has to offer for @files.
**/
GList*
thunarx_property_page_provider_get_pages (ThunarxPropertyPageProvider *provider,
GList *files)
{
GList *pages;
g_return_val_if_fail (THUNARX_IS_PROPERTY_PAGE_PROVIDER (provider), NULL);
g_return_val_if_fail (files != NULL, NULL);
if (THUNARX_PROPERTY_PAGE_PROVIDER_GET_IFACE (provider)->get_pages != NULL)
{
/* query the property pages from the implementation */
pages = (*THUNARX_PROPERTY_PAGE_PROVIDER_GET_IFACE (provider)->get_pages) (provider, files);
/* take a reference on the provider for each page */
thunarx_object_list_take_reference (pages, provider);
}
else
{
pages = NULL;
}
return pages;
}
|
