/usr/share/qt5/doc/qtsvg/qgraphicssvgitem.html is in qtsvg5-doc-html 5.2.1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 | <?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" xml:lang="en_US" lang="en_US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qgraphicssvgitem.cpp -->
<title>QGraphicsSvgItem Class | QtSvg 5.2</title>
<link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<ul>
<li>Qt 5.2</li>
<li><a href="qtsvg-index.html">Qt SVG</a></li>
<li><a href="qtsvg-module.html">C++ Classes</a></li>
<li>QGraphicsSvgItem</li>
<li id="buildversion">
Qt 5.2.1 Reference Documentation</li>
</ul>
</div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#properties">Properties</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QGraphicsSvgItem Class</h1>
<!-- $$$QGraphicsSvgItem-brief -->
<p>The QGraphicsSvgItem class is a QGraphicsItem that can be used to render the contents of SVG files. <a href="#details">More...</a></p>
<!-- @@@QGraphicsSvgItem -->
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> </b><tt><span class="preprocessor">#include <QGraphicsSvgItem></span>
</tt></td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> <tt>QT += svg</tt></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 4.2</td></tr></table><ul>
<li><a href="qgraphicssvgitem-members.html">List of all members, including inherited members</a></li>
<li><a href="qgraphicssvgitem-obsolete.html">Obsolete members</a></li>
</ul>
<a name="properties"></a>
<h2>Properties</h2>
<ul>
<li class="fn"><b><a href="qgraphicssvgitem.html#elementId-prop">elementId</a></b> : QString</li>
<li class="fn"><b><a href="qgraphicssvgitem.html#maximumCacheSize-prop">maximumCacheSize</a></b> : QSize</li>
</ul>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qgraphicssvgitem.html#QGraphicsSvgItem">QGraphicsSvgItem</a></b>(QGraphicsItem *<i> parent</i> = 0)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qgraphicssvgitem.html#QGraphicsSvgItem-2">QGraphicsSvgItem</a></b>(const QString &<i> fileName</i>, QGraphicsItem *<i> parent</i> = 0)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QRectF </td><td class="memItemRight bottomAlign"><b><a href="qgraphicssvgitem.html#boundingRect">boundingRect</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qgraphicssvgitem.html#elementId-prop">elementId</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QSize </td><td class="memItemRight bottomAlign"><b><a href="qgraphicssvgitem.html#maximumCacheSize-prop">maximumCacheSize</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qgraphicssvgitem.html#paint">paint</a></b>(QPainter *<i> painter</i>, const QStyleOptionGraphicsItem *<i> option</i>, QWidget *<i> widget</i> = 0)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QSvgRenderer * </td><td class="memItemRight bottomAlign"><b><a href="qgraphicssvgitem.html#renderer">renderer</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgraphicssvgitem.html#elementId-prop">setElementId</a></b>(const QString &<i> id</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgraphicssvgitem.html#maximumCacheSize-prop">setMaximumCacheSize</a></b>(const QSize &<i> size</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgraphicssvgitem.html#setSharedRenderer">setSharedRenderer</a></b>(QSvgRenderer *<i> renderer</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual int </td><td class="memItemRight bottomAlign"><b><a href="qgraphicssvgitem.html#type">type</a></b>() const</td></tr>
</table>
<a name="details"></a>
<!-- $$$QGraphicsSvgItem-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QGraphicsSvgItem class is a QGraphicsItem that can be used to render the contents of SVG files.</p>
<p>QGraphicsSvgItem provides a way of rendering SVG files onto QGraphicsView. QGraphicsSvgItem can be created by passing the SVG file to be rendered to its constructor or by explicit setting a shared <a href="qsvgrenderer.html">QSvgRenderer</a> on it.</p>
<p>Note that setting <a href="qsvgrenderer.html">QSvgRenderer</a> on a QGraphicsSvgItem doesn't make the item take ownership of the renderer, therefore if using <a href="qgraphicssvgitem.html#setSharedRenderer">setSharedRenderer</a>() method one has to make sure that the lifetime of the <a href="qsvgrenderer.html">QSvgRenderer</a> object will be at least as long as that of the QGraphicsSvgItem.</p>
<p>QGraphicsSvgItem provides a way of rendering only parts of the SVG files via the setElementId. If <a href="qgraphicssvgitem.html#elementId-prop">setElementId</a>() method is called, only the SVG element (and its children) with the passed id will be renderer. This provides a convenient way of selectively rendering large SVG files that contain a number of discrete elements. For example the following code renders only jokers from a SVG file containing a whole card deck:</p>
<pre class="cpp"><span class="type"><a href="qsvgrenderer.html">QSvgRenderer</a></span> <span class="operator">*</span>renderer <span class="operator">=</span> <span class="keyword">new</span> <span class="type"><a href="qsvgrenderer.html">QSvgRenderer</a></span>(QLatin1String(<span class="string">"SvgCardDeck.svg"</span>));
<span class="type">QGraphicsSvgItem</span> <span class="operator">*</span>black <span class="operator">=</span> <span class="keyword">new</span> <span class="type">QGraphicsSvgItem</span>();
<span class="type">QGraphicsSvgItem</span> <span class="operator">*</span>red <span class="operator">=</span> <span class="keyword">new</span> <span class="type">QGraphicsSvgItem</span>();
black<span class="operator">-</span><span class="operator">></span><a href="qgraphicssvgitem.html#setSharedRenderer">setSharedRenderer</a>(renderer);
black<span class="operator">-</span><span class="operator">></span><a href="qgraphicssvgitem.html#elementId-prop">setElementId</a>(QLatin1String(<span class="string">"black_joker"</span>));
red<span class="operator">-</span><span class="operator">></span><a href="qgraphicssvgitem.html#setSharedRenderer">setSharedRenderer</a>(renderer);
red<span class="operator">-</span><span class="operator">></span><a href="qgraphicssvgitem.html#elementId-prop">setElementId</a>(QLatin1String(<span class="string">"red_joker"</span>));</pre>
<p>Size of the item can be set via the setSize() method of the <a href="qgraphicssvgitem.html#boundingRect">bounding rectangle</a> or via direct manipulation of the items transformation matrix.</p>
<p>By default the SVG rendering is cached using QGraphicsItem::DeviceCoordinateCache mode to speedup the display of items. Caching can be disabled by passing QGraphicsItem::NoCache to the QGraphicsItem::setCacheMode() method.</p>
</div>
<p><b>See also </b><a href="qsvgwidget.html">QSvgWidget</a>, <a href="qtsvg-module.html">Qt SVG C++ Classes</a>, QGraphicsItem, and QGraphicsView.</p>
<!-- @@@QGraphicsSvgItem -->
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$elementId-prop$$$elementId$$$setElementIdconstQString& -->
<h3 class="fn"><a name="elementId-prop"></a><span class="name">elementId</span> : <span class="type">QString</span></h3>
<p>This property holds the element's XML ID.</p>
<p>This property was introduced in Qt 4.6.</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QString </td><td class="memItemRight bottomAlign"><span class="name"><b>elementId</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setElementId</b></span>(const QString &<i> id</i>)</td></tr>
</table>
<!-- @@@elementId -->
<!-- $$$maximumCacheSize-prop$$$maximumCacheSize$$$setMaximumCacheSizeconstQSize& -->
<h3 class="fn"><a name="maximumCacheSize-prop"></a><span class="name">maximumCacheSize</span> : <span class="type">QSize</span></h3>
<p>This property holds the maximum size of the device coordinate cache for this item.</p>
<p>This property was introduced in Qt 4.6.</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QSize </td><td class="memItemRight bottomAlign"><span class="name"><b>maximumCacheSize</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setMaximumCacheSize</b></span>(const QSize &<i> size</i>)</td></tr>
</table>
<!-- @@@maximumCacheSize -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QGraphicsSvgItem[overload1]$$$QGraphicsSvgItemQGraphicsItem* -->
<h3 class="fn"><a name="QGraphicsSvgItem"></a>QGraphicsSvgItem::<span class="name">QGraphicsSvgItem</span>(<span class="type">QGraphicsItem</span> *<i> parent</i> = 0)</h3>
<p>Constructs a new SVG item with the given <i>parent</i>.</p>
<!-- @@@QGraphicsSvgItem -->
<!-- $$$QGraphicsSvgItem$$$QGraphicsSvgItemconstQString&QGraphicsItem* -->
<h3 class="fn"><a name="QGraphicsSvgItem-2"></a>QGraphicsSvgItem::<span class="name">QGraphicsSvgItem</span>(const <span class="type">QString</span> &<i> fileName</i>, <span class="type">QGraphicsItem</span> *<i> parent</i> = 0)</h3>
<p>Constructs a new item with the given <i>parent</i> and loads the contents of the SVG file with the specified <i>fileName</i>.</p>
<!-- @@@QGraphicsSvgItem -->
<!-- $$$boundingRect[overload1]$$$boundingRect -->
<h3 class="fn"><a name="boundingRect"></a><span class="type">QRectF</span> QGraphicsSvgItem::<span class="name">boundingRect</span>() const<tt> [virtual]</tt></h3>
<p>Returns the bounding rectangle of this item.</p>
<!-- @@@boundingRect -->
<!-- $$$paint[overload1]$$$paintQPainter*constQStyleOptionGraphicsItem*QWidget* -->
<h3 class="fn"><a name="paint"></a><span class="type">void</span> QGraphicsSvgItem::<span class="name">paint</span>(<span class="type">QPainter</span> *<i> painter</i>, const <span class="type">QStyleOptionGraphicsItem</span> *<i> option</i>, <span class="type">QWidget</span> *<i> widget</i> = 0)<tt> [virtual]</tt></h3>
<!-- @@@paint -->
<!-- $$$renderer[overload1]$$$renderer -->
<h3 class="fn"><a name="renderer"></a><span class="type"><a href="qsvgrenderer.html">QSvgRenderer</a></span> * QGraphicsSvgItem::<span class="name">renderer</span>() const</h3>
<p>Returns the currently use <a href="qsvgrenderer.html">QSvgRenderer</a>.</p>
<!-- @@@renderer -->
<!-- $$$setSharedRenderer[overload1]$$$setSharedRendererQSvgRenderer* -->
<h3 class="fn"><a name="setSharedRenderer"></a><span class="type">void</span> QGraphicsSvgItem::<span class="name">setSharedRenderer</span>(<span class="type"><a href="qsvgrenderer.html">QSvgRenderer</a></span> *<i> renderer</i>)</h3>
<p>Sets <i>renderer</i> to be a shared <a href="qsvgrenderer.html">QSvgRenderer</a> on the item. By using this method one can share the same <a href="qsvgrenderer.html">QSvgRenderer</a> on a number of items. This means that the SVG file will be parsed only once. <a href="qsvgrenderer.html">QSvgRenderer</a> passed to this method has to exist for as long as this item is used.</p>
<!-- @@@setSharedRenderer -->
<!-- $$$type[overload1]$$$type -->
<h3 class="fn"><a name="type"></a><span class="type">int</span> QGraphicsSvgItem::<span class="name">type</span>() const<tt> [virtual]</tt></h3>
<!-- @@@type -->
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2013 Digia Plc and/or its
subsidiaries. Documentation contributions included herein are the copyrights of
their respective owners.<br> The documentation provided herein is licensed under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation License version 1.3</a> as published by the Free Software Foundation.<br> Digia, Qt and their respective logos are trademarks of Digia Plc in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. </p>
</div>
</body>
</html>
|