/usr/share/gtk-doc/html/thunarx/ThunarxPreferencesProvider.html is in thunar-data 1.6.3-1ubuntu5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ThunarxPreferencesProvider</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Thunar Extensions Reference Manual">
<link rel="up" href="thunarx-providers.html" title="Part V. Providers">
<link rel="prev" href="ThunarxPropertyPageProvider.html" title="ThunarxPropertyPageProvider">
<link rel="next" href="ThunarxRenamerProvider.html" title="ThunarxRenamerProvider">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="ThunarxPropertyPageProvider.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="thunarx-providers.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Thunar Extensions Reference Manual</th>
<td><a accesskey="n" href="ThunarxRenamerProvider.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#ThunarxPreferencesProvider.synopsis" class="shortcut">Top</a>
|
<a href="#ThunarxPreferencesProvider.description" class="shortcut">Description</a>
|
<a href="#ThunarxPreferencesProvider.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#ThunarxPreferencesProvider.prerequisites" class="shortcut">Prerequisites</a>
</td></tr>
</table>
<div class="refentry">
<a name="ThunarxPreferencesProvider"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="ThunarxPreferencesProvider.top_of_page"></a>ThunarxPreferencesProvider</span></h2>
<p>ThunarxPreferencesProvider — The interface to extensions that provide preferences</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="ThunarxPreferencesProvider.stability-level"></a><h2>Stability Level</h2>
Stable, unless otherwise indicated
</div>
<div class="refsynopsisdiv">
<a name="ThunarxPreferencesProvider.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <thunarx/thunarx.h>
struct <a class="link" href="ThunarxPreferencesProvider.html#ThunarxPreferencesProviderIface" title="struct ThunarxPreferencesProviderIface">ThunarxPreferencesProviderIface</a>;
<a class="link" href="ThunarxPreferencesProvider.html#ThunarxPreferencesProvider-struct" title="ThunarxPreferencesProvider">ThunarxPreferencesProvider</a>;
<a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> * <a class="link" href="ThunarxPreferencesProvider.html#thunarx-preferences-provider-get-actions" title="thunarx_preferences_provider_get_actions ()">thunarx_preferences_provider_get_actions</a>
(<em class="parameter"><code><a class="link" href="ThunarxPreferencesProvider.html" title="ThunarxPreferencesProvider"><span class="type">ThunarxPreferencesProvider</span></a> *provider</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/gtk2/GtkWidget.html"><span class="type">GtkWidget</span></a> *window</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="ThunarxPreferencesProvider.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GInterface
+----ThunarxPreferencesProvider
</pre>
</div>
<div class="refsect1">
<a name="ThunarxPreferencesProvider.prerequisites"></a><h2>Prerequisites</h2>
<p>
ThunarxPreferencesProvider requires
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>.</p>
</div>
<div class="refsect1">
<a name="ThunarxPreferencesProvider.description"></a><h2>Description</h2>
<p>
The ThunarxPreferencesProvider interface is implemented by extensions that
want to register additional actions in the preferences menu of the file
manager. In general this should only be done by extensions that are closely
tied to the file manager (for example, the <code class="literal">thunar-uca</code> is
such an extension, while an extension that just adds <span class="guimenuitem">Compress
file</span> and <span class="guimenuitem">Uncompress file</span> to the
context menu of compressed files should not add their own preferences to
the file manager menu, because it should use desktop-wide settings for
archive managers instead).
</p>
<p>
The <a href="http://developer.gnome.org/gtk2/GtkAction.html"><span class="type">GtkAction</span></a>s returned from the
<a class="link" href="ThunarxPreferencesProvider.html#thunarx-preferences-provider-get-actions" title="thunarx_preferences_provider_get_actions ()"><code class="function">thunarx_preferences_provider_get_actions()</code></a> method must be namespaced with the
model to avoid collision with internal file manager actions and actions provided
by other extensions. For example, the preferences action provided by the
<code class="literal">thunar-uca</code> extension is called
<code class="literal">ThunarUca::manage-actions</code>.
</p>
<div class="example">
<a name="idp37583360"></a><p class="title"><b>Example 6. Preferences provider example</b></p>
<div class="example-contents"><pre class="programlisting">
static void hello_preferences_provider_init (ThunarxPreferencesProviderIface *iface);
static void hello_get_actions (ThunarxPreferencesProvider *provider,
GtkWidget *window);
THUNARX_DEFINE_TYPE_WITH_CODE (Hello, hello, G_TYPE_OBJECT,
THUNARX_IMPLEMENT_INTERFACE (THUNARX_TYPE_PREFERENCES_PROVIDER,
hello_preferences_provider_init));
static void
hello_preferences_provider_init (ThunarxPreferencesProviderIface *iface)
{
iface->get_actions = hello_get_actions;
}
static void
hello_activated (GtkWidget *window)
{
GtkWidget *dialog;
dialog = gtk_message_dialog_new (GTK_WINDOW (window),
GTK_DIALOG_MODAL
| GTK_DIALOG_DESTROY_WITH_PARENT,
GTK_MESSAGE_INFO,
GTK_BUTTONS_OK,
"Hello World!");
gtk_dialog_run (GTK_DIALOG (dialog));
gtk_widget_destroy (dialog);
}
static GList*
hello_get_actions (ThunarxPreferencesProvider *provider,
GtkWidget *window)
{
GtkAction *action;
GClosure *closure;
action = gtk_action_new ("Hello::say-hello", "Say hello", "Say hello", NULL);
closure = g_cclosure_new_object_swap (G_CALLBACK (hello_activated), G_OBJECT (window));
g_signal_connect_closure (G_OBJECT (action), "activate", closure, TRUE);
return g_list_prepend (NULL, action);
}
</pre></div>
</div>
<br class="example-break">
</div>
<div class="refsect1">
<a name="ThunarxPreferencesProvider.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="ThunarxPreferencesProviderIface"></a><h3>struct ThunarxPreferencesProviderIface</h3>
<pre class="programlisting">struct ThunarxPreferencesProviderIface {
GList *(*get_actions) (ThunarxPreferencesProvider *provider,
GtkWidget *window);
};
</pre>
<p>
Interface with virtual methods implementation by extensions that
want to install preferences actions in the file managers menu.
</p>
<p>
Providers don't need to implement all of the virtual methods listed
in the interface.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><em class="structfield"><code><a name="ThunarxPreferencesProviderIface.get-actions"></a>get_actions</code></em> ()</span></p></td>
<td>See <a class="link" href="ThunarxPreferencesProvider.html#thunarx-preferences-provider-get-actions" title="thunarx_preferences_provider_get_actions ()"><code class="function">thunarx_preferences_provider_get_actions()</code></a>.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ThunarxPreferencesProvider-struct"></a><h3>ThunarxPreferencesProvider</h3>
<pre class="programlisting">typedef struct _ThunarxPreferencesProvider ThunarxPreferencesProvider;</pre>
<p>
Preferences provider type.
</p>
</div>
<hr>
<div class="refsect2">
<a name="thunarx-preferences-provider-get-actions"></a><h3>thunarx_preferences_provider_get_actions ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> * thunarx_preferences_provider_get_actions
(<em class="parameter"><code><a class="link" href="ThunarxPreferencesProvider.html" title="ThunarxPreferencesProvider"><span class="type">ThunarxPreferencesProvider</span></a> *provider</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/gtk2/GtkWidget.html"><span class="type">GtkWidget</span></a> *window</code></em>);</pre>
<p>
Returns the list of <a href="http://developer.gnome.org/gtk2/GtkAction.html"><span class="type">GtkAction</span></a>s that <em class="parameter"><code>provider</code></em> has to offer
as preferences within <em class="parameter"><code>window</code></em>. These actions will usually be added
to the builtin list of preferences in the "Edit" menu of the file
manager's <em class="parameter"><code>window</code></em>.
</p>
<p>
Plugin writers that implement this interface should make sure to
choose descriptive action names and tooltips, and not to crowd the
"Edit" menu too much. That said, think twice before implementing
this interface, as too many preference actions will render the
file manager useless over time!
</p>
<p>
The caller is responsible to free the returned list of actions using
something like this when no longer needed:
</p>
<div class="informalexample"><pre class="programlisting">
g_list_free_full (list, g_object_unref);
</pre></div>
<p>
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>provider</code></em> :</span></p></td>
<td>a <a class="link" href="ThunarxPreferencesProvider.html" title="ThunarxPreferencesProvider"><span class="type">ThunarxPreferencesProvider</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>window</code></em> :</span></p></td>
<td>the <a href="http://developer.gnome.org/gtk2/GtkWindow.html"><span class="type">GtkWindow</span></a> within which the actions will be used.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the list of <a href="http://developer.gnome.org/gtk2/GtkAction.html"><span class="type">GtkAction</span></a>s that <em class="parameter"><code>provider</code></em> has
to offer as preferences within <em class="parameter"><code>window</code></em>.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|