← Back to branch summary

~ubuntu-branches/ubuntu/precise/evince/precise-updates

« back to all changes in this revision

Viewing changes to help/reference/xml/ev-attachment.xml

  • Committer: Bazaar Package Importer
  • Author(s): Didier Roche
  • Date: 2009-02-10 15:24:04 UTC
  • mto: (1.6.1 upstream)
  • mto: This revision was merged to the branch mainline in revision 72.
  • Revision ID: james.westby@ubuntu.com-20090210152404-9el29bkm4unsnj6n
Tags: upstream-2.25.90
Import upstream version 2.25.90

Show diffs side-by-side

added added

removed removed

Lines of Context:
help/reference/xml/ev-attachment.xml
1
 
<refentry id="EvAttachment">
2
 
<refmeta>
3
 
<refentrytitle role="top_of_page" id="EvAttachment.top_of_page">EvAttachment</refentrytitle>
4
 
<manvolnum>3</manvolnum>
5
 
<refmiscinfo>EVINCE Library</refmiscinfo>
6
 
</refmeta>
7
 
 
8
 
<refnamediv>
9
 
<refname>EvAttachment</refname>
10
 
<refpurpose></refpurpose>
11
 
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
12
 
</refnamediv>
13
 
 
14
 
<refsynopsisdiv id="EvAttachment.synopsis" role="synopsis">
15
 
<title role="synopsis.title">Synopsis</title>
16
 
 
17
 
<synopsis>
18
 
                    <link linkend="EvAttachmentPrivate">EvAttachmentPrivate</link>;
19
 
#define             <link linkend="EV-ATTACHMENT-ERROR:CAPS">EV_ATTACHMENT_ERROR</link>
20
 
                    <link linkend="EvAttachment-struct">EvAttachment</link>;
21
 
<link linkend="GQuark">GQuark</link>              <link linkend="ev-attachment-error-quark">ev_attachment_error_quark</link>           (void);
22
 
<link linkend="EvAttachment">EvAttachment</link>*       <link linkend="ev-attachment-new">ev_attachment_new</link>                   (const <link linkend="gchar">gchar</link> *name,
23
 
                                                         const <link linkend="gchar">gchar</link> *description,
24
 
                                                         <link linkend="GTime">GTime</link> mtime,
25
 
                                                         <link linkend="GTime">GTime</link> ctime,
26
 
                                                         <link linkend="gsize">gsize</link> size,
27
 
                                                         <link linkend="gpointer">gpointer</link> data);
28
 
const <link linkend="gchar">gchar</link>*        <link linkend="ev-attachment-get-name">ev_attachment_get_name</link>              (<link linkend="EvAttachment">EvAttachment</link> *attachment);
29
 
const <link linkend="gchar">gchar</link>*        <link linkend="ev-attachment-get-description">ev_attachment_get_description</link>       (<link linkend="EvAttachment">EvAttachment</link> *attachment);
30
 
<link linkend="GTime">GTime</link>               <link linkend="ev-attachment-get-modification-date">ev_attachment_get_modification_date</link> (<link linkend="EvAttachment">EvAttachment</link> *attachment);
31
 
<link linkend="GTime">GTime</link>               <link linkend="ev-attachment-get-creation-date">ev_attachment_get_creation_date</link>     (<link linkend="EvAttachment">EvAttachment</link> *attachment);
32
 
const <link linkend="gchar">gchar</link>*        <link linkend="ev-attachment-get-mime-type">ev_attachment_get_mime_type</link>         (<link linkend="EvAttachment">EvAttachment</link> *attachment);
33
 
<link linkend="gboolean">gboolean</link>            <link linkend="ev-attachment-save">ev_attachment_save</link>                  (<link linkend="EvAttachment">EvAttachment</link> *attachment,
34
 
                                                         <link linkend="GFile">GFile</link> *file,
35
 
                                                         <link linkend="GError">GError</link> **error);
