← Back to branch summary

~ubuntu-branches/ubuntu/natty/eog/natty

« back to all changes in this revision

Viewing changes to doc/reference/html/eog-eog-plugin.html

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2010-05-20 15:09:47 UTC
  • mfrom: (1.14.6 upstream) (2.1.9 squeeze)
  • Revision ID: james.westby@ubuntu.com-20100520150947-esb0vjp9p72g74qt
Tags: 2.30.1-1ubuntu1
* Resync on Debian
* debian/control.in, 
  debian/rules:
  - build with python
* debian/control.in,
  debian/patches/01_lpi.patch,
  debian/patches/99_autoconf.patch:
  - launchpad integration changes
* debian/patches/02_toolbar_edit_button.patch:
  - change by Ryan Lortie to add an edit button to the toolbar
  - set /apps/eog/ui/external_editor to f-spot-viewer, it can't do editing
    right now but that will be changed in lucid

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/html/eog-eog-plugin.html
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html>
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 
5
<title>EogPlugin</title>
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
 
7
<link rel="home" href="index.html" title="Eye of GNOME Reference Manual">
 
8
<link rel="up" href="ch05.html" title="Plugins">
 
9
<link rel="prev" href="ch05.html" title="Plugins">
 
10
<link rel="next" href="EogPluginManager.html" title="EogPluginManager">
 
11
<meta name="generator" content="GTK-Doc V1.14 (XML mode)">
 
12
<link rel="stylesheet" href="style.css" type="text/css">
 
13
</head>
 
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
 
16
<tr valign="middle">
 
17
<td><a accesskey="p" href="ch05.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
18
<td><a accesskey="u" href="ch05.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
19
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
 
20
<th width="100%" align="center">Eye of GNOME Reference Manual</th>
 
21
<td><a accesskey="n" href="EogPluginManager.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
22
</tr>
 
23
<tr><td colspan="5" class="shortcuts">
 
24
<a href="#eog-eog-plugin.synopsis" class="shortcut">Top</a>
 
25
                   | 
 
26
                  <a href="#eog-eog-plugin.description" class="shortcut">Description</a>
 
27
                   | 
 
28
                  <a href="#eog-eog-plugin.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
29
</td></tr>
 
30
</table>
 
31
<div class="refentry" title="EogPlugin">
 
32
<a name="eog-eog-plugin"></a><div class="titlepage"></div>
 
33
<div class="refnamediv"><table width="100%"><tr>
 
34
<td valign="top">
 
35
<h2><span class="refentrytitle"><a name="eog-eog-plugin.top_of_page"></a>EogPlugin</span></h2>
 
36
<p>EogPlugin</p>
 
37
</td>
 
38
<td valign="top" align="right"></td>
 
39
</tr></table></div>
 
40
<div class="refsynopsisdiv" title="Synopsis">
 
41
<a name="eog-eog-plugin.synopsis"></a><h2>Synopsis</h2>
 
42
<a name="EogPlugin"></a><pre class="synopsis">#define             <a class="link" href="eog-eog-plugin.html#EOG-PLUGIN-CONST:CAPS" title="EOG_PLUGIN_CONST()">EOG_PLUGIN_CONST</a>                    (obj)
 
43
                    <a class="link" href="eog-eog-plugin.html#EogPlugin-struct" title="EogPlugin">EogPlugin</a>;
 
44
<span class="returnvalue">void</span>                <a class="link" href="eog-eog-plugin.html#eog-plugin-activate" title="eog_plugin_activate ()">eog_plugin_activate</a>                 (<em class="parameter"><code><a class="link" href="eog-eog-plugin.html#EogPlugin"><span class="type">EogPlugin</span></a> *plugin</code></em>,
 
45
                                                         <em class="parameter"><code><a class="link" href="eog-eog-window.html#EogWindow"><span class="type">EogWindow</span></a> *window</code></em>);
 
