← Back to branch summary

~bratsche/oif/eog-zoom-drag-gestures

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2010-02-23 01:04:18 UTC
  • mfrom: (1.14.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20100223010418-sm4krkv058hfwqiu
Tags: 2.29.91-0ubuntu1
* New upstream version:
  - Build fixes 
  Bug fixes:
  - #609184, Build failure: doesn't look for some required libs 
  - #610692, eog 2.29.90 fails to build 
  New and updated translations
  

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/xml/eog-plugin.xml
1
 
<?xml version="1.0"?>
2
 
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
3
 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
4
 
<!ENTITY version SYSTEM "version.xml">
5
 
]>
6
 
<refentry id="EogPlugin">
7
 
<refmeta>
8
 
<refentrytitle role="top_of_page" id="EogPlugin.top_of_page">EogPlugin</refentrytitle>
9
 
<manvolnum>3</manvolnum>
10
 
<refmiscinfo>EOG Library</refmiscinfo>
11
 
</refmeta>
12
 
 
13
 
<refnamediv>
14
 
<refname>EogPlugin</refname>
15
 
<refpurpose></refpurpose>
16
 
</refnamediv>
17
 
 
18
 
<refsynopsisdiv id="EogPlugin.synopsis" role="synopsis">
19
 
<title role="synopsis.title">Synopsis</title>
20
 
 
21
 
<synopsis>
22
 
#define             <link linkend="EOG-PLUGIN-CONST--CAPS">EOG_PLUGIN_CONST</link>                    (obj)
23
 
                    <link linkend="EogPlugin-struct">EogPlugin</link>;
24
 
<link linkend="void">void</link>                <link linkend="eog-plugin-activate">eog_plugin_activate</link>                 (<link linkend="EogPlugin">EogPlugin</link> *plugin,
25
 
                                                         <link linkend="EogWindow">EogWindow</link> *window);
26
 
<link linkend="void">void</link>                <link linkend="eog-plugin-deactivate">eog_plugin_deactivate</link>               (<link linkend="EogPlugin">EogPlugin</link> *plugin,
27
 
                                                         <link linkend="EogWindow">EogWindow</link> *window);
28
 
<link linkend="void">void</link>                <link linkend="eog-plugin-update-ui">eog_plugin_update_ui</link>                (<link linkend="EogPlugin">EogPlugin</link> *plugin,
29
 
                                                         <link linkend="EogWindow">EogWindow</link> *window);
30
 
<link linkend="gboolean">gboolean</link>            <link linkend="eog-plugin-is-configurable">eog_plugin_is_configurable</link>          (<link linkend="EogPlugin">EogPlugin</link> *plugin);
31
 
<link linkend="GtkWidget">GtkWidget</link> *         <link linkend="eog-plugin-create-configure-dialog">eog_plugin_create_configure_dialog</link>  (<link linkend="EogPlugin">EogPlugin</link> *plugin);
32
 
#define             <link linkend="EOG-PLUGIN-REGISTER-TYPE-WITH-CODE--CAPS">EOG_PLUGIN_REGISTER_TYPE_WITH_CODE</link>  (PluginName, plugin_name, CODE)
33
 
#define             <link linkend="EOG-PLUGIN-REGISTER-TYPE--CAPS">EOG_PLUGIN_REGISTER_TYPE</link>            (PluginName, plugin_name)
34
 
#define             <link linkend="EOG-PLUGIN-DEFINE-TYPE-WITH-CODE--CAPS">EOG_PLUGIN_DEFINE_TYPE_WITH_CODE</link>    (ObjectName, object_name, PARENT_TYPE, CODE)
35
 
#define             <link linkend="EOG-PLUGIN-DEFINE-TYPE--CAPS">EOG_PLUGIN_DEFINE_TYPE</link>              (ObjectName, object_name, PARENT_TYPE)
36
 
</synopsis>
37
 