36
 
<link linkend="gboolean">gboolean</link>            <link linkend="ev-attachment-open">ev_attachment_open</link>                  (<link linkend="EvAttachment">EvAttachment</link> *attachment,
37
 
                                                         <link linkend="GdkScreen">GdkScreen</link> *screen,
38
 
                                                         <link linkend="guint32">guint32</link> timestamp,
39
 
                                                         <link linkend="GError">GError</link> **error);
40
 
</synopsis>
41
 
</refsynopsisdiv>
42
 
 
43
 
<refsect1 id="EvAttachment.object-hierarchy" role="object_hierarchy">
44
 
<title role="object_hierarchy.title">Object Hierarchy</title>
45
 
<synopsis>
46
 
  <link linkend="GObject">GObject</link>
47
 
   +----EvAttachment
48
 
</synopsis>
49
 
 
50
 
</refsect1>
51
 
 
52
 
 
53
 
 
54
 
 
55
 
 
56
 
<refsect1 id="EvAttachment.properties" role="properties">
57
 
<title role="properties.title">Properties</title>
58
 
<synopsis>
59
 
  &quot;<link linkend="EvAttachment--ctime">ctime</link>&quot;                    <link linkend="gulong">gulong</link>                : Write / Construct Only
60
 
  &quot;<link linkend="EvAttachment--data">data</link>&quot;                     <link linkend="gpointer">gpointer</link>              : Write / Construct Only
61
 
  &quot;<link linkend="EvAttachment--description">description</link>&quot;              <link linkend="gchar">gchar</link>*                : Write / Construct Only
62
 
  &quot;<link linkend="EvAttachment--mtime">mtime</link>&quot;                    <link linkend="gulong">gulong</link>                : Write / Construct Only
63
 
  &quot;<link linkend="EvAttachment--name">name</link>&quot;                     <link linkend="gchar">gchar</link>*                : Write / Construct Only
64
 
  &quot;<link linkend="EvAttachment--size">size</link>&quot;                     <link linkend="guint">guint</link>                 : Write / Construct Only
65
 
</synopsis>
66
 
</refsect1>
67
 
 
68
 
 
69
 
 
70
 
<refsect1 id="EvAttachment.description" role="desc">
71
 
<title role="desc.title">Description</title>
72
 
<para>
73
 
 
74
 
</para>
75
 
</refsect1>
76
 
 
77
 
<refsect1 id="EvAttachment.details" role="details">
78
 
<title role="details.title">Details</title>
79
 
<refsect2 id="EvAttachmentPrivate" role="struct">
80
 
<title>EvAttachmentPrivate</title>
81
 
<indexterm zone="EvAttachmentPrivate"><primary>EvAttachmentPrivate</primary></indexterm><programlisting>typedef struct _EvAttachmentPrivate EvAttachmentPrivate;</programlisting>
82
 
<para>
83
 
 
84
 
</para></refsect2>
85
 
<refsect2 id="EV-ATTACHMENT-ERROR:CAPS" role="macro">
86
 
<title>EV_ATTACHMENT_ERROR</title>
87
 
<indexterm zone="EV-ATTACHMENT-ERROR:CAPS"><primary>EV_ATTACHMENT_ERROR</primary></indexterm><programlisting>#define EV_ATTACHMENT_ERROR (ev_attachment_error_quark ())
88
 
</programlisting>
89
 
<para>
90
 
 
91
 
</para></refsect2>
92
 
<refsect2 id="EvAttachment-struct" role="struct">
93
 
<title>EvAttachment</title>
94
 
<indexterm zone="EvAttachment-struct"><primary>EvAttachment</primary></indexterm><programlisting>typedef struct _EvAttachment EvAttachment;</programlisting>
95
 
<para>
96
 
 
97
 
</para></refsect2>
98
 
<refsect2 id="ev-attachment-error-quark" role="function">
99
 
