\hypertarget{classDviFileEvent}{\section{Dvi\-File\-Event Class Reference}
\label{classDviFileEvent}\index{Dvi\-File\-Event@{Dvi\-File\-Event}}
}


Abstracts the contents of a D\-V\-I file.  




{\ttfamily \#include $<$Dvi\-File.\-h$>$}

Inheritance diagram for Dvi\-File\-Event\-:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=1.240310cm]{classDviFileEvent}
\end{center}
\end{figure}
\subsection*{Public Types}
\begin{DoxyCompactItemize}
\item 
enum \hyperlink{classDviFileEvent_a3ad105a035adc18fb50fba70bb00e948}{event\-Types} \{ \\*
\hyperlink{classDviFileEvent_a3ad105a035adc18fb50fba70bb00e948a7c6735271b6bda07c536aa8157d95550}{setchar}, 
\hyperlink{classDviFileEvent_a3ad105a035adc18fb50fba70bb00e948a6831fe1ee4202de4d550af79114d2416}{setrule}, 
\hyperlink{classDviFileEvent_a3ad105a035adc18fb50fba70bb00e948af8413f01798a36b625c69c7720619904}{fontchange}, 
\hyperlink{classDviFileEvent_a3ad105a035adc18fb50fba70bb00e948a637f73ffc5158583f5270d104443fb8c}{special}, 
\\*
\hyperlink{classDviFileEvent_a3ad105a035adc18fb50fba70bb00e948aeefe27282c6667cf7919bed52cf1d6a5}{page}, 
\hyperlink{classDviFileEvent_a3ad105a035adc18fb50fba70bb00e948ae6f71c3b51926547eeeab6886899ae22}{preamble}, 
\hyperlink{classDviFileEvent_a3ad105a035adc18fb50fba70bb00e948a0bf783ad9625a23634cd5ad298df915a}{postamble}
 \}
\end{DoxyCompactItemize}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
virtual void \hyperlink{classDviFileEvent_aaf083953d65851e339db881643e77260}{debug} () const 
\begin{DoxyCompactList}\small\item\em Writes a representation of this event on cerr. \end{DoxyCompactList}\item 
\hyperlink{classDviFileEvent_a3ad105a035adc18fb50fba70bb00e948}{event\-Types} \hyperlink{classDviFileEvent_a34c0bafd0dd91b3762a447005a97968d}{type} () const 
\begin{DoxyCompactList}\small\item\em Gets the type of this event. \end{DoxyCompactList}\item 
const unsigned char \hyperlink{classDviFileEvent_aa2acf76ccc9006d62e4cd967a1bc5341}{opcode} () const 
\begin{DoxyCompactList}\small\item\em Gets the underlying opcode which produced this event. \end{DoxyCompactList}\item 
void \hyperlink{classDviFileEvent_a63d6630a9224d369c6cefd5123ce3c6c}{release} ()
\begin{DoxyCompactList}\small\item\em Release this event. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Static Public Member Functions}
\begin{DoxyCompactItemize}
\item 
static \hyperlink{verbosity_8h_a886df075e73fd6d54e018791f87fa071}{verbosities} \hyperlink{classDviFileEvent_a19b0a66610224d9e41e7b9af4c0a42e4}{verbosity} (const \hyperlink{verbosity_8h_a886df075e73fd6d54e018791f87fa071}{verbosities} level)
\begin{DoxyCompactList}\small\item\em Sets the verbosity for \hyperlink{classDviFileEvent}{Dvi\-File\-Event} and its subclasses. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Protected Member Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{classDviFileEvent_af687e86be5289ad30830b76afcea1fe4}{Dvi\-File\-Event} (unsigned char \hyperlink{classDviFileEvent_aa2acf76ccc9006d62e4cd967a1bc5341}{opcode}, \hyperlink{classDviFileEvent_a3ad105a035adc18fb50fba70bb00e948}{event\-Types} t, \hyperlink{classDviFile}{Dvi\-File} $\ast$dp=0)
\begin{DoxyCompactList}\small\item\em Creates a new event. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Static Protected Attributes}
\begin{DoxyCompactItemize}
\item 
static \hyperlink{verbosity_8h_a886df075e73fd6d54e018791f87fa071}{verbosities} \hyperlink{classDviFileEvent_aa3a74416f748073de93232e48f7709ac}{verbosity\-\_\-} = \hyperlink{verbosity_8h_a886df075e73fd6d54e018791f87fa071aebc81705969b8c5ae986b0b2ec08d1d5}{normal}
\end{DoxyCompactItemize}


