TQImageConsumer Class

Home | All Classes | Main Classes | Annotated | Grouped Classes | Functions |

# TQImageConsumer Class Reference

The TQImageConsumer class is an abstraction used by TQImageDecoder. More...

`#include <tqasyncimageio.h>`

List of all member functions.

## Public Members

- virtual void end () = 0
- virtual void changed ( const TQRect & ) = 0
- virtual void frameDone () = 0
- virtual void frameDone ( const TQPoint & offset, const TQRect & rect ) = 0
- virtual void setLooping ( int n ) = 0
- virtual void setFramePeriod ( int milliseconds ) = 0
- virtual void setSize ( int, int ) = 0

## Detailed Description

The TQImageConsumer class is an abstraction used by TQImageDecoder.

The TQMovie class, or TQLabel::setMovie(), are easy to use and for most situations do what you want with regards animated images.

A TQImageConsumer consumes information about changes to the TQImage maintained by a TQImageDecoder. Think of the TQImage as the model or source of the image data, with the TQImageConsumer as a view of that data and the TQImageDecoder being the controller that orchestrates the relationship between the model and the view.

You'd use the TQImageConsumer class, for example, if you were implementing a web browser with your own image loaders.

See also TQImageDecoder, Graphics Classes, Image Processing Classes, and Multimedia Classes.

## Member Function Documentation

### void TQImageConsumer::changed ( const TQRect & )`[pure virtual]`

Called when the given area of the image has changed.

### void TQImageConsumer::end ()`[pure virtual]`

Called when all the data from all the frames has been decoded and revealed as changed().

### void TQImageConsumer::frameDone ()`[pure virtual]`

One of the two frameDone() functions will be called when a frame of an animated image has ended and been revealed as changed().

When this function is called, the current image should be displayed.

The decoder will not make any further changes to the image until the next call to TQImageFormat::decode().

### void TQImageConsumer::frameDone ( const TQPoint & offset, const TQRect & rect )`[pure virtual]`

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

One of the two frameDone() functions will be called when a frame of an animated image has ended and been revealed as changed().

When this function is called, the area rect in the current image should be moved by offset and displayed.

The decoder will not make any further changes to the image until the next call to TQImageFormat::decode().

### void TQImageConsumer::setFramePeriod ( int milliseconds )`[pure virtual]`

Notes that the frame about to be decoded should not be displayed until the given number of milliseconds after the time that this function is called. Of course, the image may not have been decoded by then, in which case the frame should not be displayed until it is complete. A value of -1 (the assumed default) indicates that the image should be displayed even while it is only partially loaded.

### void TQImageConsumer::setLooping ( int n )`[pure virtual]`

Called to indicate that the sequence of frames in the image should be repeated n times, including the sequence during decoding.

- 0 = Forever
- 1 = Only display frames the first time through
- 2 = Repeat once after first pass through images
- etc.

To make the TQImageDecoder do this, just delete it and pass the information to it again for decoding (setLooping() will be called again, of course, but that can be ignored), or keep copies of the changed areas at the ends of frames.

### void TQImageConsumer::setSize ( int, int )`[pure virtual]`

This function is called as soon as the size of the image has been determined.

This file is part of the TQt toolkit. Copyright © 1995-2007 Trolltech. All Rights Reserved.