<title>ev_attachment_error_quark ()</title>
100
 
<indexterm zone="ev-attachment-error-quark"><primary>ev_attachment_error_quark</primary></indexterm><programlisting><link linkend="GQuark">GQuark</link>              ev_attachment_error_quark           (void);</programlisting>
101
 
<para>
102
 
 
103
 
</para><variablelist role="params">
104
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
105
 
 
106
 
 
107
 
</simpara></listitem></varlistentry>
108
 
</variablelist></refsect2>
109
 
<refsect2 id="ev-attachment-new" role="function">
110
 
<title>ev_attachment_new ()</title>
111
 
<indexterm zone="ev-attachment-new"><primary>ev_attachment_new</primary></indexterm><programlisting><link linkend="EvAttachment">EvAttachment</link>*       ev_attachment_new                   (const <link linkend="gchar">gchar</link> *name,
112
 
                                                         const <link linkend="gchar">gchar</link> *description,
113
 
                                                         <link linkend="GTime">GTime</link> mtime,
114
 
                                                         <link linkend="GTime">GTime</link> ctime,
115
 
                                                         <link linkend="gsize">gsize</link> size,
116
 
                                                         <link linkend="gpointer">gpointer</link> data);</programlisting>
117
 
<para>
118
 
 
119
 
</para><variablelist role="params">
120
 
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
121
 
<listitem><simpara>
122
 
</simpara></listitem></varlistentry>
123
 
<varlistentry><term><parameter>description</parameter>&nbsp;:</term>
124
 
<listitem><simpara>
125
 
</simpara></listitem></varlistentry>
126
 
<varlistentry><term><parameter>mtime</parameter>&nbsp;:</term>
127
 
<listitem><simpara>
128
 
</simpara></listitem></varlistentry>
129
 
<varlistentry><term><parameter>ctime</parameter>&nbsp;:</term>
130
 
<listitem><simpara>
131
 
</simpara></listitem></varlistentry>
132
 
<varlistentry><term><parameter>size</parameter>&nbsp;:</term>
133
 
<listitem><simpara>
134
 
</simpara></listitem></varlistentry>
135
 
<varlistentry><term><parameter>data</parameter>&nbsp;:</term>
136
 
<listitem><simpara>
137
 
</simpara></listitem></varlistentry>
138
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
139
 
 
140
 
 
141
 
</simpara></listitem></varlistentry>
142
 
</variablelist></refsect2>
143
 
<refsect2 id="ev-attachment-get-name" role="function">
144
 
<title>ev_attachment_get_name ()</title>
145
 
<indexterm zone="ev-attachment-get-name"><primary>ev_attachment_get_name</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>*        ev_attachment_get_name              (<link linkend="EvAttachment">EvAttachment</link> *attachment);</programlisting>
146
 
<para>
147
 
 
148
 
</para><variablelist role="params">
149
 
<varlistentry><term><parameter>attachment</parameter>&nbsp;:</term>
150
 
<listitem><simpara>
151
 
</simpara></listitem></varlistentry>
152
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
153
 
 
154
 
 
155
 
</simpara></listitem></varlistentry>
156
 
</variablelist></refsect2>
157
 
<refsect2 id="ev-attachment-get-description" role="function">
158
 
<title>ev_attachment_get_description ()</title>
159
 
<indexterm zone="ev-attachment-get-description"><primary>ev_attachment_get_description</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>*        ev_attachment_get_description       (<link linkend="EvAttachment">EvAttachment</link> *attachment);</programlisting>
160
 
<para>
161
 
 
162
 
</para><variablelist role="params">
163
 
<varlistentry><term><parameter>attachment</parameter>&nbsp;:</term>
164
 
<listitem><simpara>
165
 
</simpara></listitem></varlistentry>
166
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
167
 
 
168
 
 
169
 
</simpara></listitem></varlistentry>
170
 
