← Back to branch summary

~ubuntu-branches/ubuntu/precise/gedit/precise

« back to all changes in this revision

Viewing changes to docs/reference/html/GeditPlugin.html

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2010-04-14 16:41:13 UTC
  • mfrom: (1.1.78 upstream)
  • Revision ID: james.westby@ubuntu.com-20100414164113-0xgl3u73pcs0ngbc
Tags: 2.30.0git20100413-0ubuntu1
* Updating to git snaptshot since 2.30.1 will be after lucid
* debian/patches/90_autoconf.patch:
  - new version update

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/html/GeditPlugin.html
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.13 (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
 
<link rel="chapter" href="ch01.html" title="gedit">
14
13
</head>
15
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
16
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
17
16
<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>
 
17
<td><a accesskey="p" href="gedit-gedit-panel.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
19
18
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
20
19
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
21
20
<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>
 
21
<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>
23
22
</tr>
24
23
<tr><td colspan="5" class="shortcuts">
25
24
<a href="#GeditPlugin.synopsis" class="shortcut">Top</a>
43
42
<div class="refsynopsisdiv" title="Synopsis">
44
43
<a name="GeditPlugin.synopsis"></a><h2>Synopsis</h2>
45
44
<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>               (<a class="link" href="GeditPlugin.html" title="GeditPlugin"><span class="returnvalue">GeditPlugin</span></a> *plugin,
47
 
                                                         <a class="link" href="GeditWindow.html" title="GeditWindow"><span class="returnvalue">GeditWindow</span></a> *window);
48
 
<span class="returnvalue">void</span>                <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"><span class="returnvalue">GeditPlugin</span></a> *plugin,
49
 
                                                         <a class="link" href="GeditWindow.html" title="GeditWindow"><span class="returnvalue">GeditWindow</span></a> *window);
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>              (<a class="link" href="GeditPlugin.html" title="GeditPlugin"><span class="returnvalue">GeditPlugin</span></a> *plugin,
51
 
                                                         <a class="link" href="GeditWindow.html" title="GeditWindow"><span class="returnvalue">GeditWindow</span></a> *window);
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>        (<a class="link" href="GeditPlugin.html" title="GeditPlugin"><span class="returnvalue">GeditPlugin</span></a> *plugin);
 
45
<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>,
 
46
                                                         <em class="parameter"><code><a class="link" href="gedit-gedit-window.html#GeditWindow"><span class="type">GeditWindow</span></a> *window</code></em>);
 
47
<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>,
 
48
                                                         <em class="parameter"><code><a class="link" href="gedit-gedit-window.html#GeditWindow"><span class="type">GeditWindow</span></a> *window</code></em>);
 
49
<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>,
 
50
                                                         <em class="parameter"><code><a class="link" href="gedit-gedit-window.html#GeditWindow"><span class="type">GeditWindow</span></a> *window</code></em>);
 
51
<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
52
<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>
54
 
                                                        (<a class="link" href="GeditPlugin.html" title="GeditPlugin"><span class="returnvalue">GeditPlugin</span></a> *plugin);
55
 
#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)
 
53
                                                        (<em class="parameter"><code><a class="link" href="GeditPlugin.html" title="GeditPlugin"><span class="type">GeditPlugin</span></a> *plugin</code></em>);
 
54
#define             <a class="link" href="GeditPlugin.html#GEDIT-PLUGIN-REGISTER-TYPE:CAPS" title="GEDIT_PLUGIN_REGISTER_TYPE()">GEDIT_PLUGIN_REGISTER_TYPE</a>          (PluginName,
 
55
                                                         plugin_name)
56
56
</pre>
57
57
</div>
58
58
<div class="refsect1" title="Object Hierarchy">
72
72
</div>
73
73
<div class="refsect1" title="Description">
74
74
<a name="GeditPlugin.description"></a><h2>Description</h2>
75
 
<p>
76
 
</p>
77
75
</div>
78
76
<div class="refsect1" title="Details">
79
77
<a name="GeditPlugin.details"></a><h2>Details</h2>
80
78
<div class="refsect2" title="GeditPlugin">
81
79
<a name="GeditPlugin-struct"></a><h3>GeditPlugin</h3>
82
80
<pre class="programlisting">typedef struct _GeditPlugin GeditPlugin;</pre>
83
 
<p>
84
 
</p>
85
81
</div>
86
82
<hr>
87
83
<div class="refsect2" title="gedit_plugin_activate ()">
88
84
<a name="gedit-plugin-activate"></a><h3>gedit_plugin_activate ()</h3>
89
 
