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
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
|
<?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>Plasma.Svg</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>Svg Class Reference</h1>
<code>from PyKDE4.plasma import *</code>
<p>
Inherits: QObject<br />
Subclasses: <a href="../plasma/Plasma.FrameSvg.html">Plasma.FrameSvg</a><br />
Namespace: <a href="../plasma/Plasma.html">Plasma</a><br />
<h2>Detailed Description</h2>
<p>Svg plasma/svg.h <Plasma/Svg>
</p>
<p>
A theme aware image-centric SVG class
</p>
<p>
Plasma.Svg provides a class for rendering SVG images to a QPainter in a
convenient manner. Unless an absolute path to a file is provided, it loads
the SVG document using Plasma.Theme. It also provides a number of internal
optimizations to help lower the cost of painting SVGs, such as caching.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> Plasma.FrameSvg
</dd></dl>
</p>
<table border="0" cellpadding="0" cellspacing="0"><tr><td colspan="2"><br><h2>Signals</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#repaintNeeded">repaintNeeded</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#sizeChanged">sizeChanged</a> ()</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="#Svg">__init__</a> (self, QObject parent=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#containsMultipleImages">containsMultipleImages</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#elementAtPoint">elementAtPoint</a> (self, QPoint point)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QRectF </td><td class="memItemRight" valign="bottom"><a class="el" href="#elementRect">elementRect</a> (self, QString elementId)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QSize </td><td class="memItemRight" valign="bottom"><a class="el" href="#elementSize">elementSize</a> (self, QString elementId)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#hasElement">hasElement</a> (self, QString elementId)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#imagePath">imagePath</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isUsingRenderingCache">isUsingRenderingCache</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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#paint">paint</a> (self, QPainter painter, QPointF point, QString elementID=QString())</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#paint">paint</a> (self, QPainter painter, int x, int y, QString elementID=QString())</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#paint">paint</a> (self, QPainter painter, QRectF rect, QString elementID=QString())</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#paint">paint</a> (self, QPainter painter, int x, int y, int width, int height, QString elementID=QString())</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QPixmap </td><td class="memItemRight" valign="bottom"><a class="el" href="#pixmap">pixmap</a> (self, QString elementID=QString())</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#resize">resize</a> (self, float width, float height)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#resize">resize</a> (self, QSizeF size)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#resize">resize</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setContainsMultipleImages">setContainsMultipleImages</a> (self, bool multiple)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setImagePath">setImagePath</a> (self, QString svgFilePath)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setTheme">setTheme</a> (self, <a href="../plasma/Plasma.Theme.html">Plasma.Theme</a> theme)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setUsingRenderingCache">setUsingRenderingCache</a> (self, bool useCache)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QSize </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"><a href="../plasma/Plasma.Theme.html">Plasma.Theme</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#theme">theme</a> (self)</td></tr>
</table>
<hr><h2>Signal Documentation</h2><a class="anchor" name="repaintNeeded"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> repaintNeeded</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Emitted whenever the SVG data has changed in such a way that a repaint is required.
Any usage of an Svg object that does the painting itself must connect to this signal
and respond by updating the painting. Note that connected to Theme.themeChanged is
incorrect in such a use case as the Svg itself may not be updated yet nor may theme
change be the only case when a repaint is needed. Also note that classes or QML code
which take Svg objects as parameters for their own painting all respond to this signal
so that in those cases manually responding to the signal is unnecessary; ONLY when
direct, manual painting with an Svg object is done in application code is this signal
used.
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("repaintNeeded()"), target_slot)</code></dd></dl></div></div><a class="anchor" name="sizeChanged"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> sizeChanged</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Emitted whenever the size of the Svg is changed. <dl class="see" compact><dt><b>See also:</b></dt><dd> resize()
</dd></dl>
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("sizeChanged()"), target_slot)</code></dd></dl></div></div><hr><h2>Method Documentation</h2><a class="anchor" name="Svg"></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">QObject </td>
<td class="paramname"><em>parent=0</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Constructs an SVG object that implicitly shares and caches rendering.
</p>
<p>
Unlike QSvgRenderer, which this class uses internally,
Plasma.Svg represents an image generated from an SVG. As such, it
has a related size and transform matrix (the latter being provided
by the painter used to paint the image).
</p>
<p>
The size is initialized to be the SVG's native size.
</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>parent</em> </td><td> options QObject to parent this to
</td></tr>
</table></dl>
<p> @related Plasma.Theme
</p></div></div><a class="anchor" name="containsMultipleImages"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool containsMultipleImages</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 the SVG contains multiple images.
</p>
<p>
If this is true, the SVG will be treated as a
collection of related images, rather than a consistent
drawing.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> true if the SVG will be treated as containing
multiple images, false if it will be treated
as a coherent image.
</dd></dl>
</p></div></div><a class="anchor" name="elementAtPoint"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString elementAtPoint</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">QPoint </td>
<td class="paramname"><em>point</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Returns the element (by id) at the given point.
</p>
<p>
An empty string is returned if there no element is at <b>point.</b>
</p>
<p>
NOTE: not implemented! This will currently return an empty string!
</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>point</em> </td><td> a point in SVG co-ordinates
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> an empty string
</dd></dl>
</p></div></div><a class="anchor" name="elementRect"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QRectF elementRect</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>elementId</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>The bounding rect of a given element.
</p>
<p>
This is the bounding rect of the element with ID <b>elementId</b> after
the SVG has been scaled (see resize()). Note that this is
unaffected by the containsMultipleImages property.
</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>elementId</em> </td><td> the id of the element to check
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> the current rect of a given element, given the current size of the SVG
</dd></dl>
</p></div></div><a class="anchor" name="elementSize"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QSize elementSize</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>elementId</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Find the size of a given element.
</p>
<p>
This is the size of the element with ID <b>elementId</b> after the SVG
has been scaled (see resize()). Note that this is unaffected by
the containsMultipleImages property.
</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>elementId</em> </td><td> the id of the element to check
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> the size of a given element, given the current size of the SVG
</dd></dl>
</p></div></div><a class="anchor" name="hasElement"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool hasElement</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>elementId</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Check whether an element exists in the loaded SVG.
</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>elementId</em> </td><td> the id of the element to check for
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> true if the element is defined in the SVG, otherwise false
</dd></dl>
</p></div></div><a class="anchor" name="imagePath"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString imagePath</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>The SVG file to render.
</p>
<p>
If this SVG is themed, this will be a relative path, and will not
include a file extension.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> either an absolute path to an SVG file, or an image name
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> Theme.imagePath()
</dd></dl>
</p></div></div><a class="anchor" name="isUsingRenderingCache"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool isUsingRenderingCache</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 the rendering cache is being used.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> true if the Svg object is using caching for rendering results
</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.3
</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>Check whether this object is backed by a valid SVG file.
</p>
<p>
This method can be expensive as it causes disk access.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> true if the SVG file exists and the document is valid,
otherwise false.
</dd></dl>
</p></div></div><a class="anchor" name="paint"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> paint</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">QPainter </td>
<td class="paramname"><em>painter</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QPointF </td>
<td class="paramname"><em>point</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>elementID=QString()</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Paints all or part of the SVG represented by this object
</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>painter</em> </td><td> the QPainter to use
<tr><td></td><td valign="top"><em>x</em> </td><td> the horizontal coordinate to start painting from
<tr><td></td><td valign="top"><em>y</em> </td><td> the vertical coordinate to start painting from
<tr><td></td><td valign="top"><em>width</em> </td><td> the width of the element to draw
<tr><td></td><td valign="top"><em>height</em> </td><td> the height of the element do draw
<tr><td></td><td valign="top"><em>elementId</em> </td><td> the ID string of the element to render, or an empty
string for the whole SVG (the default)
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="paint"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> paint</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">QPainter </td>
<td class="paramname"><em>painter</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>elementID=QString()</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Paints all or part of the SVG represented by this object
</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>painter</em> </td><td> the QPainter to use
<tr><td></td><td valign="top"><em>x</em> </td><td> the horizontal coordinate to start painting from
<tr><td></td><td valign="top"><em>y</em> </td><td> the vertical coordinate to start painting from
<tr><td></td><td valign="top"><em>width</em> </td><td> the width of the element to draw
<tr><td></td><td valign="top"><em>height</em> </td><td> the height of the element do draw
<tr><td></td><td valign="top"><em>elementId</em> </td><td> the ID string of the element to render, or an empty
string for the whole SVG (the default)
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="paint"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> paint</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">QPainter </td>
<td class="paramname"><em>painter</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QRectF </td>
<td class="paramname"><em>rect</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>elementID=QString()</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Paints all or part of the SVG represented by this object
</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>painter</em> </td><td> the QPainter to use
<tr><td></td><td valign="top"><em>x</em> </td><td> the horizontal coordinate to start painting from
<tr><td></td><td valign="top"><em>y</em> </td><td> the vertical coordinate to start painting from
<tr><td></td><td valign="top"><em>width</em> </td><td> the width of the element to draw
<tr><td></td><td valign="top"><em>height</em> </td><td> the height of the element do draw
<tr><td></td><td valign="top"><em>elementId</em> </td><td> the ID string of the element to render, or an empty
string for the whole SVG (the default)
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="paint"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> paint</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">QPainter </td>
<td class="paramname"><em>painter</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>width</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>height</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>elementID=QString()</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Paints all or part of the SVG represented by this object
</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>painter</em> </td><td> the QPainter to use
<tr><td></td><td valign="top"><em>x</em> </td><td> the horizontal coordinate to start painting from
<tr><td></td><td valign="top"><em>y</em> </td><td> the vertical coordinate to start painting from
<tr><td></td><td valign="top"><em>width</em> </td><td> the width of the element to draw
<tr><td></td><td valign="top"><em>height</em> </td><td> the height of the element do draw
<tr><td></td><td valign="top"><em>elementId</em> </td><td> the ID string of the element to render, or an empty
string for the whole SVG (the default)
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="pixmap"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QPixmap pixmap</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>elementID=QString()</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Returns a pixmap of the SVG represented by this object.
</p>
<p>
The size of the pixmap will be the size of this Svg object (size())
if containsMultipleImages is true; otherwise, it will be the
size of the requested element after the whole SVG has been scaled
to size().
</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>elementId</em> </td><td> the ID string of the element to render, or an empty
string for the whole SVG (the default)
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> a QPixmap of the rendered SVG
</dd></dl>
</p></div></div><a class="anchor" name="resize"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> resize</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">float </td>
<td class="paramname"><em>width</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>height</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Resizes the rendered image to the natural size of the SVG.
</p>
<p>
Rendering will actually take place on the next call to paint.
</p></div></div><a class="anchor" name="resize"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> resize</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">QSizeF </td>
<td class="paramname"><em>size</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Resizes the rendered image to the natural size of the SVG.
</p>
<p>
Rendering will actually take place on the next call to paint.
</p></div></div><a class="anchor" name="resize"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> resize</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>Resizes the rendered image to the natural size of the SVG.
</p>
<p>
Rendering will actually take place on the next call to paint.
</p></div></div><a class="anchor" name="setContainsMultipleImages"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setContainsMultipleImages</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>multiple</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Set whether the SVG contains a single image or multiple ones.
</p>
<p>
If this is set to true, the SVG will be treated as a
collection of related images, rather than a consistent
drawing.
</p>
<p>
In particular, when individual elements are rendered, this
affects whether the elements are resized to size() by default.
See paint() and pixmap().
</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>multiple</em> </td><td> true if the svg contains multiple images
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="setImagePath"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setImagePath</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>svgFilePath</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Set the SVG file to render.
</p>
<p>
Relative paths are looked for in the current Plasma theme,
and should not include the file extension (.svg and .svgz
files will be searched for). See Theme.imagePath().
</p>
<p>
If the parent object of this Svg is a Plasma.Applet,
relative paths will be searched for in the applet's package
first.
</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>svgFilePath</em> </td><td> either an absolute path to an SVG file, or
an image name
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="setTheme"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setTheme</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="../plasma/Plasma.Theme.html">Plasma.Theme</a> </td>
<td class="paramname"><em>theme</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 Plasma.Theme to use with this Svg object.
</p>
<p>
By default, Svg objects use Plasma.Theme.default().
</p>
<p>
This determines how relative image paths are interpreted.
</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>theme</em> </td><td> the theme object to use
</td></tr> </table></dl>
<p> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.3
</dd></dl>
</p></div></div><a class="anchor" name="setUsingRenderingCache"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setUsingRenderingCache</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>useCache</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 or not to cache the results of rendering to pixmaps.
</p>
<p>
If the SVG is resized and re-rendered often (and does not keep using the
same small set of pixmap dimensions), then it may be less efficient to do
disk caching. A good example might be a progress meter that uses an Svg
object to paint itself: the meter will be changing often enough, with
enough unpredictability and without re-use of the previous pixmaps to
not get a gain from caching.
</p>
<p>
Most Svg objects should use the caching feature, however.
Therefore, the default is to use the render cache.
</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>useCache</em> </td><td> true to cache rendered pixmaps
</td></tr> </table></dl>
<p> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.3
</dd></dl>
</p></div></div><a class="anchor" name="size"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QSize 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>The size of the SVG.
</p>
<p>
If the SVG has been resized with resize(), that size will be
returned; otherwise, the natural size of the SVG will be returned.
</p>
<p>
If containsMultipleImages is true, each element of the SVG
will be rendered at this size by default.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> the current size of the SVG
</dd></dl>
</p></div></div><a class="anchor" name="theme"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../plasma/Plasma.Theme.html">Plasma.Theme</a> theme</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>The Plasma.Theme used by this Svg object.
</p>
<p>
This determines how relative image paths are interpreted.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> the theme used by this Svg
</dd></dl>
</p></div></div>
</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>
|
