totem-common 3.26.0-0ubuntu6 / usr / share / gtk-doc / html / totem / totem-TotemPlugin.html

This file is indexed.

/usr/share/gtk-doc/html/totem/totem-TotemPlugin.html is in totem-common 3.26.0-0ubuntu6.

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
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>TotemPlugin: Totem Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Totem Reference Manual">
<link rel="up" href="core-api.html" title="Core API">
<link rel="prev" href="totem-Interface.html" title="Interface">
<link rel="next" href="totem-BaconVideoWidget.html" title="BaconVideoWidget">
<meta name="generator" content="GTK-Doc V1.27 (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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#totem-TotemPlugin.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="core-api.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="totem-Interface.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="totem-BaconVideoWidget.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="totem-TotemPlugin"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="totem-TotemPlugin.top_of_page"></a>TotemPlugin</span></h2>
<p>TotemPlugin — base plugin class and loading/unloading functions</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="totem-TotemPlugin.stability-level"></a><h2>Stability Level</h2>
<acronym title="Unstable interfaces are experimental or transitional. They are typically used to
give outside developers early access to new or rapidly changing technology, or
to provide an interim solution to a problem where a more general solution is
anticipated. No claims are made about either source or binary compatibility from
one minor release to the next.

The Unstable interface level is a warning that these interfaces are  subject to
change without warning and should not be used in unbundled products.

Given such caveats, customer impact need not be a factor when considering
incompatible changes to an Unstable interface in a major or minor release.
Nonetheless, when such changes are introduced, the changes should still be
mentioned in the release notes for the affected release.
"><span class="acronym">Unstable</span></acronym>, unless otherwise indicated
</div>
<div class="refsect1">
<a name="totem-TotemPlugin.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="totem-TotemPlugin.html#TOTEM-PLUGIN-REGISTER:CAPS" title="TOTEM_PLUGIN_REGISTER()">TOTEM_PLUGIN_REGISTER</a><span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="totem-TotemPlugin.html#TOTEM-PLUGIN-REGISTER-CONFIGURABLE:CAPS" title="TOTEM_PLUGIN_REGISTER_CONFIGURABLE()">TOTEM_PLUGIN_REGISTER_CONFIGURABLE</a><span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">char</span> *
</td>
<td class="function_name">
<a class="link" href="totem-TotemPlugin.html#totem-plugin-find-file" title="totem_plugin_find_file ()">totem_plugin_find_file</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GtkBuilder</span> *
</td>
<td class="function_name">
<a class="link" href="totem-TotemPlugin.html#totem-plugin-load-interface" title="totem_plugin_load_interface ()">totem_plugin_load_interface</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">char</span> **
</td>
<td class="function_name">
<a class="link" href="totem-TotemPlugin.html#totem-get-plugin-paths" title="totem_get_plugin_paths ()">totem_get_plugin_paths</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="totem-TotemPlugin.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;totem-dirs.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="totem-TotemPlugin.description"></a><h2>Description</h2>
<p>libpeas is used as a general-purpose architecture for adding plugins to Totem, with
derived support for different programming languages.</p>
<p>The functions in totem-dirs.h are used to allow plugins to find and load files installed alongside the plugins, such as UI files.</p>
</div>
<div class="refsect1">
<a name="totem-TotemPlugin.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="TOTEM-PLUGIN-REGISTER:CAPS"></a><h3>TOTEM_PLUGIN_REGISTER()</h3>
<pre class="programlisting">#define             TOTEM_PLUGIN_REGISTER(TYPE_NAME, TypeName, type_name)</pre>
<p>Registers a plugin with the Totem plugin system, including registering the type specified in the parameters and declaring its activate and
deactivate functions.</p>
<div class="refsect3">
<a name="TOTEM-PLUGIN-REGISTER.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>TYPE_NAME</p></td>
<td class="parameter_description"><p>the name of the plugin type, in UPPER_CASE</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>TypeName</p></td>
<td class="parameter_description"><p>the name of the plugin type, in CamelCase</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>type_name</p></td>
<td class="parameter_description"><p>the name of the plugin type, in lower_case</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="TOTEM-PLUGIN-REGISTER-CONFIGURABLE:CAPS"></a><h3>TOTEM_PLUGIN_REGISTER_CONFIGURABLE()</h3>
<pre class="programlisting">#define             TOTEM_PLUGIN_REGISTER_CONFIGURABLE(TYPE_NAME, TypeName, type_name)</pre>
<p>Registers a configurable plugin with the Totem plugin system, including registering the type specified in the parameters and declaring its activate
and deactivate and widget creation functions.</p>
<div class="refsect3">
<a name="TOTEM-PLUGIN-REGISTER-CONFIGURABLE.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>TYPE_NAME</p></td>
<td class="parameter_description"><p>the name of the plugin type, in UPPER_CASE</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>TypeName</p></td>
<td class="parameter_description"><p>the name of the plugin type, in CamelCase</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>type_name</p></td>
<td class="parameter_description"><p>the name of the plugin type, in lower_case</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="totem-plugin-find-file"></a><h3>totem_plugin_find_file ()</h3>
<pre class="programlisting"><span class="returnvalue">char</span> *
totem_plugin_find_file (<em class="parameter"><code>const <span class="type">char</span> *plugin_name</code></em>,
                        <em class="parameter"><code>const <span class="type">char</span> *file</code></em>);</pre>