</refsynopsisdiv>
38
 
 
39
 
<refsect1 id="EogPlugin.object-hierarchy" role="object_hierarchy">
40
 
<title role="object_hierarchy.title">Object Hierarchy</title>
41
 
<synopsis>
42
 
  <link linkend="GObject">GObject</link>
43
 
   +----EogPlugin
44
 
</synopsis>
45
 
</refsect1>
46
 
 
47
 
 
48
 
 
49
 
 
50
 
 
51
 
 
52
 
 
53
 
 
54
 
<refsect1 id="EogPlugin.description" role="desc">
55
 
<title role="desc.title">Description</title>
56
 
<para>
57
 
</para>
58
 
</refsect1>
59
 
 
60
 
<refsect1 id="EogPlugin.details" role="details">
61
 
<title role="details.title">Details</title>
62
 
<refsect2 id="EOG-PLUGIN-CONST--CAPS" role="macro">
63
 
<title>EOG_PLUGIN_CONST()</title>
64
 
<indexterm zone="EOG-PLUGIN-CONST--CAPS"><primary sortas="EOG_PLUGIN_CONST">EOG_PLUGIN_CONST</primary></indexterm><programlisting>#define EOG_PLUGIN_CONST(obj)      (G_TYPE_CHECK_INSTANCE_CAST((obj), EOG_TYPE_PLUGIN, EogPlugin const))
65
 
</programlisting>
66
 
<para>
67
 
</para><variablelist role="params">
68
 
<varlistentry><term><parameter>obj</parameter>&#160;:</term>
69
 
<listitem><simpara>
70
 
</simpara></listitem></varlistentry>
71
 
</variablelist></refsect2>
72
 
<refsect2 id="EogPlugin-struct" role="struct">
73
 
<title>EogPlugin</title>
74
 
<indexterm zone="EogPlugin-struct"><primary sortas="EogPlugin">EogPlugin</primary></indexterm><programlisting>typedef struct _EogPlugin EogPlugin;</programlisting>
75
 
<para>
76
 
</para></refsect2>
77
 
<refsect2 id="eog-plugin-activate" role="function">
78
 
<title>eog_plugin_activate ()</title>
79
 
<indexterm zone="eog-plugin-activate"><primary sortas="eog_plugin_activate">eog_plugin_activate</primary></indexterm><programlisting><link linkend="void">void</link>                eog_plugin_activate                 (<link linkend="EogPlugin">EogPlugin</link> *plugin,
80
 
                                                         <link linkend="EogWindow">EogWindow</link> *window);</programlisting>
81
 
<para>
82
 
</para><variablelist role="params">
83
 
<varlistentry><term><parameter>plugin</parameter>&#160;:</term>
84
 
<listitem><simpara>
85
 
</simpara></listitem></varlistentry>
86
 
<varlistentry><term><parameter>window</parameter>&#160;:</term>
87
 
<listitem><simpara>
88
 
</simpara></listitem></varlistentry>
89
 
</variablelist></refsect2>
90
 
<refsect2 id="eog-plugin-deactivate" role="function">
91
 
<title>eog_plugin_deactivate ()</title>
92
 
<indexterm zone="eog-plugin-deactivate"><primary sortas="eog_plugin_deactivate">eog_plugin_deactivate</primary></indexterm><programlisting><link linkend="void">void</link>                eog_plugin_deactivate               (<link linkend="EogPlugin">EogPlugin</link> *plugin,
93
 
                                                         <link linkend="EogWindow">EogWindow</link> *window);</programlisting>
94
 
<para>
95
 
</para><variablelist role="params">
96
 
<varlistentry><term><parameter>plugin</parameter>&#160;:</term>
97
 
<listitem><simpara>
98
 
</simpara></listitem></varlistentry>
99
 
<varlistentry><term><parameter>window</parameter>&#160;:</term>
100
 
<listitem><simpara>
101
 
