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
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta content="text/html; charset=ISO-8859-1"
http-equiv="content-type">
<title>GTK+ Foundation Classes</title>
<link href="gfc.css" rel="stylesheet" type="text/css">
<meta content="The GFC Development Team" name="author">
<meta content="Core Library Reference Manual" name="description">
</head>
<body style="color: rgb(0, 0, 0); background-color: rgb(243, 244, 248);"
alink="#000099" link="#000099" vlink="#990099">
<table style="text-align: left; width: 1227px; height: 117px;"
border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td
style="text-align: center; background-color: rgb(255, 255, 255); width: 220px; vertical-align: top;"><img
alt="GFC Logo" src="../images/gfc.png"
style="width: 207px; height: 92px;"></td>
<td
style="text-align: center; background-color: rgb(87, 107, 152); vertical-align: middle;"><img
alt="GFC Title Logo" src="../images/gfc-title.png"
style="width: 418px; height: 76px;"><br>
</td>
</tr>
<tr>
<td
style="text-align: center; background-color: rgb(65, 77, 104); vertical-align: middle;"><big><span
style="color: rgb(255, 255, 153); font-weight: bold;">Reference Manual</span></big><br>
</td>
<td
style="text-align: center; background-color: rgb(148, 164, 200); vertical-align: middle;"><small
style="font-family: helvetica,arial,sans-serif;"><a
href="../html/index.html">Main Page</a> | <a
href="../html/namespaces.html">Namespace List</a> | <a
href="classes.html">Alphabetical List</a> | <a
href="../html/annotated.html">Class List</a> | <a
href="../html/files.html">File List</a></small><br>
</td>
</tr>
</tbody>
</table>
<small> </small>
</body>
</html>
<!-- Generated by Doxygen 1.3.8 -->
<h1>GFC::Gdk::PixbufLoader Class Reference</h1>A GdkPixbufLoader C++ wrapper class.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="pixbuf-loader_8hh-source.html">gfc/gdk-pixbuf/pixbuf-loader.hh</a>></code>
<p>
<p>Inheritance diagram for GFC::Gdk::PixbufLoader:
<p><center><img src="classGFC_1_1Gdk_1_1PixbufLoader.png" usemap="#GFC::Gdk::PixbufLoader_map" border="0" alt=""></center>
<map name="GFC::Gdk::PixbufLoader_map">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Object.html" alt="GFC::G::Object" shape="rect" coords="0,112,147,136">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1TypeInstance.html" alt="GFC::G::TypeInstance" shape="rect" coords="0,56,147,80">
<area doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html" alt="GFC::Trackable" shape="rect" coords="0,0,147,24">
</map>
<a href="classGFC_1_1Gdk_1_1PixbufLoader-members.html">List of all members.</a><h2>Signal Prototypes</h2>
<ul>
<li>const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Signal.html">SizePreparedSignalType</a> <a class="el" href="classGFC_1_1Gdk_1_1PixbufLoader.html#z244_8">size_prepared_signal</a>
<dl class="el"><dd class="mdescRight">Size prepared signal (see <a class="el" href="classGFC_1_1Gdk_1_1PixbufLoader.html#z248_0">sig_size_prepared()</a>). <a href="#z244_8"></a><br></dl><li>const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Signal.html">AreaPreparedSignalType</a> <a class="el" href="classGFC_1_1Gdk_1_1PixbufLoader.html#z244_9">area_prepared_signal</a>
<dl class="el"><dd class="mdescRight">Area prepared signal (see <a class="el" href="classGFC_1_1Gdk_1_1PixbufLoader.html#z248_1">sig_area_prepared()</a>). <a href="#z244_9"></a><br></dl><li>const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Signal.html">AreaUpdatedSignalType</a> <a class="el" href="classGFC_1_1Gdk_1_1PixbufLoader.html#z244_10">area_updated_signal</a>
<dl class="el"><dd class="mdescRight">Area updated signal (see <a class="el" href="classGFC_1_1Gdk_1_1PixbufLoader.html#z248_2">sig_area_updated()</a>). <a href="#z244_10"></a><br></dl><li>const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Signal.html">ClosedSignalType</a> <a class="el" href="classGFC_1_1Gdk_1_1PixbufLoader.html#z244_11">closed_signal</a>
<dl class="el"><dd class="mdescRight">Closed signal (see <a class="el" href="classGFC_1_1Gdk_1_1PixbufLoader.html#z248_3">sig_closed()</a>). <a href="#z244_11"></a><br></dl></ul>
<h2>Public Member Functions</h2>
<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
<ul>
<li><a class="anchor" name="z245_0" doxytag="GFC::Gdk::PixbufLoader::PixbufLoader" ></a>
<a class="el" href="classGFC_1_1Gdk_1_1PixbufLoader.html#z245_0">PixbufLoader</a> ()
<dl class="el"><dd class="mdescRight">Constructs a new pixbuf loader object. <br></dl><li><a class="anchor" name="z245_1" doxytag="GFC::Gdk::PixbufLoader::~PixbufLoader" ></a>
virtual <a class="el" href="classGFC_1_1Gdk_1_1PixbufLoader.html#z245_1">~PixbufLoader</a> ()
<dl class="el"><dd class="mdescRight">Destructor. <br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Accessors</div></td></tr>
<ul>
<li><a class="anchor" name="z246_0" doxytag="GFC::Gdk::PixbufLoader::gdk_pixbuf_loader" ></a>
GdkPixbufLoader * <a class="el" href="classGFC_1_1Gdk_1_1PixbufLoader.html#z246_0">gdk_pixbuf_loader</a> () const
<dl class="el"><dd class="mdescRight">Get a pointer to the GdkPixbufLoader structure. <br></dl><li><a class="anchor" name="z246_1" doxytag="GFC::Gdk::PixbufLoader::operator GdkPixbufLoader *" ></a>
<a class="el" href="classGFC_1_1Gdk_1_1PixbufLoader.html#z246_1">operator GdkPixbufLoader *</a> () const
<dl class="el"><dd class="mdescRight">Conversion operator; safely converts a <a class="el" href="classGFC_1_1Gdk_1_1PixbufLoader.html">PixbufLoader</a> to a GdkPixbufLoader pointer. <br></dl><li><a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1Pointer.html">Pointer</a>< <a class="el" href="classGFC_1_1Gdk_1_1Pixbuf.html">Pixbuf</a> > <a class="el" href="classGFC_1_1Gdk_1_1PixbufLoader.html#z246_2">get_pixbuf</a> () const
<dl class="el"><dd class="mdescRight">Queries the <a class="el" href="classGFC_1_1Gdk_1_1Pixbuf.html">Pixbuf</a> that the pixbuf loader is currently creating. <a href="#z246_2"></a><br></dl><li><a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1Pointer.html">Pointer</a>< <a class="el" href="classGFC_1_1Gdk_1_1PixbufAnimation.html">PixbufAnimation</a> > <a class="el" href="classGFC_1_1Gdk_1_1PixbufLoader.html#z246_3">get_animation</a> () const
<dl class="el"><dd class="mdescRight">Queries the <a class="el" href="classGFC_1_1Gdk_1_1PixbufAnimation.html">PixbufAnimation</a> that the pixbuf loader is currently creating. <a href="#z246_3"></a><br></dl><li><a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1Pointer.html">Pointer</a>< <a class="el" href="classGFC_1_1Gdk_1_1PixbufFormat.html">PixbufFormat</a> > <a class="el" href="classGFC_1_1Gdk_1_1PixbufLoader.html#z246_4">get_format</a> () const
<dl class="el"><dd class="mdescRight">Obtains the available information about the format of the currently loading image file. <a href="#z246_4"></a><br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Methods</div></td></tr>
<ul>
<li>void <a class="el" href="classGFC_1_1Gdk_1_1PixbufLoader.html#z247_0">set_size</a> (int width, int height)
<dl class="el"><dd class="mdescRight">Causes the image to be scaled while it is loaded. <a href="#z247_0"></a><br></dl><li>bool <a class="el" href="classGFC_1_1Gdk_1_1PixbufLoader.html#z247_1">write</a> (const unsigned char *buffer, size_t count, <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Error.html">G::Error</a> *error)
<dl class="el"><dd class="mdescRight">This method will cause a pixbuf loader to parse the next count bytes of an image. <a href="#z247_1"></a><br></dl><li>bool <a class="el" href="classGFC_1_1Gdk_1_1PixbufLoader.html#z247_2">close</a> (<a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Error.html">G::Error</a> *error=0)
<dl class="el"><dd class="mdescRight">Informs a pixbuf loader that no further writes with <a class="el" href="classGFC_1_1Gdk_1_1PixbufLoader.html#z247_1">write()</a> will occur, so that it can free its internal loading structures. <a href="#z247_2"></a><br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Signal Proxies</div></td></tr>
<ul>
<li><a class="anchor" name="z248_0" doxytag="GFC::Gdk::PixbufLoader::sig_size_prepared" ></a>
const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1SignalProxy.html">SizePreparedSignalProxy</a> <a class="el" href="classGFC_1_1Gdk_1_1PixbufLoader.html#z248_0">sig_size_prepared</a> ()
<dl class="el"><dd class="mdescRight">Connect to the size_prepared_signal; emitted when the pixbuf loader has been fed the initial amount of data that is required to figure out the size of the image that it will create. <br></dl><li><a class="anchor" name="z248_1" doxytag="GFC::Gdk::PixbufLoader::sig_area_prepared" ></a>
const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1SignalProxy.html">AreaPreparedSignalProxy</a> <a class="el" href="classGFC_1_1Gdk_1_1PixbufLoader.html#z248_1">sig_area_prepared</a> ()
<dl class="el"><dd class="mdescRight">Connect to the area_prepared_signal; emitted when the pixbuf loader has allocated the pixbuf in the desired size. <br></dl><li><a class="anchor" name="z248_2" doxytag="GFC::Gdk::PixbufLoader::sig_area_updated" ></a>
const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1SignalProxy.html">AreaUpdatedSignalProxy</a> <a class="el" href="classGFC_1_1Gdk_1_1PixbufLoader.html#z248_2">sig_area_updated</a> ()
<dl class="el"><dd class="mdescRight">Connect to the area_updated_signal; emitted when a significant area of the image being loaded has been updated. <br></dl><li><a class="anchor" name="z248_3" doxytag="GFC::Gdk::PixbufLoader::sig_closed" ></a>
const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1SignalProxy.html">ClosedSignalProxy</a> <a class="el" href="classGFC_1_1Gdk_1_1PixbufLoader.html#z248_3">sig_closed</a> ()
<dl class="el"><dd class="mdescRight">Connect to the closed_signal; emitted when <a class="el" href="classGFC_1_1Gdk_1_1PixbufLoader.html#z247_2">close()</a> is called. <br></dl></ul>
<h2>Static Public Member Functions</h2>
<ul>
<li><a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1Pointer.html">Pointer</a>< <a class="el" href="classGFC_1_1Gdk_1_1PixbufLoader.html">PixbufLoader</a> > <a class="el" href="classGFC_1_1Gdk_1_1PixbufLoader.html#e1">create_with_type</a> (const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> &image_type, <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Error.html">G::Error</a> *error=0)
<dl class="el"><dd class="mdescRight">Creates a new pixbuf loader object that always attempts to parse image data as if it were an image of type image_type, instead of identifying the type automatically. <a href="#e1"></a><br></dl><li><a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1Pointer.html">Pointer</a>< <a class="el" href="classGFC_1_1Gdk_1_1PixbufLoader.html">PixbufLoader</a> > <a class="el" href="classGFC_1_1Gdk_1_1PixbufLoader.html#e3">create_with_mime_type</a> (const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> &mime_type, <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Error.html">G::Error</a> *error=0)
<dl class="el"><dd class="mdescRight">Creates a new pixbuf loader object that always attempts to parse image data as if it were an image of mime type <em>mime_type</em>, instead of identifying the type automatically. <a href="#e3"></a><br></dl></ul>
<h2>Protected Member Functions</h2>
<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
<ul>
<li><a class="el" href="classGFC_1_1Gdk_1_1PixbufLoader.html#z243_0">PixbufLoader</a> (GdkPixbufLoader *pixbuf_loader, bool <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html#z143_1">owns_reference</a>=true)
<dl class="el"><dd class="mdescRight">Construct a new <a class="el" href="classGFC_1_1Gdk_1_1PixbufLoader.html">PixbufLoader</a> from an existing GdkPixbufLoader. <a href="#z243_0"></a><br></dl></ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A GdkPixbufLoader C++ wrapper class.
<p>
<a class="el" href="classGFC_1_1Gdk_1_1PixbufLoader.html">PixbufLoader</a> provides a way for applications to drive the process of loading an image, by letting them send the image data directly to the loader instead of having the loader read the data from a file. Applications can use this functionality instead of constructing a <a class="el" href="classGFC_1_1Gdk_1_1Pixbuf.html">Pixbuf</a> or a <a class="el" href="classGFC_1_1Gdk_1_1PixbufAnimation.html">PixbufAnimation</a> directly from a file when they need to parse image data in small chunks. For example, it should be used when reading an image from a (potentially) slow network connection, or when loading an extremely large file.<p>
To use <a class="el" href="classGFC_1_1Gdk_1_1PixbufLoader.html">PixbufLoader</a> to load an image, just construct a new one, and call <a class="el" href="classGFC_1_1Gdk_1_1PixbufLoader.html#z247_1">write()</a> to send the data to it. When done, <a class="el" href="classGFC_1_1Gdk_1_1PixbufLoader.html#z247_2">close()</a> should be called to end the stream and finalize everything. The loader will emit three important signals throughout the process. The first, <em>size_prepared</em>, will be called as soon as the image has enough information to determine the size of the image to be used. If you want to scale the image while loading it, you can call <a class="el" href="classGFC_1_1Gdk_1_1PixbufLoader.html#z247_0">set_size()</a> in response to this signal.<p>
The second signal, <em>area_prepared</em>, will be called as soon as the pixbuf of the desired size has been allocated. You can obtain it by calling <a class="el" href="classGFC_1_1Gdk_1_1PixbufLoader.html#z246_2">get_pixbuf()</a>. If you want to use it, simply <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Object.html#z72_0">ref()</a> it. In addition, no actual information will be passed in yet, so the pixbuf can be safely filled with any temporary graphics (or an initial color) as needed. You can also call <a class="el" href="classGFC_1_1Gdk_1_1PixbufLoader.html#z246_2">get_pixbuf()</a> later and get the same pixbuf.<p>
The last signal, <em>area_updated</em> gets called every time a region is updated. This way you can update a partially completed image. Note that you do not know anything about the completeness of an image from the area updated. For example, in an interlaced image, you need to make several passes before the image is done loading.<p>
Loading an animation is almost as easy as loading an image. Once the first <em>area_prepared</em> signal has been emitted, you can call <a class="el" href="classGFC_1_1Gdk_1_1PixbufLoader.html#z246_3">get_animation()</a> to get the <a class="el" href="classGFC_1_1Gdk_1_1PixbufAnimation.html">PixbufAnimation</a> object and get_iter() to get an <a class="el" href="classGFC_1_1Gdk_1_1PixbufAnimationIter.html">PixbufAnimationIter</a> for displaying it.
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="z243_0" doxytag="GFC::Gdk::PixbufLoader::PixbufLoader" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> GFC::Gdk::PixbufLoader::PixbufLoader </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">GdkPixbufLoader * </td>
<td class="mdname" nowrap> <em>pixbuf_loader</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>owns_reference</em> = <code>true</code></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [explicit, protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Construct a new <a class="el" href="classGFC_1_1Gdk_1_1PixbufLoader.html">PixbufLoader</a> from an existing GdkPixbufLoader.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>pixbuf_loader</em> </td><td>A pointer to a GdkPixbufLoader. </td></tr>
<tr><td></td><td valign=top><em>owns_reference</em> </td><td>Set false if the initial reference count is floating, set true if it's not.</td></tr>
</table>
</dl>
<br>
The <em>pixbuf_loader</em> can be a newly created GdkPixbufLoader or an existing GdkPixbufLoader. (see <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Object.html#z68_0">G::Object::Object</a>). </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="z247_2" doxytag="GFC::Gdk::PixbufLoader::close" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool GFC::Gdk::PixbufLoader::close </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Error.html">G::Error</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>error</em> = <code>0</code> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Informs a pixbuf loader that no further writes with <a class="el" href="classGFC_1_1Gdk_1_1PixbufLoader.html#z247_1">write()</a> will occur, so that it can free its internal loading structures.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>error</em> </td><td>The return location for a <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Error.html">G::Error</a>, or null to ignore errors. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><em>true</em> if all image data written so far was successfully passed out via the <em>area_updated</em> signal.</dd></dl>
<br>
This method tries to parse any data that hasn't yet been parsed; if the remaining data is partial or corrupt, an error will be returned. If false is returned, error will be set to an error from the GDK_PIXBUF_ERROR or G_FILE_ERROR domains. If you're just cancelling a load rather than expecting it to be finished, passing null for error to ignore it is reasonable. </td>
</tr>
</table>
<a class="anchor" name="e3" doxytag="GFC::Gdk::PixbufLoader::create_with_mime_type" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1Pointer.html">Pointer</a><<a class="el" href="classGFC_1_1Gdk_1_1PixbufLoader.html">PixbufLoader</a>> GFC::Gdk::PixbufLoader::create_with_mime_type </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> & </td>
<td class="mdname" nowrap> <em>mime_type</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap><a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Error.html">G::Error</a> * </td>
<td class="mdname" nowrap> <em>error</em> = <code>0</code></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Creates a new pixbuf loader object that always attempts to parse image data as if it were an image of mime type <em>mime_type</em>, instead of identifying the type automatically.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>mime_type</em> </td><td>The mime type to be loaded. </td></tr>
<tr><td></td><td valign=top><em>error</em> </td><td>The return location for an allocated <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Error.html">G::Error</a>, or null to ignore errors. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>A newly-created pixbuf loader, or null if any error occurs.</dd></dl>
<br>
This is useful if you want an error if the image isn't the expected mime type, for loading image formats that can't be reliably identified by looking at the data, or if the user manually forces a specific mime type. </td>
</tr>
</table>
<a class="anchor" name="e1" doxytag="GFC::Gdk::PixbufLoader::create_with_type" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1Pointer.html">Pointer</a><<a class="el" href="classGFC_1_1Gdk_1_1PixbufLoader.html">PixbufLoader</a>> GFC::Gdk::PixbufLoader::create_with_type </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> & </td>
<td class="mdname" nowrap> <em>image_type</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap><a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Error.html">G::Error</a> * </td>
<td class="mdname" nowrap> <em>error</em> = <code>0</code></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Creates a new pixbuf loader object that always attempts to parse image data as if it were an image of type image_type, instead of identifying the type automatically.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>image_type</em> </td><td>The name of the image format to be loaded with the image. </td></tr>
<tr><td></td><td valign=top><em>error</em> </td><td>The return location for an allocated <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Error.html">G::Error</a>, or null to ignore errors. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>A newly-created pixbuf loader, or null if any error occurs.</dd></dl>
<br>
Useful if you want an error if the image isn't the expected type, for loading image formats that can't be reliably identified by looking at the data, or if the user manually forces a specific type. The <em>image_type</em> can be png, jpeg, tiff, gif, xpm, pnm, ras, ico, bmp or wbmp. </td>
</tr>
</table>
<a class="anchor" name="z246_3" doxytag="GFC::Gdk::PixbufLoader::get_animation" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1Pointer.html">Pointer</a><<a class="el" href="classGFC_1_1Gdk_1_1PixbufAnimation.html">PixbufAnimation</a>> GFC::Gdk::PixbufLoader::get_animation </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Queries the <a class="el" href="classGFC_1_1Gdk_1_1PixbufAnimation.html">PixbufAnimation</a> that the pixbuf loader is currently creating.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>A smart pointer to the <a class="el" href="classGFC_1_1Gdk_1_1PixbufAnimation.html">PixbufAnimation</a> that the loader is loading, or null if not enough data has been read to determine the information.</dd></dl>
<br>
In general it only makes sense to call this function after the <em>area_prepared</em> signal has been emitted by the loader. If the loader doesn't have enough bytes yet (hasn't emitted the area_prepared signal) this method will return null. </td>
</tr>
</table>
<a class="anchor" name="z246_4" doxytag="GFC::Gdk::PixbufLoader::get_format" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1Pointer.html">Pointer</a><<a class="el" href="classGFC_1_1Gdk_1_1PixbufFormat.html">PixbufFormat</a>> GFC::Gdk::PixbufLoader::get_format </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Obtains the available information about the format of the currently loading image file.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>A smart pointer to the new <a class="el" href="classGFC_1_1Gdk_1_1PixbufFormat.html">PixbufFormat</a>, or null. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z246_2" doxytag="GFC::Gdk::PixbufLoader::get_pixbuf" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1Pointer.html">Pointer</a><<a class="el" href="classGFC_1_1Gdk_1_1Pixbuf.html">Pixbuf</a>> GFC::Gdk::PixbufLoader::get_pixbuf </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Queries the <a class="el" href="classGFC_1_1Gdk_1_1Pixbuf.html">Pixbuf</a> that the pixbuf loader is currently creating.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>A smart pointer to the new <a class="el" href="classGFC_1_1Gdk_1_1Pixbuf.html">Pixbuf</a> the loader is creating, or null if not enough data has been read to determine how to create the image buffer.</dd></dl>
<br>
In general it only makes sense to call this function after the <em>area_prepared</em> signal has been emitted by the loader; this means that enough data has been read to know the size of the image that will be allocated. If the loader has not received enough data via <a class="el" href="classGFC_1_1Gdk_1_1PixbufLoader.html#z247_1">write()</a>, then this function returns null. The returned pixbuf will be the same in all future calls to the loader. If the loader is an animation, it will return the "static image" of the animation (see <a class="el" href="classGFC_1_1Gdk_1_1PixbufAnimation.html#z242_5">Gdk::PixbufAnimation::get_static_image()</a>). </td>
</tr>
</table>
<a class="anchor" name="z247_0" doxytag="GFC::Gdk::PixbufLoader::set_size" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void GFC::Gdk::PixbufLoader::set_size </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname" nowrap> <em>width</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>height</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Causes the image to be scaled while it is loaded.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>width</em> </td><td>The desired width of the image being loaded. </td></tr>
<tr><td></td><td valign=top><em>height</em> </td><td>The desired height of the image being loaded.</td></tr>
</table>
</dl>
<br>
The desired image size can be determined relative to the original size of the image by calling <a class="el" href="classGFC_1_1Gdk_1_1PixbufLoader.html#z247_0">set_size()</a> from a signal handler for the <em>size_prepared</em> signal. Attempts to set the desired image size are ignored after the emission of the <em>size_prepared</em> signal. </td>
</tr>
</table>
<a class="anchor" name="z247_1" doxytag="GFC::Gdk::PixbufLoader::write" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool GFC::Gdk::PixbufLoader::write </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const unsigned char * </td>
<td class="mdname" nowrap> <em>buffer</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>size_t </td>
<td class="mdname" nowrap> <em>count</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap><a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Error.html">G::Error</a> * </td>
<td class="mdname" nowrap> <em>error</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
This method will cause a pixbuf loader to parse the next count bytes of an image.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>buffer</em> </td><td>A pointer to the image data. </td></tr>
<tr><td></td><td valign=top><em>count</em> </td><td>The length of <em>buffer</em> in bytes. </td></tr>
<tr><td></td><td valign=top><em>error</em> </td><td>The return location for errors. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><em>true</em> if the data was loaded successfully, <em>false</em> if an error occurred.</dd></dl>
<br>
If an error occurs, the loader will be closed, and will not accept further writes. If false is returned, error will be set to an error from the GDK_PIXBUF_ERROR or G_FILE_ERROR domains. </td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="z244_9" doxytag="GFC::Gdk::PixbufLoader::area_prepared_signal" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Signal.html">AreaPreparedSignalType</a> <a class="el" href="classGFC_1_1Gdk_1_1PixbufLoader.html#z244_9">GFC::Gdk::PixbufLoader::area_prepared_signal</a><code> [static, protected]</code> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Area prepared signal (see <a class="el" href="classGFC_1_1Gdk_1_1PixbufLoader.html#z248_1">sig_area_prepared()</a>).
<p>
Calls a slot with the signature: <div class="fragment"><pre> <span class="keywordtype">void</span> function();
</pre></div> </td>
</tr>
</table>
<a class="anchor" name="z244_10" doxytag="GFC::Gdk::PixbufLoader::area_updated_signal" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Signal.html">AreaUpdatedSignalType</a> <a class="el" href="classGFC_1_1Gdk_1_1PixbufLoader.html#z244_10">GFC::Gdk::PixbufLoader::area_updated_signal</a><code> [static, protected]</code> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Area updated signal (see <a class="el" href="classGFC_1_1Gdk_1_1PixbufLoader.html#z248_2">sig_area_updated()</a>).
<p>
Calls a slot with the signature: <div class="fragment"><pre> <span class="keywordtype">void</span> function(<span class="keywordtype">int</span> x, <span class="keywordtype">int</span> y, <span class="keywordtype">int</span> width, <span class="keywordtype">int</span> height);
<span class="comment">// x: The X coordinate of the updated area.</span>
<span class="comment">// y: The Y coordinate of the updated area.</span>
<span class="comment">// width: The width of the updated area.</span>
<span class="comment">// height: The height of the updated area.</span>
</pre></div> </td>
</tr>
</table>
<a class="anchor" name="z244_11" doxytag="GFC::Gdk::PixbufLoader::closed_signal" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Signal.html">ClosedSignalType</a> <a class="el" href="classGFC_1_1Gdk_1_1PixbufLoader.html#z244_11">GFC::Gdk::PixbufLoader::closed_signal</a><code> [static, protected]</code> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Closed signal (see <a class="el" href="classGFC_1_1Gdk_1_1PixbufLoader.html#z248_3">sig_closed()</a>).
<p>
Calls a slot with the signature: <div class="fragment"><pre> <span class="keywordtype">void</span> function();
</pre></div> </td>
</tr>
</table>
<a class="anchor" name="z244_8" doxytag="GFC::Gdk::PixbufLoader::size_prepared_signal" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Signal.html">SizePreparedSignalType</a> <a class="el" href="classGFC_1_1Gdk_1_1PixbufLoader.html#z244_8">GFC::Gdk::PixbufLoader::size_prepared_signal</a><code> [static, protected]</code> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Size prepared signal (see <a class="el" href="classGFC_1_1Gdk_1_1PixbufLoader.html#z248_0">sig_size_prepared()</a>).
<p>
Calls a slot with the signature: <div class="fragment"><pre> <span class="keywordtype">void</span> function(<span class="keywordtype">int</span> width, <span class="keywordtype">int</span> height);
<span class="comment">// width: The width of the image the pixbuf loader will create.</span>
<span class="comment">// height: The height of the image the pixbuf loader will create.</span>
</pre></div> </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="pixbuf-loader_8hh-source.html">pixbuf-loader.hh</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Aug 24 00:34:36 2004 for GFC-UI by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 ></a> 1.3.8 </small></address>
</body>
</html>
|
