QXpmHandler Class Reference

#include <qxpmhandler_p.h>

Inheritance diagram for QXpmHandler:

Public Functions
bool	canRead () const
	Returns true if an image can be read from the device (i. More...
QByteArray	name () const
	Use format() instead. More...
QVariant	option (ImageOption option) const
	Returns the value assigned to option as a QVariant. More...
	QXpmHandler ()
bool	read (QImage *image)
	Read an image from the device, and stores it in image. More...
void	setOption (ImageOption option, const QVariant &value)
	Sets the option option with the value value. More...
bool	supportsOption (ImageOption option) const
	Returns true if the QImageIOHandler supports the option option; otherwise returns false. More...
bool	write (const QImage &image)
	Writes the image image to the assigned device. More...
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	~QImageIOHandler ()
	Destructs the QImageIOHandler object. More...

Static Public Functions
static bool	canRead (QIODevice *device)

Private Types
enum	State { Ready, ReadHeader, Error }

Private Functions
bool	readHeader ()
bool	readImage (QImage *image)

Properties
QByteArray	buffer
int	cpp
QString	fileName
int	height
int	index
int	ncols
State	state
int	width

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 62 of file qxpmhandler_p.h.

Enumerations

State

enum QXpmHandler::State

private

Enumerator
Ready
ReadHeader
Error

Definition at line 81 of file qxpmhandler_p.h.

               {
        Ready,
        ReadHeader,
        Error
    };

Constructors and Destructors

QXpmHandler()

QXpmHandler::QXpmHandler

(

)

Definition at line 1175 of file qxpmhandler.cpp.

    : state(Ready), index(0)
{
}

Functions

canRead() [1/2]

bool QXpmHandler::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 1208 of file qxpmhandler.cpp.

Referenced by createReadHandlerHelper(), and read().

{
    if (state == Ready && !canRead(device()))
        return false;

    if (state != Error) {
        setFormat("xpm");
        return true;
    }

    return false;
}

canRead() [2/2]

bool QXpmHandler::canRead ( QIODevice *  device )

static

Definition at line 1221 of file qxpmhandler.cpp.

{
    if (!device) {
        qWarning("QXpmHandler::canRead() called with no device");
        return false;
    }

    char head[6];
    if (device->peek(head, sizeof(head)) != sizeof(head))
        return false;

    return qstrncmp(head, "/* XPM", 6) == 0;
}

name()

QByteArray QXpmHandler::name ( ) const

virtual

Use format() instead.

Reimplemented from QImageIOHandler.

Definition at line 1288 of file qxpmhandler.cpp.

{
    return "xpm";
}

option()

QVariant QXpmHandler::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 1254 of file qxpmhandler.cpp.

{
    if (option == Name) {
        return fileName;
    } else if (option == Size) {
        if (state == Error)
            return QVariant();
        if (state == Ready && !const_cast<QXpmHandler*>(this)->readHeader())
            return QVariant();
        return QSize(width, height);
    } else if (option == ImageFormat) {
        if (state == Error)
            return QVariant();
        if (state == Ready && !const_cast<QXpmHandler*>(this)->readHeader())
            return QVariant();
        // If we have more than 256 colors in the table, we need to
        // figure out, if it contains transparency. That means reading
        // the whole color table, which is too much work work pre-checking
        // the image format
        if (ncols <= 256)
            return QImage::Format_Indexed8;
        else
            return QImage::Format_Invalid;
    }

    return QVariant();
}

read()

bool QXpmHandler::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 1235 of file qxpmhandler.cpp.

{
    if (!canRead())
        return false;
    return readImage(image);
}

readHeader()

bool QXpmHandler::readHeader ( )

private

Definition at line 1180 of file qxpmhandler.cpp.

Referenced by option(), and readImage().

{
    state = Error;
    if (!read_xpm_header(device(), 0, index, buffer, &cpp, &ncols, &width, &height))
        return false;
    state = ReadHeader;
    return true;
}

readImage()

bool QXpmHandler::readImage ( QImage *  image )

private

Definition at line 1189 of file qxpmhandler.cpp.

Referenced by read().

{
    if (state == Error)
        return false;

    if (state == Ready && !readHeader()) {
        state = Error;
        return false;
    }

    if (!read_xpm_body(device(), 0, index, buffer, cpp, ncols, width, height, *image)) {
        state = Error;
        return false;
    }

    state = Ready;
    return true;
}

setOption()

void QXpmHandler::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 1282 of file qxpmhandler.cpp.

{
    if (option == Name)
        fileName = value.toString();
}

supportsOption()

bool QXpmHandler::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 1247 of file qxpmhandler.cpp.

{
    return option == Name
        || option == Size
        || option == ImageFormat;
}

write()

bool QXpmHandler::write ( const QImage &  image )

virtual

Writes the image image to the assigned device.

Returns true on success; otherwise returns false.

The default implementation does nothing, and simply returns false.

Reimplemented from QImageIOHandler.

Definition at line 1242 of file qxpmhandler.cpp.

{
    return write_xpm_image(image, device(), fileName);
}

Properties

buffer

QByteArray QXpmHandler::buffer

private

Definition at line 91 of file qxpmhandler_p.h.

Referenced by readHeader(), and readImage().

cpp

int QXpmHandler::cpp

private

Definition at line 90 of file qxpmhandler_p.h.

Referenced by readHeader(), and readImage().

fileName

QString QXpmHandler::fileName

private

Definition at line 93 of file qxpmhandler_p.h.

Referenced by option(), setOption(), and write().

height

int QXpmHandler::height

private

Definition at line 88 of file qxpmhandler_p.h.

Referenced by option(), readHeader(), and readImage().

index

int QXpmHandler::index

private

Definition at line 92 of file qxpmhandler_p.h.

Referenced by readHeader(), and readImage().

ncols

int QXpmHandler::ncols

private

Definition at line 89 of file qxpmhandler_p.h.

Referenced by option(), readHeader(), and readImage().

state

State QXpmHandler::state

private

Definition at line 86 of file qxpmhandler_p.h.

Referenced by canRead(), option(), readHeader(), and readImage().

width

int QXpmHandler::width

private

Definition at line 87 of file qxpmhandler_p.h.

Referenced by option(), readHeader(), and readImage().

---

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

• /src/gui/image/qxpmhandler_p.h
• /src/gui/image/qxpmhandler.cpp