46
<span class="returnvalue">void</span>                <a class="link" href="eog-eog-plugin.html#eog-plugin-deactivate" title="eog_plugin_deactivate ()">eog_plugin_deactivate</a>               (<em class="parameter"><code><a class="link" href="eog-eog-plugin.html#EogPlugin"><span class="type">EogPlugin</span></a> *plugin</code></em>,
 
47
                                                         <em class="parameter"><code><a class="link" href="eog-eog-window.html#EogWindow"><span class="type">EogWindow</span></a> *window</code></em>);
 
48
<span class="returnvalue">void</span>                <a class="link" href="eog-eog-plugin.html#eog-plugin-update-ui" title="eog_plugin_update_ui ()">eog_plugin_update_ui</a>                (<em class="parameter"><code><a class="link" href="eog-eog-plugin.html#EogPlugin"><span class="type">EogPlugin</span></a> *plugin</code></em>,
 
49
                                                         <em class="parameter"><code><a class="link" href="eog-eog-window.html#EogWindow"><span class="type">EogWindow</span></a> *window</code></em>);
 
50
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="eog-eog-plugin.html#eog-plugin-is-configurable" title="eog_plugin_is_configurable ()">eog_plugin_is_configurable</a>          (<em class="parameter"><code><a class="link" href="eog-eog-plugin.html#EogPlugin"><span class="type">EogPlugin</span></a> *plugin</code></em>);
 
51
<a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *         <a class="link" href="eog-eog-plugin.html#eog-plugin-create-configure-dialog" title="eog_plugin_create_configure_dialog ()">eog_plugin_create_configure_dialog</a>  (<em class="parameter"><code><a class="link" href="eog-eog-plugin.html#EogPlugin"><span class="type">EogPlugin</span></a> *plugin</code></em>);
 
52
#define             <a class="link" href="eog-eog-plugin.html#EOG-PLUGIN-REGISTER-TYPE-WITH-CODE:CAPS" title="EOG_PLUGIN_REGISTER_TYPE_WITH_CODE()">EOG_PLUGIN_REGISTER_TYPE_WITH_CODE</a>  (PluginName,
 
53
                                                         plugin_name,
 
54
                                                         CODE)
 
55
#define             <a class="link" href="eog-eog-plugin.html#EOG-PLUGIN-REGISTER-TYPE:CAPS" title="EOG_PLUGIN_REGISTER_TYPE()">EOG_PLUGIN_REGISTER_TYPE</a>            (PluginName,
 
56
                                                         plugin_name)
 
57
#define             <a class="link" href="eog-eog-plugin.html#EOG-PLUGIN-DEFINE-TYPE-WITH-CODE:CAPS" title="EOG_PLUGIN_DEFINE_TYPE_WITH_CODE()">EOG_PLUGIN_DEFINE_TYPE_WITH_CODE</a>    (ObjectName,
 
58
                                                         object_name,
 
59
                                                         PARENT_TYPE,
 
60
                                                         CODE)
 
61
#define             <a class="link" href="eog-eog-plugin.html#EOG-PLUGIN-DEFINE-TYPE:CAPS" title="EOG_PLUGIN_DEFINE_TYPE()">EOG_PLUGIN_DEFINE_TYPE</a>              (ObjectName,
 
62
                                                         object_name,
 
63
                                                         PARENT_TYPE)
 
64
</pre>
 
65
</div>
 
66
<div class="refsect1" title="Object Hierarchy">
 
67
<a name="eog-eog-plugin.object-hierarchy"></a><h2>Object Hierarchy</h2>
 
68
<pre class="synopsis">
 
69
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 
70
   +----EogPlugin
 
71
</pre>
 
72
</div>
 
73
<div class="refsect1" title="Description">
 
74
<a name="eog-eog-plugin.description"></a><h2>Description</h2>
 
75
<p>
 
76
</p>
 
77
</div>
 
78
<div class="refsect1" title="Details">
 
79
<a name="eog-eog-plugin.details"></a><h2>Details</h2>
 
80
<div class="refsect2" title="EOG_PLUGIN_CONST()">
 
81
<a name="EOG-PLUGIN-CONST:CAPS"></a><h3>EOG_PLUGIN_CONST()</h3>
 
