Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > a6711891ce757817bba854bf3f25205a > files > 2264

qtjambi-doc-4.3.3-3mdv2008.1.i586.rpm

<class name="QSvgRenderer" doc="/**
&lt;p&gt;The &lt;a href=&quot;QSvgRenderer.html#QSvgRenderer(com.trolltech.qt.core.QByteArray, com.trolltech.qt.core.QObject)&quot;&gt;&lt;tt&gt;QSvgRenderer&lt;/tt&gt;&lt;/a&gt; class is used to draw the contents of SVG files onto paint devices.&lt;/p&gt;
&lt;p&gt;Using &lt;a href=&quot;QSvgRenderer.html#QSvgRenderer(com.trolltech.qt.core.QByteArray, com.trolltech.qt.core.QObject)&quot;&gt;&lt;tt&gt;QSvgRenderer&lt;/tt&gt;&lt;/a&gt;, Scalable Vector Graphics (SVG) can be rendered onto any &lt;a href=&quot;%2E%2E/gui/QPaintDevice.html&quot;&gt;&lt;tt&gt;QPaintDevice&lt;/tt&gt;&lt;/a&gt; subclass, including &lt;a href=&quot;%2E%2E/gui/QWidget.html&quot;&gt;&lt;tt&gt;QWidget&lt;/tt&gt;&lt;/a&gt;, &lt;a href=&quot;%2E%2E/gui/QImage.html&quot;&gt;&lt;tt&gt;QImage&lt;/tt&gt;&lt;/a&gt;, and &lt;a href=&quot;%2E%2E/opengl/QGLWidget.html&quot;&gt;&lt;tt&gt;QGLWidget&lt;/tt&gt;&lt;/a&gt;.&lt;/p&gt;
&lt;p&gt;&lt;a href=&quot;QSvgRenderer.html#QSvgRenderer(com.trolltech.qt.core.QByteArray, com.trolltech.qt.core.QObject)&quot;&gt;&lt;tt&gt;QSvgRenderer&lt;/tt&gt;&lt;/a&gt; provides an API that supports basic features of SVG rendering, such as loading and rendering of static drawings, and more interactive features like animation. Since the rendering is performed using &lt;a href=&quot;%2E%2E/gui/QPainter.html&quot;&gt;&lt;tt&gt;QPainter&lt;/tt&gt;&lt;/a&gt;, SVG drawings can be rendered on any subclass of &lt;a href=&quot;%2E%2E/gui/QPaintDevice.html&quot;&gt;&lt;tt&gt;QPaintDevice&lt;/tt&gt;&lt;/a&gt;.&lt;/p&gt;
&lt;p&gt;SVG drawings are either loaded when an &lt;a href=&quot;QSvgRenderer.html#QSvgRenderer(com.trolltech.qt.core.QByteArray, com.trolltech.qt.core.QObject)&quot;&gt;&lt;tt&gt;QSvgRenderer&lt;/tt&gt;&lt;/a&gt; is constructed, or loaded later using the &lt;a href=&quot;QSvgRenderer.html#load(com.trolltech.qt.core.QByteArray)&quot;&gt;&lt;tt&gt;load&lt;/tt&gt;&lt;/a&gt; functions. Data is either supplied directly as serialized XML, or indirectly using a file name. If a valid file has been loaded, either when the renderer is constructed or at some later time, &lt;a href=&quot;QSvgRenderer.html#isValid()&quot;&gt;&lt;tt&gt;isValid&lt;/tt&gt;&lt;/a&gt; returns true; otherwise it returns false. &lt;a href=&quot;QSvgRenderer.html#QSvgRenderer(com.trolltech.qt.core.QByteArray, com.trolltech.qt.core.QObject)&quot;&gt;&lt;tt&gt;QSvgRenderer&lt;/tt&gt;&lt;/a&gt; provides the &lt;a href=&quot;QSvgRenderer.html#render(com.trolltech.qt.gui.QPainter)&quot;&gt;&lt;tt&gt;render&lt;/tt&gt;&lt;/a&gt; slot to render the current document, or the current frame of an animated document, using a given painter.&lt;/p&gt;
&lt;p&gt;The &lt;a href=&quot;QSvgRenderer.html#defaultSize()&quot;&gt;&lt;tt&gt;defaultSize&lt;/tt&gt;&lt;/a&gt; function provides information about the amount of space that is required to render the currently loaded SVG file. This is useful for paint devices, such as &lt;a href=&quot;%2E%2E/gui/QWidget.html&quot;&gt;&lt;tt&gt;QWidget&lt;/tt&gt;&lt;/a&gt;, that often need to supply a size hint to their parent layout. The default size of a drawing may differ from its visible area, found using the &lt;a href=&quot;QSvgRenderer.html#viewBox()&quot;&gt;&lt;tt&gt;viewBox&lt;/tt&gt;&lt;/a&gt; property.&lt;/p&gt;
&lt;p&gt;Animated SVG drawings are supported, and can be controlled with a simple collection of functions and properties:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;The &lt;a href=&quot;QSvgRenderer.html#animated()&quot;&gt;&lt;tt&gt;animated&lt;/tt&gt;&lt;/a&gt; function indicates whether a drawing contains animation information.&lt;/li&gt;
&lt;li&gt;The &lt;a href=&quot;QSvgRenderer.html#framesPerSecond()&quot;&gt;&lt;tt&gt;framesPerSecond&lt;/tt&gt;&lt;/a&gt; property contains the rate at which the animation plays.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;Finally, the &lt;a href=&quot;QSvgRenderer.html#QSvgRenderer(com.trolltech.qt.core.QByteArray, com.trolltech.qt.core.QObject)&quot;&gt;&lt;tt&gt;QSvgRenderer&lt;/tt&gt;&lt;/a&gt; class provides the &lt;a href=&quot;QSvgRenderer.html#repaintNeeded()&quot;&gt;&lt;tt&gt;repaintNeeded&lt;/tt&gt;&lt;/a&gt; signal which is emitted whenever the rendering of the document needs to be updated.&lt;/p&gt;

