This file is indexed.

/usr/share/gtk-doc/html/libxfce4panel-1.0/libxfce4panel-Panel-Plugin-Register-Macros-(4.6-Style).html is in xfce4-panel-dev 4.11.0-0ubuntu1.

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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Panel Plugin Register Macros (4.6 Style)</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Libxfce4panel Reference Manual">
<link rel="up" href="libxfce4panel-plugins.html" title="Part II. Panel Plugins">
<link rel="prev" href="libxfce4panel-Panel-Plugin-Register-Macros.html" title="Panel Plugin Register Macros">
<link rel="next" href="libxfce4panel-GObject-Oriented-Panel-Plugin-Registers-Macros.html" title="GObject Oriented Panel Plugin Registers Macros">
<meta name="generator" content="GTK-Doc V1.19 (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="libxfce4panel-Panel-Plugin-Register-Macros.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libxfce4panel-plugins.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">Libxfce4panel Reference Manual</th>
<td><a accesskey="n" href="libxfce4panel-GObject-Oriented-Panel-Plugin-Registers-Macros.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libxfce4panel-Panel-Plugin-Register-Macros-(4.6-Style).synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#libxfce4panel-Panel-Plugin-Register-Macros-(4.6-Style).description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libxfce4panel-Panel-Plugin-Register-Macros-(4.6-Style)"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libxfce4panel-Panel-Plugin-Register-Macros-(4.6-Style).top_of_page"></a>Panel Plugin Register Macros (4.6 Style)</span></h2>
<p>Panel Plugin Register Macros (4.6 Style) — The 4.6 way of registering plugins that compiled as executables</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libxfce4panel-Panel-Plugin-Register-Macros-(4.6-Style).synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;libxfce4panel/libxfce4panel.h&gt;

#define             <a class="link" href="libxfce4panel-Panel-Plugin-Register-Macros-(4.6-Style).html#XFCE-PANEL-PLUGIN-REGISTER-EXTERNAL:CAPS" title="XFCE_PANEL_PLUGIN_REGISTER_EXTERNAL()">XFCE_PANEL_PLUGIN_REGISTER_EXTERNAL</a> (construct_func)
#define             <a class="link" href="libxfce4panel-Panel-Plugin-Register-Macros-(4.6-Style).html#XFCE-PANEL-PLUGIN-REGISTER-EXTERNAL-FULL:CAPS" title="XFCE_PANEL_PLUGIN_REGISTER_EXTERNAL_FULL()">XFCE_PANEL_PLUGIN_REGISTER_EXTERNAL_FULL</a>(construct_func,
                                                         preinit_func,
                                                         check_func)
#define             <a class="link" href="libxfce4panel-Panel-Plugin-Register-Macros-(4.6-Style).html#XFCE-PANEL-PLUGIN-REGISTER-EXTERNAL-WITH-CHECK:CAPS" title="XFCE_PANEL_PLUGIN_REGISTER_EXTERNAL_WITH_CHECK()">XFCE_PANEL_PLUGIN_REGISTER_EXTERNAL_WITH_CHECK</a>(construct_func,
                                                         check_func)

#define             <a class="link" href="libxfce4panel-Panel-Plugin-Register-Macros-(4.6-Style).html#XFCE-PANEL-PLUGIN-REGISTER-INTERNAL:CAPS" title="XFCE_PANEL_PLUGIN_REGISTER_INTERNAL()">XFCE_PANEL_PLUGIN_REGISTER_INTERNAL</a> (construct_func)
#define             <a class="link" href="libxfce4panel-Panel-Plugin-Register-Macros-(4.6-Style).html#XFCE-PANEL-PLUGIN-REGISTER-INTERNAL-WITH-CHECK:CAPS" title="XFCE_PANEL_PLUGIN_REGISTER_INTERNAL_WITH_CHECK()">XFCE_PANEL_PLUGIN_REGISTER_INTERNAL_WITH_CHECK</a>(construct_func,
                                                         check_func)