</simpara></listitem></varlistentry>
102
 
</variablelist></refsect2>
103
 
<refsect2 id="eog-plugin-update-ui" role="function">
104
 
<title>eog_plugin_update_ui ()</title>
105
 
<indexterm zone="eog-plugin-update-ui"><primary sortas="eog_plugin_update_ui">eog_plugin_update_ui</primary></indexterm><programlisting><link linkend="void">void</link>                eog_plugin_update_ui                (<link linkend="EogPlugin">EogPlugin</link> *plugin,
106
 
                                                         <link linkend="EogWindow">EogWindow</link> *window);</programlisting>
107
 
<para>
108
 
</para><variablelist role="params">
109
 
<varlistentry><term><parameter>plugin</parameter>&#160;:</term>
110
 
<listitem><simpara>
111
 
</simpara></listitem></varlistentry>
112
 
<varlistentry><term><parameter>window</parameter>&#160;:</term>
113
 
<listitem><simpara>
114
 
</simpara></listitem></varlistentry>
115
 
</variablelist></refsect2>
116
 
<refsect2 id="eog-plugin-is-configurable" role="function">
117
 
<title>eog_plugin_is_configurable ()</title>
118
 
<indexterm zone="eog-plugin-is-configurable"><primary sortas="eog_plugin_is_configurable">eog_plugin_is_configurable</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            eog_plugin_is_configurable          (<link linkend="EogPlugin">EogPlugin</link> *plugin);</programlisting>
119
 
<para>
120
 
</para><variablelist role="params">
121
 
<varlistentry><term><parameter>plugin</parameter>&#160;:</term>
122
 
<listitem><simpara>
123
 
</simpara></listitem></varlistentry>
124
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
125
 
</simpara></listitem></varlistentry>
126
 
</variablelist></refsect2>
127
 
<refsect2 id="eog-plugin-create-configure-dialog" role="function">
128
 
<title>eog_plugin_create_configure_dialog ()</title>
129
 
<indexterm zone="eog-plugin-create-configure-dialog"><primary sortas="eog_plugin_create_configure_dialog">eog_plugin_create_configure_dialog</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> *         eog_plugin_create_configure_dialog  (<link linkend="EogPlugin">EogPlugin</link> *plugin);</programlisting>
130
 
<para>
131
 
</para><variablelist role="params">
132
 
<varlistentry><term><parameter>plugin</parameter>&#160;:</term>
133
 
<listitem><simpara>
134
 
</simpara></listitem></varlistentry>
135
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
136
 
</simpara></listitem></varlistentry>
137
 
</variablelist></refsect2>
138
 
<refsect2 id="EOG-PLUGIN-REGISTER-TYPE-WITH-CODE--CAPS" role="macro">
139
 
<title>EOG_PLUGIN_REGISTER_TYPE_WITH_CODE()</title>
140
 
<indexterm zone="EOG-PLUGIN-REGISTER-TYPE-WITH-CODE--CAPS"><primary sortas="EOG_PLUGIN_REGISTER_TYPE_WITH_CODE">EOG_PLUGIN_REGISTER_TYPE_WITH_CODE</primary></indexterm><programlisting>#define             EOG_PLUGIN_REGISTER_TYPE_WITH_CODE(PluginName, plugin_name, CODE)</programlisting>
141
 
<para>
142
 
</para><variablelist role="params">
143
 
<varlistentry><term><parameter>PluginName</parameter>&#160;:</term>
144
 
<listitem><simpara>
145
 
</simpara></listitem></varlistentry>
146
 
<varlistentry><term><parameter>plugin_name</parameter>&#160;:</term>
147
 
<listitem><simpara>
148
 
</simpara></listitem></varlistentry>
149
 
<varlistentry><term><parameter>CODE</parameter>&#160;:</term>
150
 
<listitem><simpara>
151
 
</simpara></listitem></varlistentry>
152
 
</variablelist></refsect2>
153
 