@see &lt;a href=&quot;QSvgWidget.html&quot;&gt;&lt;tt&gt;QSvgWidget&lt;/tt&gt;&lt;/a&gt;
@see &lt;tt&gt;QtSvg Module&lt;/tt&gt;
@see SVG Viewer Example&lt;/tt&gt;
@see &lt;a href=&quot;%2E%2E/gui/QPicture.html&quot;&gt;&lt;tt&gt;QPicture&lt;/tt&gt;&lt;/a&gt; */">
    <signal name="protected final void repaintNeeded()" doc="/**
&lt;p&gt;This signal is emitted whenever the rendering of the document needs to be updated, usually for the purposes of animation.&lt;/p&gt;
&lt;dl&gt;
&lt;dt&gt;&lt;b&gt;Compatible Slot Signature:&lt;/b&gt;&lt;/dt&gt;
&lt;dd&gt;&lt;tt&gt;void mySlot()&lt;/tt&gt;&lt;/dd&gt;
&lt;/dl&gt;
 */"/>
    <method name="public QSvgRenderer(com.trolltech.qt.core.QObject parent)" doc="/**
&lt;p&gt;Constructs a new renderer with the given &lt;tt&gt;parent&lt;/tt&gt;.&lt;/p&gt;
 */"/>
    <method name="public QSvgRenderer()" doc="/**
&lt;p&gt;Equivalent to &lt;a href=&quot;QSvgRenderer.html#QSvgRenderer(com.trolltech.qt.core.QByteArray, com.trolltech.qt.core.QObject)&quot;&gt;&lt;tt&gt;QSvgRenderer&lt;/tt&gt;&lt;/a&gt;(0). */"/>
    <method name="public QSvgRenderer(java.lang.String filename, com.trolltech.qt.core.QObject parent)" doc="/**
&lt;p&gt;Constructs a new renderer with the given &lt;tt&gt;parent&lt;/tt&gt; and loads the contents of the SVG file with the specified &lt;tt&gt;filename&lt;/tt&gt;.&lt;/p&gt;
 */"/>
    <method name="public QSvgRenderer(java.lang.String filename)" doc="/**
&lt;p&gt;Equivalent to &lt;a href=&quot;QSvgRenderer.html#QSvgRenderer(com.trolltech.qt.core.QByteArray, com.trolltech.qt.core.QObject)&quot;&gt;&lt;tt&gt;QSvgRenderer&lt;/tt&gt;&lt;/a&gt;(&lt;tt&gt;filename&lt;/tt&gt;, 0). */"/>
    <method name="public QSvgRenderer(com.trolltech.qt.core.QByteArray contents, com.trolltech.qt.core.QObject parent)" doc="/**
&lt;p&gt;Constructs a new renderer with the given &lt;tt&gt;parent&lt;/tt&gt; and loads the specified SVG format &lt;tt&gt;contents&lt;/tt&gt;.&lt;/p&gt;
 */"/>
    <method name="public QSvgRenderer(com.trolltech.qt.core.QByteArray contents)" doc="/**
