/usr/share/gtk-doc/html/libpeas/PeasExtensionBase.html is in libpeas-doc 1.12.1-2.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Peas Reference Manual: PeasExtensionBase</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Peas Reference Manual">
<link rel="up" href="ch01.html" title="Core Classes">
<link rel="prev" href="PeasExtensionSet.html" title="PeasExtensionSet">
<link rel="next" href="PeasObjectModule.html" title="PeasObjectModule">
<meta name="generator" content="GTK-Doc V1.21 (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="#PeasExtensionBase.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#PeasExtensionBase.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#PeasExtensionBase.properties" class="shortcut">Properties</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="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="PeasExtensionSet.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="PeasObjectModule.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="PeasExtensionBase"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="PeasExtensionBase.top_of_page"></a>PeasExtensionBase</span></h2>
<p>PeasExtensionBase — Base class for C extensions.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="PeasExtensionBase.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="returnvalue">PeasPluginInfo</span></a> *
</td>
<td class="function_name">
<a class="link" href="PeasExtensionBase.html#peas-extension-base-get-plugin-info" title="peas_extension_base_get_plugin_info ()">peas_extension_base_get_plugin_info</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="PeasExtensionBase.html#peas-extension-base-get-data-dir" title="peas_extension_base_get_data_dir ()">peas_extension_base_get_data_dir</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="PeasExtensionBase.properties"></a><h2>Properties</h2>
<div class="informaltable"><table border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="PeasExtensionBase.html#PeasExtensionBase--data-dir" title="The “data-dir” property">data-dir</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a> *</td>
<td class="property_name"><a class="link" href="PeasExtensionBase.html#PeasExtensionBase--plugin-info" title="The “plugin-info” property">plugin-info</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="PeasExtensionBase.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="PeasExtensionBase.html#PeasExtensionBase-struct" title="struct PeasExtensionBase">PeasExtensionBase</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="PeasExtensionBase.html#PeasExtensionBaseClass" title="struct PeasExtensionBaseClass">PeasExtensionBaseClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="PeasExtensionBase.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> PeasExtensionBase
</pre>
</div>
<div class="refsect1">
<a name="PeasExtensionBase.description"></a><h2>Description</h2>
<p><a class="link" href="PeasExtensionBase.html" title="PeasExtensionBase"><span class="type">PeasExtensionBase</span></a> can optionally be used as a base class for the extensions
of your plugin. By inheriting from it, you will make your extension able to
access the related <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a>, and especially the location where all
the data of your plugin lives.</p>
<p>Non-C extensions will usually not inherit from this class: Python and
Seed plugins automatically get a "plugin_info" attribute that serves
the same purpose.</p>
</div>
<div class="refsect1">
<a name="PeasExtensionBase.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="peas-extension-base-get-plugin-info"></a><h3>peas_extension_base_get_plugin_info ()</h3>
<pre class="programlisting"><a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="returnvalue">PeasPluginInfo</span></a> *
peas_extension_base_get_plugin_info (<em class="parameter"><code><a class="link" href="PeasExtensionBase.html" title="PeasExtensionBase"><span class="type">PeasExtensionBase</span></a> *extbase</code></em>);</pre>
<p>Get information relative to <em class="parameter"><code>extbase</code></em>
.</p>
<div class="refsect3">
<a name="id-1.2.2.6.8.2.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>extbase</p></td>
<td class="parameter_description"><p>A <a class="link" href="PeasExtensionBase.html" title="PeasExtensionBase"><span class="type">PeasExtensionBase</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.6.8.2.6"></a><h4>Returns</h4>
<p> the <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a> relative
to the <a class="link" href="PeasExtensionBase.html" title="PeasExtensionBase"><span class="type">PeasExtensionBase</span></a>. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="peas-extension-base-get-data-dir"></a><h3>peas_extension_base_get_data_dir ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *
peas_extension_base_get_data_dir (<em class="parameter"><code><a class="link" href="PeasExtensionBase.html" title="PeasExtensionBase"><span class="type">PeasExtensionBase</span></a> *extbase</code></em>);</pre>
<p>Get the path of the directory where the plugin should look for
its data files.</p>
<div class="refsect3">
<a name="id-1.2.2.6.8.3.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>extbase</p></td>
<td class="parameter_description"><p>A <a class="link" href="PeasExtensionBase.html" title="PeasExtensionBase"><span class="type">PeasExtensionBase</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.6.8.3.6"></a><h4>Returns</h4>
<p> A newly allocated string with the path of the
directory where the plugin should look for its data files</p>
<p></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="PeasExtensionBase.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="PeasExtensionBase-struct"></a><h3>struct PeasExtensionBase</h3>
<pre class="programlisting">struct PeasExtensionBase;</pre>
<p>Base class for C extensions.</p>
</div>
<hr>
<div class="refsect2">
<a name="PeasExtensionBaseClass"></a><h3>struct PeasExtensionBaseClass</h3>
<pre class="programlisting">struct PeasExtensionBaseClass {
GObjectClass parent_class;
};
</pre>
<p>The class structure of <a class="link" href="PeasExtensionBase.html" title="PeasExtensionBase"><span class="type">PeasExtensionBase</span></a>.</p>
<div class="refsect3">
<a name="id-1.2.2.6.9.3.5"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody><tr>
<td class="struct_member_name"><p><span class="type">GObjectClass</span> <em class="structfield"><code><a name="PeasExtensionBaseClass.parent-class"></a>parent_class</code></em>;</p></td>
<td class="struct_member_description"><p>The parent class.</p></td>
<td class="struct_member_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="PeasExtensionBase.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="PeasExtensionBase--data-dir"></a><h3>The <code class="literal">“data-dir”</code> property</h3>
<pre class="programlisting"> “data-dir” <span class="type">gchar</span> *</pre>
<p>The full path of the directory where the plugin should look for its data files.</p>
<p>Flags: Read</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="PeasExtensionBase--plugin-info"></a><h3>The <code class="literal">“plugin-info”</code> property</h3>
<pre class="programlisting"> “plugin-info” <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a> *</pre>
<p>Information related to the current plugin.</p>
<p>Flags: Read / Write / Construct Only</p>
</div>
</div>
<div class="refsect1">
<a name="PeasExtensionBase.see-also"></a><h2>See Also</h2>
<p><a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a></p>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.21</div>
</body>
</html>
|