82
<pre class="programlisting">#define EOG_PLUGIN_CONST(obj)      (G_TYPE_CHECK_INSTANCE_CAST((obj), EOG_TYPE_PLUGIN, EogPlugin const))
 
83
</pre>
 
84
<p>
 
85
</p>
 
86
<div class="variablelist"><table border="0">
 
87
<col align="left" valign="top">
 
88
<tbody><tr>
 
89
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 
90
<td>
 
91
</td>
 
92
</tr></tbody>
 
93
</table></div>
 
94
</div>
 
95
<hr>
 
96
<div class="refsect2" title="EogPlugin">
 
97
<a name="EogPlugin-struct"></a><h3>EogPlugin</h3>
 
98
<pre class="programlisting">typedef struct _EogPlugin EogPlugin;</pre>
 
99
<p>
 
100
</p>
 
101
</div>
 
102
<hr>
 
103
<div class="refsect2" title="eog_plugin_activate ()">
 
104
<a name="eog-plugin-activate"></a><h3>eog_plugin_activate ()</h3>
 
105
<pre class="programlisting"><span class="returnvalue">void</span>                eog_plugin_activate                 (<em class="parameter"><code><a class="link" href="eog-eog-plugin.html#EogPlugin"><span class="type">EogPlugin</span></a> *plugin</code></em>,
 
106
                                                         <em class="parameter"><code><a class="link" href="eog-eog-window.html#EogWindow"><span class="type">EogWindow</span></a> *window</code></em>);</pre>
 
107
<p>
 
108
</p>
 
109
<div class="variablelist"><table border="0">
 
110
<col align="left" valign="top">
 
111
<tbody>
 
112
<tr>
 
113
<td><p><span class="term"><em class="parameter"><code>plugin</code></em> :</span></p></td>
 
114
<td>
 
115
</td>
 
116
</tr>
 
117
<tr>
 
118
<td><p><span class="term"><em class="parameter"><code>window</code></em> :</span></p></td>
 
119
<td>
 
120
</td>
 
121
</tr>
 
122
</tbody>
 
123
</table></div>
 
124
</div>
 
125
<hr>
 
126
<div class="refsect2" title="eog_plugin_deactivate ()">
 
127
<a name="eog-plugin-deactivate"></a><h3>eog_plugin_deactivate ()</h3>
 
128
<pre class="programlisting"><span class="returnvalue">void</span>                eog_plugin_deactivate               (<em class="parameter"><code><a class="link" href="eog-eog-plugin.html#EogPlugin"><span class="type">EogPlugin</span></a> *plugin</code></em>,
 
129
                                                         <em class="parameter"><code><a class="link" href="eog-eog-window.html#EogWindow"><span class="type">EogWindow</span></a> *window</code></em>);</pre>
 
130
<p>
 
131
</p>
 
132
<div class="variablelist"><table border="0">
 
133
<col align="left" valign="top">
 
134
<tbody>
 
135
<tr>
 
136
<td><p><span class="term"><em class="parameter"><code>plugin</code></em> :</span></p></td>
 
137
<td>
 
138
</td>
 
139
</tr>
 
140
<tr>
 
141
<td><p><span class="term"><em class="parameter"><code>window</code></em> :</span></p></td>
 
142
<td>
 
143
</td>
 
144
</tr>
 
145
</tbody>
 
146
</table></div>
 
147
</div>
 
148
<hr>
 
149
<div class="refsect2" title="eog_plugin_update_ui ()">
 
150
<a name="eog-plugin-update-ui"></a><h3>eog_plugin_update_ui ()</h3>
 
151
<pre class="programlisting"><span class="returnvalue">void</span>                eog_plugin_update_ui                (<em class="parameter"><code><a class="link" href="eog-eog-plugin.html#EogPlugin"><span class="type">EogPlugin</span></a> *plugin</code></em>,
 
152
                                                         <em class="parameter"><code><a class="link" href="eog-eog-window.html#EogWindow"><span class="type">EogWindow</span></a> *window</code></em>);</pre>
 
