libgexiv2-doc 0.10.8-1 / usr / share / gtk-doc / html / gexiv2 / gexiv2-GExiv2PreviewImage.html

This file is indexed.

/usr/share/gtk-doc/html/gexiv2/gexiv2-GExiv2PreviewImage.html is in libgexiv2-doc 0.10.8-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GExiv2PreviewImage: gexiv2 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="gexiv2 Reference Manual">
<link rel="up" href="ch01.html" title="GExiv2">
<link rel="prev" href="gexiv2-GExiv2Metadata.html" title="GExiv2Metadata">
<link rel="next" href="gexiv2-GExiv2PreviewProperties.html" title="GExiv2PreviewProperties">
<meta name="generator" content="GTK-Doc V1.27 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#gexiv2-GExiv2PreviewImage.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="gexiv2-GExiv2Metadata.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="gexiv2-GExiv2PreviewProperties.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="gexiv2-GExiv2PreviewImage"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gexiv2-GExiv2PreviewImage.top_of_page"></a>GExiv2PreviewImage</span></h2>
<p>GExiv2PreviewImage — Class describing preview images (or thumbnails) that
are part of the metadata.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="gexiv2-GExiv2PreviewImage.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="gexiv2-GExiv2PreviewImage.html#gexiv2-preview-image-free" title="gexiv2_preview_image_free ()">gexiv2_preview_image_free</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="../glib/glib-Basic-Types.html#guint8"><span class="returnvalue">guint8</span></a> *
</td>
<td class="function_name">
<a class="link" href="gexiv2-GExiv2PreviewImage.html#gexiv2-preview-image-get-data" title="gexiv2_preview_image_get_data ()">gexiv2_preview_image_get_data</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="gexiv2-GExiv2PreviewImage.html#gexiv2-preview-image-get-mime-type" title="gexiv2_preview_image_get_mime_type ()">gexiv2_preview_image_get_mime_type</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="gexiv2-GExiv2PreviewImage.html#gexiv2-preview-image-get-extension" title="gexiv2_preview_image_get_extension ()">gexiv2_preview_image_get_extension</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a>
</td>
<td class="function_name">
<a class="link" href="gexiv2-GExiv2PreviewImage.html#gexiv2-preview-image-get-width" title="gexiv2_preview_image_get_width ()">gexiv2_preview_image_get_width</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a>
</td>
<td class="function_name">
<a class="link" href="gexiv2-GExiv2PreviewImage.html#gexiv2-preview-image-get-height" title="gexiv2_preview_image_get_height ()">gexiv2_preview_image_get_height</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#glong"><span class="returnvalue">glong</span></a>
</td>
<td class="function_name">
<a class="link" href="gexiv2-GExiv2PreviewImage.html#gexiv2-preview-image-write-file" title="gexiv2_preview_image_write_file ()">gexiv2_preview_image_write_file</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gexiv2-GExiv2PreviewImage.description"></a><h2>Description</h2>
<p><span class="type">GExiv2PreviewImage</span> is an accessor to the preview images contained in
the image's metadata. This could be anything from a thumbnail to a
full-sized camera development of a RAW image.</p>
<p>The <span class="type">GExiv2PreviewImage</span> is obtained by calling <a class="link" href="gexiv2-GExiv2Metadata.html#gexiv2-metadata-get-preview-image" title="gexiv2_metadata_get_preview_image ()"><code class="function">gexiv2_metadata_get_preview_image()</code></a>
with an instance of <span class="type">GExiv2PreviewProperties</span> that are describing the image
to be fetched.</p>
<div class="informalexample">
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
    <tbody>
      <tr>
        <td class="listing_lines" align="right"><pre>1
2
3
4
5
6
7</pre></td>
        <td class="listing_code"><pre class="programlisting">GExiv2PreviewProperties <span class="gtkdoc opt">**</span>properties<span class="gtkdoc opt">, **</span>it<span class="gtkdoc opt">;</span>
properties <span class="gtkdoc opt">=</span> it <span class="gtkdoc opt">=</span> <span class="function"><a href="gexiv2-GExiv2Metadata.html#gexiv2-metadata-get-preview-properties">gexiv2_metadata_get_preview_properties</a></span><span class="gtkdoc opt">(</span>metadata<span class="gtkdoc opt">);</span>

<span class="keyword">while</span> <span class="gtkdoc opt">(*</span>it<span class="gtkdoc opt">) {</span>
  preview_image <span class="gtkdoc opt">=</span> <span class="function"><a href="gexiv2-GExiv2Metadata.html#gexiv2-metadata-get-preview-image">gexiv2_metadata_get_preview_image</a></span><span class="gtkdoc opt">(</span>metadata<span class="gtkdoc opt">, *</span>it<span class="gtkdoc opt">);</span>
  it<span class="gtkdoc opt">++;</span>
<span class="gtkdoc opt">}</span></pre></td>
      </tr>
    </tbody>
  </table>
