.TH "BitmapImage" 3 "Mon Jan 12 2015" "Version dvi2bitmap1.0" "dvi2bitmap" \" -*- nroff -*-
.ad l
.nh
.SH NAME
BitmapImage \- 
.PP
The superclass of the various bitmap formats\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <BitmapImage\&.h>\fP
.PP
Inherited by \fBGIFBitmap\fP, \fBPNGBitmap\fP, \fBXBMBitmap\fP, and \fBXPMBitmap\fP\&.
.SS "Public Types"

.in +1c
.ti -1c
.RI "enum \fBinfoFields\fP { \fBSOFTWAREVERSION\fP, \fBINPUTFILENAME\fP, \fBFURTHERINFO\fP }"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBBitmapImage\fP (const int w, const int h, const int bpp=1)"
.br
.ti -1c
.RI "virtual \fB~BitmapImage\fP ()"
.br
.ti -1c
.RI "void \fBsetBitmap\fP (const \fBByte\fP *B)"
.br
.ti -1c
.RI "void \fBsetBitmapRow\fP (const \fBByte\fP *B)"
.br
.ti -1c
.RI "void \fBsetTransparent\fP (const bool sw)"
.br
.ti -1c
.RI "void \fBsetRGB\fP (const bool fg, const \fBBitmap::BitmapColour\fP *rgb)"
.br
.ti -1c
.RI "virtual void \fBwrite\fP (const string filename)=0"
.br
.ti -1c
.RI "virtual string \fBfileExtension\fP () const =0"
.br
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "static void \fBsetInfo\fP (const \fBinfoFields\fP which, const string *s)"
.br
.ti -1c
.RI "static \fBBitmapImage\fP * \fBnewBitmapImage\fP (const string format, const int w, const int h, const int bpp=1)"
.br
.ti -1c
.RI "static bool \fBsupportedBitmapImage\fP (const string format)"
.br
.ti -1c
.RI "static const char * \fBfirstBitmapImageFormat\fP ()"
.br
.ti -1c
.RI "static const char * \fBnextBitmapImageFormat\fP ()"
.br
.ti -1c
.RI "static void \fBverbosity\fP (const \fBverbosities\fP level)"
.br
.in -1c
.SS "Protected Attributes"

.in +1c
.ti -1c
.RI "int \fBw_\fP"
.br
.ti -1c
.RI "int \fBh_\fP"
.br
.ti -1c
.RI "const int \fBbpp_\fP"
.br
.ti -1c
.RI "const \fBByte\fP * \fBbitmap_\fP"
.br
.ti -1c
.RI "\fBByte\fP * \fBallocBitmap_\fP"
.br
.ti -1c
.RI "bool \fBmyBitmap_\fP"
.br
.ti -1c
.RI "int \fBbitmapRows_\fP"
.br
.ti -1c
.RI "bool \fBisTransparent_\fP"
.br
.ti -1c
.RI "\fBBitmap::BitmapColour\fP \fBfg_\fP"
.br
.ti -1c
.RI "\fBBitmap::BitmapColour\fP \fBbg_\fP"
.br
.in -1c
.SS "Static Protected Attributes"

.in +1c
.ti -1c
.RI "static const string * \fBsoftwareversion\fP = 0"
.br
.ti -1c
.RI "static const string * \fBinputfilename\fP = 0"
.br
.ti -1c
.RI "static const string * \fBfurtherinfo\fP = 0"
.br
.ti -1c
.RI "static const char * \fBformats\fP []"
.br
.ti -1c
.RI "static const int \fBnformats\fP = sizeof(\fBformats\fP)/sizeof(\fBformats\fP[0])"
.br
.ti -1c
.RI "static int \fBiterator_index\fP = 0"
.br
.ti -1c
.RI "static \fBverbosities\fP \fBverbosity_\fP = \fBnormal\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
The superclass of the various bitmap formats\&. 
.SH "Member Enumeration Documentation"
.PP 
.SS "enum \fBBitmapImage::infoFields\fP"

.PP
\fBEnumerator\fP
.in +1c
.TP
\fB\fISOFTWAREVERSION \fP\fP
.TP
\fB\fIINPUTFILENAME \fP\fP
.TP
\fB\fIFURTHERINFO \fP\fP
.SH "Constructor & Destructor Documentation"
.PP 
.SS "BitmapImage::BitmapImage (const intw, const inth, const intbpp = \fC1\fP)"

.PP
References bg_, Bitmap::BitmapColour_s::blue, fg_, Bitmap::BitmapColour_s::green, and Bitmap::BitmapColour_s::red\&.
.SS "BitmapImage::~BitmapImage ()\fC [virtual]\fP"

.PP
References allocBitmap_, and myBitmap_\&.
.SH "Member Function Documentation"
.PP 
.SS "virtual string BitmapImage::fileExtension () const\fC [pure virtual]\fP"

.PP
Implemented in \fBGIFBitmap\fP, \fBPNGBitmap\fP, \fBXPMBitmap\fP, and \fBXBMBitmap\fP\&.
.PP
Referenced by Bitmap::write()\&.
.SS "const char * BitmapImage::firstBitmapImageFormat ()\fC [static]\fP"

.PP
References formats, and iterator_index\&.
.PP
Referenced by main(), and Bitmap::write()\&.
.SS "\fBBitmapImage\fP * BitmapImage::newBitmapImage (const stringformat, const intw, const inth, const intbpp = \fC1\fP)\fC [static]\fP"

.PP
Referenced by Bitmap::write()\&.
.SS "const char * BitmapImage::nextBitmapImageFormat ()\fC [static]\fP"

.PP
References formats, iterator_index, and nformats\&.
.PP
Referenced by main()\&.
.SS "void BitmapImage::setBitmap (const \fBByte\fP *B)"

