.TH "KarlPathSearcher" 3 "Mon Jan 12 2015" "Version dvi2bitmap1.0" "dvi2bitmap" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KarlPathSearcher \- 
.PP
Abstracts access to the \fCkpathsea\fP library\&.  

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

.in +1c
.ti -1c
.RI "const char * \fBfind\fP (const char *font, int \fBresolution\fP)"
.br
.RI "\fIFinds a font at a given resolution\&. \fP"
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "static \fBKarlPathSearcher\fP * \fBgetInstance\fP (const char *name=0, const int basedpi=0)"
.br
.RI "\fIReturns an instance of the object which searches the TeX tree, using Karl's path-searching algorithm (KPSE)\&. \fP"
.ti -1c
.RI "static \fBverbosities\fP \fBverbosity\fP (const \fBverbosities\fP level)"
.br
.RI "\fISets the verbosity level\&. \fP"
.ti -1c
.RI "static const char * \fBversion_string\fP (void)"
.br
.RI "\fIObtains the Kpathsea version\&. \fP"
.ti -1c
.RI "static void \fBsetProgramName\fP (const char *name)"
.br
.RI "\fISets the name of the invoking program\&. \fP"
.in -1c
.SH "Detailed Description"
.PP 
Abstracts access to the \fCkpathsea\fP library\&. 

This class provides at singleton object which can service requests to the library\&. 
.SH "Member Function Documentation"
.PP 
.SS "const char * KarlPathSearcher::find (const char *fontname, intresolution)"

.PP
Finds a font at a given resolution\&. 
.PP
\fBParameters:\fP
.RS 4
\fIfontname\fP the name of the font to search for 
.br
\fIresolution\fP the desired font resolution 
.RE
.PP
\fBReturns:\fP
.RS 4
the full path to the PK file which defines the font, or zero if the font cannot be found 
.RE
.PP

.PP
References normal\&.
.SS "\fBKarlPathSearcher\fP * KarlPathSearcher::getInstance (const char *program_name = \fC0\fP, const intbasedpi = \fC0\fP)\fC [static]\fP"

.PP
Returns an instance of the object which searches the TeX tree, using Karl's path-searching algorithm (KPSE)\&. Note that, although it looks as if you should be able to call this more than once with different parameters, you can't in fact, and if you call it more than once (that's fine and sensible) you get the same instance back each time\&. In fact, there's no good reason I can think of why you'd \fIwant\fP to initialise this in different ways, so this isn't a problem in fact\&. The door remains open to this changing in future, though\&. About the only reason for giving non-default parameters here is to register a different \fCprogram_name\fP for the kpathsea library to use when reporting errors or warnings\&.
.PP
\fBParameters:\fP
.RS 4
\fIprogram_name\fP the name to be used in kpathsea feedback; if zero, this default to the value set by \fBsetProgramName\fP, and if that has not been set, to \fC'tex'\fP 
.br
\fIbasedpi\fP the base resolution of the PK fonts; if zero, it is taken to be \fBPkFont\&.dpiBase\fP (a sensible default) 
.RE
.PP

.PP
References PkFont::dpiBase()\&.
.SS "static void KarlPathSearcher::setProgramName (const char *name)\fC [inline]\fP, \fC [static]\fP"

.PP
Sets the name of the invoking program\&. This acts as the default for the initialising \fCname\fP parameter to method \fBgetInstance\fP 
.PP
\fBParameters:\fP
.RS 4
\fIname\fP the name of the invoking program 
.RE
.PP

.PP
Referenced by main()\&.
.SS "\fBverbosities\fP KarlPathSearcher::verbosity (const \fBverbosities\fPlevel)\fC [static]\fP"

.PP
Sets the verbosity level\&. As well as setting the intrinsic level of chatter for this class, it controls the amount of chatter from the \fClibkpathsea\fP library itself: if the \fClevel\fP is above \fCdebug\fP, then \fIall\fP kpathsea debugging information is switched on\&. 
.PP
\fBParameters:\fP
.RS 4
\fIlevel\fP the desired verbosity level 
.RE
.PP
\fBReturns:\fP
.RS 4
the previous verbosity level 
.RE
.PP

.PP
References debug\&.
.PP
Referenced by PkFont::verbosity()\&.
.SS "const char * KarlPathSearcher::version_string (void)\fC [static]\fP"

.PP
Obtains the Kpathsea version\&. 
.PP
\fBReturns:\fP
.RS 4
the kpathsea version string 
.RE
.PP

.PP
Referenced by main()\&.

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