</div>

</div>
<div class="refsect1">
<a name="gexiv2-GExiv2PreviewImage.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gexiv2-preview-image-free"></a><h3>gexiv2_preview_image_free ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gexiv2_preview_image_free (<em class="parameter"><code><span class="type">GExiv2PreviewImage</span> *self</code></em>);</pre>
<div class="warning">
<p><code class="literal">gexiv2_preview_image_free</code> has been deprecated since version 0.10.3 and should not be used in newly-written code.</p>
<p>Use <a href="../gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> instead.</p>
</div>
<p>Releases the preview image and all associated memory.</p>
<div class="refsect3">
<a name="gexiv2-preview-image-free.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>An instance of <span class="type">GExiv2PreviewImage</span></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gexiv2-preview-image-get-data"></a><h3>gexiv2_preview_image_get_data ()</h3>
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#guint8"><span class="returnvalue">guint8</span></a> *
gexiv2_preview_image_get_data (<em class="parameter"><code><span class="type">GExiv2PreviewImage</span> *self</code></em>,
                               <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> *size</code></em>);</pre>
<div class="refsect3">
<a name="gexiv2-preview-image-get-data.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>An instance of <span class="type">GExiv2PreviewImage</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>size</p></td>
<td class="parameter_description"><p>The size of the buffer holding the data. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gexiv2-preview-image-get-data.returns"></a><h4>Returns</h4>
<p>The raw image data. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=size]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gexiv2-preview-image-get-mime-type"></a><h3>gexiv2_preview_image_get_mime_type ()</h3>
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
gexiv2_preview_image_get_mime_type (<em class="parameter"><code><span class="type">GExiv2PreviewImage</span> *self</code></em>);</pre>
<div class="refsect3">
<a name="gexiv2-preview-image-get-mime-type.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>An instance of <span class="type">GExiv2PreviewImage</span></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gexiv2-preview-image-get-mime-type.returns"></a><h4>Returns</h4>
<p>The preview image's MIME type. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gexiv2-preview-image-get-extension"></a><h3>gexiv2_preview_image_get_extension ()</h3>
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
gexiv2_preview_image_get_extension (<em class="parameter"><code><span class="type">GExiv2PreviewImage</span> *self</code></em>);</pre>
<div class="refsect3">
<a name="gexiv2-preview-image-get-extension.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>An instance of <span class="type">GExiv2PreviewImage</span></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gexiv2-preview-image-get-extension.returns"></a><h4>Returns</h4>
<p>The preview image's recommended file extension. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gexiv2-preview-image-get-width"></a><h3>gexiv2_preview_image_get_width ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a>
gexiv2_preview_image_get_width (<em class="parameter"><code><span class="type">GExiv2PreviewImage</span> *self</code></em>);</pre>
<div class="refsect3">
<a name="gexiv2-preview-image-get-width.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>An instance of <span class="type">GExiv2PreviewImage</span></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gexiv2-preview-image-get-width.returns"></a><h4>Returns</h4>
<p> The preview image's display width in pixels.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gexiv2-preview-image-get-height"></a><h3>gexiv2_preview_image_get_height ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a>
gexiv2_preview_image_get_height (<em class="parameter"><code><span class="type">GExiv2PreviewImage</span> *self</code></em>);</pre>
<div class="refsect3">
<a name="gexiv2-preview-image-get-height.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>An instance of <span class="type">GExiv2PreviewImage</span></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gexiv2-preview-image-get-height.returns"></a><h4>Returns</h4>
<p> The preview image's display height in pixels.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gexiv2-preview-image-write-file"></a><h3>gexiv2_preview_image_write_file ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#glong"><span class="returnvalue">glong</span></a>
gexiv2_preview_image_write_file (<em class="parameter"><code><span class="type">GExiv2PreviewImage</span> *self</code></em>,
                                 <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *path</code></em>);</pre>
<div class="refsect3">
<a name="gexiv2-preview-image-write-file.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>An instance of <span class="type">GExiv2PreviewImage</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>path</p></td>
<td class="parameter_description"><p>The file path to write the preview image to. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gexiv2-preview-image-write-file.returns"></a><h4>Returns</h4>
<p> The number of bytes written to the file.</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="gexiv2-GExiv2PreviewImage.other_details"></a><h2>Types and Values</h2>
</div>
<div class="refsect1">
<a name="gexiv2-GExiv2PreviewImage.see-also"></a><h2>See Also</h2>
<p><a class="link" href="gexiv2-GExiv2Metadata.html#GExiv2Metadata" title="struct GExiv2Metadata"><span class="type">GExiv2Metadata</span></a> <span class="type">GExiv2PreviewProperties</span></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.