View::SubImageIterator Class Reference

This class accesses portions of a view image. More...

#include <View.h>

List of all members.

Public Member Functions
virtual	~SubImageIterator ()
virtual bool	hasNext () const =0
virtual bool	next (QImage &image)=0
virtual void	location (int &x, int &y) const =0
virtual void	count (int &x, int &y) const =0

---

Detailed Description

This class accesses portions of a view image.

If you need to grab a "screen shot" of an image which is larger than the physical display dimensions, this class can be used to access tiled sub-images.

Definition at line 860 of file View.h.

---

Constructor & Destructor Documentation

virtual View::SubImageIterator::~SubImageIterator

(

)

[virtual]

Destructor.

It is safe to delete a SubImageIterator. Ownership semantics are described in functions which return a SubImageIterator. Typically, the caller owns the SubImageIterator and must delete it when finished.

See also:

View::getSubImageIterator()

Definition at line 873 of file View.h.

---

Member Function Documentation

virtual bool View::SubImageIterator::hasNext

(

)

const [pure virtual]

Is there another sub-image? This should be checked before calling next().

Returns:

True if there is another sub-image, false otherwise.

virtual bool View::SubImageIterator::next

(

QImage &

image

)

[pure virtual]

Get the next sub-image.

This will initialize the image to the size and encoding specified when the SubImageIterator was created.

Parameters:

image

This will hold the resultant image. If this is an invalid QImage, it will be initialized by this method. Alternately, a QImage which was initialized by a previous call to next() may be passed. This prevents re-initialization of the QImage which is more efficient.

Returns:

True if the image was successfully returned. False if an error occurred. If there are no tiles left (the iterator is at the end), false will be returned. If false is returned the state of image is undefined.

virtual void View::SubImageIterator::location	(	int &	x,
		int &	y
	)			const [pure virtual]

Access the location of the current sub-image.

This should be called after next(). It will return the sub-image location of the image returned by next().

Parameters:

	x	The zero indexed x-access index of the sub-image.
	y	The zero indexed y-access index of the sub-image.

virtual void View::SubImageIterator::count	(	int &	x,
		int &	y
	)			const [pure virtual]

Access the total number of sub-images.

Parameters:

	x	The number of horizontal sub-images.
	y	The number of vertical sub-images.