</variablelist></refsect2>
171
 
<refsect2 id="ev-attachment-get-modification-date" role="function">
172
 
<title>ev_attachment_get_modification_date ()</title>
173
 
<indexterm zone="ev-attachment-get-modification-date"><primary>ev_attachment_get_modification_date</primary></indexterm><programlisting><link linkend="GTime">GTime</link>               ev_attachment_get_modification_date (<link linkend="EvAttachment">EvAttachment</link> *attachment);</programlisting>
174
 
<para>
175
 
 
176
 
</para><variablelist role="params">
177
 
<varlistentry><term><parameter>attachment</parameter>&nbsp;:</term>
178
 
<listitem><simpara>
179
 
</simpara></listitem></varlistentry>
180
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
181
 
 
182
 
 
183
 
</simpara></listitem></varlistentry>
184
 
</variablelist></refsect2>
185
 
<refsect2 id="ev-attachment-get-creation-date" role="function">
186
 
<title>ev_attachment_get_creation_date ()</title>
187
 
<indexterm zone="ev-attachment-get-creation-date"><primary>ev_attachment_get_creation_date</primary></indexterm><programlisting><link linkend="GTime">GTime</link>               ev_attachment_get_creation_date     (<link linkend="EvAttachment">EvAttachment</link> *attachment);</programlisting>
188
 
<para>
189
 
 
190
 
</para><variablelist role="params">
191
 
<varlistentry><term><parameter>attachment</parameter>&nbsp;:</term>
192
 
<listitem><simpara>
193
 
</simpara></listitem></varlistentry>
194
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
195
 
 
196
 
 
197
 
</simpara></listitem></varlistentry>
198
 
</variablelist></refsect2>
199
 
<refsect2 id="ev-attachment-get-mime-type" role="function">
200
 
<title>ev_attachment_get_mime_type ()</title>
201
 
<indexterm zone="ev-attachment-get-mime-type"><primary>ev_attachment_get_mime_type</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>*        ev_attachment_get_mime_type         (<link linkend="EvAttachment">EvAttachment</link> *attachment);</programlisting>
202
 
<para>
203
 
 
204
 
</para><variablelist role="params">
205
 
<varlistentry><term><parameter>attachment</parameter>&nbsp;:</term>
206
 
<listitem><simpara>
207
 
</simpara></listitem></varlistentry>
208
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
209
 
 
210
 
 
211
 
</simpara></listitem></varlistentry>
212
 
</variablelist></refsect2>
213
 
<refsect2 id="ev-attachment-save" role="function">
214
 
<title>ev_attachment_save ()</title>
215
 
