.TH "Bitmap::const_iterator" 3 "Mon Jan 12 2015" "Version dvi2bitmap1.0" "dvi2bitmap" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Bitmap::const_iterator \- 
.PP
Iterator class\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <Bitmap\&.h>\fP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBByte\fP * \fBoperator*\fP ()  throw (DviError)"
.br
.RI "\fIReturns the current member of the set of rows returned by the iterator\&. \fP"
.ti -1c
.RI "\fBconst_iterator\fP & \fBoperator++\fP ()  throw (DviError)"
.br
.RI "\fIIncrements the iterator\&. \fP"
.ti -1c
.RI "bool \fBoperator==\fP (const \fBconst_iterator\fP &it) const "
.br
.ti -1c
.RI "bool \fBoperator!=\fP (const \fBconst_iterator\fP &it) const "
.br
.ti -1c
.RI "\fB~const_iterator\fP ()"
.br
.in -1c
.SS "Friends"

.in +1c
.ti -1c
.RI "class \fBBitmap\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
Iterator class\&. 
.SH "Constructor & Destructor Documentation"
.PP 
.SS "Bitmap::const_iterator::~const_iterator ()"

.SH "Member Function Documentation"
.PP 
.SS "bool Bitmap::const_iterator::operator!= (const \fBconst_iterator\fP &it) const"

.SS "\fBByte\fP * Bitmap::const_iterator::operator* ()\fBDviError\fP"

.PP
Returns the current member of the set of rows returned by the iterator\&. This returns a pointer to an array of \fCByte\fP, with elements \fC[0\&.\&.W-1]\fP being guaranteed to be valid, where \fCW\fP is the width of the bitmap\&. If the bitmap is uncropped, this is the total width of the bitmap as returned by method \fBgetWidth\fP; if cropped, the width is the difference of the [2] and [0] elements of the array returned by \fBboundingBox\fP\&.
.PP
\fBReturns:\fP
.RS 4
pointer to an array of \fCByte\fP 
.RE
.PP
\fBExceptions:\fP
.RS 4
\fI\fBDviError\fP\fP if the iterator is dereferenced after it has come to the end 
.RE
.PP

.SS "\fBBitmap::const_iterator\fP & Bitmap::const_iterator::operator++ ()\fBDviError\fP"

.PP
Increments the iterator\&. If the bitmap is uncropped, all the rows in the bitmap will eventually be iterator over, namely the number of rows returned by method \fBgetHeight\fP; if it is cropped, the number of rows returned will be the difference between the [3] and [1] elements of the \fBboundingBox\fP array\&.
.PP
\fBReturns:\fP
.RS 4
the iterator 
.RE
.PP
\fBExceptions:\fP
.RS 4
\fI\fBDviError\fP\fP if the iterator is incremented after it has come to the end 
.RE
.PP

.SS "bool Bitmap::const_iterator::operator== (const \fBconst_iterator\fP &it) const"

.SH "Friends And Related Function Documentation"
.PP 
.SS "friend class \fBBitmap\fP\fC [friend]\fP"


.SH "Author"
.PP 
Generated automatically by Doxygen for dvi2bitmap from the source code\&.