<pre class="programlisting"><span class="returnvalue">void</span>                gedit_plugin_activate               (<a class="link" href="GeditPlugin.html" title="GeditPlugin"><span class="returnvalue">GeditPlugin</span></a> *plugin,
90
 
                                                         <a class="link" href="GeditWindow.html" title="GeditWindow"><span class="returnvalue">GeditWindow</span></a> *window);</pre>
 
85
<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>,
 
86
                                                         <em class="parameter"><code><a class="link" href="gedit-gedit-window.html#GeditWindow"><span class="type">GeditWindow</span></a> *window</code></em>);</pre>
91
87
<p>
92
 
Activates the plugin.</p>
 
88
Activates the plugin.
 
89
</p>
93
90
<div class="variablelist"><table border="0">
94
91
<col align="left" valign="top">
95
92
<tbody>
96
93
<tr>
97
94
<td><p><span class="term"><em class="parameter"><code>plugin</code></em> :</span></p></td>
98
 
<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>
99
96
</td>
100
97
</tr>
101
98
<tr>
102
99
<td><p><span class="term"><em class="parameter"><code>window</code></em> :</span></p></td>
103
 
<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>
104
101
</td>
105
102
</tr>
106
103
</tbody>
109
106
<hr>
110
107
<div class="refsect2" title="gedit_plugin_deactivate ()">
111
108
<a name="gedit-plugin-deactivate"></a><h3>gedit_plugin_deactivate ()</h3>
112
 
<pre class="programlisting"><span class="returnvalue">void</span>                gedit_plugin_deactivate             (<a class="link" href="GeditPlugin.html" title="GeditPlugin"><span class="returnvalue">GeditPlugin</span></a> *plugin,
113
 
                                                         <a class="link" href="GeditWindow.html" title="GeditWindow"><span class="returnvalue">GeditWindow</span></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>
114
111
<p>
115
 
Deactivates the plugin.</p>
 
112
Deactivates the plugin.
 
113
</p>
116
114
<div class="variablelist"><table border="0">
117
115
<col align="left" valign="top">
118
116
<tbody>
119
117
<tr>
120
118
<td><p><span class="term"><em class="parameter"><code>plugin</code></em> :</span></p></td>
121
 
<td> a <a class="link" href="GeditPlugin.html" title="GeditPlugin"><span class="type">GeditPlugin</span></a>
 
119
<td>a <a class="link" href="GeditPlugin.html" title="GeditPlugin"><span class="type">GeditPlugin</span></a>
122
120
</td>
123
121
</tr>
124
122
<tr>
125
123
<td><p><span class="term"><em class="parameter"><code>window</code></em> :</span></p></td>
126
 
<td> a <a class="link" href="GeditWindow.html" title="GeditWindow"><span class="type">GeditWindow</span></a>
 
124
<td>a <a class="link" href="gedit-gedit-window.html#GeditWindow"><span class="type">GeditWindow</span></a>
127
125
</td>
128
126
</tr>
129
127
</tbody>
132
130
<hr>
133
131
<div class="refsect2" title="gedit_plugin_update_ui ()">
134
132
<a name="gedit-plugin-update-ui"></a><h3>gedit_plugin_update_ui ()</h3>
135
 
<pre class="programlisting"><span class="returnvalue">void</span>                gedit_plugin_update_ui              (<a class="link" href="GeditPlugin.html" title="GeditPlugin"><span class="returnvalue">GeditPlugin</span></a> *plugin,
136
 
                                                         <a class="link" href="GeditWindow.html" title="GeditWindow"><span class="returnvalue">GeditWindow</span></a> *window);</pre>
 
133
<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>,
 
134
                                                         <em class="parameter"><code><a class="link" href="gedit-gedit-window.html#GeditWindow"><span class="type">GeditWindow</span></a> *window</code></em>);</pre>
137
135
<p>
138
136
Triggers an update of the user interface to take into account state changes
139
 
caused by the plugin.</p>
 
137
caused by the plugin.
 
138
</p>
140
139
<div class="variablelist"><table border="0">
141
140
<col align="left" valign="top">
142
141
<tbody>
143
142
<tr>
144
143
<td><p><span class="term"><em class="parameter"><code>plugin</code></em> :</span></p></td>
145
 
<td> a <a class="link" href="GeditPlugin.html" title="GeditPlugin"><span class="type">GeditPlugin</span></a>
 