153
<p>
 
154
</p>
 
155
<div class="variablelist"><table border="0">
 
156
<col align="left" valign="top">
 
157
<tbody>
 
158
<tr>
 
159
<td><p><span class="term"><em class="parameter"><code>plugin</code></em> :</span></p></td>
 
160
<td>
 
161
</td>
 
162
</tr>
 
163
<tr>
 
164
<td><p><span class="term"><em class="parameter"><code>window</code></em> :</span></p></td>
 
165
<td>
 
166
</td>
 
167
</tr>
 
168
</tbody>
 
169
</table></div>
 
170
</div>
 
171
<hr>
 
172
<div class="refsect2" title="eog_plugin_is_configurable ()">
 
173
<a name="eog-plugin-is-configurable"></a><h3>eog_plugin_is_configurable ()</h3>
 
174
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            eog_plugin_is_configurable          (<em class="parameter"><code><a class="link" href="eog-eog-plugin.html#EogPlugin"><span class="type">EogPlugin</span></a> *plugin</code></em>);</pre>
 
175
<p>
 
176
</p>
 
177
<div class="variablelist"><table border="0">
 
178
<col align="left" valign="top">
 
179
<tbody>
 
180
<tr>
 
181
<td><p><span class="term"><em class="parameter"><code>plugin</code></em> :</span></p></td>
 
182
<td>
 
183
</td>
 
184
</tr>
 
185
<tr>
 
186
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
187
<td>
 
188
</td>
 
189
</tr>
 
190
</tbody>
 
191
</table></div>
 
192
</div>
 
193
<hr>
 
194
<div class="refsect2" title="eog_plugin_create_configure_dialog ()">
 
195
<a name="eog-plugin-create-configure-dialog"></a><h3>eog_plugin_create_configure_dialog ()</h3>
 
196
<pre class="programlisting"><a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *         eog_plugin_create_configure_dialog  (<em class="parameter"><code><a class="link" href="eog-eog-plugin.html#EogPlugin"><span class="type">EogPlugin</span></a> *plugin</code></em>);</pre>
 
197
<p>
 
198
</p>
 
199
<div class="variablelist"><table border="0">
 
200
<col align="left" valign="top">
 
201
<tbody>
 
202
<tr>
 
203
<td><p><span class="term"><em class="parameter"><code>plugin</code></em> :</span></p></td>
 
204
<td>
 
205
</td>
 
206
</tr>
 
207
<tr>
 
208
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
209
<td>
 
210
</td>
 
211
</tr>
 
212
</tbody>
 
213
</table></div>
 
214
</div>
 
215
<hr>
 
216
<div class="refsect2" title="EOG_PLUGIN_REGISTER_TYPE_WITH_CODE()">
 
217
<a name="EOG-PLUGIN-REGISTER-TYPE-WITH-CODE:CAPS"></a><h3>EOG_PLUGIN_REGISTER_TYPE_WITH_CODE()</h3>
 
218
<pre class="programlisting">#define             EOG_PLUGIN_REGISTER_TYPE_WITH_CODE(PluginName, plugin_name, CODE)</pre>
 
219
<p>
 
220
</p>
 
221
<div class="variablelist"><table border="0">
 
222
<col align="left" valign="top">
 
223
<tbody>
 
224
<tr>
 
225
<td><p><span class="term"><em class="parameter"><code>PluginName</code></em> :</span></p></td>
 
226
<td>
 
227
</td>
 
228
</tr>
 
229
<tr>
 
230
<td><p><span class="term"><em class="parameter"><code>plugin_name</code></em> :</span></p></td>
 
231
<td>
 
232
</td>
 
233
</tr>
 
234
<tr>
 
235
<td><p><span class="term"><em class="parameter"><code>CODE</code></em> :</span></p></td>
 
236
<td>
 
237
</td>
 
238
</tr>
 
239
</tbody>
 
240
</table></div>
 
241
</div>
 
242
<hr>
 
243
<div class="refsect2" title="EOG_PLUGIN_REGISTER_TYPE()">
 