&lt;p&gt;Equivalent to &lt;a href=&quot;QSvgRenderer.html#QSvgRenderer(com.trolltech.qt.core.QByteArray, com.trolltech.qt.core.QObject)&quot;&gt;&lt;tt&gt;QSvgRenderer&lt;/tt&gt;&lt;/a&gt;(&lt;tt&gt;contents&lt;/tt&gt;, 0). */"/>
    <method name="public final boolean animated()" doc="/**
&lt;p&gt;Returns true if the current document contains animated elements; otherwise returns false.&lt;/p&gt;

@see &lt;a href=&quot;QSvgRenderer.html#framesPerSecond()&quot;&gt;&lt;tt&gt;framesPerSecond&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final int animationDuration()" doc="/**
&lt;p&gt;This method is used internally by Qt Jambi.
Do not use it in your applications.&lt;/p&gt;

@see &lt;a href=&quot;QSvgRenderer.html#animated()&quot;&gt;&lt;tt&gt;animated&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;QSvgRenderer.html#framesPerSecond()&quot;&gt;&lt;tt&gt;framesPerSecond&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final com.trolltech.qt.core.QRectF boundsOnElement(java.lang.String id)" doc="/**
&lt;p&gt;Returns bounding rectangle of the item with the given &lt;tt&gt;id&lt;/tt&gt;. The transformation matrix of parent elements is not affecting the bounds of the element.&lt;/p&gt;
 */"/>
    <method name="public final int currentFrame()" doc="/**
&lt;p&gt;Returns the current frame of the document's animation, or 0 if the document is not animated.&lt;/p&gt;

@see &lt;a href=&quot;QSvgRenderer.html#setCurrentFrame(int)&quot;&gt;&lt;tt&gt;setCurrentFrame&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;QSvgRenderer.html#animationDuration()&quot;&gt;&lt;tt&gt;animationDuration&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;QSvgRenderer.html#framesPerSecond()&quot;&gt;&lt;tt&gt;framesPerSecond&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;QSvgRenderer.html#animated()&quot;&gt;&lt;tt&gt;animated&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final com.trolltech.qt.core.QSize defaultSize()" doc="/**
&lt;p&gt;Returns the default size of the document contents.&lt;/p&gt;
 */"/>
    <method name="public final boolean elementExists(java.lang.String id)" doc="/**
&lt;p&gt;Returns true if the element with the given &lt;tt&gt;id&lt;/tt&gt; exists in the currently parsed SVG file and is a renderable element.&lt;/p&gt;
&lt;p&gt;Note: this method returns true only for elements that can be rendered. Which implies that elements that are considered part of the fill/stroke style properties, e.g&amp;#x2e; radialGradients even tough marked with &amp;quot;id&amp;quot; attributes will not be found by this method.&lt;/p&gt;
 */"/>
    <method name="public final int framesPerSecond()" doc="/**
&lt;p&gt;Returns the number of frames per second to be shown.&lt;/p&gt;
&lt;p&gt;The number of frames per second is 0 if the current document is not animated.&lt;/p&gt;

@see &lt;a href=&quot;QSvgRenderer.html#setFramesPerSecond(int)&quot;&gt;&lt;tt&gt;setFramesPerSecond&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;QSvgRenderer.html#animated()&quot;&gt;&lt;tt&gt;animated&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final boolean isValid()" doc="/**
&lt;p&gt;Returns true if there is a valid current document; otherwise returns false.&lt;/p&gt;
 */"/>
    <method name="public final boolean load(java.lang.String filename)" doc="/**
&lt;p&gt;Loads the SVG file specified by &lt;tt&gt;filename&lt;/tt&gt;, returning true if the content was successfully parsed; otherwise returns false.&lt;/p&gt;
 */"/>
    <method name="public final boolean load(com.trolltech.qt.core.QByteArray contents)" doc="/**
&lt;p&gt;Loads the specified SVG format &lt;tt&gt;contents&lt;/tt&gt;, returning true if the content was successfully parsed; otherwise returns false.&lt;/p&gt;
 */"/>
    <method name="public final com.trolltech.qt.gui.QMatrix matrixForElement(java.lang.String id)" doc="/**
&lt;p&gt;Returns the transformation matrix setup for the element with the given &lt;tt&gt;id&lt;/tt&gt;. That includes the transformation on the element itself.&lt;/p&gt;
 */"/>
    <method name="public final void render(com.trolltech.qt.gui.QPainter p, java.lang.String elementId, com.trolltech.qt.core.QRectF bounds)" doc="/**