\subsection{Detailed Description}
Abstracts the contents of a D\-V\-I file. 

All the features of a D\-V\-I 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 \hyperlink{classDviFile_a61972430078d5a4e6a5caa5ce454c92a}{Dvi\-File\#get\-Event} method on {\ttfamily \hyperlink{classDviFile}{Dvi\-File}}.

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 {\ttfamily \hyperlink{classDviFileEvent}{Dvi\-File\-Event}} yourself, but use only those returned to you by \hyperlink{classDviFile_a61972430078d5a4e6a5caa5ce454c92a}{Dvi\-File\#get\-Event}.

The documentation here concentrates on how the methods and variables here relate to the underlying quantities obtained from the D\-V\-I file. For fuller information on these, see the D\-V\-I standard. 

\subsection{Member Enumeration Documentation}
\hypertarget{classDviFileEvent_a3ad105a035adc18fb50fba70bb00e948}{\index{Dvi\-File\-Event@{Dvi\-File\-Event}!event\-Types@{event\-Types}}
\index{event\-Types@{event\-Types}!DviFileEvent@{Dvi\-File\-Event}}
\subsubsection[{event\-Types}]{\setlength{\rightskip}{0pt plus 5cm}enum {\bf Dvi\-File\-Event\-::event\-Types}}}\label{classDviFileEvent_a3ad105a035adc18fb50fba70bb00e948}
\begin{Desc}
\item[Enumerator]\par
\begin{description}
\index{setchar@{setchar}!Dvi\-File\-Event@{Dvi\-File\-Event}}\index{Dvi\-File\-Event@{Dvi\-File\-Event}!setchar@{setchar}}\item[{\em 
\hypertarget{classDviFileEvent_a3ad105a035adc18fb50fba70bb00e948a7c6735271b6bda07c536aa8157d95550}{setchar}\label{classDviFileEvent_a3ad105a035adc18fb50fba70bb00e948a7c6735271b6bda07c536aa8157d95550}
}]\index{setrule@{setrule}!Dvi\-File\-Event@{Dvi\-File\-Event}}\index{Dvi\-File\-Event@{Dvi\-File\-Event}!setrule@{setrule}}\item[{\em 
\hypertarget{classDviFileEvent_a3ad105a035adc18fb50fba70bb00e948a6831fe1ee4202de4d550af79114d2416}{setrule}\label{classDviFileEvent_a3ad105a035adc18fb50fba70bb00e948a6831fe1ee4202de4d550af79114d2416}
}]\index{fontchange@{fontchange}!Dvi\-File\-Event@{Dvi\-File\-Event}}\index{Dvi\-File\-Event@{Dvi\-File\-Event}!fontchange@{fontchange}}\item[{\em 
\hypertarget{classDviFileEvent_a3ad105a035adc18fb50fba70bb00e948af8413f01798a36b625c69c7720619904}{fontchange}\label{classDviFileEvent_a3ad105a035adc18fb50fba70bb00e948af8413f01798a36b625c69c7720619904}
}]\index{special@{special}!Dvi\-File\-Event@{Dvi\-File\-Event}}\index{Dvi\-File\-Event@{Dvi\-File\-Event}!special@{special}}\item[{\em 
\hypertarget{classDviFileEvent_a3ad105a035adc18fb50fba70bb00e948a637f73ffc5158583f5270d104443fb8c}{special}\label{classDviFileEvent_a3ad105a035adc18fb50fba70bb00e948a637f73ffc5158583f5270d104443fb8c}
}]\index{page@{page}!Dvi\-File\-Event@{Dvi\-File\-Event}}\index{Dvi\-File\-Event@{Dvi\-File\-Event}!page@{page}}\item[{\em 
\hypertarget{classDviFileEvent_a3ad105a035adc18fb50fba70bb00e948aeefe27282c6667cf7919bed52cf1d6a5}{page}\label{classDviFileEvent_a3ad105a035adc18fb50fba70bb00e948aeefe27282c6667cf7919bed52cf1d6a5}
}]\index{preamble@{preamble}!Dvi\-File\-Event@{Dvi\-File\-Event}}\index{Dvi\-File\-Event@{Dvi\-File\-Event}!preamble@{preamble}}\item[{\em 
\hypertarget{classDviFileEvent_a3ad105a035adc18fb50fba70bb00e948ae6f71c3b51926547eeeab6886899ae22}{preamble}\label{classDviFileEvent_a3ad105a035adc18fb50fba70bb00e948ae6f71c3b51926547eeeab6886899ae22}
}]\index{postamble@{postamble}!Dvi\-File\-Event@{Dvi\-File\-Event}}\index{Dvi\-File\-Event@{Dvi\-File\-Event}!postamble@{postamble}}\item[{\em 
\hypertarget{classDviFileEvent_a3ad105a035adc18fb50fba70bb00e948a0bf783ad9625a23634cd5ad298df915a}{postamble}\label{classDviFileEvent_a3ad105a035adc18fb50fba70bb00e948a0bf783ad9625a23634cd5ad298df915a}
}]\end{description}
\end{Desc}


\subsection{Constructor \& Destructor Documentation}
\hypertarget{classDviFileEvent_af687e86be5289ad30830b76afcea1fe4}{\index{Dvi\-File\-Event@{Dvi\-File\-Event}!Dvi\-File\-Event@{Dvi\-File\-Event}}
\index{Dvi\-File\-Event@{Dvi\-File\-Event}!DviFileEvent@{Dvi\-File\-Event}}
\subsubsection[{Dvi\-File\-Event}]{\setlength{\rightskip}{0pt plus 5cm}Dvi\-File\-Event\-::\-Dvi\-File\-Event (
\begin{DoxyParamCaption}
\item[{unsigned char}]{opcode, }
\item[{{\bf event\-Types}}]{t, }
\item[{{\bf Dvi\-File} $\ast$}]{dp = {\ttfamily 0}}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [protected]}}}\label{classDviFileEvent_af687e86be5289ad30830b76afcea1fe4}


Creates a new event. 


\begin{DoxyParams}{Parameters}
{\em opcode} & the D\-V\-I opcode which resulted in this event \\
\hline
{\em t} & the type of this event \\
\hline
{\em dp} & the {\ttfamily \hyperlink{classDviFile}{Dvi\-File}} it is associated with \\
\hline
\end{DoxyParams}


\subsection{Member Function Documentation}
\hypertarget{classDviFileEvent_aaf083953d65851e339db881643e77260}{\index{Dvi\-File\-Event@{Dvi\-File\-Event}!debug@{debug}}
\index{debug@{debug}!DviFileEvent@{Dvi\-File\-Event}}
\subsubsection[{debug}]{\setlength{\rightskip}{0pt plus 5cm}void Dvi\-File\-Event\-::debug (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [virtual]}}}\label{classDviFileEvent_aaf083953d65851e339db881643e77260}


Writes a representation of this event on cerr. 



Reimplemented in \hyperlink{classDviFilePreamble_a126d04e04075feb11eab29022c2ebefd}{Dvi\-File\-Preamble}, \hyperlink{classDviFilePage_a90b5f40197fa442a4961e86e00517fae}{Dvi\-File\-Page}, \hyperlink{classDviFileSpecial_ab548507909f32fb69940ac6e941fa168}{Dvi\-File\-Special}, \hyperlink{classDviFileFontChange_a7d0c734df90a15321786256417c9680f}{Dvi\-File\-Font\-Change}, \hyperlink{classDviFileSetRule_a0778e7d145b7c2b35972646e3aec9080}{Dvi\-File\-Set\-Rule}, and \hyperlink{classDviFileSetChar_ad49944a8412998c7c72a0bb43976111b}{Dvi\-File\-Set\-Char}.



Referenced by main().

\hypertarget{classDviFileEvent_aa2acf76ccc9006d62e4cd967a1bc5341}{\index{Dvi\-File\-Event@{Dvi\-File\-Event}!opcode@{opcode}}
\index{opcode@{opcode}!DviFileEvent@{Dvi\-File\-Event}}
\subsubsection[{opcode}]{\setlength{\rightskip}{0pt plus 5cm}const unsigned char Dvi\-File\-Event\-::opcode (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [inline]}}}\label{classDviFileEvent_aa2acf76ccc9006d62e4cd967a1bc5341}


Gets the underlying opcode which produced this event. 

\begin{DoxyReturn}{Returns}
the opcode 
\end{DoxyReturn}
\hypertarget{classDviFileEvent_a63d6630a9224d369c6cefd5123ce3c6c}{\index{Dvi\-File\-Event@{Dvi\-File\-Event}!release@{release}}
\index{release@{release}!DviFileEvent@{Dvi\-File\-Event}}
\subsubsection[{release}]{\setlength{\rightskip}{0pt plus 5cm}void Dvi\-File\-Event\-::release (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}}\label{classDviFileEvent_a63d6630a9224d369c6cefd5123ce3c6c}


Release this event. 

Client code which has been given an event by \hyperlink{classDviFile_a61972430078d5a4e6a5caa5ce454c92a}{Dvi\-File\#get\-Event} 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 {\itshape may} call {\ttfamily delete} on the associated object, so the client code should assume that it has done so, and make no further reference to the object. 

Referenced by main().

\hypertarget{classDviFileEvent_a34c0bafd0dd91b3762a447005a97968d}{\index{Dvi\-File\-Event@{Dvi\-File\-Event}!type@{type}}
\index{type@{type}!DviFileEvent@{Dvi\-File\-Event}}
\subsubsection[{type}]{\setlength{\rightskip}{0pt plus 5cm}{\bf event\-Types} Dvi\-File\-Event\-::type (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [inline]}}}\label{classDviFileEvent_a34c0bafd0dd91b3762a447005a97968d}


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, {\ttfamily dynamic\-\_\-cast$<$\hyperlink{classDviFileSetChar}{Dvi\-File\-Set\-Char} $\ast$$>$(event\-\_\-ptr)}.

\begin{DoxyReturn}{Returns}
the type 
\end{DoxyReturn}
\hypertarget{classDviFileEvent_a19b0a66610224d9e41e7b9af4c0a42e4}{\index{Dvi\-File\-Event@{Dvi\-File\-Event}!verbosity@{verbosity}}
\index{verbosity@{verbosity}!DviFileEvent@{Dvi\-File\-Event}}
\subsubsection[{verbosity}]{\setlength{\rightskip}{0pt plus 5cm}{\bf verbosities} Dvi\-File\-Event\-::verbosity (
\begin{DoxyParamCaption}
\item[{const {\bf verbosities}}]{level}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [static]}}}\label{classDviFileEvent_a19b0a66610224d9e41e7b9af4c0a42e4}


Sets the verbosity for \hyperlink{classDviFileEvent}{Dvi\-File\-Event} and its subclasses. 


\begin{DoxyParams}{Parameters}
{\em level} & the desired verbosity \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
the old verbosity 
\end{DoxyReturn}


References verbosity\-\_\-.



Referenced by Dvi\-File\-::verbosity().



\subsection{Member Data Documentation}
\hypertarget{classDviFileEvent_aa3a74416f748073de93232e48f7709ac}{\index{Dvi\-File\-Event@{Dvi\-File\-Event}!verbosity\-\_\-@{verbosity\-\_\-}}
\index{verbosity\-\_\-@{verbosity\-\_\-}!DviFileEvent@{Dvi\-File\-Event}}
\subsubsection[{verbosity\-\_\-}]{\setlength{\rightskip}{0pt plus 5cm}{\bf verbosities} Dvi\-File\-Event\-::verbosity\-\_\- = {\bf normal}\hspace{0.3cm}{\ttfamily [static]}, {\ttfamily [protected]}}}\label{classDviFileEvent_aa3a74416f748073de93232e48f7709ac}


Referenced by Dvi\-File\-Set\-Char\-::\-Dvi\-File\-Set\-Char(), and verbosity().



The documentation for this class was generated from the following files\-:\begin{DoxyCompactItemize}
\item 
\hyperlink{DviFile_8h}{Dvi\-File.\-h}\item 
\hyperlink{DviFile_8cc}{Dvi\-File.\-cc}\end{DoxyCompactItemize}