<p>Finds the specified <em class="parameter"><code>file</code></em>
 by looking in the plugin paths
listed by <a class="link" href="totem-TotemPlugin.html#totem-get-plugin-paths" title="totem_get_plugin_paths ()"><code class="function">totem_get_plugin_paths()</code></a> and then in the system
Totem data directory.</p>
<p>This should be used by plugins to find plugin-specific
resource files.</p>
<div class="refsect3">
<a name="totem-plugin-find-file.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>plugin_name</p></td>
<td class="parameter_description"><p>the plugin name</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>file</p></td>
<td class="parameter_description"><p>the file to find</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="totem-plugin-find-file.returns"></a><h4>Returns</h4>
<p> a newly-allocated absolute path for the file, or <code class="literal">NULL</code></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="totem-plugin-load-interface"></a><h3>totem_plugin_load_interface ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkBuilder</span> *
totem_plugin_load_interface (<em class="parameter"><code>const <span class="type">char</span> *plugin_name</code></em>,
                             <em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
                             <em class="parameter"><code><span class="type">gboolean</span> fatal</code></em>,
                             <em class="parameter"><code><span class="type">GtkWindow</span> *parent</code></em>,
                             <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<p>Loads an interface file (GtkBuilder UI file) for a plugin, given its filename and
assuming it's installed in the plugin's data directory.</p>
<p>This should be used instead of attempting to load interfaces manually in plugins.</p>
<div class="refsect3">
<a name="totem-plugin-load-interface.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>plugin_name</p></td>
<td class="parameter_description"><p>the plugin name</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>interface filename</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>fatal</p></td>
<td class="parameter_description"><p><code class="literal">TRUE</code> if it's a fatal error if the interface can't be loaded</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>parent</p></td>
<td class="parameter_description"><p>the interface's parent <span class="type">GtkWindow</span>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>a pointer to be passed to each signal handler in the interface when they're called. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="totem-plugin-load-interface.returns"></a><h4>Returns</h4>
<p>the <span class="type">GtkBuilder</span> instance for the interface. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="totem-get-plugin-paths"></a><h3>totem_get_plugin_paths ()</h3>
<pre class="programlisting"><span class="returnvalue">char</span> **
totem_get_plugin_paths (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Return a <code class="literal">NULL</code>-terminated array of paths to directories which can contain Totem plugins. This respects the GSettings disable_user_plugins setting.</p>
<div class="refsect3">
<a name="totem-get-plugin-paths.returns"></a><h4>Returns</h4>
<p>a <code class="literal">NULL</code>-terminated array of paths to plugin directories. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="ix02.html#api-index-2.90.0">2.90.0</a></p>
</div>
</div>
<div class="refsect1">
<a name="totem-TotemPlugin.other_details"></a><h2>Types and Values</h2>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.