244
<a name="EOG-PLUGIN-REGISTER-TYPE:CAPS"></a><h3>EOG_PLUGIN_REGISTER_TYPE()</h3>
 
245
<pre class="programlisting">#define             EOG_PLUGIN_REGISTER_TYPE(PluginName, plugin_name)</pre>
 
246
<p>
 
247
</p>
 
248
<div class="variablelist"><table border="0">
 
249
<col align="left" valign="top">
 
250
<tbody>
 
251
<tr>
 
252
<td><p><span class="term"><em class="parameter"><code>PluginName</code></em> :</span></p></td>
 
253
<td>
 
254
</td>
 
255
</tr>
 
256
<tr>
 
257
<td><p><span class="term"><em class="parameter"><code>plugin_name</code></em> :</span></p></td>
 
258
<td>
 
259
</td>
 
260
</tr>
 
261
</tbody>
 
262
</table></div>
 
263
</div>
 
264
<hr>
 
265
<div class="refsect2" title="EOG_PLUGIN_DEFINE_TYPE_WITH_CODE()">
 
266
<a name="EOG-PLUGIN-DEFINE-TYPE-WITH-CODE:CAPS"></a><h3>EOG_PLUGIN_DEFINE_TYPE_WITH_CODE()</h3>
 
267
<pre class="programlisting">#define             EOG_PLUGIN_DEFINE_TYPE_WITH_CODE(ObjectName, object_name, PARENT_TYPE, CODE)</pre>
 
268
<p>
 
269
</p>
 
270
<div class="variablelist"><table border="0">
 
271
<col align="left" valign="top">
 
272
<tbody>
 
273
<tr>
 
274
<td><p><span class="term"><em class="parameter"><code>ObjectName</code></em> :</span></p></td>
 
275
<td>
 
276
</td>
 
277
</tr>
 
278
<tr>
 
279
<td><p><span class="term"><em class="parameter"><code>object_name</code></em> :</span></p></td>
 
280
<td>
 
281
</td>
 
282
</tr>
 
283
<tr>
 
284
<td><p><span class="term"><em class="parameter"><code>PARENT_TYPE</code></em> :</span></p></td>
 
285
<td>
 
286
</td>
 
287
</tr>
 
288
<tr>
 
289
<td><p><span class="term"><em class="parameter"><code>CODE</code></em> :</span></p></td>
 
290
<td>
 
291
</td>
 
292
</tr>
 
293
</tbody>
 
294
</table></div>
 
295
</div>
 
296
<hr>
 
297
<div class="refsect2" title="EOG_PLUGIN_DEFINE_TYPE()">
 
298
<a name="EOG-PLUGIN-DEFINE-TYPE:CAPS"></a><h3>EOG_PLUGIN_DEFINE_TYPE()</h3>
 
299
<pre class="programlisting">#define             EOG_PLUGIN_DEFINE_TYPE(ObjectName, object_name, PARENT_TYPE)</pre>
 
300
<p>
 
301
</p>
 
302
<div class="variablelist"><table border="0">
 
303
<col align="left" valign="top">
 
304
<tbody>
 
305
<tr>
 
306
<td><p><span class="term"><em class="parameter"><code>ObjectName</code></em> :</span></p></td>
 
307
<td>
 
308
</td>
 
309
</tr>
 
310
<tr>
 
311
<td><p><span class="term"><em class="parameter"><code>object_name</code></em> :</span></p></td>
 
312
<td>
 
313
</td>
 
314
</tr>
 
315
<tr>
 
316
<td><p><span class="term"><em class="parameter"><code>PARENT_TYPE</code></em> :</span></p></td>
 
317
<td>
 
318
</td>
 
319
</tr>
 
320
</tbody>
 
321
</table></div>
 
322
</div>
 
323
</div>
 
324
</div>
 
325
<div class="footer">
 
326
<hr>
 
327
          Generated by GTK-Doc V1.14</div>
 
328
</body>
 
329
</html>
 
 
b'\\ No newline at end of file'