Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QWbmpHandler Class Reference

The QWbmpHandler class provides support for the WBMP image format. More...

#include <qwbmphandler_p.h>

Inheritance diagram for QWbmpHandler:
Collaboration diagram for QWbmpHandler:

Public Member Functions

 QWbmpHandler (QIODevice *device)
 Constructs an instance of QWbmpHandler initialized to use device.
 ~QWbmpHandler ()
 Destructor for QWbmpHandler.
bool canRead () const override
 Verifies if some values (magic bytes) are set as expected in the header of the file.
bool read (QImage *image) override
 \reimp
bool write (const QImage &image) override
 \reimp
QVariant option (ImageOption option) const override
 Only Size option is supported.
bool supportsOption (ImageOption option) const override
 Returns true if the QImageIOHandler supports the option option; otherwise returns false.
Public Member Functions inherited from QImageIOHandler
 QImageIOHandler ()
 Constructs a QImageIOHandler object.
virtual ~QImageIOHandler ()
 Destructs the QImageIOHandler object.
void setDevice (QIODevice *device)
 Sets the device of the QImageIOHandler to device.
QIODevice * device () const
 Returns the device currently assigned to the QImageIOHandler.
void setFormat (const QByteArray &format)
 Sets the format of the QImageIOHandler to format.
void setFormat (const QByteArray &format) const
 Sets the format of the QImageIOHandler to format.
QByteArray format () const
 Returns the format that is currently assigned to QImageIOHandler.
virtual void setOption (ImageOption option, const QVariant &value)
 Sets the option option with the value value.
virtual bool jumpToNextImage ()
 For image formats that support animation, this function jumps to the next image.
virtual bool jumpToImage (int imageNumber)
 For image formats that support animation, this function jumps to the image whose sequence number is imageNumber.
virtual int loopCount () const
 For image formats that support animation, this function returns the number of times the animation should loop.
virtual int imageCount () const
 For image formats that support animation, this function returns the number of images in the animation.
virtual int nextImageDelay () const
 For image formats that support animation, this function returns the number of milliseconds to wait until reading the next image.
virtual int currentImageNumber () const
 For image formats that support animation, this function returns the sequence number of the current image in the animation.
virtual QRect currentImageRect () const
 Returns the rect of the current image.

Static Public Member Functions

static bool canRead (QIODevice *device)
Static Public Member Functions inherited from QImageIOHandler
static bool allocateImage (QSize size, QImage::Format format, QImage *image)

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 , SupportedSubTypes ,
  OptimizedWrite , ProgressiveScanWrite , ImageTransformation
}
 This enum describes the different options supported by QImageIOHandler. More...
enum  Transformation {
  TransformationNone = 0 , TransformationMirror = 1 , TransformationFlip = 2 , TransformationRotate180 = TransformationMirror | TransformationFlip ,
  TransformationRotate90 = 4 , TransformationMirrorAndRotate90 = TransformationMirror | TransformationRotate90 , TransformationFlipAndRotate90 = TransformationFlip | TransformationRotate90 , TransformationRotate270 = TransformationRotate180 | TransformationRotate90
}
Protected Member Functions inherited from QImageIOHandler
 QImageIOHandler (QImageIOHandlerPrivate &dd)
Protected Attributes inherited from QImageIOHandler
QScopedPointer< QImageIOHandlerPrivate > d_ptr

Detailed Description

The QWbmpHandler class provides support for the WBMP image format.

Since
5.0

Definition at line 24 of file qwbmphandler_p.h.

Constructor & Destructor Documentation

◆ QWbmpHandler()

QWbmpHandler::QWbmpHandler ( QIODevice * device)

Constructs an instance of QWbmpHandler initialized to use device.

Definition at line 228 of file qwbmphandler.cpp.

◆ ~QWbmpHandler()

QWbmpHandler::~QWbmpHandler ( )

Destructor for QWbmpHandler.

Definition at line 236 of file qwbmphandler.cpp.

Member Function Documentation

◆ canRead() [1/2]

bool QWbmpHandler::canRead ( ) const
overridevirtual

Verifies if some values (magic bytes) are set as expected in the header of the file.

If the magic bytes were found, it is assumed that the QWbmpHandler can read the file.

Implements QImageIOHandler.

Definition at line 245 of file qwbmphandler.cpp.

References canRead().

Referenced by canRead().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ canRead() [2/2]

bool QWbmpHandler::canRead ( QIODevice * device)
static

Definition at line 321 of file qwbmphandler.cpp.

References WBMPReader::canRead().

Here is the call graph for this function:

◆ option()

QVariant QWbmpHandler::option ( ImageOption option) const
overridevirtual

Only Size option is supported.

Reimplemented from QImageIOHandler.

Definition at line 290 of file qwbmphandler.cpp.

References readWBMPHeader().

Here is the call graph for this function:

◆ read()

bool QWbmpHandler::read ( QImage * image)
overridevirtual

\reimp

Implements QImageIOHandler.

Definition at line 264 of file qwbmphandler.cpp.

◆ supportsOption()

bool QWbmpHandler::supportsOption ( ImageOption option) const
overridevirtual

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

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

See also
setOption(), option()

Reimplemented from QImageIOHandler.

Definition at line 315 of file qwbmphandler.cpp.

◆ write()

bool QWbmpHandler::write ( const QImage & image)
overridevirtual

\reimp

Reimplemented from QImageIOHandler.

Definition at line 279 of file qwbmphandler.cpp.

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