&lt;p&gt;Renders the given element with &lt;tt&gt;elementId&lt;/tt&gt; using the given &lt;tt&gt;p&lt;/tt&gt; on the specified &lt;tt&gt;bounds&lt;/tt&gt;. If the bounding rectangle is not specified the SVG element is mapped to the whole paint device.&lt;/p&gt;
 */"/>
    <method name="public final void render(com.trolltech.qt.gui.QPainter p, java.lang.String elementId)" doc="/**
&lt;p&gt;Equivalent to &lt;a href=&quot;QSvgRenderer.html#render(com.trolltech.qt.gui.QPainter)&quot;&gt;render&lt;/tt&gt;&lt;/a&gt;(&lt;tt&gt;p&lt;/tt&gt;, &lt;tt&gt;elementId&lt;/tt&gt;, QRectF()). */"/>
    <method name="public final void render(com.trolltech.qt.gui.QPainter p, com.trolltech.qt.core.QRectF bounds)" doc="/**
&lt;p&gt;Renders the current document, or the current frame of an animated document, using the given &lt;tt&gt;p&lt;/tt&gt; on the specified &lt;tt&gt;bounds&lt;/tt&gt; within the painter. If the bounding rectangle is not specified the SVG file is mapped to the whole paint device.&lt;/p&gt;
 */"/>
    <method name="public final void render(com.trolltech.qt.gui.QPainter p)" doc="/**
&lt;p&gt;Renders the current document, or the current frame of an animated document, using the given &lt;tt&gt;p&lt;/tt&gt;.&lt;/p&gt;
 */"/>
    <method name="public final void setCurrentFrame(int arg__1)" doc="/**
&lt;p&gt;Sets the current frame of the document's animation, or 0 if the document is not animated to &lt;tt&gt;arg__1&lt;/tt&gt;.&lt;/p&gt;

@see &lt;a href=&quot;QSvgRenderer.html#currentFrame()&quot;&gt;&lt;tt&gt;currentFrame&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;QSvgRenderer.html#animationDuration()&quot;&gt;&lt;tt&gt;animationDuration&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;QSvgRenderer.html#framesPerSecond()&quot;&gt;&lt;tt&gt;framesPerSecond&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;QSvgRenderer.html#animated()&quot;&gt;&lt;tt&gt;animated&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final void setFramesPerSecond(int num)" doc="/**
&lt;p&gt;Sets the number of frames per second to be shown to &lt;tt&gt;num&lt;/tt&gt;.&lt;/p&gt;
&lt;p&gt;The number of frames per second is 0 if the current document is not animated.&lt;/p&gt;

@see &lt;a href=&quot;QSvgRenderer.html#framesPerSecond()&quot;&gt;&lt;tt&gt;framesPerSecond&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;QSvgRenderer.html#animated()&quot;&gt;&lt;tt&gt;animated&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final void setViewBox(com.trolltech.qt.core.QRect viewbox)" doc="/**
&lt;p&gt;Sets the rectangle specifying the visible area of the document in logical coordinates to &lt;tt&gt;viewbox&lt;/tt&gt;.&lt;/p&gt;
 */"/>
    <method name="public final void setViewBox(com.trolltech.qt.core.QRectF viewbox)" doc="/**
&lt;p&gt;Sets the rectangle specifying the visible area of the document in logical coordinates to &lt;tt&gt;viewbox&lt;/tt&gt;.&lt;/p&gt;

@see &lt;a href=&quot;QSvgRenderer.html#viewBox()&quot;&gt;&lt;tt&gt;viewBox&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final com.trolltech.qt.core.QRect viewBox()" doc="/**
&lt;p&gt;Returns &lt;a href=&quot;QSvgRenderer.html#viewBoxF()&quot;&gt;&lt;tt&gt;viewBoxF&lt;/tt&gt;&lt;/a&gt;.toRect().&lt;/p&gt;

@see &lt;a href=&quot;QSvgRenderer.html#setViewBox(com.trolltech.qt.core.QRectF)&quot;&gt;&lt;tt&gt;setViewBox&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;QSvgRenderer.html#viewBoxF()&quot;&gt;&lt;tt&gt;viewBoxF&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final com.trolltech.qt.core.QRectF viewBoxF()" doc="/**
&lt;p&gt;Returns the rectangle specifying the visible area of the document in logical coordinates.&lt;/p&gt;
 */"/>
</class>