6
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7
7
<link rel="home" href="index.html" title="gedit Reference Manual">
8
8
<link rel="up" href="ch01.html" title="gedit">
9
<link rel="prev" href="GeditPanel.html" title="GeditPanel">
10
<link rel="next" href="gedit-GeditPrintJobPreview.html" title="GeditPrintJobPreview">
11
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
9
<link rel="prev" href="gedit-gedit-panel.html" title="GeditPanel">
10
<link rel="next" href="gedit-gedit-print-job-preview.html" title="GeditPrintJobPreview">
11
<meta name="generator" content="GTK-Doc V1.14 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
<link rel="chapter" href="ch01.html" title="gedit">
15
15
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
16
16
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
17
17
<tr valign="middle">
18
<td><a accesskey="p" href="GeditPanel.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18
<td><a accesskey="p" href="gedit-gedit-panel.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
19
19
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
20
20
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
21
21
<th width="100%" align="center">gedit Reference Manual</th>
22
<td><a accesskey="n" href="gedit-GeditPrintJobPreview.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
22
<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>
24
24
<tr><td colspan="5" class="shortcuts">
25
25
<a href="#GeditPlugin.synopsis" class="shortcut">Top</a>
27
<a href="#GeditPlugin.description" class="shortcut">Description</a>
29
<a href="#GeditPlugin.object-hierarchy" class="shortcut">Object Hierarchy</a>
31
<a href="#GeditPlugin.properties" class="shortcut">Properties</a>
27
<a href="#GeditPlugin.description" class="shortcut">Description</a>
29
<a href="#GeditPlugin.object-hierarchy" class="shortcut">Object Hierarchy</a>
31
<a href="#GeditPlugin.properties" class="shortcut">Properties</a>
34
34
<div class="refentry" title="GeditPlugin">
42
42
</tr></table></div>
43
43
<div class="refsynopsisdiv" title="Synopsis">
44
44
<a name="GeditPlugin.synopsis"></a><h2>Synopsis</h2>
45
<pre class="synopsis">
46
<a class="link" href="GeditPlugin.html#GeditPlugin-struct" title="GeditPlugin">GeditPlugin</a>;
47
void <a class="link" href="GeditPlugin.html#gedit-plugin-activate" title="gedit_plugin_activate ()">gedit_plugin_activate</a> (<a class="link" href="GeditPlugin.html" title="GeditPlugin">GeditPlugin</a> *plugin,
48
<a class="link" href="GeditWindow.html" title="GeditWindow">GeditWindow</a> *window);
49
void <a class="link" href="GeditPlugin.html#gedit-plugin-deactivate" title="gedit_plugin_deactivate ()">gedit_plugin_deactivate</a> (<a class="link" href="GeditPlugin.html" title="GeditPlugin">GeditPlugin</a> *plugin,
50
<a class="link" href="GeditWindow.html" title="GeditWindow">GeditWindow</a> *window);
51
void <a class="link" href="GeditPlugin.html#gedit-plugin-update-ui" title="gedit_plugin_update_ui ()">gedit_plugin_update_ui</a> (<a class="link" href="GeditPlugin.html" title="GeditPlugin">GeditPlugin</a> *plugin,
52
<a class="link" href="GeditWindow.html" title="GeditWindow">GeditWindow</a> *window);
54
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
55
>gboolean</a> <a class="link" href="GeditPlugin.html#gedit-plugin-is-configurable" title="gedit_plugin_is_configurable ()">gedit_plugin_is_configurable</a> (<a class="link" href="GeditPlugin.html" title="GeditPlugin">GeditPlugin</a> *plugin);
57
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
58
>GtkWidget</a> * <a class="link" href="GeditPlugin.html#gedit-plugin-create-configure-dialog" title="gedit_plugin_create_configure_dialog ()">gedit_plugin_create_configure_dialog</a>
59
(<a class="link" href="GeditPlugin.html" title="GeditPlugin">GeditPlugin</a> *plugin);
60
#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)
45
<pre class="synopsis"> <a class="link" href="GeditPlugin.html#GeditPlugin-struct" title="GeditPlugin">GeditPlugin</a>;
46
<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>,
47
<em class="parameter"><code><a class="link" href="gedit-gedit-window.html#GeditWindow"><span class="type">GeditWindow</span></a> *window</code></em>);
48
<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>,
49
<em class="parameter"><code><a class="link" href="gedit-gedit-window.html#GeditWindow"><span class="type">GeditWindow</span></a> *window</code></em>);
50
<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>,
51
<em class="parameter"><code><a class="link" href="gedit-gedit-window.html#GeditWindow"><span class="type">GeditWindow</span></a> *window</code></em>);
52
<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>);
53
<span class="returnvalue">GtkWidget</span> * <a class="link" href="GeditPlugin.html#gedit-plugin-create-configure-dialog" title="gedit_plugin_create_configure_dialog ()">gedit_plugin_create_configure_dialog</a>
54
(<em class="parameter"><code><a class="link" href="GeditPlugin.html" title="GeditPlugin"><span class="type">GeditPlugin</span></a> *plugin</code></em>);
55
#define <a class="link" href="GeditPlugin.html#GEDIT-PLUGIN-REGISTER-TYPE:CAPS" title="GEDIT_PLUGIN_REGISTER_TYPE()">GEDIT_PLUGIN_REGISTER_TYPE</a> (PluginName,
63
59
<div class="refsect1" title="Object Hierarchy">
64
60
<a name="GeditPlugin.object-hierarchy"></a><h2>Object Hierarchy</h2>
65
61
<pre class="synopsis">
67
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
62
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
72
66
<div class="refsect1" title="Properties">
73
67
<a name="GeditPlugin.properties"></a><h2>Properties</h2>
74
68
<pre class="synopsis">
75
"<a class="link" href="GeditPlugin.html#GeditPlugin--data-dir" title='The "data-dir" property'>data-dir</a>" <a
76
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
78
"<a class="link" href="GeditPlugin.html#GeditPlugin--data-dir-name" title='The "data-dir-name" property'>data-dir-name</a>" <a
79
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
80
>gchar</a>* : Write / Construct Only
81
"<a class="link" href="GeditPlugin.html#GeditPlugin--install-dir" title='The "install-dir" property'>install-dir</a>" <a
82
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
83
>gchar</a>* : Read / Write / Construct Only
69
"<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
70
"<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
71
"<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
86
74
<div class="refsect1" title="Description">
87
75
<a name="GeditPlugin.description"></a><h2>Description</h2>
91
77
<div class="refsect1" title="Details">
92
78
<a name="GeditPlugin.details"></a><h2>Details</h2>
93
79
<div class="refsect2" title="GeditPlugin">
94
80
<a name="GeditPlugin-struct"></a><h3>GeditPlugin</h3>
95
81
<pre class="programlisting">typedef struct _GeditPlugin GeditPlugin;</pre>
100
84
<div class="refsect2" title="gedit_plugin_activate ()">
101
85
<a name="gedit-plugin-activate"></a><h3>gedit_plugin_activate ()</h3>
102
<pre class="programlisting">void gedit_plugin_activate (<a class="link" href="GeditPlugin.html" title="GeditPlugin">GeditPlugin</a> *plugin,
103
<a class="link" href="GeditWindow.html" title="GeditWindow">GeditWindow</a> *window);</pre>
86
<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>,
87
<em class="parameter"><code><a class="link" href="gedit-gedit-window.html#GeditWindow"><span class="type">GeditWindow</span></a> *window</code></em>);</pre>
105
89
Activates the plugin.</p>
108
90
<div class="variablelist"><table border="0">
109
91
<col align="left" valign="top">
112
94
<td><p><span class="term"><em class="parameter"><code>plugin</code></em> :</span></p></td>
113
<td> a <a class="link" href="GeditPlugin.html" title="GeditPlugin"><span class="type">GeditPlugin</span></a>
95
<td>a <a class="link" href="GeditPlugin.html" title="GeditPlugin"><span class="type">GeditPlugin</span></a>
117
99
<td><p><span class="term"><em class="parameter"><code>window</code></em> :</span></p></td>
118
<td> a <a class="link" href="GeditWindow.html" title="GeditWindow"><span class="type">GeditWindow</span></a>
100
<td>a <a class="link" href="gedit-gedit-window.html#GeditWindow"><span class="type">GeditWindow</span></a>
125
107
<div class="refsect2" title="gedit_plugin_deactivate ()">
126
108
<a name="gedit-plugin-deactivate"></a><h3>gedit_plugin_deactivate ()</h3>
127
<pre class="programlisting">void gedit_plugin_deactivate (<a class="link" href="GeditPlugin.html" title="GeditPlugin">GeditPlugin</a> *plugin,
128
<a class="link" href="GeditWindow.html" title="GeditWindow">GeditWindow</a> *window);</pre>
109
<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>,
110
<em class="parameter"><code><a class="link" href="gedit-gedit-window.html#GeditWindow"><span class="type">GeditWindow</span></a> *window</code></em>);</pre>
130
112
Deactivates the plugin.</p>
133
113
<div class="variablelist"><table border="0">
134
114
<col align="left" valign="top">
137
117
<td><p><span class="term"><em class="parameter"><code>plugin</code></em> :</span></p></td>
138
<td> a <a class="link" href="GeditPlugin.html" title="GeditPlugin"><span class="type">GeditPlugin</span></a>
118
<td>a <a class="link" href="GeditPlugin.html" title="GeditPlugin"><span class="type">GeditPlugin</span></a>
142
122
<td><p><span class="term"><em class="parameter"><code>window</code></em> :</span></p></td>
143
<td> a <a class="link" href="GeditWindow.html" title="GeditWindow"><span class="type">GeditWindow</span></a>
123
<td>a <a class="link" href="gedit-gedit-window.html#GeditWindow"><span class="type">GeditWindow</span></a>
150
130
<div class="refsect2" title="gedit_plugin_update_ui ()">
151
131
<a name="gedit-plugin-update-ui"></a><h3>gedit_plugin_update_ui ()</h3>
152
<pre class="programlisting">void gedit_plugin_update_ui (<a class="link" href="GeditPlugin.html" title="GeditPlugin">GeditPlugin</a> *plugin,
153
<a class="link" href="GeditWindow.html" title="GeditWindow">GeditWindow</a> *window);</pre>
132
<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>,
133
<em class="parameter"><code><a class="link" href="gedit-gedit-window.html#GeditWindow"><span class="type">GeditWindow</span></a> *window</code></em>);</pre>
155
135
Triggers an update of the user interface to take into account state changes
156
136
caused by the plugin.</p>
159
137
<div class="variablelist"><table border="0">
160
138
<col align="left" valign="top">
163
141
<td><p><span class="term"><em class="parameter"><code>plugin</code></em> :</span></p></td>
164
<td> a <a class="link" href="GeditPlugin.html" title="GeditPlugin"><span class="type">GeditPlugin</span></a>
142
<td>a <a class="link" href="GeditPlugin.html" title="GeditPlugin"><span class="type">GeditPlugin</span></a>
168
146
<td><p><span class="term"><em class="parameter"><code>window</code></em> :</span></p></td>
169
<td> a <a class="link" href="GeditWindow.html" title="GeditWindow"><span class="type">GeditWindow</span></a>
147
<td>a <a class="link" href="gedit-gedit-window.html#GeditWindow"><span class="type">GeditWindow</span></a>
202
176
<div class="refsect2" title="gedit_plugin_create_configure_dialog ()">
203
177
<a name="gedit-plugin-create-configure-dialog"></a><h3>gedit_plugin_create_configure_dialog ()</h3>
204
<pre class="programlisting"><a
205
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
206
>GtkWidget</a> * gedit_plugin_create_configure_dialog
207
(<a class="link" href="GeditPlugin.html" title="GeditPlugin">GeditPlugin</a> *plugin);</pre>
178
<pre class="programlisting"><span class="returnvalue">GtkWidget</span> * gedit_plugin_create_configure_dialog
179
(<em class="parameter"><code><a class="link" href="GeditPlugin.html" title="GeditPlugin"><span class="type">GeditPlugin</span></a> *plugin</code></em>);</pre>
209
181
Creates the configure dialog widget for the plugin.</p>
212
182
<div class="variablelist"><table border="0">
213
183
<col align="left" valign="top">
216
186
<td><p><span class="term"><em class="parameter"><code>plugin</code></em> :</span></p></td>
217
<td> a <a class="link" href="GeditPlugin.html" title="GeditPlugin"><span class="type">GeditPlugin</span></a>
187
<td>a <a class="link" href="GeditPlugin.html" title="GeditPlugin"><span class="type">GeditPlugin</span></a>
229
199
<div class="refsect2" title="GEDIT_PLUGIN_REGISTER_TYPE()">
230
<a name="GEDIT-PLUGIN-REGISTER-TYPE--CAPS"></a><h3>GEDIT_PLUGIN_REGISTER_TYPE()</h3>
200
<a name="GEDIT-PLUGIN-REGISTER-TYPE:CAPS"></a><h3>GEDIT_PLUGIN_REGISTER_TYPE()</h3>
231
201
<pre class="programlisting">#define GEDIT_PLUGIN_REGISTER_TYPE(PluginName, plugin_name)</pre>
233
Utility macro used to register plugins.</p>
236
<div class="variablelist"><table border="0">
237
<col align="left" valign="top">
240
<td><p><span class="term"><em class="parameter"><code>PluginName</code></em> :</span></p></td>
245
<td><p><span class="term"><em class="parameter"><code>plugin_name</code></em> :</span></p></td>
253
204
<div class="refsect1" title="Property Details">
254
205
<a name="GeditPlugin.property-details"></a><h2>Property Details</h2>
255
206
<div class="refsect2" title='The "data-dir" property'>
256
207
<a name="GeditPlugin--data-dir"></a><h3>The <code class="literal">"data-dir"</code> property</h3>
257
<pre class="programlisting"> "data-dir" <a
258
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
259
>gchar</a>* : Read</pre>
208
<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>
260
209
<p>The full path of the directory where the plugin should look for its data files.</p>
261
210
<p>Default value: NULL</p>
264
213
<div class="refsect2" title='The "data-dir-name" property'>
265
214
<a name="GeditPlugin--data-dir-name"></a><h3>The <code class="literal">"data-dir-name"</code> property</h3>
266
<pre class="programlisting"> "data-dir-name" <a
267
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
268
>gchar</a>* : Write / Construct Only</pre>
215
<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>
269
216
<p>The basename of the directory where the plugin should look for its data files.</p>
270
217
<p>Default value: NULL</p>
273
220
<div class="refsect2" title='The "install-dir" property'>
274
221
<a name="GeditPlugin--install-dir"></a><h3>The <code class="literal">"install-dir"</code> property</h3>
275
<pre class="programlisting"> "install-dir" <a
276
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
277
>gchar</a>* : Read / Write / Construct Only</pre>
222
<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>
278
223
<p>The directory where the plugin is installed.</p>
279
224
<p>Default value: NULL</p>