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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>PeasExtensionBase</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.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.18.1 (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="PeasExtensionSet.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.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">Peas Reference Manual</th>
<td><a accesskey="n" href="PeasObjectModule.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#PeasExtensionBase.synopsis" class="shortcut">Top</a>
|
<a href="#PeasExtensionBase.description" class="shortcut">Description</a>
|
<a href="#PeasExtensionBase.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#PeasExtensionBase.properties" class="shortcut">Properties</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 valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="PeasExtensionBase.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct <a class="link" href="PeasExtensionBase.html#PeasExtensionBase-struct" title="struct PeasExtensionBase">PeasExtensionBase</a>;
struct <a class="link" href="PeasExtensionBase.html#PeasExtensionBaseClass" title="struct PeasExtensionBaseClass">PeasExtensionBaseClass</a>;
<a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="returnvalue">PeasPluginInfo</span></a> * <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> (<em class="parameter"><code><a class="link" href="PeasExtensionBase.html" title="PeasExtensionBase"><span class="type">PeasExtensionBase</span></a> *extbase</code></em>);
<span class="returnvalue">gchar</span> * <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> (<em class="parameter"><code><a class="link" href="PeasExtensionBase.html" title="PeasExtensionBase"><span class="type">PeasExtensionBase</span></a> *extbase</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="PeasExtensionBase.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----PeasExtensionBase
</pre>
</div>
<div class="refsect1">
<a name="PeasExtensionBase.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="PeasExtensionBase.html#PeasExtensionBase--data-dir" title='The "data-dir" property'>data-dir</a>" <span class="type">gchar</span>* : Read
"<a class="link" href="PeasExtensionBase.html#PeasExtensionBase--plugin-info" title='The "plugin-info" property'>plugin-info</a>" <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a>* : Read / Write / Construct Only
</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, Seed
and GJS plugins automatically get a "plugin_info" attribute that serves
the same purpose.
</p>
</div>
<div class="refsect1">
<a name="PeasExtensionBase.details"></a><h2>Details</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="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="type">GObjectClass</span> <em class="structfield"><code><a name="PeasExtensionBaseClass.parent-class"></a>parent_class</code></em>;</span></p></td>
<td>The parent class.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<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="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>extbase</code></em> :</span></p></td>
<td>A <a class="link" href="PeasExtensionBase.html" title="PeasExtensionBase"><span class="type">PeasExtensionBase</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>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>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></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="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>extbase</code></em> :</span></p></td>
<td>A <a class="link" href="PeasExtensionBase.html" title="PeasExtensionBase"><span class="type">PeasExtensionBase</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A newly allocated string with the path of the
directory where the plugin should look for its data files</td>
</tr>
</tbody>
</table></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>* : Read</pre>
<p>The full path of the directory where the plugin should look for its data files.</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>* : Read / Write / Construct Only</pre>
<p>Information related to the current plugin.</p>
</div>
</div>
<div class="refsect1">
<a name="PeasExtensionBase.see-also"></a><h2>See Also</h2>
<a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18.1</div>
</body>
</html>
|