144
<td>a <a class="link" href="GeditPlugin.html" title="GeditPlugin"><span class="type">GeditPlugin</span></a>
146
145
</td>
147
146
</tr>
148
147
<tr>
149
148
<td><p><span class="term"><em class="parameter"><code>window</code></em> :</span></p></td>
150
 
<td> a <a class="link" href="GeditWindow.html" title="GeditWindow"><span class="type">GeditWindow</span></a>
 
149
<td>a <a class="link" href="gedit-gedit-window.html#GeditWindow"><span class="type">GeditWindow</span></a>
151
150
</td>
152
151
</tr>
153
152
</tbody>
156
155
<hr>
157
156
<div class="refsect2" title="gedit_plugin_is_configurable ()">
158
157
<a name="gedit-plugin-is-configurable"></a><h3>gedit_plugin_is_configurable ()</h3>
159
 
<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        (<a class="link" href="GeditPlugin.html" title="GeditPlugin"><span class="returnvalue">GeditPlugin</span></a> *plugin);</pre>
 
158
<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>
160
159
<p>
161
 
Whether the plugin is configurable.</p>
 
160
Whether the plugin is configurable.
 
161
</p>
162
162
<div class="variablelist"><table border="0">
163
163
<col align="left" valign="top">
164
164
<tbody>
165
165
<tr>
166
166
<td><p><span class="term"><em class="parameter"><code>plugin</code></em> :</span></p></td>
167
 
<td> a <a class="link" href="GeditPlugin.html" title="GeditPlugin"><span class="type">GeditPlugin</span></a>
 
167
<td>a <a class="link" href="GeditPlugin.html" title="GeditPlugin"><span class="type">GeditPlugin</span></a>
168
168
</td>
169
169
</tr>
170
170
<tr>
179
179
<div class="refsect2" title="gedit_plugin_create_configure_dialog ()">
180
180
<a name="gedit-plugin-create-configure-dialog"></a><h3>gedit_plugin_create_configure_dialog ()</h3>
181
181
<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
182
 
                                                        (<a class="link" href="GeditPlugin.html" title="GeditPlugin"><span class="returnvalue">GeditPlugin</span></a> *plugin);</pre>
 
182
                                                        (<em class="parameter"><code><a class="link" href="GeditPlugin.html" title="GeditPlugin"><span class="type">GeditPlugin</span></a> *plugin</code></em>);</pre>
183
183
<p>
184
 
Creates the configure dialog widget for the plugin.</p>
 
184
Creates the configure dialog widget for the plugin.
 
185
</p>
185
186
<div class="variablelist"><table border="0">
186
187
<col align="left" valign="top">
187
188
<tbody>
188
189
<tr>
189
190
<td><p><span class="term"><em class="parameter"><code>plugin</code></em> :</span></p></td>
190
 
<td> a <a class="link" href="GeditPlugin.html" title="GeditPlugin"><span class="type">GeditPlugin</span></a>
 
191
<td>a <a class="link" href="GeditPlugin.html" title="GeditPlugin"><span class="type">GeditPlugin</span></a>
191
192
</td>
192
193
</tr>
193
194
<tr>
202
203
<div class="refsect2" title="GEDIT_PLUGIN_REGISTER_TYPE()">
203
204
<a name="GEDIT-PLUGIN-REGISTER-TYPE:CAPS"></a><h3>GEDIT_PLUGIN_REGISTER_TYPE()</h3>
204
205
<pre class="programlisting">#define             GEDIT_PLUGIN_REGISTER_TYPE(PluginName, plugin_name)</pre>
205
 
<p>
206
 
</p>
207
 
<div class="variablelist"><table border="0">
208
 
<col align="left" valign="top">
209
 
<tbody>
210
 
<tr>
211
 
<td><p><span class="term"><em class="parameter"><code>PluginName</code></em> :</span></p></td>
212
 
<td>
213
 
</td>
214
 
</tr>
215
 
<tr>
216
 
<td><p><span class="term"><em class="parameter"><code>plugin_name</code></em> :</span></p></td>
217
 
<td>
218
 
</td>
219
 
</tr>
220
 
</tbody>
221
 
</table></div>
222
206
</div>
223
207
</div>
224
208
<div class="refsect1" title="Property Details">
247
231
</div>
248
232
<div class="footer">
249
233
<hr>
250
 
          Generated by GTK-Doc V1.13</div>
 
234
          Generated by GTK-Doc V1.14</div>
251
235
</body>
252
236
</html>
 
 
b'\\ No newline at end of file'