<refsect2 id="EOG-PLUGIN-REGISTER-TYPE--CAPS" role="macro">
154
 
<title>EOG_PLUGIN_REGISTER_TYPE()</title>
155
 
<indexterm zone="EOG-PLUGIN-REGISTER-TYPE--CAPS"><primary sortas="EOG_PLUGIN_REGISTER_TYPE">EOG_PLUGIN_REGISTER_TYPE</primary></indexterm><programlisting>#define             EOG_PLUGIN_REGISTER_TYPE(PluginName, plugin_name)</programlisting>
156
 
<para>
157
 
</para><variablelist role="params">
158
 
<varlistentry><term><parameter>PluginName</parameter>&#160;:</term>
159
 
<listitem><simpara>
160
 
</simpara></listitem></varlistentry>
161
 
<varlistentry><term><parameter>plugin_name</parameter>&#160;:</term>
162
 
<listitem><simpara>
163
 
</simpara></listitem></varlistentry>
164
 
</variablelist></refsect2>
165
 
<refsect2 id="EOG-PLUGIN-DEFINE-TYPE-WITH-CODE--CAPS" role="macro">
166
 
<title>EOG_PLUGIN_DEFINE_TYPE_WITH_CODE()</title>
167
 
<indexterm zone="EOG-PLUGIN-DEFINE-TYPE-WITH-CODE--CAPS"><primary sortas="EOG_PLUGIN_DEFINE_TYPE_WITH_CODE">EOG_PLUGIN_DEFINE_TYPE_WITH_CODE</primary></indexterm><programlisting>#define             EOG_PLUGIN_DEFINE_TYPE_WITH_CODE(ObjectName, object_name, PARENT_TYPE, CODE)</programlisting>
168
 
<para>
169
 
</para><variablelist role="params">
170
 
<varlistentry><term><parameter>ObjectName</parameter>&#160;:</term>
171
 
<listitem><simpara>
172
 
</simpara></listitem></varlistentry>
173
 
<varlistentry><term><parameter>object_name</parameter>&#160;:</term>
174
 
<listitem><simpara>
175
 
</simpara></listitem></varlistentry>
176
 
<varlistentry><term><parameter>PARENT_TYPE</parameter>&#160;:</term>
177
 
<listitem><simpara>
178
 
</simpara></listitem></varlistentry>
179
 
<varlistentry><term><parameter>CODE</parameter>&#160;:</term>
180
 
<listitem><simpara>
181
 
</simpara></listitem></varlistentry>
182
 
</variablelist></refsect2>
183
 
<refsect2 id="EOG-PLUGIN-DEFINE-TYPE--CAPS" role="macro">
184
 
<title>EOG_PLUGIN_DEFINE_TYPE()</title>
185
 
<indexterm zone="EOG-PLUGIN-DEFINE-TYPE--CAPS"><primary sortas="EOG_PLUGIN_DEFINE_TYPE">EOG_PLUGIN_DEFINE_TYPE</primary></indexterm><programlisting>#define             EOG_PLUGIN_DEFINE_TYPE(ObjectName, object_name, PARENT_TYPE)</programlisting>
186
 
<para>
187
 
</para><variablelist role="params">
188
 
<varlistentry><term><parameter>ObjectName</parameter>&#160;:</term>
189
 
<listitem><simpara>
190
 
</simpara></listitem></varlistentry>
191
 
<varlistentry><term><parameter>object_name</parameter>&#160;:</term>
192
 
<listitem><simpara>
193
 
</simpara></listitem></varlistentry>
194
 
<varlistentry><term><parameter>PARENT_TYPE</parameter>&#160;:</term>
195
 
<listitem><simpara>
196
 
</simpara></listitem></varlistentry>
197
 
</variablelist></refsect2>
198
 
 
199
 
</refsect1>
200
 
 
201
 
 
202
 
 
203
 
 
204
 
</refentry>