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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GeditPlugin</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="gedit Reference Manual">
<link rel="up" href="ch01.html" title="gedit">
<link rel="prev" href="gedit-gedit-panel.html" title="GeditPanel">
<link rel="next" href="gedit-gedit-print-job-preview.html" title="GeditPrintJobPreview">
<meta name="generator" content="GTK-Doc V1.15 (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="gedit-gedit-panel.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">gedit Reference Manual</th>
<td><a accesskey="n" href="gedit-gedit-print-job-preview.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GeditPlugin.synopsis" class="shortcut">Top</a>
|
<a href="#GeditPlugin.description" class="shortcut">Description</a>
|
<a href="#GeditPlugin.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#GeditPlugin.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry" title="GeditPlugin">
<a name="GeditPlugin"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GeditPlugin.top_of_page"></a>GeditPlugin</span></h2>
<p>GeditPlugin</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="GeditPlugin.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"> <a class="link" href="GeditPlugin.html#GeditPlugin-struct" title="GeditPlugin">GeditPlugin</a>;
<span class="returnvalue">void</span> <a class="link" href="GeditPlugin.html#gedit-plugin-activate" title="gedit_plugin_activate ()">gedit_plugin_activate</a> (<em class="parameter"><code><a class="link" href="GeditPlugin.html" title="GeditPlugin"><span class="type">GeditPlugin</span></a> *plugin</code></em>,
<em class="parameter"><code><a class="link" href="gedit-gedit-window.html#GeditWindow"><span class="type">GeditWindow</span></a> *window</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GeditPlugin.html#gedit-plugin-deactivate" title="gedit_plugin_deactivate ()">gedit_plugin_deactivate</a> (<em class="parameter"><code><a class="link" href="GeditPlugin.html" title="GeditPlugin"><span class="type">GeditPlugin</span></a> *plugin</code></em>,
<em class="parameter"><code><a class="link" href="gedit-gedit-window.html#GeditWindow"><span class="type">GeditWindow</span></a> *window</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GeditPlugin.html#gedit-plugin-update-ui" title="gedit_plugin_update_ui ()">gedit_plugin_update_ui</a> (<em class="parameter"><code><a class="link" href="GeditPlugin.html" title="GeditPlugin"><span class="type">GeditPlugin</span></a> *plugin</code></em>,
<em class="parameter"><code><a class="link" href="gedit-gedit-window.html#GeditWindow"><span class="type">GeditWindow</span></a> *window</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GeditPlugin.html#gedit-plugin-is-configurable" title="gedit_plugin_is_configurable ()">gedit_plugin_is_configurable</a> (<em class="parameter"><code><a class="link" href="GeditPlugin.html" title="GeditPlugin"><span class="type">GeditPlugin</span></a> *plugin</code></em>);
<a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> * <a class="link" href="GeditPlugin.html#gedit-plugin-create-configure-dialog" title="gedit_plugin_create_configure_dialog ()">gedit_plugin_create_configure_dialog</a>
(<em class="parameter"><code><a class="link" href="GeditPlugin.html" title="GeditPlugin"><span class="type">GeditPlugin</span></a> *plugin</code></em>);
#define <a class="link" href="GeditPlugin.html#GEDIT-PLUGIN-REGISTER-TYPE:CAPS" title="GEDIT_PLUGIN_REGISTER_TYPE()">GEDIT_PLUGIN_REGISTER_TYPE</a> (PluginName,
plugin_name)
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="GeditPlugin.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+----GeditPlugin
</pre>
</div>
<div class="refsect1" title="Properties">
<a name="GeditPlugin.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="GeditPlugin.html#GeditPlugin--data-dir" title='The "data-dir" property'>data-dir</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read
"<a class="link" href="GeditPlugin.html#GeditPlugin--data-dir-name" title='The "data-dir-name" property'>data-dir-name</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Write / Construct Only
"<a class="link" href="GeditPlugin.html#GeditPlugin--install-dir" title='The "install-dir" property'>install-dir</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct Only
</pre>
</div>
<div class="refsect1" title="Description">
<a name="GeditPlugin.description"></a><h2>Description</h2>
</div>
<div class="refsect1" title="Details">
<a name="GeditPlugin.details"></a><h2>Details</h2>
<div class="refsect2" title="GeditPlugin">
<a name="GeditPlugin-struct"></a><h3>GeditPlugin</h3>
<pre class="programlisting">typedef struct _GeditPlugin GeditPlugin;</pre>
</div>
<hr>
<div class="refsect2" title="gedit_plugin_activate ()">
<a name="gedit-plugin-activate"></a><h3>gedit_plugin_activate ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gedit_plugin_activate (<em class="parameter"><code><a class="link" href="GeditPlugin.html" title="GeditPlugin"><span class="type">GeditPlugin</span></a> *plugin</code></em>,
<em class="parameter"><code><a class="link" href="gedit-gedit-window.html#GeditWindow"><span class="type">GeditWindow</span></a> *window</code></em>);</pre>
<p>
Activates the plugin.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>plugin</code></em> :</span></p></td>
<td>a <a class="link" href="GeditPlugin.html" title="GeditPlugin"><span class="type">GeditPlugin</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>window</code></em> :</span></p></td>
<td>a <a class="link" href="gedit-gedit-window.html#GeditWindow"><span class="type">GeditWindow</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gedit_plugin_deactivate ()">
<a name="gedit-plugin-deactivate"></a><h3>gedit_plugin_deactivate ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gedit_plugin_deactivate (<em class="parameter"><code><a class="link" href="GeditPlugin.html" title="GeditPlugin"><span class="type">GeditPlugin</span></a> *plugin</code></em>,
<em class="parameter"><code><a class="link" href="gedit-gedit-window.html#GeditWindow"><span class="type">GeditWindow</span></a> *window</code></em>);</pre>
<p>
Deactivates the plugin.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>plugin</code></em> :</span></p></td>
<td>a <a class="link" href="GeditPlugin.html" title="GeditPlugin"><span class="type">GeditPlugin</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>window</code></em> :</span></p></td>
<td>a <a class="link" href="gedit-gedit-window.html#GeditWindow"><span class="type">GeditWindow</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gedit_plugin_update_ui ()">
<a name="gedit-plugin-update-ui"></a><h3>gedit_plugin_update_ui ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gedit_plugin_update_ui (<em class="parameter"><code><a class="link" href="GeditPlugin.html" title="GeditPlugin"><span class="type">GeditPlugin</span></a> *plugin</code></em>,
<em class="parameter"><code><a class="link" href="gedit-gedit-window.html#GeditWindow"><span class="type">GeditWindow</span></a> *window</code></em>);</pre>
<p>
Triggers an update of the user interface to take into account state changes
caused by the plugin.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>plugin</code></em> :</span></p></td>
<td>a <a class="link" href="GeditPlugin.html" title="GeditPlugin"><span class="type">GeditPlugin</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>window</code></em> :</span></p></td>
<td>a <a class="link" href="gedit-gedit-window.html#GeditWindow"><span class="type">GeditWindow</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gedit_plugin_is_configurable ()">
<a name="gedit-plugin-is-configurable"></a><h3>gedit_plugin_is_configurable ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gedit_plugin_is_configurable (<em class="parameter"><code><a class="link" href="GeditPlugin.html" title="GeditPlugin"><span class="type">GeditPlugin</span></a> *plugin</code></em>);</pre>
<p>
Whether the plugin is configurable.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>plugin</code></em> :</span></p></td>
<td>a <a class="link" href="GeditPlugin.html" title="GeditPlugin"><span class="type">GeditPlugin</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> TRUE if the plugin is configurable:
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gedit_plugin_create_configure_dialog ()">
<a name="gedit-plugin-create-configure-dialog"></a><h3>gedit_plugin_create_configure_dialog ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> * gedit_plugin_create_configure_dialog
(<em class="parameter"><code><a class="link" href="GeditPlugin.html" title="GeditPlugin"><span class="type">GeditPlugin</span></a> *plugin</code></em>);</pre>
<p>
Creates the configure dialog widget for the plugin.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>plugin</code></em> :</span></p></td>
<td>a <a class="link" href="GeditPlugin.html" title="GeditPlugin"><span class="type">GeditPlugin</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the configure dialog widget for the plugin.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="GEDIT_PLUGIN_REGISTER_TYPE()">
<a name="GEDIT-PLUGIN-REGISTER-TYPE:CAPS"></a><h3>GEDIT_PLUGIN_REGISTER_TYPE()</h3>
<pre class="programlisting">#define GEDIT_PLUGIN_REGISTER_TYPE(PluginName, plugin_name)</pre>
</div>
</div>
<div class="refsect1" title="Property Details">
<a name="GeditPlugin.property-details"></a><h2>Property Details</h2>
<div class="refsect2" title='The "data-dir" property'>
<a name="GeditPlugin--data-dir"></a><h3>The <code class="literal">"data-dir"</code> property</h3>
<pre class="programlisting"> "data-dir" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : 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" title='The "data-dir-name" property'>
<a name="GeditPlugin--data-dir-name"></a><h3>The <code class="literal">"data-dir-name"</code> property</h3>
<pre class="programlisting"> "data-dir-name" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Write / Construct Only</pre>
<p>The basename of the directory where the plugin should look for its data files.</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2" title='The "install-dir" property'>
<a name="GeditPlugin--install-dir"></a><h3>The <code class="literal">"install-dir"</code> property</h3>
<pre class="programlisting"> "install-dir" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct Only</pre>
<p>The directory where the plugin is installed.</p>
<p>Default value: NULL</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.15</div>
</body>
</html>
|
