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
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
|
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<title>KPixmapCache</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<link rel="stylesheet" type="text/css" href="../common/doxygen.css" />
<link rel="stylesheet" media="screen" type="text/css" title="KDE Colors" href="../common/kde.css" />
</head>
<body>
<div id="container">
<div id="header">
<div id="header_top">
<div>
<div>
<img alt ="" src="../common/top-kde.jpg"/>
KDE 4.9 PyKDE API Reference
</div>
</div>
</div>
<div id="header_bottom">
<div id="location">
<ul>
<li>KDE's Python API</li>
</ul>
</div>
<div id="menu">
<ul>
<li><a href="../modules.html">Overview</a></li>
<li><a href="http://techbase.kde.org/Development/Languages/Python">PyKDE Home</a></li>
<li><a href="http://kde.org/family/">Sitemap</a></li>
<li><a href="http://kde.org/contact/">Contact Us</a></li>
</ul>
</div>
</div>
</div>
<div id="body_wrapper">
<div id="body">
<div id="right">
<div class="content">
<div id="main">
<div class="clearer"> </div>
<h1>KPixmapCache Class Reference</h1>
<code>from PyKDE4.kdeui import *</code>
<p>
Subclasses: <a href="../kdeui/KIconCache.html">KIconCache</a><br />
<h2>Detailed Description</h2>
<p>General-purpose pixmap cache for KDE.
</p>
<p>
The pixmap cache can be used to store pixmaps which can later be loaded
from the cache very quickly.
</p>
<p>
Its most common use is storing SVG images which might be expensive to
render every time they are used. With the cache you can render each SVG
only once and later use the stored version unless the SVG file or requested
pixmap size changes.
</p>
<p>
KPixmapCache's API is similar to that of the QPixmapCache so if you're
already using the latter then all you need to do is creating a KPixmapCache
object (unlike QPixmapCache, KPixmapCache doesn't have many static methods)
and calling insert() and find() method on that object:
<pre class="fragment">
// Create KPixmapCache object
KPixmapCache* cache = new KPixmapCache("myapp-pixmaps");
// Load a pixmap
QPixmap pix;
if (!cache->find("pixmap-1", pix)) {
// Pixmap isn't in the cache, create it and insert to cache
pix = createPixmapFromData();
cache->insert("pixmap-1", pix);
}
// Use pix
</pre>
</p>
<p>
The above example illustrates that you can also cache pixmaps created from
some data. In case such data is updated, you might need to discard cache
contents using discard() method:
<pre class="fragment">
// Discard the cache if it's too old
if (cache->timestamp() < mydataTimestamp()) {
cache->discard();
}
// Now the cache contains up-to-date data
</pre>
As demonstrated, you can use cache's timestamp() method to see when
the cache was created. If necessary, you can also change the timestamp
using setTimestamp() method.
</p>
<p>
<dl class="deprecated" compact><dt><b>Deprecated:</b></dt><dd> KPixmapCache is susceptible to various non-trivial locking bugs and
inefficiencies, and is supported for backward compatibility only (since it exposes
a QDataStream API for subclasses). Users should port to KImageCache for a very close
work-alike, or KSharedDataCache if they need more control.
</dd></dl> </p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> KImageCache, KSharedDataCache
</dd></dl> </p>
<p>
<dl class="author" compact><dt><b>Author:</b></dt><dd> Rivo Laks </dd></dl>
</p>
<table border="0" cellpadding="0" cellspacing="0"><tr><td colspan="2"><br><h2>Enumerations</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#RemoveStrategy">RemoveStrategy</a> </td><td class="memItemRight" valign="bottom">{ RemoveOldest, RemoveSeldomUsed, RemoveLeastRecentlyUsed }</td></tr>
<tr><td colspan="2"><br><h2>Methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#KPixmapCache">__init__</a> (self, <a href="../kdeui/KPixmapCache.html">KPixmapCache</a> other)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#KPixmapCache">__init__</a> (self, QString name)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#cacheLimit">cacheLimit</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#discard">discard</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ensureInited">ensureInited</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#find">find</a> (self, QString key, QPixmap pix)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#insert">insert</a> (self, QString key, QPixmap pix)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isEnabled">isEnabled</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isValid">isValid</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#loadCustomData">loadCustomData</a> (self, QDataStream stream)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#loadCustomIndexHeader">loadCustomIndexHeader</a> (self, QDataStream stream)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QPixmap </td><td class="memItemRight" valign="bottom"><a class="el" href="#loadFromFile">loadFromFile</a> (self, QString filename)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QPixmap </td><td class="memItemRight" valign="bottom"><a class="el" href="#loadFromSvg">loadFromSvg</a> (self, QString filename, QSize size=QSize())</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#recreateCacheFiles">recreateCacheFiles</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#removeEntries">removeEntries</a> (self, int newsize=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdeui/KPixmapCache.html#RemoveStrategy">KPixmapCache.RemoveStrategy</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#removeEntryStrategy">removeEntryStrategy</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setCacheLimit">setCacheLimit</a> (self, int kbytes)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setRemoveEntryStrategy">setRemoveEntryStrategy</a> (self, <a href="../kdeui/KPixmapCache.html#RemoveStrategy">KPixmapCache.RemoveStrategy</a> strategy)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setTimestamp">setTimestamp</a> (self, long time)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setUseQPixmapCache">setUseQPixmapCache</a> (self, bool use)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setValid">setValid</a> (self, bool valid)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#size">size</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="#timestamp">timestamp</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#useQPixmapCache">useQPixmapCache</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#writeCustomData">writeCustomData</a> (self, QDataStream stream)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#writeCustomIndexHeader">writeCustomIndexHeader</a> (self, QDataStream stream)</td></tr>
<tr><td colspan="2"><br><h2>Static Methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#deleteCache">deleteCache</a> (QString name)</td></tr>
</table>
<hr><h2>Method Documentation</h2><a class="anchor" name="KPixmapCache"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdeui/KPixmapCache.html">KPixmapCache</a> </td>
<td class="paramname"><em>other</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="KPixmapCache"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>name</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Constucts the pixmap cache object.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>name</em> </td><td> unique name of the cache
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="cacheLimit"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">int cacheLimit</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p><dl class="return" compact><dt><b>Returns:</b></dt><dd> maximum size of the cache (in kilobytes).
Default setting is 3 megabytes (1 megabyte = 2^20 bytes).
</dd></dl>
</p></div></div><a class="anchor" name="discard"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> discard</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Deletes all entries and reinitializes this cache.
</p>
<p>
<b>NOTE:</b> If useQPixmapCache is set to true then that cache must also
be cleared. There is only one QPixmapCache for the entire process
however so other KPixmapCaches and other QPixmapCache users may also
be affected, leading to a temporary slowdown until the QPixmapCache is
repopulated.
</p></div></div><a class="anchor" name="ensureInited"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> ensureInited</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Makes sure that the cache is initialized correctly, including the loading of the
cache index and data, and any shared memory attachments (for systems where that
is enabled).
</p>
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd> Although this method is protected you should not use it from any subclasses.
</dd></dl> </p>
<p>
<dl class="internal" compact><dt><b>Internal:</b></dt><dd>
</dd></dl>
</p></div></div><a class="anchor" name="find"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool find</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QPixmap </td>
<td class="paramname"><em>pix</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Tries to load pixmap with the specified <b>key</b> from cache. If the pixmap
is found it is stored in <b>pix,</b> otherwise <b>pix</b> is unchanged.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> true when pixmap was found and loaded from cache, false otherwise
</dd></dl>
</p></div></div><a class="anchor" name="insert"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> insert</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QPixmap </td>
<td class="paramname"><em>pix</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Inserts the pixmap <b>pix</b> into the cache, associated with the key <b>key.</b>
</p>
<p>
Any existing pixmaps associated with <b>key</b> are overwritten.
</p></div></div><a class="anchor" name="isEnabled"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool isEnabled</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Cache will be disabled when e.g. its data file cannot be created or
read.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> true when the cache is enabled.
</dd></dl>
</p></div></div><a class="anchor" name="isValid"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool isValid</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p><dl class="return" compact><dt><b>Returns:</b></dt><dd> true when the cache is ready to be used. Not being valid usually
means that some additional initialization has to be done before the
cache can be used.
</dd></dl>
</p></div></div><a class="anchor" name="loadCustomData"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool loadCustomData</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QDataStream </td>
<td class="paramname"><em>stream</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Can be used by subclasses to load custom data from the stream.
This function will be called by KPixmapCache immediately following the
image data for a single image being read from <b>stream.</b>
(This function is called once for every single image).
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> writeCustomData
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> loadCustomIndexHeader
</dd></dl> </p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>stream</em> </td><td> the QDataStream to read data from
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> true if custom data was successfully loaded, false otherwise. If
false is returned then the cached item is assumed to be invalid and
will not be available to find() or contains().
</dd></dl>
</p></div></div><a class="anchor" name="loadCustomIndexHeader"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool loadCustomIndexHeader</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QDataStream </td>
<td class="paramname"><em>stream</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Can be used by subclasses to load custom data from cache's header.
This function will be called by KPixmapCache immediately after the
index header has been written out. (This function is called one time
only for the entire cache).
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> loadCustomData
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> writeCustomIndexHeader
</dd></dl> </p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>stream</em> </td><td> the QDataStream to read data from
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> true if custom index header data was successfully read, false
otherwise. If false is returned then the cache is assumed to
be invalid and further processing does not occur.
</dd></dl>
</p></div></div><a class="anchor" name="loadFromFile"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QPixmap loadFromFile</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>filename</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Loads a pixmap from given file, using the cache. If the file does not
exist on disk, an empty pixmap is returned, even if that file had
previously been cached. In addition, if the file's modified-time is
more recent than cache's timestamp(), the <b>entire</b> cache is
discarded (to be regenerated). This behavior may change in a future
KDE Platform release. If the cached data is current the pixmap
is returned directly from the cache without any file loading.
</p>
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd> The mapping between <b>filename</b> and the actual key used internally
is implementation-dependent and can change without warning. Use insert()
manually if you need control of the key, otherwise consistently use this
function.
</dd></dl> </p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>filename</em> </td><td> The name of the pixmap to load, cache, and return.
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> The given pixmap, or an empty pixmap if the file was invalid or did
not exist.
</dd></dl>
</p></div></div><a class="anchor" name="loadFromSvg"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QPixmap loadFromSvg</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>filename</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QSize </td>
<td class="paramname"><em>size=QSize()</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Same as loadFromFile(), but using an SVG file instead. You may optionally
pass in a <b>size</b> to control the size of the output pixmap.
</p>
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd> The returned pixmap is only cached for identical filenames and sizes.
If you change the size in between calls to this function then the
pixmap will have to be regenerated again.
</dd></dl> </p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>filename</em> </td><td> The filename of the SVG file to load.
<tr><td></td><td valign="top"><em>size</em> </td><td> size of the pixmap where the SVG is render to. If not given
then the SVG file's default size is used.
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> an empty pixmap if the file does not exist or was invalid, otherwise
a pixmap of the desired <b>size.</b>
</dd></dl>
</p></div></div><a class="anchor" name="recreateCacheFiles"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool recreateCacheFiles</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>This function causes the cache files to be recreate by invalidating the cache.
Any shared memory mappings (if enabled) are dropped temporarily as well.
</p>
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd> The recreated cache will be initially empty, but with the same size limits
and entry removal strategy (see removeEntryStrategy()).
</dd></dl> </p>
<p>
If you use this in a subclass be prepared to handle writeCustomData() and
writeCustomIndexHeader().
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> true if the cache was successfully recreated.
</dd></dl>
</p></div></div><a class="anchor" name="removeEntries"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> removeEntries</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>newsize=0</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Removes some of the entries in the cache according to current
removeEntryStrategy().
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>newsize</em> </td><td> wanted size of the cache, in bytes. If 0 is given then
current cacheLimit() is used.
</td></tr>
</table></dl>
<p> <dl class="warning" compact><dt><b>Warning:</b></dt><dd> This currently works by copying some entries to a new cache and
then replacing the old cache with the new one. Thus it might be slow and
will temporarily use extra disk space.
</dd></dl>
</p></div></div><a class="anchor" name="removeEntryStrategy"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kdeui/KPixmapCache.html#RemoveStrategy">KPixmapCache.RemoveStrategy</a> removeEntryStrategy</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p><dl class="return" compact><dt><b>Returns:</b></dt><dd> current entry removal strategy.
Default is RemoveLeastRecentlyUsed.
</dd></dl>
</p></div></div><a class="anchor" name="setCacheLimit"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setCacheLimit</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>kbytes</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Sets the maximum size of the cache (in kilobytes). If cache gets bigger
than the limit then some entries are removed (according to
removeEntryStrategy()).
</p>
<p>
Setting the cache limit to 0 disables caching (as all entries will get
immediately removed).
</p>
<p>
Note that the cleanup might not be done immediately, so the cache might
temporarily (for a few seconds) grow bigger than the limit.
</p></div></div><a class="anchor" name="setRemoveEntryStrategy"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setRemoveEntryStrategy</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdeui/KPixmapCache.html#RemoveStrategy">KPixmapCache.RemoveStrategy</a> </td>
<td class="paramname"><em>strategy</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Sets the removeEntryStrategy used when removing entries.
</p></div></div><a class="anchor" name="setTimestamp"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setTimestamp</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"><em>time</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Sets the timestamp of app-specific cache. It's saved in the cache file
and can later be retrieved using the timestamp() method.
By default the timestamp is set to the cache creation time.
</p></div></div><a class="anchor" name="setUseQPixmapCache"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setUseQPixmapCache</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>use</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Sets whether QPixmapCache (memory caching) should be used in addition
to disk cache. QPixmapCache is used by default.
</p>
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd> On most systems KPixmapCache can use shared-memory to share cached
pixmaps with other applications attached to the same shared pixmap,
which means additional memory caching is unnecessary and actually
wasteful of memory.
</dd></dl> </p>
<p>
<dl class="warning" compact><dt><b>Warning:</b></dt><dd> QPixmapCache is shared among the entire process and therefore
can cause strange interactions with other instances of KPixmapCache.
This may be fixed in the future and should be not relied upon.
</dd></dl>
</p></div></div><a class="anchor" name="setValid"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setValid</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>valid</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Sets whether this cache is valid or not. (The cache must be enabled in addition
for isValid() to return true. <dl class="see" compact><dt><b>See also:</b></dt><dd> isEnabled(), <dl class="see" compact><dt><b>See also:</b></dt><dd> setEnabled()).
</dd></dl> </p>
<p>
Most cache functions do not work if the cache is not valid. KPixmapCache assumes
the cache is valid as long as its cache files were able to be created (see
recreateCacheFiles()) even if the cache is not enabled.
</p>
<p>
Can be used by subclasses to indicate that cache needs some additional
initialization before it can be used (note that KPixmapCache will <b>not</b> handle
actually performing this extra initialization).
</p></div></div><a class="anchor" name="size"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">int size</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p><dl class="return" compact><dt><b>Returns:</b></dt><dd> approximate size of the cache, in kilobytes (1 kilobyte == 1024 bytes)
</dd></dl>
</p></div></div><a class="anchor" name="timestamp"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">long timestamp</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p><dl class="note" compact><dt><b>Note:</b></dt><dd> KPixmapCache does not ever change the timestamp, so the application
must set the timestamp if it to be used.
</dd></dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd> Timestamp of the cache, set using the setTimestamp() method.
</dd></dl>
</p></div></div><a class="anchor" name="useQPixmapCache"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool useQPixmapCache</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Whether QPixmapCache should be used to cache pixmaps in memory in
addition to caching them on the disk.
</p>
<p>
<b>NOTE:</b> The design of QPixmapCache means that the entries stored in
the cache are shared throughout the entire process, and not just in
this particular KPixmapCache. KPixmapCache makes an effort to ensure
that entries from other KPixmapCaches do not inadvertently spill over
into this one, but is not entirely successful (see discard())
</p></div></div><a class="anchor" name="writeCustomData"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool writeCustomData</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QDataStream </td>
<td class="paramname"><em>stream</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Can be used by subclasses to write custom data into the stream.
This function will be called by KPixmapCache immediately after the
image data for a single image has been written to <b>stream.</b>
(This function is called once for every single image).
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> loadCustomData
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> writeCustomIndexHeader
</dd></dl> </p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>stream</em> </td><td> the QDataStream to write data to
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="writeCustomIndexHeader"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> writeCustomIndexHeader</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QDataStream </td>
<td class="paramname"><em>stream</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Can be used by subclasses to write custom data into cache's header.
This function will be called by KPixmapCache immediately following the
index header has being loaded. (This function is called one time
only for the entire cache).
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> writeCustomData
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> loadCustomIndexHeader
</dd></dl> </p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>stream</em> </td><td> the QDataStream to write data to
</td></tr>
</table></dl>
<p>
</p></div></div><hr><h2>Static Method Documentation</h2><a class="anchor" name="deleteCache"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> deleteCache</td>
<td>(</td>
<td class="paramtype">QString </td>
<td class="paramname"><em>name</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Deletes a pixmap cache.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>name</em> </td><td> unique name of the cache to be deleted
</td></tr>
</table></dl>
<p>
</p></div></div><hr><h2>Enumeration Documentation</h2><a class="anchor" name="RemoveStrategy"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">RemoveStrategy</td>
</tr>
</table>
</div>
<div class="memdoc"><p>Describes which entries will be removed first during cache cleanup.
<dl class="see" compact><dt><b>See also:</b></dt><dd> removeEntryStrategy(), <dl class="see" compact><dt><b>See also:</b></dt><dd> setRemoveEntryStrategy()
</dd></dl>
</p><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>RemoveOldest</em> </td><td><tr><td valign="top"><em>RemoveSeldomUsed</em> </td><td><tr><td valign="top"><em>RemoveLeastRecentlyUsed</em> </td><td></table>
</dl>
</div></div><p>
</div>
</div>
</div>
<div id="left">
<div class="menu_box">
<div class="nav_list">
<ul>
<li><a href="../allclasses.html">Full Index</a></li>
</ul>
</div>
<a name="cp-menu" /><div class="menutitle"><div>
<h2 id="cp-menu-project">Modules</h2>
</div></div>
<div class="nav_list">
<ul><li><a href="../akonadi/index.html">akonadi</a></li>
<li><a href="../dnssd/index.html">dnssd</a></li>
<li><a href="../kdecore/index.html">kdecore</a></li>
<li><a href="../kdeui/index.html">kdeui</a></li>
<li><a href="../khtml/index.html">khtml</a></li>
<li><a href="../kio/index.html">kio</a></li>
<li><a href="../knewstuff/index.html">knewstuff</a></li>
<li><a href="../kparts/index.html">kparts</a></li>
<li><a href="../kutils/index.html">kutils</a></li>
<li><a href="../nepomuk/index.html">nepomuk</a></li>
<li><a href="../phonon/index.html">phonon</a></li>
<li><a href="../plasma/index.html">plasma</a></li>
<li><a href="../polkitqt/index.html">polkitqt</a></li>
<li><a href="../solid/index.html">solid</a></li>
<li><a href="../soprano/index.html">soprano</a></li>
</ul></div></div>
</div>
</div>
<div class="clearer"/>
</div>
<div id="end_body"></div>
</div>
<div id="footer"><div id="footer_text">
This documentation is maintained by <a href="mailto:simon@simonzone.com">Simon Edwards</a>.<br />
KDE<sup>®</sup> and <a href="../images/kde_gear_black.png">the K Desktop Environment<sup>®</sup> logo</a> are registered trademarks of <a href="http://ev.kde.org/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
<a href="http://www.kde.org/contact/impressum.php">Legal</a>
</div></div>
</body>
</html>
|
