.TH "DviFileEvent" 3 "Mon Jan 12 2015" "Version dvi2bitmap1.0" "dvi2bitmap" \" -*- nroff -*-
.ad l
.nh
.SH NAME
DviFileEvent \- 
.PP
Abstracts the contents of a DVI file\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <DviFile\&.h>\fP
.PP
Inherited by \fBDviFileFontChange\fP, \fBDviFilePage\fP, \fBDviFilePostamble\fP, \fBDviFilePreamble\fP, \fBDviFileSetChar\fP, \fBDviFileSetRule\fP, and \fBDviFileSpecial\fP\&.
.SS "Public Types"

.in +1c
.ti -1c
.RI "enum \fBeventTypes\fP { \fBsetchar\fP, \fBsetrule\fP, \fBfontchange\fP, \fBspecial\fP, \fBpage\fP, \fBpreamble\fP, \fBpostamble\fP }"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "virtual void \fBdebug\fP () const "
.br
.RI "\fIWrites a representation of this event on cerr\&. \fP"
.ti -1c
.RI "\fBeventTypes\fP \fBtype\fP () const "
.br
.RI "\fIGets the type of this event\&. \fP"
.ti -1c
.RI "const unsigned char \fBopcode\fP () const "
.br
.RI "\fIGets the underlying opcode which produced this event\&. \fP"
.ti -1c
.RI "void \fBrelease\fP ()"
.br
.RI "\fIRelease this event\&. \fP"
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "static \fBverbosities\fP \fBverbosity\fP (const \fBverbosities\fP level)"
.br
.RI "\fISets the verbosity for \fBDviFileEvent\fP and its subclasses\&. \fP"
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "\fBDviFileEvent\fP (unsigned char \fBopcode\fP, \fBeventTypes\fP t, \fBDviFile\fP *dp=0)"
.br
.RI "\fICreates a new event\&. \fP"
.in -1c
.SS "Static Protected Attributes"

.in +1c
.ti -1c
.RI "static \fBverbosities\fP \fBverbosity_\fP = \fBnormal\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
Abstracts the contents of a DVI file\&. 

All the features of a DVI file which calling code might be interested in are represented by one of the subclasses of this, and these are obtained in order by calling the \fBDviFile#getEvent\fP method on \fC\fBDviFile\fP\fP\&.
.PP
The design here is likely to be adjusted in future releases of this library\&. Although it is possible now, you should avoid constructing any of the subtypes \fC\fBDviFileEvent\fP\fP yourself, but use only those returned to you by \fBDviFile#getEvent\fP\&.
.PP
The documentation here concentrates on how the methods and variables here relate to the underlying quantities obtained from the DVI file\&. For fuller information on these, see the DVI standard\&. 
.SH "Member Enumeration Documentation"
.PP 
.SS "enum \fBDviFileEvent::eventTypes\fP"

.PP
\fBEnumerator\fP
.in +1c
.TP
\fB\fIsetchar \fP\fP
.TP
\fB\fIsetrule \fP\fP
.TP
\fB\fIfontchange \fP\fP
.TP
\fB\fIspecial \fP\fP
.TP
\fB\fIpage \fP\fP
.TP
\fB\fIpreamble \fP\fP
.TP
\fB\fIpostamble \fP\fP
.SH "Constructor & Destructor Documentation"
.PP 
.SS "DviFileEvent::DviFileEvent (unsigned charopcode, \fBeventTypes\fPt, \fBDviFile\fP *dp = \fC0\fP)\fC [protected]\fP"

.PP
Creates a new event\&. 
.PP
\fBParameters:\fP
.RS 4
\fIopcode\fP the DVI opcode which resulted in this event 
.br
\fIt\fP the type of this event 
.br
\fIdp\fP the \fC\fBDviFile\fP\fP it is associated with 
.RE
.PP

.SH "Member Function Documentation"
.PP 
.SS "void DviFileEvent::debug () const\fC [virtual]\fP"

.PP
Writes a representation of this event on cerr\&. 
.PP
Reimplemented in \fBDviFilePreamble\fP, \fBDviFilePage\fP, \fBDviFileSpecial\fP, \fBDviFileFontChange\fP, \fBDviFileSetRule\fP, and \fBDviFileSetChar\fP\&.
.PP
Referenced by main()\&.
.SS "const unsigned char DviFileEvent::opcode () const\fC [inline]\fP"

.PP
Gets the underlying opcode which produced this event\&. 
.PP
\fBReturns:\fP
.RS 4
the opcode 
.RE
.PP

.SS "void DviFileEvent::release ()"

.PP
Release this event\&. Client code which has been given an event by \fBDviFile#getEvent\fP should call this method on that event when it has no further use for it\&. This releases or reclaims all resources associated with it\&. This \fImay\fP call \fCdelete\fP on the associated object, so the client code should assume that it has done so, and make no further reference to the object\&. 
.PP
Referenced by main()\&.
.SS "\fBeventTypes\fP DviFileEvent::type () const\fC [inline]\fP"

.PP
Gets the type of this event\&. This information can also be obtained in a more object-oriented style by attempting a cast to the appropriate subtype, using, for example, \fCdynamic_cast<\fBDviFileSetChar\fP *>(event_ptr)\fP\&.
.PP
\fBReturns:\fP
.RS 4
the type 
.RE
.PP

.SS "\fBverbosities\fP DviFileEvent::verbosity (const \fBverbosities\fPlevel)\fC [static]\fP"

.PP
Sets the verbosity for \fBDviFileEvent\fP and its subclasses\&. 
.PP
\fBParameters:\fP
.RS 4
\fIlevel\fP the desired verbosity 
.RE
.PP
\fBReturns:\fP
.RS 4
the old verbosity 
.RE
.PP

.PP
References verbosity_\&.
.PP
Referenced by DviFile::verbosity()\&.
.SH "Member Data Documentation"
.PP 
.SS "\fBverbosities\fP DviFileEvent::verbosity_ = \fBnormal\fP\fC [static]\fP, \fC [protected]\fP"

.PP
Referenced by DviFileSetChar::DviFileSetChar(), and verbosity()\&.

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