</pre>
</div>
<div class="refsect1">
<a name="libxfce4panel-Panel-Plugin-Register-Macros-(4.6-Style).description"></a><h2>Description</h2>
<p>
Macros to register old external panel plugins that are compiled as executables.
</p>
</div>
<div class="refsect1">
<a name="libxfce4panel-Panel-Plugin-Register-Macros-(4.6-Style).details"></a><h2>Details</h2>
<div class="refsect2">
<a name="XFCE-PANEL-PLUGIN-REGISTER-EXTERNAL:CAPS"></a><h3>XFCE_PANEL_PLUGIN_REGISTER_EXTERNAL()</h3>
<pre class="programlisting">#define             XFCE_PANEL_PLUGIN_REGISTER_EXTERNAL(construct_func)</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">XFCE_PANEL_PLUGIN_REGISTER_EXTERNAL</code> has been deprecated since version 4.8 and should not be used in newly-written code. Deprecation is not entirely true, but it should be made
                 clear that it is recommended to use <a class="link" href="libxfce4panel-Panel-Plugin-Register-Macros.html#XFCE-PANEL-PLUGIN-REGISTER:CAPS" title="XFCE_PANEL_PLUGIN_REGISTER()"><code class="function">XFCE_PANEL_PLUGIN_REGISTER()</code></a>.
                 See the <a class="link" href="libxfce4panel-plugins.html#libxfce4panel-register" title="Register plugins with the panel">Registering Plugins</a>
                 for more information.</p>
</div>
<p>
Registers and initializes the plugin. This is the only thing that is
required to create a panel plugin.
</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>construct_func</code></em> :</span></p></td>
<td>name of a function that can be cast to an
<a class="link" href="libxfce4panel-Panel-Plugin-Register-Macros.html#XfcePanelPluginFunc" title="XfcePanelPluginFunc ()"><span class="type">XfcePanelPluginFunc</span></a>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="XFCE-PANEL-PLUGIN-REGISTER-EXTERNAL-FULL:CAPS"></a><h3>XFCE_PANEL_PLUGIN_REGISTER_EXTERNAL_FULL()</h3>
<pre class="programlisting">#define             XFCE_PANEL_PLUGIN_REGISTER_EXTERNAL_FULL(construct_func, preinit_func, check_func)</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">XFCE_PANEL_PLUGIN_REGISTER_EXTERNAL_FULL</code> has been deprecated since version 4.8 and should not be used in newly-written code. Deprecation is not entirely true, but it should be made
                 clear that it is recommended to use <a class="link" href="libxfce4panel-Panel-Plugin-Register-Macros.html#XFCE-PANEL-PLUGIN-REGISTER-FULL:CAPS" title="XFCE_PANEL_PLUGIN_REGISTER_FULL()"><code class="function">XFCE_PANEL_PLUGIN_REGISTER_FULL()</code></a>.
                 See the <a class="link" href="libxfce4panel-plugins.html#libxfce4panel-register" title="Register plugins with the panel">Registering Plugins</a>
                 for more information.</p>
</div>
<p>
Same as <a class="link" href="libxfce4panel-Panel-Plugin-Register-Macros-(4.6-Style).html#XFCE-PANEL-PLUGIN-REGISTER-EXTERNAL-WITH-CHECK:CAPS" title="XFCE_PANEL_PLUGIN_REGISTER_EXTERNAL_WITH_CHECK()"><code class="function">XFCE_PANEL_PLUGIN_REGISTER_EXTERNAL_WITH_CHECK()</code></a>, but with a
preinit function that is called before <a href="http://developer.gnome.org/gtk2/gtk3-General.html#gtk-init"><code class="function">gtk_init()</code></a>. This allows plugins
to initialize libraries or threads.
</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>construct_func</code></em> :</span></p></td>
<td>name of a function that can be cast to an
<a class="link" href="libxfce4panel-Panel-Plugin-Register-Macros.html#XfcePanelPluginFunc" title="XfcePanelPluginFunc ()"><span class="type">XfcePanelPluginFunc</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>preinit_func</code></em> :</span></p></td>
<td>name of a function that can be case to <a class="link" href="libxfce4panel-Panel-Plugin-Register-Macros.html#XfcePanelPluginPreInit" title="XfcePanelPluginPreInit ()"><span class="type">XfcePanelPluginPreInit</span></a>
or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>check_func</code></em> :</span></p></td>
<td>name of a function that can be cast to an
<a class="link" href="libxfce4panel-Panel-Plugin-Register-Macros.html#XfcePanelPluginCheck" title="XfcePanelPluginCheck ()"><span class="type">XfcePanelPluginCheck</span></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 4.6</p>
</div>
<hr>
<div class="refsect2">
<a name="XFCE-PANEL-PLUGIN-REGISTER-EXTERNAL-WITH-CHECK:CAPS"></a><h3>XFCE_PANEL_PLUGIN_REGISTER_EXTERNAL_WITH_CHECK()</h3>
<pre class="programlisting">#define             XFCE_PANEL_PLUGIN_REGISTER_EXTERNAL_WITH_CHECK(construct_func ,check_func)</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">XFCE_PANEL_PLUGIN_REGISTER_EXTERNAL_WITH_CHECK</code> has been deprecated since version 4.8 and should not be used in newly-written code. Deprecation is not entirely true, but it should be made
                 clear that it is recommended to use <a class="link" href="libxfce4panel-Panel-Plugin-Register-Macros.html#XFCE-PANEL-PLUGIN-REGISTER-WITH-CHECK:CAPS" title="XFCE_PANEL_PLUGIN_REGISTER_WITH_CHECK()"><code class="function">XFCE_PANEL_PLUGIN_REGISTER_WITH_CHECK()</code></a>.
                 See the <a class="link" href="libxfce4panel-plugins.html#libxfce4panel-register" title="Register plugins with the panel">Registering Plugins</a>
                 for more information.</p>