<indexterm zone="ev-attachment-save"><primary>ev_attachment_save</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            ev_attachment_save                  (<link linkend="EvAttachment">EvAttachment</link> *attachment,
216
 
                                                         <link linkend="GFile">GFile</link> *file,
217
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
218
 
<para>
219
 
 
220
 
</para><variablelist role="params">
221
 
<varlistentry><term><parameter>attachment</parameter>&nbsp;:</term>
222
 
<listitem><simpara>
223
 
</simpara></listitem></varlistentry>
224
 
<varlistentry><term><parameter>file</parameter>&nbsp;:</term>
225
 
<listitem><simpara>
226
 
</simpara></listitem></varlistentry>
227
 
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
228
 
<listitem><simpara>
229
 
</simpara></listitem></varlistentry>
230
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
231
 
 
232
 
 
233
 
</simpara></listitem></varlistentry>
234
 
</variablelist></refsect2>
235
 
<refsect2 id="ev-attachment-open" role="function">
236
 
<title>ev_attachment_open ()</title>
237
 
<indexterm zone="ev-attachment-open"><primary>ev_attachment_open</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            ev_attachment_open                  (<link linkend="EvAttachment">EvAttachment</link> *attachment,
238
 
                                                         <link linkend="GdkScreen">GdkScreen</link> *screen,
239
 
                                                         <link linkend="guint32">guint32</link> timestamp,
240
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
241
 
<para>
242
 
 
243
 
</para><variablelist role="params">
244
 
<varlistentry><term><parameter>attachment</parameter>&nbsp;:</term>
245
 
<listitem><simpara>
246
 
</simpara></listitem></varlistentry>
247
 
<varlistentry><term><parameter>screen</parameter>&nbsp;:</term>
248
 
<listitem><simpara>
249
 
</simpara></listitem></varlistentry>
250
 
<varlistentry><term><parameter>timestamp</parameter>&nbsp;:</term>
251
 
<listitem><simpara>
252
 
</simpara></listitem></varlistentry>
253
 
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
254
 
<listitem><simpara>
255
 
</simpara></listitem></varlistentry>
256
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
257
 
 
258
 
 
259
 
</simpara></listitem></varlistentry>
260
 
</variablelist></refsect2>
261
 
 
262
 
</refsect1>
263
 
<refsect1 id="EvAttachment.property-details" role="property_details">
264
 
<title role="property_details.title">Property Details</title>
265
 
<refsect2 id="EvAttachment--ctime"><title>The <literal>&quot;ctime&quot;</literal> property</title>
266
 
<indexterm zone="EvAttachment--ctime"><primary>EvAttachment:ctime</primary></indexterm><programlisting>  &quot;ctime&quot;                    <link linkend="gulong">gulong</link>                : Write / Construct Only</programlisting>
267
 
<para>The attachment creation date.</para></refsect2>
268
 
<refsect2 id="EvAttachment--data"><title>The <literal>&quot;data&quot;</literal> property</title>
269
 
<indexterm zone="EvAttachment--data"><primary>EvAttachment:data</primary></indexterm><programlisting>  &quot;data&quot;                     <link linkend="gpointer">gpointer</link>              : Write / Construct Only</programlisting>
270
 
<para>The attachment data.</para></refsect2>
271
 
<refsect2 id="EvAttachment--description"><title>The <literal>&quot;description&quot;</literal> property</title>
272
 
<indexterm zone="EvAttachment--description"><primary>EvAttachment:description</primary></indexterm><programlisting>  &quot;description&quot;              <link linkend="gchar">gchar</link>*                : Write / Construct Only</programlisting>
273
 
<para>The attachment description.</para><para>Default value: NULL</para>
274
 
</refsect2>
275
 
<refsect2 id="EvAttachment--mtime"><title>The <literal>&quot;mtime&quot;</literal> property</title>
276
 
<indexterm zone="EvAttachment--mtime"><primary>EvAttachment:mtime</primary></indexterm><programlisting>  &quot;mtime&quot;                    <link linkend="gulong">gulong</link>                : Write / Construct Only</programlisting>
277
 
<para>The attachment modification date.</para></refsect2>
278
 
<refsect2 id="EvAttachment--name"><title>The <literal>&quot;name&quot;</literal> property</title>
279
 
<indexterm zone="EvAttachment--name"><primary>EvAttachment:name</primary></indexterm><programlisting>  &quot;name&quot;                     <link linkend="gchar">gchar</link>*                : Write / Construct Only</programlisting>
280
 
<para>The attachment name.</para><para>Default value: NULL</para>
281
 
</refsect2>
282
 
<refsect2 id="EvAttachment--size"><title>The <literal>&quot;size&quot;</literal> property</title>
283
 
<indexterm zone="EvAttachment--size"><primary>EvAttachment:size</primary></indexterm><programlisting>  &quot;size&quot;                     <link linkend="guint">guint</link>                 : Write / Construct Only</programlisting>
284
 
<para>The attachment size.</para><para>Default value: 0</para>
285
 
</refsect2>
286
 
 
287
 
</refsect1>
288
 
 
289
 
 
290
 
 
291
 
 
292
 
</refentry>