QSvgIOHandler Class Reference

#include <qsvgiohandler.h>

Inheritance diagram for QSvgIOHandler:

Public Functions
virtual bool	canRead () const
	Returns true if an image can be read from the device (i. More...
virtual QByteArray	name () const
	Use format() instead. More...
virtual QVariant	option (ImageOption option) const
	Returns the value assigned to option as a QVariant. More...
	QSvgIOHandler ()
virtual bool	read (QImage *image)
	Read an image from the device, and stores it in image. More...
virtual void	setOption (ImageOption option, const QVariant &value)
	Sets the option option with the value value. More...
virtual bool	supportsOption (ImageOption option) const
	Returns true if the QImageIOHandler supports the option option; otherwise returns false. More...
	~QSvgIOHandler ()
Public Functions inherited from QImageIOHandler
virtual int	currentImageNumber () const
	For image formats that support animation, this function returns the sequence number of the current image in the animation. More...
virtual QRect	currentImageRect () const
	Returns the rect of the current image. More...
QIODevice *	device () const
	Returns the device currently assigned to the QImageIOHandler. More...
QByteArray	format () const
	Returns the format that is currently assigned to QImageIOHandler. More...
virtual int	imageCount () const
	For image formats that support animation, this function returns the number of images in the animation. More...
virtual bool	jumpToImage (int imageNumber)
	For image formats that support animation, this function jumps to the image whose sequence number is imageNumber. More...
virtual bool	jumpToNextImage ()
	For image formats that support animation, this function jumps to the next image. More...
virtual int	loopCount () const
	For image formats that support animation, this function returns the number of times the animation should loop. More...
virtual int	nextImageDelay () const
	For image formats that support animation, this function returns the number of milliseconds to wait until reading the next image. More...
	QImageIOHandler ()
	Constructs a QImageIOHandler object. More...
void	setDevice (QIODevice *device)
	Sets the device of the QImageIOHandler to device. More...
void	setFormat (const QByteArray &format)
	Sets the format of the QImageIOHandler to format. More...
void	setFormat (const QByteArray &format) const
	Sets the format of the QImageIOHandler to format. More...
virtual bool	write (const QImage &image)
	Writes the image image to the assigned device. More...
virtual	~QImageIOHandler ()
	Destructs the QImageIOHandler object. More...

Static Public Functions
static bool	canRead (QIODevice *device)

Properties
QSvgIOHandlerPrivate *	d

Additional Inherited Members
Public Types inherited from QImageIOHandler
enum	ImageOption {   Size, ClipRect, Description, ScaledClipRect,   ScaledSize, CompressionRatio, Gamma, Quality,   Name, SubType, IncrementalReading, Endianness,   Animation, BackgroundColor, ImageFormat }
	This enum describes the different options supported by QImageIOHandler. More...
Protected Functions inherited from QImageIOHandler
	QImageIOHandler (QImageIOHandlerPrivate &dd)
	Constructs a QImageIOHandler object, using the private member dd. More...
Protected Variables inherited from QImageIOHandler
QScopedPointer< QImageIOHandlerPrivate >	d_ptr

Detailed Description

Definition at line 57 of file qsvgiohandler.h.

Constructors and Destructors

QSvgIOHandler()

QSvgIOHandler::QSvgIOHandler

(

)

Definition at line 109 of file qsvgiohandler.cpp.

    : d(new QSvgIOHandlerPrivate(this))
{

}

~QSvgIOHandler()

QSvgIOHandler::~QSvgIOHandler

(

)

Definition at line 116 of file qsvgiohandler.cpp.

{
    delete d;
}

Functions

canRead() [1/2]

bool QSvgIOHandler::canRead ( ) const

virtual

Returns true if an image can be read from the device (i.

e., the image format is supported, the device can be read from and the initial header information suggests that the image can be read); otherwise returns false.

When reimplementing canRead(), make sure that the I/O device (device()) is left in its original state (e.g., by using peek() rather than read()).

See also

read(), QIODevice::peek()

Implements QImageIOHandler.

Definition at line 122 of file qsvgiohandler.cpp.

Referenced by QSvgPlugin::capabilities(), and QSvgIOHandlerPrivate::load().

{
    if (!device())
        return false;
    if (d->loaded && !d->readDone)
        return true;        // Will happen if we have been asked for the size

    QByteArray buf = device()->peek(8);
    if (buf.startsWith("\x1f\x8b")) {
        setFormat("svgz");
        return true;
    } else if (buf.contains("<?xml") || buf.contains("<svg")) {
        setFormat("svg");
        return true;
    }
    return false;
}

canRead() [2/2]

bool QSvgIOHandler::canRead ( QIODevice *  device )

static

Definition at line 259 of file qsvgiohandler.cpp.

{
    QByteArray buf = device->peek(8);
    return buf.startsWith("\x1f\x8b") || buf.contains("<?xml") || buf.contains("<svg");
}

name()

QByteArray QSvgIOHandler::name ( ) const

virtual

Use format() instead.

Reimplemented from QImageIOHandler.

Definition at line 141 of file qsvgiohandler.cpp.

{
    return "svg";
}

option()

QVariant QSvgIOHandler::option ( ImageOption  option ) const

virtual

Returns the value assigned to option as a QVariant.

The type of the value depends on the option. For example, option(Size) returns a QSize variant.

See also

setOption(), supportsOption()

Reimplemented from QImageIOHandler.

Definition at line 191 of file qsvgiohandler.cpp.

{
    switch(option) {
    case ImageFormat:
        return QImage::Format_ARGB32_Premultiplied;
        break;
    case Size:
        d->load(device());
        return d->defaultSize;
        break;
    case ClipRect:
        return d->clipRect;
        break;
    case ScaledSize:
        return d->scaledSize;
        break;
    case ScaledClipRect:
        return d->scaledClipRect;
        break;
    case BackgroundColor:
        return d->backColor;
        break;
    default:
        break;
    }
    return QVariant();
}

read()

bool QSvgIOHandler::read ( QImage *  image )

virtual

Read an image from the device, and stores it in image.

Returns true if the image is successfully read; otherwise returns false.

For image formats that support incremental loading, and for animation formats, the image handler can assume that image points to the previous frame.

See also

canRead()

Implements QImageIOHandler.

Definition at line 147 of file qsvgiohandler.cpp.

{
    if (!d->readDone && d->load(device())) {
        bool xform = (d->clipRect.isValid() || d->scaledSize.isValid() || d->scaledClipRect.isValid());
        QSize finalSize = d->defaultSize;
        QRectF bounds;
        if (xform && !d->defaultSize.isEmpty()) {
            bounds = QRectF(QPointF(0,0), QSizeF(d->defaultSize));
            QPoint tr1, tr2;
            QSizeF sc(1, 1);
            if (d->clipRect.isValid()) {
                tr1 = -d->clipRect.topLeft();
                finalSize = d->clipRect.size();
            }
            if (d->scaledSize.isValid()) {
                sc = QSizeF(qreal(d->scaledSize.width()) / finalSize.width(),
                            qreal(d->scaledSize.height()) / finalSize.height());
                finalSize = d->scaledSize;
            }
            if (d->scaledClipRect.isValid()) {
                tr2 = -d->scaledClipRect.topLeft();
                finalSize = d->scaledClipRect.size();
            }
            QTransform t;
            t.translate(tr2.x(), tr2.y());
            t.scale(sc.width(), sc.height());
            t.translate(tr1.x(), tr1.y());
            bounds = t.mapRect(bounds);
        }
        *image = QImage(finalSize, QImage::Format_ARGB32_Premultiplied);
        if (!finalSize.isEmpty()) {
            image->fill(d->backColor.rgba());
            QPainter p(image);
            d->r.render(&p, bounds);
            p.end();
        }
        d->readDone = true;
        return true;
    }

    return false;
}

setOption()

void QSvgIOHandler::setOption ( ImageOption  option, const QVariant &  value  )

virtual

Sets the option option with the value value.

See also

option(), ImageOption

Reimplemented from QImageIOHandler.

Definition at line 220 of file qsvgiohandler.cpp.

{
    switch(option) {
    case ClipRect:
        d->clipRect = value.toRect();
        break;
    case ScaledSize:
        d->scaledSize = value.toSize();
        break;
    case ScaledClipRect:
        d->scaledClipRect = value.toRect();
        break;
    case BackgroundColor:
        d->backColor = value.value<QColor>();
        break;
    default:
        break;
    }
}

supportsOption()

bool QSvgIOHandler::supportsOption ( ImageOption  option ) const

virtual

Returns true if the QImageIOHandler supports the option option; otherwise returns false.

For example, if the QImageIOHandler supports the Size option, supportsOption(Size) must return true.

See also

setOption(), option()

Reimplemented from QImageIOHandler.

Definition at line 241 of file qsvgiohandler.cpp.

{
    switch(option)
    {
    case ImageFormat:
    case Size:
    case ClipRect:
    case ScaledSize:
    case ScaledClipRect:
    case BackgroundColor:
        return true;
    default:
        break;
    }
    return false;
}

Properties

d

QSvgIOHandlerPrivate* QSvgIOHandler::d

private

Definition at line 71 of file qsvgiohandler.h.

Referenced by canRead(), option(), read(), setOption(), and ~QSvgIOHandler().

---

The documentation for this class was generated from the following files:

• /src/plugins/imageformats/svg/qsvgiohandler.h
• /src/plugins/imageformats/svg/qsvgiohandler.cpp