</div>
<p>
Registers and initializes the plugin. This is the only thing that is
required to create a panel plugin. The <em class="parameter"><code>check</code></em> functions is run before
creating the plugin, and should return FALSE if plugin creation is not
possible.
</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>construct_func</code></em> :</span></p></td>
<td>name of a function that can be cast to an
<a class="link" href="libxfce4panel-Panel-Plugin-Register-Macros.html#XfcePanelPluginFunc" title="XfcePanelPluginFunc ()"><span class="type">XfcePanelPluginFunc</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>check_func</code></em> :</span></p></td>
<td>name of a function that can be cast to an
<a class="link" href="libxfce4panel-Panel-Plugin-Register-Macros.html#XfcePanelPluginCheck" title="XfcePanelPluginCheck ()"><span class="type">XfcePanelPluginCheck</span></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="XFCE-PANEL-PLUGIN-REGISTER-INTERNAL:CAPS"></a><h3>XFCE_PANEL_PLUGIN_REGISTER_INTERNAL()</h3>
<pre class="programlisting">#define             XFCE_PANEL_PLUGIN_REGISTER_INTERNAL(construct_func)</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">XFCE_PANEL_PLUGIN_REGISTER_INTERNAL</code> has been deprecated since version 4.8 and should not be used in newly-written code. Use <a class="link" href="libxfce4panel-Panel-Plugin-Register-Macros.html#XFCE-PANEL-PLUGIN-REGISTER:CAPS" title="XFCE_PANEL_PLUGIN_REGISTER()"><code class="function">XFCE_PANEL_PLUGIN_REGISTER()</code></a> instead.</p>
</div>
<p>
See <a class="link" href="libxfce4panel-Panel-Plugin-Register-Macros.html#XFCE-PANEL-PLUGIN-REGISTER:CAPS" title="XFCE_PANEL_PLUGIN_REGISTER()"><code class="function">XFCE_PANEL_PLUGIN_REGISTER()</code></a> for more information.
</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>construct_func</code></em> :</span></p></td>
<td>name of a function that can be cast to an
<a class="link" href="libxfce4panel-Panel-Plugin-Register-Macros.html#XfcePanelPluginFunc" title="XfcePanelPluginFunc ()"><span class="type">XfcePanelPluginFunc</span></a>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="XFCE-PANEL-PLUGIN-REGISTER-INTERNAL-WITH-CHECK:CAPS"></a><h3>XFCE_PANEL_PLUGIN_REGISTER_INTERNAL_WITH_CHECK()</h3>
<pre class="programlisting">#define             XFCE_PANEL_PLUGIN_REGISTER_INTERNAL_WITH_CHECK(construct_func ,check_func)</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">XFCE_PANEL_PLUGIN_REGISTER_INTERNAL_WITH_CHECK</code> has been deprecated since version 4.8 and should not be used in newly-written code. use <a class="link" href="libxfce4panel-Panel-Plugin-Register-Macros.html#XFCE-PANEL-PLUGIN-REGISTER-WITH-CHECK:CAPS" title="XFCE_PANEL_PLUGIN_REGISTER_WITH_CHECK()"><code class="function">XFCE_PANEL_PLUGIN_REGISTER_WITH_CHECK()</code></a> instead.</p>
</div>
<p>
See <a class="link" href="libxfce4panel-Panel-Plugin-Register-Macros.html#XFCE-PANEL-PLUGIN-REGISTER:CAPS" title="XFCE_PANEL_PLUGIN_REGISTER()"><code class="function">XFCE_PANEL_PLUGIN_REGISTER()</code></a> for more information.
</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>construct_func</code></em> :</span></p></td>
<td>name of a function that can be cast to an
<a class="link" href="libxfce4panel-Panel-Plugin-Register-Macros.html#XfcePanelPluginFunc" title="XfcePanelPluginFunc ()"><span class="type">XfcePanelPluginFunc</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>check_func</code></em> :</span></p></td>
<td>name of a function that can be cast to an
<a class="link" href="libxfce4panel-Panel-Plugin-Register-Macros.html#XfcePanelPluginCheck" title="XfcePanelPluginCheck ()"><span class="type">XfcePanelPluginCheck</span></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.19</div>
</body>
</html>