libfm-doc 1.2.0-1ubuntu2 / usr / share / gtk-doc / html / libfm / libfm-FmThumbnailRequest.html

This file is indexed.

/usr/share/gtk-doc/html/libfm/libfm-FmThumbnailRequest.html is in libfm-doc 1.2.0-1ubuntu2.

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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Libfm Reference Manual: FmThumbnailRequest</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Libfm Reference Manual">
<link rel="up" href="libfm-gtk.html" title="Libfm Gtk+ Widgets and Objects.">
<link rel="prev" href="FmTabLabel.html" title="FmTabLabel">
<link rel="next" href="object-tree.html" title="Part II. Object Hierarchy">
<meta name="generator" content="GTK-Doc V1.20 (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="10"><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="#libfm-FmThumbnailRequest.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 
                  <a href="#libfm-FmThumbnailRequest.object-hierarchy" class="shortcut">Object Hierarchy</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="libfm-gtk.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="FmTabLabel.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="object-tree.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libfm-FmThumbnailRequest"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libfm-FmThumbnailRequest.top_of_page"></a>FmThumbnailRequest</span></h2>
<p>FmThumbnailRequest — A thumbnails cache loader and generator.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libfm-FmThumbnailRequest.functions"></a><h2>Functions</h2>
<div class="informaltable"><table 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">
<span class="c_punctuation">(</span><a class="link" href="libfm-FmThumbnailRequest.html#FmThumbnailReadyCallback" title="FmThumbnailReadyCallback ()">*FmThumbnailReadyCallback</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="libfm-FmThumbnailRequest.html#FmThumbnailRequest" title="FmThumbnailRequest"><span class="returnvalue">FmThumbnailRequest</span></a> *
</td>
<td class="function_name">
<a class="link" href="libfm-FmThumbnailRequest.html#fm-thumbnail-request" title="fm_thumbnail_request ()">fm_thumbnail_request</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libfm-FmThumbnailRequest.html#fm-thumbnail-request-cancel" title="fm_thumbnail_request_cancel ()">fm_thumbnail_request_cancel</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="libfm-FmFileInfo.html#FmFileInfo" title="FmFileInfo"><span class="returnvalue">FmFileInfo</span></a> *
</td>
<td class="function_name">
<a class="link" href="libfm-FmThumbnailRequest.html#fm-thumbnail-request-get-file-info" title="fm_thumbnail_request_get_file_info ()">fm_thumbnail_request_get_file_info</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GdkPixbuf</span> *
</td>
<td class="function_name">
<a class="link" href="libfm-FmThumbnailRequest.html#fm-thumbnail-request-get-pixbuf" title="fm_thumbnail_request_get_pixbuf ()">fm_thumbnail_request_get_pixbuf</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
</td>
<td class="function_name">
<a class="link" href="libfm-FmThumbnailRequest.html#fm-thumbnail-request-get-size" title="fm_thumbnail_request_get_size ()">fm_thumbnail_request_get_size</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libfm-FmThumbnailRequest.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="libfm-FmThumbnailRequest.html#FmThumbnailRequest" title="FmThumbnailRequest">FmThumbnailRequest</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libfm-FmThumbnailRequest.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">
</pre>
</div>
<div class="refsect1">
<a name="libfm-FmThumbnailRequest.description"></a><h2>Description</h2>
<p><em class="parameter"><code>include</code></em>
: libfm/fm-gtk.h</p>
<p>This API allows to generate thumbnails for files and save them on
disk then use that cache next time to display them.</p>
</div>
<div class="refsect1">
<a name="libfm-FmThumbnailRequest.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="FmThumbnailReadyCallback"></a><h3>FmThumbnailReadyCallback ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
<span class="c_punctuation">(</span>*FmThumbnailReadyCallback<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="libfm-FmThumbnailRequest.html#FmThumbnailRequest" title="FmThumbnailRequest"><span class="type">FmThumbnailRequest</span></a> *req</code></em>,
                             <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);</pre>
<p>The callback to requestor when thumbnail is ready.
Note that this call is done outside of GTK loop so if the callback
wants to use any GTK API it should call <a href="/usr/share/gtk-doc/html/gdk3/gdk3-Threads.html#gdk-threads-enter"><code class="function">gdk_threads_enter()</code></a> and
<a href="/usr/share/gtk-doc/html/gdk3/gdk3-Threads.html#gdk-threads-leave"><code class="function">gdk_threads_leave()</code></a> for safety.</p>
<div class="refsect3">
<a name="id-1.2.6.31.7.2.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>req</p></td>
<td class="parameter_description"><p>request descriptor</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p>user data provided when request was made</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since 0.1.0</p>
</div>
<hr>
<div class="refsect2">
<a name="fm-thumbnail-request"></a><h3>fm_thumbnail_request ()</h3>
<pre class="programlisting"><a class="link" href="libfm-FmThumbnailRequest.html#FmThumbnailRequest" title="FmThumbnailRequest"><span class="returnvalue">FmThumbnailRequest</span></a> *
fm_thumbnail_request (<em class="parameter"><code><a class="link" href="libfm-FmFileInfo.html#FmFileInfo" title="FmFileInfo"><span class="type">FmFileInfo</span></a> *src_file</code></em>,
                      <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> size</code></em>,
                      <em class="parameter"><code><a class="link" href="libfm-FmThumbnailRequest.html#FmThumbnailReadyCallback" title="FmThumbnailReadyCallback ()"><span class="type">FmThumbnailReadyCallback</span></a> callback</code></em>,
                      <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
<p>Schedules loading/generation of thumbnail for <em class="parameter"><code>src_file</code></em>
. If the
request isn't cancelled then ready thumbnail will be given to the
requestor in <em class="parameter"><code>callback</code></em>
. Returned descriptor can be used to cancel
the job.</p>
<div class="refsect3">
<a name="id-1.2.6.31.7.3.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>src_file</p></td>
<td class="parameter_description"><p>an image file</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>size</p></td>
<td class="parameter_description"><p>thumbnail size</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>callback</p></td>
<td class="parameter_description"><p>callback to requestor</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>data provided for <em class="parameter"><code>callback</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.6.31.7.3.6"></a><h4>Returns</h4>
<p> request descriptor. </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>
<p class="since">Since 0.1.0</p>
</div>
<hr>
<div class="refsect2">
<a name="fm-thumbnail-request-cancel"></a><h3>fm_thumbnail_request_cancel ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
fm_thumbnail_request_cancel (<em class="parameter"><code><a class="link" href="libfm-FmThumbnailRequest.html#FmThumbnailRequest" title="FmThumbnailRequest"><span class="type">FmThumbnailRequest</span></a> *req</code></em>);</pre>
<p>Cancels request. After return from this call the <em class="parameter"><code>req</code></em>
 becomes invalid
and cannot be used. Caller will never get callback for cancelled
request either.</p>
<div class="refsect3">
<a name="id-1.2.6.31.7.4.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>req</p></td>
<td class="parameter_description"><p>the request descriptor</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since 0.1.0</p>
</div>
<hr>
<div class="refsect2">
<a name="fm-thumbnail-request-get-file-info"></a><h3>fm_thumbnail_request_get_file_info ()</h3>
<pre class="programlisting"><a class="link" href="libfm-FmFileInfo.html#FmFileInfo" title="FmFileInfo"><span class="returnvalue">FmFileInfo</span></a> *
fm_thumbnail_request_get_file_info (<em class="parameter"><code><a class="link" href="libfm-FmThumbnailRequest.html#FmThumbnailRequest" title="FmThumbnailRequest"><span class="type">FmThumbnailRequest</span></a> *req</code></em>);</pre>
<p>Retrieves file descriptor that request is for. Returned data are
owned by <em class="parameter"><code>req</code></em>
 and should be not freed by caller.</p>
<div class="refsect3">
<a name="id-1.2.6.31.7.5.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>req</p></td>
<td class="parameter_description"><p>request descriptor</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.6.31.7.5.6"></a><h4>Returns</h4>
<p> file descriptor. </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>
<p class="since">Since 0.1.0</p>
</div>
<hr>
<div class="refsect2">
<a name="fm-thumbnail-request-get-pixbuf"></a><h3>fm_thumbnail_request_get_pixbuf ()</h3>
<pre class="programlisting"><span class="returnvalue">GdkPixbuf</span> *
fm_thumbnail_request_get_pixbuf (<em class="parameter"><code><a class="link" href="libfm-FmThumbnailRequest.html#FmThumbnailRequest" title="FmThumbnailRequest"><span class="type">FmThumbnailRequest</span></a> *req</code></em>);</pre>
<p>Retrieves loaded thumbnail. Returned data are owned by <em class="parameter"><code>req</code></em>
 and should
be not freed by caller.</p>
<div class="refsect3">
<a name="id-1.2.6.31.7.6.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>req</p></td>
<td class="parameter_description"><p>request descriptor</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.6.31.7.6.6"></a><h4>Returns</h4>
<p> thumbnail. </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>
<p class="since">Since 0.1.0</p>
</div>
<hr>
<div class="refsect2">
<a name="fm-thumbnail-request-get-size"></a><h3>fm_thumbnail_request_get_size ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
fm_thumbnail_request_get_size (<em class="parameter"><code><a class="link" href="libfm-FmThumbnailRequest.html#FmThumbnailRequest" title="FmThumbnailRequest"><span class="type">FmThumbnailRequest</span></a> *req</code></em>);</pre>
<p>Retrieves thumbnail size that request is for.</p>
<div class="refsect3">
<a name="id-1.2.6.31.7.7.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>req</p></td>
<td class="parameter_description"><p>request descriptor</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.6.31.7.7.6"></a><h4>Returns</h4>
<p> size in pixels.</p>
<p></p>
</div>
<p class="since">Since 0.1.0</p>
</div>
</div>
<div class="refsect1">
<a name="libfm-FmThumbnailRequest.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="FmThumbnailRequest"></a><h3>FmThumbnailRequest</h3>
<pre class="programlisting">#define FmThumbnailRequest FmThumbnailLoader
</pre>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.20</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.