.PP
References bitmap_, bitmapRows_, and h_\&.
.PP
Referenced by Bitmap::write()\&.
.SS "void BitmapImage::setBitmapRow (const \fBByte\fP *B)"

.PP
References allocBitmap_, bitmap_, bitmapRows_, h_, myBitmap_, and w_\&.
.PP
Referenced by Bitmap::write()\&.
.SS "void BitmapImage::setInfo (const \fBinfoFields\fPwhich, const string *s)\fC [static]\fP"

.PP
References FURTHERINFO, furtherinfo, INPUTFILENAME, inputfilename, SOFTWAREVERSION, and softwareversion\&.
.PP
Referenced by main()\&.
.SS "void BitmapImage::setRGB (const boolfg, const \fBBitmap::BitmapColour\fP *rgb)\fC [inline]\fP"

.PP
References bg_, Bitmap::BitmapColour_s::blue, fg_, Bitmap::BitmapColour_s::green, and Bitmap::BitmapColour_s::red\&.
.PP
Referenced by Bitmap::write()\&.
.SS "void BitmapImage::setTransparent (const boolsw)\fC [inline]\fP"

.PP
References isTransparent_\&.
.PP
Referenced by Bitmap::write()\&.
.SS "bool BitmapImage::supportedBitmapImage (const stringformat)\fC [static]\fP"

.PP
References formats, and nformats\&.
.PP
Referenced by main()\&.
.SS "static void BitmapImage::verbosity (const \fBverbosities\fPlevel)\fC [inline]\fP, \fC [static]\fP"

.PP
References verbosity_\&.
.PP
Referenced by main()\&.
.SS "virtual void BitmapImage::write (const stringfilename)\fC [pure virtual]\fP"

.PP
Implemented in \fBGIFBitmap\fP, \fBPNGBitmap\fP, \fBXPMBitmap\fP, and \fBXBMBitmap\fP\&.
.PP
Referenced by Bitmap::write()\&.
.SH "Member Data Documentation"
.PP 
.SS "\fBByte\fP* BitmapImage::allocBitmap_\fC [protected]\fP"

.PP
Referenced by setBitmapRow(), and ~BitmapImage()\&.
.SS "\fBBitmap::BitmapColour\fP BitmapImage::bg_\fC [protected]\fP"

.PP
Referenced by BitmapImage(), setRGB(), PNGBitmap::write(), and GIFBitmap::write()\&.
.SS "const \fBByte\fP* BitmapImage::bitmap_\fC [protected]\fP"

.PP
Referenced by setBitmap(), setBitmapRow(), XBMBitmap::write(), XPMBitmap::write(), and PNGBitmap::write()\&.
.SS "int BitmapImage::bitmapRows_\fC [protected]\fP"

.PP
Referenced by setBitmap(), setBitmapRow(), PNGBitmap::write(), and GIFBitmap::write()\&.
.SS "const int BitmapImage::bpp_\fC [protected]\fP"

.PP
Referenced by PNGBitmap::write(), and GIFBitmap::write()\&.
.SS "\fBBitmap::BitmapColour\fP BitmapImage::fg_\fC [protected]\fP"

.PP
Referenced by BitmapImage(), setRGB(), PNGBitmap::write(), and GIFBitmap::write()\&.
.SS "const char * BitmapImage::formats\fC [static]\fP, \fC [protected]\fP"
\fBInitial value:\fP
.PP
.nf
= {

    "png",


    "gif",

    "xbm",
    "xpm",
}
.fi
.PP
Referenced by firstBitmapImageFormat(), nextBitmapImageFormat(), and supportedBitmapImage()\&.
.SS "const string * BitmapImage::furtherinfo = 0\fC [static]\fP, \fC [protected]\fP"

.PP
Referenced by setInfo(), and PNGBitmap::write()\&.
.SS "int BitmapImage::h_\fC [protected]\fP"

.PP
Referenced by setBitmap(), setBitmapRow(), XBMBitmap::write(), XPMBitmap::write(), PNGBitmap::write(), and GIFBitmap::write()\&.
.SS "const string * BitmapImage::inputfilename = 0\fC [static]\fP, \fC [protected]\fP"

.PP
Referenced by setInfo(), and PNGBitmap::write()\&.
.SS "bool BitmapImage::isTransparent_\fC [protected]\fP"

.PP
Referenced by setTransparent(), PNGBitmap::write(), and GIFBitmap::write()\&.
.SS "int BitmapImage::iterator_index = 0\fC [static]\fP, \fC [protected]\fP"

.PP
Referenced by firstBitmapImageFormat(), and nextBitmapImageFormat()\&.
.SS "bool BitmapImage::myBitmap_\fC [protected]\fP"

.PP
Referenced by setBitmapRow(), and ~BitmapImage()\&.
.SS "const int BitmapImage::nformats = sizeof(\fBformats\fP)/sizeof(\fBformats\fP[0])\fC [static]\fP, \fC [protected]\fP"

.PP
Referenced by nextBitmapImageFormat(), and supportedBitmapImage()\&.
.SS "const string * BitmapImage::softwareversion = 0\fC [static]\fP, \fC [protected]\fP"

.PP
Referenced by setInfo(), and PNGBitmap::write()\&.
.SS "\fBverbosities\fP BitmapImage::verbosity_ = \fBnormal\fP\fC [static]\fP, \fC [protected]\fP"

.PP
Referenced by GIFBitmap::GIFBitmap(), verbosity(), PNGBitmap::write(), and GIFBitmap::write()\&.
.SS "int BitmapImage::w_\fC [protected]\fP"

.PP
Referenced by setBitmapRow(), XBMBitmap::write(), XPMBitmap::write(), PNGBitmap::write(), and GIFBitmap::write()\&.

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