6645 lines
240 KiB
HTML
6645 lines
240 KiB
HTML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<!-- template designed by Marco Von Ballmoos -->
|
|
<title>Docs For Class TCPDF</title>
|
|
<link rel="stylesheet" href="../media/stylesheet.css" />
|
|
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
|
</head>
|
|
<body>
|
|
<div class="page-body">
|
|
<h2 class="class-name">Class TCPDF</h2>
|
|
|
|
<a name="sec-description"></a>
|
|
<div class="info-box">
|
|
<div class="info-box-title">Description</div>
|
|
<div class="nav-bar">
|
|
<span class="disabled">Description</span> |
|
|
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
|
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
|
|
|
</div>
|
|
<div class="info-box-body">
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">This is a PHP5 class for generating PDF files on-the-fly without requiring external extensions.<br /></p>
|
|
<p class="description"><p>This class is an extension and improvement of the FPDF class by Olivier Plathey (http://www.fpdf.org).<br /> This version contains some changes: [porting to PHP5, support for UTF-8 Unicode, code style and formatting, php documentation (www.phpdoc.org), ISO page formats, minor improvements, image scale factor]<br /> TCPDF project (http://tcpdf.sourceforge.net) is based on the Public Domain FPDF class by Olivier Plathey (http://www.fpdf.org).<br /> To add your own TTF fonts please read /fonts/README.TXT</p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">license:</span> <a href="http://www.gnu.org/copyleft/lesser.html">LGPL</a></li>
|
|
<li><span class="field">link:</span> <a href="http://tcpdf.sourceforge.net">http://tcpdf.sourceforge.net</a></li>
|
|
<li><span class="field">author:</span> Nicola Asuni</li>
|
|
<li><span class="field">version:</span> 1.53.0.TC031</li>
|
|
<li><span class="field">name:</span> TCPDF</li>
|
|
</ul>
|
|
<p class="notes">
|
|
Located in <a class="field" href="_tcpdf_tcpdf_php.html">/tcpdf.php</a> (line <span class="field">87</span>)
|
|
</p>
|
|
|
|
|
|
<pre></pre>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
<a name="sec-var-summary"></a>
|
|
<div class="info-box">
|
|
<div class="info-box-title">Variable Summary</span></div>
|
|
<div class="nav-bar">
|
|
<a href="#sec-description">Description</a> |
|
|
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
|
|
|
|
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
|
|
|
</div>
|
|
<div class="info-box-body">
|
|
<div class="var-summary">
|
|
<div class="var-title">
|
|
<span class="var-type">alias</span>
|
|
<a href="#$AliasNbPages" title="details" class="var-name">$AliasNbPages</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">author</span>
|
|
<a href="#$author" title="details" class="var-name">$author</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">automatic</span>
|
|
<a href="#$AutoPageBreak" title="details" class="var-name">$AutoPageBreak</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">Bold</span>
|
|
<a href="#$b" title="details" class="var-name">$b</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">Barcode</span>
|
|
<a href="#$barcode" title="details" class="var-name">$barcode</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">page</span>
|
|
<a href="#$bMargin" title="details" class="var-name">$bMargin</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">buffer</span>
|
|
<a href="#$buffer" title="details" class="var-name">$buffer</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">cell</span>
|
|
<a href="#$cMargin" title="details" class="var-name">$cMargin</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">indicates</span>
|
|
<a href="#$ColorFlag" title="details" class="var-name">$ColorFlag</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">compression</span>
|
|
<a href="#$compress" title="details" class="var-name">$compress</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">array</span>
|
|
<a href="#$CoreFonts" title="details" class="var-name">$CoreFonts</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">creator</span>
|
|
<a href="#$creator" title="details" class="var-name">$creator</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">current</span>
|
|
<a href="#$CurOrientation" title="details" class="var-name">$CurOrientation</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">current</span>
|
|
<a href="#$CurrentFont" title="details" class="var-name">$CurrentFont</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">Default</span>
|
|
<a href="#$default_table_columns" title="details" class="var-name">$default_table_columns</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">default</span>
|
|
<a href="#$DefOrientation" title="details" class="var-name">$DefOrientation</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">array</span>
|
|
<a href="#$diffs" title="details" class="var-name">$diffs</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">commands</span>
|
|
<a href="#$DrawColor" title="details" class="var-name">$DrawColor</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">default</span>
|
|
<a href="#$encoding" title="details" class="var-name">$encoding</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">height</span>
|
|
<a href="#$fh" title="details" class="var-name">$fh</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">height</span>
|
|
<a href="#$fhPt" title="details" class="var-name">$fhPt</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">commands</span>
|
|
<a href="#$FillColor" title="details" class="var-name">$FillColor</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">current</span>
|
|
<a href="#$FontFamily" title="details" class="var-name">$FontFamily</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">array</span>
|
|
<a href="#$FontFiles" title="details" class="var-name">$FontFiles</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">HTML</span>
|
|
<a href="#$fontList" title="details" class="var-name">$fontList</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">array</span>
|
|
<a href="#$fonts" title="details" class="var-name">$fonts</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">current</span>
|
|
<a href="#$FontSize" title="details" class="var-name">$FontSize</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">current</span>
|
|
<a href="#$FontSizePt" title="details" class="var-name">$FontSizePt</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">current</span>
|
|
<a href="#$FontStyle" title="details" class="var-name">$FontStyle</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">Footer</span>
|
|
<a href="#$footer_font" title="details" class="var-name">$footer_font</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">Minimum</span>
|
|
<a href="#$footer_margin" title="details" class="var-name">$footer_margin</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">width</span>
|
|
<a href="#$fw" title="details" class="var-name">$fw</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">width</span>
|
|
<a href="#$fwPt" title="details" class="var-name">$fwPt</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">current</span>
|
|
<a href="#$h" title="details" class="var-name">$h</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">Header</span>
|
|
<a href="#$header_font" title="details" class="var-name">$header_font</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">Header</span>
|
|
<a href="#$header_logo" title="details" class="var-name">$header_logo</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">Header</span>
|
|
<a href="#$header_logo_width" title="details" class="var-name">$header_logo_width</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">Minimum</span>
|
|
<a href="#$header_margin" title="details" class="var-name">$header_margin</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">String</span>
|
|
<a href="#$header_string" title="details" class="var-name">$header_string</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">String</span>
|
|
<a href="#$header_title" title="details" class="var-name">$header_title</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">Header</span>
|
|
<a href="#$header_width" title="details" class="var-name">$header_width</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">current</span>
|
|
<a href="#$hPt" title="details" class="var-name">$hPt</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">HTML</span>
|
|
<a href="#$HREF" title="details" class="var-name">$HREF</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">Italic</span>
|
|
<a href="#$i" title="details" class="var-name">$i</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">array</span>
|
|
<a href="#$images" title="details" class="var-name">$images</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">image</span>
|
|
<a href="#$imgscale" title="details" class="var-name">$imgscale</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">right-bottom</span>
|
|
<a href="#$img_rb_x" title="details" class="var-name">$img_rb_x</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">right-bottom</span>
|
|
<a href="#$img_rb_y" title="details" class="var-name">$img_rb_y</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">flag</span>
|
|
<a href="#$InFooter" title="details" class="var-name">$InFooter</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">PHP</span>
|
|
<a href="#$internal_encoding" title="details" class="var-name">$internal_encoding</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">HTML</span>
|
|
<a href="#$issetcolor" title="details" class="var-name">$issetcolor</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">HTML</span>
|
|
<a href="#$issetfont" title="details" class="var-name">$issetfont</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">boolean</span>
|
|
<a href="#$isunicode" title="details" class="var-name">$isunicode</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">scale</span>
|
|
<a href="#$k" title="details" class="var-name">$k</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">keywords</span>
|
|
<a href="#$keywords" title="details" class="var-name">$keywords</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">Language</span>
|
|
<a href="#$l" title="details" class="var-name">$l</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">height</span>
|
|
<a href="#$lasth" title="details" class="var-name">$lasth</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">layout</span>
|
|
<a href="#$LayoutMode" title="details" class="var-name">$LayoutMode</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">line</span>
|
|
<a href="#$LineWidth" title="details" class="var-name">$LineWidth</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">array</span>
|
|
<a href="#$links" title="details" class="var-name">$links</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">spacer</span>
|
|
<a href="#$lispacer" title="details" class="var-name">$lispacer</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">HTML</span>
|
|
<a href="#$listcount" title="details" class="var-name">$listcount</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">HTML</span>
|
|
<a href="#$listordered" title="details" class="var-name">$listordered</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">left</span>
|
|
<a href="#$lMargin" title="details" class="var-name">$lMargin</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">current</span>
|
|
<a href="#$n" title="details" class="var-name">$n</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">array</span>
|
|
<a href="#$offsets" title="details" class="var-name">$offsets</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">array</span>
|
|
<a href="#$OrientationChanges" title="details" class="var-name">$OrientationChanges</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">original</span>
|
|
<a href="#$original_lMargin" title="details" class="var-name">$original_lMargin</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">original</span>
|
|
<a href="#$original_rMargin" title="details" class="var-name">$original_rMargin</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">current</span>
|
|
<a href="#$page" title="details" class="var-name">$page</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">threshold</span>
|
|
<a href="#$PageBreakTrigger" title="details" class="var-name">$PageBreakTrigger</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">array</span>
|
|
<a href="#$PageLinks" title="details" class="var-name">$PageLinks</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">array</span>
|
|
<a href="#$pages" title="details" class="var-name">$pages</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">PDF</span>
|
|
<a href="#$PDFVersion" title="details" class="var-name">$PDFVersion</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">store</span>
|
|
<a href="#$prevFillColor" title="details" class="var-name">$prevFillColor</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">store</span>
|
|
<a href="#$prevFontFamily" title="details" class="var-name">$prevFontFamily</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">store</span>
|
|
<a href="#$prevFontStyle" title="details" class="var-name">$prevFontStyle</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">store</span>
|
|
<a href="#$prevTextColor" title="details" class="var-name">$prevTextColor</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">If</span>
|
|
<a href="#$print_footer" title="details" class="var-name">$print_footer</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">If</span>
|
|
<a href="#$print_header" title="details" class="var-name">$print_header</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">right</span>
|
|
<a href="#$rMargin" title="details" class="var-name">$rMargin</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">current</span>
|
|
<a href="#$state" title="details" class="var-name">$state</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">subject</span>
|
|
<a href="#$subject" title="details" class="var-name">$subject</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">HTML</span>
|
|
<a href="#$tableborder" title="details" class="var-name">$tableborder</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">HTML</span>
|
|
<a href="#$tdalign" title="details" class="var-name">$tdalign</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">HTML</span>
|
|
<a href="#$tdbegin" title="details" class="var-name">$tdbegin</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">HTML</span>
|
|
<a href="#$tdbgcolor" title="details" class="var-name">$tdbgcolor</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">HTML</span>
|
|
<a href="#$tdheight" title="details" class="var-name">$tdheight</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">HTML</span>
|
|
<a href="#$tdwidth" title="details" class="var-name">$tdwidth</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">Store</span>
|
|
<a href="#$tempfontsize" title="details" class="var-name">$tempfontsize</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">commands</span>
|
|
<a href="#$TextColor" title="details" class="var-name">$TextColor</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">title</span>
|
|
<a href="#$title" title="details" class="var-name">$title</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">top</span>
|
|
<a href="#$tMargin" title="details" class="var-name">$tMargin</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">Underlined</span>
|
|
<a href="#$u" title="details" class="var-name">$u</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">underlining</span>
|
|
<a href="#$underline" title="details" class="var-name">$underline</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">current</span>
|
|
<a href="#$w" title="details" class="var-name">$w</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">current</span>
|
|
<a href="#$wPt" title="details" class="var-name">$wPt</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">word</span>
|
|
<a href="#$ws" title="details" class="var-name">$ws</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">current</span>
|
|
<a href="#$x" title="details" class="var-name">$x</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">current</span>
|
|
<a href="#$y" title="details" class="var-name">$y</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">zoom</span>
|
|
<a href="#$ZoomMode" title="details" class="var-name">$ZoomMode</a>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<a name="sec-method-summary"></a>
|
|
<div class="info-box">
|
|
<div class="info-box-title">Method Summary</span></div>
|
|
<div class="nav-bar">
|
|
<a href="#sec-description">Description</a> |
|
|
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
|
|
|
|
|
|
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
|
|
</div>
|
|
<div class="info-box-body">
|
|
<div class="method-summary">
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">TCPDF</span>
|
|
<a href="#__construct" title="details" class="method-name">__construct</a>
|
|
([<span class="var-type">string</span> <span class="var-name">$orientation</span> = <span class="var-default">'P'</span>], [<span class="var-type">string</span> <span class="var-name">$unit</span> = <span class="var-default">'mm'</span>], [<span class="var-type">mixed</span> <span class="var-name">$format</span> = <span class="var-default">'A4'</span>], [<span class="var-type">boolean</span> <span class="var-name">$unicode</span> = <span class="var-default">true</span>], [<span class="var-type">String</span> <span class="var-name">$encoding</span> = <span class="var-default">"UTF-8"</span>])
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#__destruct" title="details" class="method-name">__destruct</a>
|
|
()
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">boolean</span>
|
|
<a href="#AcceptPageBreak" title="details" class="method-name">AcceptPageBreak</a>
|
|
()
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#AddFont" title="details" class="method-name">AddFont</a>
|
|
(<span class="var-type">string</span> <span class="var-name">$family</span>, [<span class="var-type">string</span> <span class="var-name">$style</span> = <span class="var-default">''</span>], [<span class="var-type">string</span> <span class="var-name">$file</span> = <span class="var-default">''</span>])
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#addHtmlLink" title="details" class="method-name">addHtmlLink</a>
|
|
(<span class="var-type">string</span> <span class="var-name">$url</span>, <span class="var-type">string</span> <span class="var-name">$name</span>, <span class="var-type">int</span> <span class="var-name">$fill</span>)
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#AddLink" title="details" class="method-name">AddLink</a>
|
|
()
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#AddPage" title="details" class="method-name">AddPage</a>
|
|
([<span class="var-type">string</span> <span class="var-name">$orientation</span> = <span class="var-default">''</span>])
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#AliasNbPages" title="details" class="method-name">AliasNbPages</a>
|
|
([<span class="var-type">string</span> <span class="var-name">$alias</span> = <span class="var-default">'{nb}'</span>])
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#Cell" title="details" class="method-name">Cell</a>
|
|
(<span class="var-type">float</span> <span class="var-name">$w</span>, <span class="var-type">float</span> <span class="var-name">$h</span>, [<span class="var-type">string</span> <span class="var-name">$txt</span> = <span class="var-default">''</span>], <span class="var-type">mixed</span> <span class="var-name">$border</span>, <span class="var-type">int</span> <span class="var-name">$ln</span>, [<span class="var-type">string</span> <span class="var-name">$align</span> = <span class="var-default">''</span>], <span class="var-type">int</span> <span class="var-name">$fill</span>, [<span class="var-type">mixed</span> <span class="var-name">$link</span> = <span class="var-default">''</span>])
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#Close" title="details" class="method-name">Close</a>
|
|
()
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#closedHTMLTagHandler" title="details" class="method-name">closedHTMLTagHandler</a>
|
|
(<span class="var-type">string</span> <span class="var-name">$tag</span>)
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">array</span>
|
|
<a href="#convertColorHexToDec" title="details" class="method-name">convertColorHexToDec</a>
|
|
([<span class="var-type">string</span> <span class="var-name">$color</span> = <span class="var-default">"#000000"</span>])
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#Error" title="details" class="method-name">Error</a>
|
|
(<span class="var-type">string</span> <span class="var-name">$msg</span>)
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#Footer" title="details" class="method-name">Footer</a>
|
|
()
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">int</span>
|
|
<a href="#getBreakMargin" title="details" class="method-name">getBreakMargin</a>
|
|
()
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">float</span>
|
|
<a href="#getImageScale" title="details" class="method-name">getImageScale</a>
|
|
()
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">int</span>
|
|
<a href="#getPageHeight" title="details" class="method-name">getPageHeight</a>
|
|
()
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">int</span>
|
|
<a href="#getPageWidth" title="details" class="method-name">getPageWidth</a>
|
|
()
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#getPDFData" title="details" class="method-name">getPDFData</a>
|
|
()
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">int</span>
|
|
<a href="#getScaleFactor" title="details" class="method-name">getScaleFactor</a>
|
|
()
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">int</span>
|
|
<a href="#GetStringWidth" title="details" class="method-name">GetStringWidth</a>
|
|
(<span class="var-type">string</span> <span class="var-name">$s</span>)
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">float</span>
|
|
<a href="#GetX" title="details" class="method-name">GetX</a>
|
|
()
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">float</span>
|
|
<a href="#GetY" title="details" class="method-name">GetY</a>
|
|
()
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#Header" title="details" class="method-name">Header</a>
|
|
()
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#Image" title="details" class="method-name">Image</a>
|
|
(<span class="var-type">string</span> <span class="var-name">$file</span>, <span class="var-type">float</span> <span class="var-name">$x</span>, <span class="var-type">float</span> <span class="var-name">$y</span>, <span class="var-type">float</span> <span class="var-name">$w</span>, <span class="var-type">float</span> <span class="var-name">$h</span>, [<span class="var-type">string</span> <span class="var-name">$type</span> = <span class="var-default">''</span>], [<span class="var-type">mixed</span> <span class="var-name">$link</span> = <span class="var-default">''</span>])
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#Line" title="details" class="method-name">Line</a>
|
|
(<span class="var-type">float</span> <span class="var-name">$x1</span>, <span class="var-type">float</span> <span class="var-name">$y1</span>, <span class="var-type">float</span> <span class="var-name">$x2</span>, <span class="var-type">float</span> <span class="var-name">$y2</span>)
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#Link" title="details" class="method-name">Link</a>
|
|
(<span class="var-type">float</span> <span class="var-name">$x</span>, <span class="var-type">float</span> <span class="var-name">$y</span>, <span class="var-type">float</span> <span class="var-name">$w</span>, <span class="var-type">float</span> <span class="var-name">$h</span>, <span class="var-type">mixed</span> <span class="var-name">$link</span>)
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#Ln" title="details" class="method-name">Ln</a>
|
|
([<span class="var-type">float</span> <span class="var-name">$h</span> = <span class="var-default">''</span>])
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#MultiCell" title="details" class="method-name">MultiCell</a>
|
|
(<span class="var-type">float</span> <span class="var-name">$w</span>, <span class="var-type">float</span> <span class="var-name">$h</span>, <span class="var-type">string</span> <span class="var-name">$txt</span>, <span class="var-type">mixed</span> <span class="var-name">$border</span>, [<span class="var-type">string</span> <span class="var-name">$align</span> = <span class="var-default">'J'</span>], <span class="var-type">int</span> <span class="var-name">$fill</span>, [<span class="var-type">int</span> <span class="var-name">$ln</span> = <span class="var-default">1</span>])
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#Open" title="details" class="method-name">Open</a>
|
|
()
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#openHTMLTagHandler" title="details" class="method-name">openHTMLTagHandler</a>
|
|
(<span class="var-type">string</span> <span class="var-name">$tag</span>, <span class="var-type">string</span> <span class="var-name">$attr</span>, <span class="var-type">int</span> <span class="var-name">$fill</span>)
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#Output" title="details" class="method-name">Output</a>
|
|
([<span class="var-type">string</span> <span class="var-name">$name</span> = <span class="var-default">''</span>], [<span class="var-type">string</span> <span class="var-name">$dest</span> = <span class="var-default">''</span>])
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">int</span>
|
|
<a href="#PageNo" title="details" class="method-name">PageNo</a>
|
|
()
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">float</span>
|
|
<a href="#pixelsToMillimeters" title="details" class="method-name">pixelsToMillimeters</a>
|
|
(<span class="var-type">int</span> <span class="var-name">$px</span>)
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#Rect" title="details" class="method-name">Rect</a>
|
|
(<span class="var-type">float</span> <span class="var-name">$x</span>, <span class="var-type">float</span> <span class="var-name">$y</span>, <span class="var-type">float</span> <span class="var-name">$w</span>, <span class="var-type">float</span> <span class="var-name">$h</span>, [<span class="var-type">string</span> <span class="var-name">$style</span> = <span class="var-default">''</span>])
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#SetAuthor" title="details" class="method-name">SetAuthor</a>
|
|
(<span class="var-type">string</span> <span class="var-name">$author</span>)
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#SetAutoPageBreak" title="details" class="method-name">SetAutoPageBreak</a>
|
|
(<span class="var-type">boolean</span> <span class="var-name">$auto</span>, <span class="var-type">float</span> <span class="var-name">$margin</span>)
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#setBarcode" title="details" class="method-name">setBarcode</a>
|
|
([<span class="var-type">string</span> <span class="var-name">$bc</span> = <span class="var-default">""</span>])
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#SetCompression" title="details" class="method-name">SetCompression</a>
|
|
(<span class="var-type">boolean</span> <span class="var-name">$compress</span>)
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#SetCreator" title="details" class="method-name">SetCreator</a>
|
|
(<span class="var-type">string</span> <span class="var-name">$creator</span>)
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#SetDisplayMode" title="details" class="method-name">SetDisplayMode</a>
|
|
(<span class="var-type">mixed</span> <span class="var-name">$zoom</span>, [<span class="var-type">string</span> <span class="var-name">$layout</span> = <span class="var-default">'continuous'</span>])
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#SetDrawColor" title="details" class="method-name">SetDrawColor</a>
|
|
(<span class="var-type">int</span> <span class="var-name">$r</span>, [<span class="var-type">int</span> <span class="var-name">$g</span> = <span class="var-default">-1</span>], [<span class="var-type">int</span> <span class="var-name">$b</span> = <span class="var-default">-1</span>])
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#SetFillColor" title="details" class="method-name">SetFillColor</a>
|
|
(<span class="var-type">int</span> <span class="var-name">$r</span>, [<span class="var-type">int</span> <span class="var-name">$g</span> = <span class="var-default">-1</span>], [<span class="var-type">int</span> <span class="var-name">$b</span> = <span class="var-default">-1</span>], [<span class="var-type">boolean</span> <span class="var-name">$storeprev</span> = <span class="var-default">false</span>])
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#SetFont" title="details" class="method-name">SetFont</a>
|
|
(<span class="var-type">string</span> <span class="var-name">$family</span>, [<span class="var-type">string</span> <span class="var-name">$style</span> = <span class="var-default">''</span>], <span class="var-type">float</span> <span class="var-name">$size</span>)
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#SetFontSize" title="details" class="method-name">SetFontSize</a>
|
|
(<span class="var-type">float</span> <span class="var-name">$size</span>)
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#setFooterFont" title="details" class="method-name">setFooterFont</a>
|
|
(<span class="var-type">array</span> <span class="var-name">$font</span>)
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#setFooterMargin" title="details" class="method-name">setFooterMargin</a>
|
|
([<span class="var-type">int</span> <span class="var-name">$fm</span> = <span class="var-default">10</span>])
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#setHeaderData" title="details" class="method-name">setHeaderData</a>
|
|
([<span class="var-type">string</span> <span class="var-name">$ln</span> = <span class="var-default">""</span>], <span class="var-type">string</span> <span class="var-name">$lw</span>, [<span class="var-type">string</span> <span class="var-name">$ht</span> = <span class="var-default">""</span>], [<span class="var-type">string</span> <span class="var-name">$hs</span> = <span class="var-default">""</span>])
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#setHeaderFont" title="details" class="method-name">setHeaderFont</a>
|
|
(<span class="var-type">array</span> <span class="var-name">$font</span>)
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#setHeaderMargin" title="details" class="method-name">setHeaderMargin</a>
|
|
([<span class="var-type">int</span> <span class="var-name">$hm</span> = <span class="var-default">10</span>])
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#setImageScale" title="details" class="method-name">setImageScale</a>
|
|
(<span class="var-type">float</span> <span class="var-name">$scale</span>)
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#SetKeywords" title="details" class="method-name">SetKeywords</a>
|
|
(<span class="var-type">string</span> <span class="var-name">$keywords</span>)
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#setLanguageArray" title="details" class="method-name">setLanguageArray</a>
|
|
(<span class="var-type">array</span> <span class="var-name">$language</span>)
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#SetLeftMargin" title="details" class="method-name">SetLeftMargin</a>
|
|
(<span class="var-type">float</span> <span class="var-name">$margin</span>)
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#SetLineWidth" title="details" class="method-name">SetLineWidth</a>
|
|
(<span class="var-type">float</span> <span class="var-name">$width</span>)
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#SetLink" title="details" class="method-name">SetLink</a>
|
|
(<span class="var-type">int</span> <span class="var-name">$link</span>, <span class="var-type">float</span> <span class="var-name">$y</span>, [<span class="var-type">int</span> <span class="var-name">$page</span> = <span class="var-default">-1</span>])
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#SetMargins" title="details" class="method-name">SetMargins</a>
|
|
(<span class="var-type">float</span> <span class="var-name">$left</span>, <span class="var-type">float</span> <span class="var-name">$top</span>, [<span class="var-type">float</span> <span class="var-name">$right</span> = <span class="var-default">-1</span>])
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#setPrintFooter" title="details" class="method-name">setPrintFooter</a>
|
|
([<span class="var-type">mixed</span> <span class="var-name">$val</span> = <span class="var-default">true</span>], <span class="var-type">boolean</span> <span class="var-name">$value</span>)
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#setPrintHeader" title="details" class="method-name">setPrintHeader</a>
|
|
([<span class="var-type">boolean</span> <span class="var-name">$val</span> = <span class="var-default">true</span>])
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#SetRightMargin" title="details" class="method-name">SetRightMargin</a>
|
|
(<span class="var-type">float</span> <span class="var-name">$margin</span>)
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#setStyle" title="details" class="method-name">setStyle</a>
|
|
(<span class="var-type">string</span> <span class="var-name">$tag</span>, <span class="var-type">boolean</span> <span class="var-name">$enable</span>)
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#SetSubject" title="details" class="method-name">SetSubject</a>
|
|
(<span class="var-type">string</span> <span class="var-name">$subject</span>)
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#SetTextColor" title="details" class="method-name">SetTextColor</a>
|
|
(<span class="var-type">int</span> <span class="var-name">$r</span>, [<span class="var-type">int</span> <span class="var-name">$g</span> = <span class="var-default">-1</span>], [<span class="var-type">int</span> <span class="var-name">$b</span> = <span class="var-default">-1</span>], [<span class="var-type">boolean</span> <span class="var-name">$storeprev</span> = <span class="var-default">false</span>])
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#SetTitle" title="details" class="method-name">SetTitle</a>
|
|
(<span class="var-type">string</span> <span class="var-name">$title</span>)
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#SetTopMargin" title="details" class="method-name">SetTopMargin</a>
|
|
(<span class="var-type">float</span> <span class="var-name">$margin</span>)
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#SetX" title="details" class="method-name">SetX</a>
|
|
(<span class="var-type">float</span> <span class="var-name">$x</span>)
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#SetXY" title="details" class="method-name">SetXY</a>
|
|
(<span class="var-type">float</span> <span class="var-name">$x</span>, <span class="var-type">float</span> <span class="var-name">$y</span>)
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#SetY" title="details" class="method-name">SetY</a>
|
|
(<span class="var-type">float</span> <span class="var-name">$y</span>)
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#Text" title="details" class="method-name">Text</a>
|
|
(<span class="var-type">float</span> <span class="var-name">$x</span>, <span class="var-type">float</span> <span class="var-name">$y</span>, <span class="var-type">string</span> <span class="var-name">$txt</span>)
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">string</span>
|
|
<a href="#unhtmlentities" title="details" class="method-name">unhtmlentities</a>
|
|
(<span class="var-type">$text_to_convert</span> <span class="var-name">$text_to_convert</span>)
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">array</span>
|
|
<a href="#UTF8StringToArray" title="details" class="method-name">UTF8StringToArray</a>
|
|
(<span class="var-type">string</span> <span class="var-name">$str</span>)
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">string</span>
|
|
<a href="#UTF8ToUTF16BE" title="details" class="method-name">UTF8ToUTF16BE</a>
|
|
(<span class="var-type">string</span> <span class="var-name">$str</span>, [<span class="var-type">boolean</span> <span class="var-name">$setbom</span> = <span class="var-default">true</span>])
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#Write" title="details" class="method-name">Write</a>
|
|
(<span class="var-type">float</span> <span class="var-name">$h</span>, <span class="var-type">string</span> <span class="var-name">$txt</span>, [<span class="var-type">mixed</span> <span class="var-name">$link</span> = <span class="var-default">''</span>], <span class="var-type">int</span> <span class="var-name">$fill</span>)
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#writeBarcode" title="details" class="method-name">writeBarcode</a>
|
|
(<span class="var-type">int</span> <span class="var-name">$x</span>, <span class="var-type">int</span> <span class="var-name">$y</span>, <span class="var-type">int</span> <span class="var-name">$w</span>, <span class="var-type">int</span> <span class="var-name">$h</span>, <span class="var-type">string</span> <span class="var-name">$type</span>, <span class="var-type">string</span> <span class="var-name">$style</span>, <span class="var-type">string</span> <span class="var-name">$font</span>, <span class="var-type">int</span> <span class="var-name">$xres</span>, <span class="var-type">string</span> <span class="var-name">$code</span>)
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#writeHTML" title="details" class="method-name">writeHTML</a>
|
|
(<span class="var-type">string</span> <span class="var-name">$html</span>, [<span class="var-type">boolean</span> <span class="var-name">$ln</span> = <span class="var-default">true</span>], <span class="var-type">int</span> <span class="var-name">$fill</span>)
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#writeHTMLCell" title="details" class="method-name">writeHTMLCell</a>
|
|
(<span class="var-type">float</span> <span class="var-name">$w</span>, <span class="var-type">float</span> <span class="var-name">$h</span>, <span class="var-type">float</span> <span class="var-name">$x</span>, <span class="var-type">float</span> <span class="var-name">$y</span>, [<span class="var-type">string</span> <span class="var-name">$html</span> = <span class="var-default">''</span>], <span class="var-type">mixed</span> <span class="var-name">$border</span>, <span class="var-type">int</span> <span class="var-name">$ln</span>, <span class="var-type">int</span> <span class="var-name">$fill</span>)
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#_begindoc" title="details" class="method-name">_begindoc</a>
|
|
()
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#_beginpage" title="details" class="method-name">_beginpage</a>
|
|
(<span class="var-type">mixed</span> <span class="var-name">$orientation</span>)
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#_dochecks" title="details" class="method-name">_dochecks</a>
|
|
()
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#_dounderline" title="details" class="method-name">_dounderline</a>
|
|
(<span class="var-type">mixed</span> <span class="var-name">$x</span>, <span class="var-type">mixed</span> <span class="var-name">$y</span>, <span class="var-type">mixed</span> <span class="var-name">$txt</span>)
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#_enddoc" title="details" class="method-name">_enddoc</a>
|
|
()
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#_endpage" title="details" class="method-name">_endpage</a>
|
|
()
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#_escape" title="details" class="method-name">_escape</a>
|
|
(<span class="var-type">mixed</span> <span class="var-name">$s</span>)
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#_escapetext" title="details" class="method-name">_escapetext</a>
|
|
(<span class="var-type">mixed</span> <span class="var-name">$s</span>)
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#_freadint" title="details" class="method-name">_freadint</a>
|
|
(<span class="var-type">mixed</span> <span class="var-name">$f</span>)
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#_getfontpath" title="details" class="method-name">_getfontpath</a>
|
|
()
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#_newobj" title="details" class="method-name">_newobj</a>
|
|
()
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#_out" title="details" class="method-name">_out</a>
|
|
(<span class="var-type">mixed</span> <span class="var-name">$s</span>)
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#_parsejpg" title="details" class="method-name">_parsejpg</a>
|
|
(<span class="var-type">mixed</span> <span class="var-name">$file</span>)
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#_parsepng" title="details" class="method-name">_parsepng</a>
|
|
(<span class="var-type">mixed</span> <span class="var-name">$file</span>)
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#_putcatalog" title="details" class="method-name">_putcatalog</a>
|
|
()
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#_putfonts" title="details" class="method-name">_putfonts</a>
|
|
()
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#_putheader" title="details" class="method-name">_putheader</a>
|
|
()
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#_putimages" title="details" class="method-name">_putimages</a>
|
|
()
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#_putinfo" title="details" class="method-name">_putinfo</a>
|
|
()
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#_putpages" title="details" class="method-name">_putpages</a>
|
|
()
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#_putresourcedict" title="details" class="method-name">_putresourcedict</a>
|
|
()
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#_putresources" title="details" class="method-name">_putresources</a>
|
|
()
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#_putstream" title="details" class="method-name">_putstream</a>
|
|
(<span class="var-type">mixed</span> <span class="var-name">$s</span>)
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#_puttrailer" title="details" class="method-name">_puttrailer</a>
|
|
()
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#_puttruetypeunicode" title="details" class="method-name">_puttruetypeunicode</a>
|
|
(<span class="var-type">mixed</span> <span class="var-name">$font</span>)
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#_putxobjectdict" title="details" class="method-name">_putxobjectdict</a>
|
|
()
|
|
</div>
|
|
|
|
<div class="method-definition">
|
|
<span class="method-result">void</span>
|
|
<a href="#_textstring" title="details" class="method-name">_textstring</a>
|
|
(<span class="var-type">mixed</span> <span class="var-name">$s</span>)
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<a name="sec-vars"></a>
|
|
<div class="info-box">
|
|
<div class="info-box-title">Variables</div>
|
|
<div class="nav-bar">
|
|
<a href="#sec-description">Description</a> |
|
|
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
|
|
|
|
|
|
|
|
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
|
|
|
</div>
|
|
<div class="info-box-body">
|
|
<a name="var$AliasNbPages" id="$AliasNbPages"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">alias</span>
|
|
<span class="var-name">$AliasNbPages</span>
|
|
(line <span class="line-number">430</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> for total number of pages</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$author" id="$author"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">author</span>
|
|
<span class="var-name">$author</span>
|
|
(line <span class="line-number">412</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$AutoPageBreak" id="$AutoPageBreak"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">automatic</span>
|
|
<span class="var-name">$AutoPageBreak</span>
|
|
(line <span class="line-number">370</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> page breaking</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$b" id="$b"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">Bold</span>
|
|
<span class="var-name">$b</span>
|
|
(line <span class="line-number">657</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> font style status.</li>
|
|
<li><span class="field">access:</span> private</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$barcode" id="$barcode"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">Barcode</span>
|
|
<span class="var-name">$barcode</span>
|
|
= <span class="var-default"> false</span> (line <span class="line-number">522</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> to print on page footer (only if set).</li>
|
|
<li><span class="field">access:</span> private</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$bMargin" id="$bMargin"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">page</span>
|
|
<span class="var-name">$bMargin</span>
|
|
(line <span class="line-number">226</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> break margin</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$buffer" id="$buffer"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">buffer</span>
|
|
<span class="var-name">$buffer</span>
|
|
(line <span class="line-number">112</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> holding in-memory PDF</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$cMargin" id="$cMargin"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">cell</span>
|
|
<span class="var-name">$cMargin</span>
|
|
(line <span class="line-number">232</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> margin</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$ColorFlag" id="$ColorFlag"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">indicates</span>
|
|
<span class="var-name">$ColorFlag</span>
|
|
(line <span class="line-number">358</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> whether fill and text colors are different</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$compress" id="$compress"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">compression</span>
|
|
<span class="var-name">$compress</span>
|
|
(line <span class="line-number">130</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> flag</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$CoreFonts" id="$CoreFonts"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">array</span>
|
|
<span class="var-name">$CoreFonts</span>
|
|
(line <span class="line-number">262</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> of standard font names</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$creator" id="$creator"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">creator</span>
|
|
<span class="var-name">$creator</span>
|
|
(line <span class="line-number">424</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$CurOrientation" id="$CurOrientation"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">current</span>
|
|
<span class="var-name">$CurOrientation</span>
|
|
(line <span class="line-number">142</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> orientation</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$CurrentFont" id="$CurrentFont"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">current</span>
|
|
<span class="var-name">$CurrentFont</span>
|
|
(line <span class="line-number">322</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> font info</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$default_table_columns" id="$default_table_columns"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">Default</span>
|
|
<span class="var-name">$default_table_columns</span>
|
|
= <span class="var-default"> 4</span> (line <span class="line-number">570</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> number of columns for html table.</li>
|
|
<li><span class="field">access:</span> private</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$DefOrientation" id="$DefOrientation"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">default</span>
|
|
<span class="var-name">$DefOrientation</span>
|
|
(line <span class="line-number">136</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> orientation</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$diffs" id="$diffs"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">array</span>
|
|
<span class="var-name">$diffs</span>
|
|
(line <span class="line-number">280</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> of encoding differences</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$DrawColor" id="$DrawColor"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">commands</span>
|
|
<span class="var-name">$DrawColor</span>
|
|
(line <span class="line-number">340</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> for drawing color</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$encoding" id="$encoding"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">default</span>
|
|
<span class="var-name">$encoding</span>
|
|
= <span class="var-default"> "UTF-8"</span> (line <span class="line-number">682</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> encoding</li>
|
|
<li><span class="field">access:</span> private</li>
|
|
<li><span class="field">since:</span> 1.53.0.TC010</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$fh" id="$fh"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">height</span>
|
|
<span class="var-name">$fh</span>
|
|
(line <span class="line-number">178</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> of page format in user unit</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$fhPt" id="$fhPt"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">height</span>
|
|
<span class="var-name">$fhPt</span>
|
|
(line <span class="line-number">166</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> of page format in points</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$FillColor" id="$FillColor"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">commands</span>
|
|
<span class="var-name">$FillColor</span>
|
|
(line <span class="line-number">346</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> for filling color</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$FontFamily" id="$FontFamily"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">current</span>
|
|
<span class="var-name">$FontFamily</span>
|
|
(line <span class="line-number">304</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> font family</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$FontFiles" id="$FontFiles"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">array</span>
|
|
<span class="var-name">$FontFiles</span>
|
|
(line <span class="line-number">274</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> of font files</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$fontList" id="$fontList"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">HTML</span>
|
|
<span class="var-name">$fontList</span>
|
|
(line <span class="line-number">585</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> PARSER: store font list.</li>
|
|
<li><span class="field">access:</span> private</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$fonts" id="$fonts"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">array</span>
|
|
<span class="var-name">$fonts</span>
|
|
(line <span class="line-number">268</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> of used fonts</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$FontSize" id="$FontSize"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">current</span>
|
|
<span class="var-name">$FontSize</span>
|
|
(line <span class="line-number">334</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> font size in user unit</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$FontSizePt" id="$FontSizePt"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">current</span>
|
|
<span class="var-name">$FontSizePt</span>
|
|
(line <span class="line-number">328</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> font size in points</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$FontStyle" id="$FontStyle"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">current</span>
|
|
<span class="var-name">$FontStyle</span>
|
|
(line <span class="line-number">310</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> font style</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$footer_font" id="$footer_font"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">Footer</span>
|
|
<span class="var-name">$footer_font</span>
|
|
(line <span class="line-number">510</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> font.</li>
|
|
<li><span class="field">access:</span> private</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$footer_margin" id="$footer_margin"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">Minimum</span>
|
|
<span class="var-name">$footer_margin</span>
|
|
(line <span class="line-number">484</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> distance between footer and bottom page margin.</li>
|
|
<li><span class="field">access:</span> private</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$fw" id="$fw"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">width</span>
|
|
<span class="var-name">$fw</span>
|
|
(line <span class="line-number">172</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> of page format in user unit</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$fwPt" id="$fwPt"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">width</span>
|
|
<span class="var-name">$fwPt</span>
|
|
(line <span class="line-number">160</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> of page format in points</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$h" id="$h"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">current</span>
|
|
<span class="var-name">$h</span>
|
|
(line <span class="line-number">202</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> height of page in user unit</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$header_font" id="$header_font"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">Header</span>
|
|
<span class="var-name">$header_font</span>
|
|
(line <span class="line-number">504</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> font.</li>
|
|
<li><span class="field">access:</span> private</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$header_logo" id="$header_logo"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">Header</span>
|
|
<span class="var-name">$header_logo</span>
|
|
= <span class="var-default"> ""</span> (line <span class="line-number">546</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> image logo.</li>
|
|
<li><span class="field">access:</span> private</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$header_logo_width" id="$header_logo_width"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">Header</span>
|
|
<span class="var-name">$header_logo_width</span>
|
|
= <span class="var-default"> 30</span> (line <span class="line-number">552</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> image logo width in mm.</li>
|
|
<li><span class="field">access:</span> private</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$header_margin" id="$header_margin"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">Minimum</span>
|
|
<span class="var-name">$header_margin</span>
|
|
(line <span class="line-number">478</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> distance between header and top page margin.</li>
|
|
<li><span class="field">access:</span> private</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$header_string" id="$header_string"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">String</span>
|
|
<span class="var-name">$header_string</span>
|
|
= <span class="var-default"> ""</span> (line <span class="line-number">564</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> to print on document header.</li>
|
|
<li><span class="field">access:</span> private</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$header_title" id="$header_title"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">String</span>
|
|
<span class="var-name">$header_title</span>
|
|
= <span class="var-default"> ""</span> (line <span class="line-number">558</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> to print as title on document header.</li>
|
|
<li><span class="field">access:</span> private</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$header_width" id="$header_width"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">Header</span>
|
|
<span class="var-name">$header_width</span>
|
|
= <span class="var-default"> 0</span> (line <span class="line-number">540</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> width (0 = full page width).</li>
|
|
<li><span class="field">access:</span> private</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$hPt" id="$hPt"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">current</span>
|
|
<span class="var-name">$hPt</span>
|
|
(line <span class="line-number">190</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> height of page in points</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$HREF" id="$HREF"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">HTML</span>
|
|
<span class="var-name">$HREF</span>
|
|
(line <span class="line-number">579</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> PARSER: store current link.</li>
|
|
<li><span class="field">access:</span> private</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$i" id="$i"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">Italic</span>
|
|
<span class="var-name">$i</span>
|
|
(line <span class="line-number">669</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> font style status.</li>
|
|
<li><span class="field">access:</span> private</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$images" id="$images"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">array</span>
|
|
<span class="var-name">$images</span>
|
|
(line <span class="line-number">286</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> of used images</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$imgscale" id="$imgscale"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">image</span>
|
|
<span class="var-name">$imgscale</span>
|
|
= <span class="var-default"> 1</span> (line <span class="line-number">454</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> scale factor</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
<li><span class="field">author:</span> Nicola Asuni</li>
|
|
<li><span class="field">since:</span> 2004-06-14</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$img_rb_x" id="$img_rb_x"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">right-bottom</span>
|
|
<span class="var-name">$img_rb_x</span>
|
|
(line <span class="line-number">438</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> corner X coordinate of inserted image</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
<li><span class="field">author:</span> Nicola Asuni</li>
|
|
<li><span class="field">since:</span> 2002-07-31</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$img_rb_y" id="$img_rb_y"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">right-bottom</span>
|
|
<span class="var-name">$img_rb_y</span>
|
|
(line <span class="line-number">446</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> corner Y coordinate of inserted image</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
<li><span class="field">author:</span> Nicola Asuni</li>
|
|
<li><span class="field">since:</span> 2002-07-31</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$InFooter" id="$InFooter"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">flag</span>
|
|
<span class="var-name">$InFooter</span>
|
|
(line <span class="line-number">382</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> set when processing footer</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$internal_encoding" id="$internal_encoding"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">PHP</span>
|
|
<span class="var-name">$internal_encoding</span>
|
|
(line <span class="line-number">689</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> internal encoding</li>
|
|
<li><span class="field">access:</span> private</li>
|
|
<li><span class="field">since:</span> 1.53.0.TC016</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$issetcolor" id="$issetcolor"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">HTML</span>
|
|
<span class="var-name">$issetcolor</span>
|
|
(line <span class="line-number">597</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> PARSER: true when color attribute is set.</li>
|
|
<li><span class="field">access:</span> private</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$issetfont" id="$issetfont"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">HTML</span>
|
|
<span class="var-name">$issetfont</span>
|
|
(line <span class="line-number">591</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> PARSER: true when font attribute is set.</li>
|
|
<li><span class="field">access:</span> private</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$isunicode" id="$isunicode"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">boolean</span>
|
|
<span class="var-name">$isunicode</span>
|
|
= <span class="var-default"> false</span> (line <span class="line-number">462</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> set to true when the input text is unicode (require unicode fonts)</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
<li><span class="field">author:</span> Nicola Asuni</li>
|
|
<li><span class="field">since:</span> 2005-01-02</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$k" id="$k"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">scale</span>
|
|
<span class="var-name">$k</span>
|
|
(line <span class="line-number">154</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> factor (number of points in user unit)</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$keywords" id="$keywords"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">keywords</span>
|
|
<span class="var-name">$keywords</span>
|
|
(line <span class="line-number">418</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$l" id="$l"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">Language</span>
|
|
<span class="var-name">$l</span>
|
|
(line <span class="line-number">516</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> templates.</li>
|
|
<li><span class="field">access:</span> private</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$lasth" id="$lasth"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">height</span>
|
|
<span class="var-name">$lasth</span>
|
|
(line <span class="line-number">250</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> of last cell printed</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$LayoutMode" id="$LayoutMode"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">layout</span>
|
|
<span class="var-name">$LayoutMode</span>
|
|
(line <span class="line-number">394</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> display mode</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$LineWidth" id="$LineWidth"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">line</span>
|
|
<span class="var-name">$LineWidth</span>
|
|
(line <span class="line-number">256</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> width in user unit</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$links" id="$links"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">array</span>
|
|
<span class="var-name">$links</span>
|
|
(line <span class="line-number">298</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> of internal links</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$lispacer" id="$lispacer"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">spacer</span>
|
|
<span class="var-name">$lispacer</span>
|
|
= <span class="var-default"> ""</span> (line <span class="line-number">675</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> for LI tags.</li>
|
|
<li><span class="field">access:</span> private</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$listcount" id="$listcount"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">HTML</span>
|
|
<span class="var-name">$listcount</span>
|
|
= <span class="var-default"> 0</span> (line <span class="line-number">609</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> PARSER: count list items.</li>
|
|
<li><span class="field">access:</span> private</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$listordered" id="$listordered"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">HTML</span>
|
|
<span class="var-name">$listordered</span>
|
|
= <span class="var-default"> false</span> (line <span class="line-number">603</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> PARSER: true in case of ordered list (OL), false otherwise.</li>
|
|
<li><span class="field">access:</span> private</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$lMargin" id="$lMargin"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">left</span>
|
|
<span class="var-name">$lMargin</span>
|
|
(line <span class="line-number">208</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> margin</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$n" id="$n"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">current</span>
|
|
<span class="var-name">$n</span>
|
|
(line <span class="line-number">100</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> object number</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$offsets" id="$offsets"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">array</span>
|
|
<span class="var-name">$offsets</span>
|
|
(line <span class="line-number">106</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> of object offsets</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$OrientationChanges" id="$OrientationChanges"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">array</span>
|
|
<span class="var-name">$OrientationChanges</span>
|
|
(line <span class="line-number">148</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> indicating orientation changes</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$original_lMargin" id="$original_lMargin"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">original</span>
|
|
<span class="var-name">$original_lMargin</span>
|
|
(line <span class="line-number">491</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> left margin value</li>
|
|
<li><span class="field">access:</span> private</li>
|
|
<li><span class="field">since:</span> 1.53.0.TC013</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$original_rMargin" id="$original_rMargin"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">original</span>
|
|
<span class="var-name">$original_rMargin</span>
|
|
(line <span class="line-number">498</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> right margin value</li>
|
|
<li><span class="field">access:</span> private</li>
|
|
<li><span class="field">since:</span> 1.53.0.TC013</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$page" id="$page"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">current</span>
|
|
<span class="var-name">$page</span>
|
|
(line <span class="line-number">94</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> page number</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$PageBreakTrigger" id="$PageBreakTrigger"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">threshold</span>
|
|
<span class="var-name">$PageBreakTrigger</span>
|
|
(line <span class="line-number">376</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> used to trigger page breaks</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$PageLinks" id="$PageLinks"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">array</span>
|
|
<span class="var-name">$PageLinks</span>
|
|
(line <span class="line-number">292</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> of links in pages</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$pages" id="$pages"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">array</span>
|
|
<span class="var-name">$pages</span>
|
|
(line <span class="line-number">118</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> containing pages</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$PDFVersion" id="$PDFVersion"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">PDF</span>
|
|
<span class="var-name">$PDFVersion</span>
|
|
= <span class="var-default"> "1.3"</span> (line <span class="line-number">469</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> version</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
<li><span class="field">since:</span> 1.5.3</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$prevFillColor" id="$prevFillColor"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">store</span>
|
|
<span class="var-name">$prevFillColor</span>
|
|
= <span class="var-default">array(255,255,255)</span> (line <span class="line-number">696</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> previous fill color as RGB array</li>
|
|
<li><span class="field">access:</span> private</li>
|
|
<li><span class="field">since:</span> 1.53.0.TC017</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$prevFontFamily" id="$prevFontFamily"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">store</span>
|
|
<span class="var-name">$prevFontFamily</span>
|
|
(line <span class="line-number">710</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> previous font family</li>
|
|
<li><span class="field">access:</span> private</li>
|
|
<li><span class="field">since:</span> 1.53.0.TC017</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$prevFontStyle" id="$prevFontStyle"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">store</span>
|
|
<span class="var-name">$prevFontStyle</span>
|
|
(line <span class="line-number">717</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> previous font style</li>
|
|
<li><span class="field">access:</span> private</li>
|
|
<li><span class="field">since:</span> 1.53.0.TC017</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$prevTextColor" id="$prevTextColor"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">store</span>
|
|
<span class="var-name">$prevTextColor</span>
|
|
= <span class="var-default">array(0,0,0)</span> (line <span class="line-number">703</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> previous text color as RGB array</li>
|
|
<li><span class="field">access:</span> private</li>
|
|
<li><span class="field">since:</span> 1.53.0.TC017</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$print_footer" id="$print_footer"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">If</span>
|
|
<span class="var-name">$print_footer</span>
|
|
= <span class="var-default"> true</span> (line <span class="line-number">534</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> true prints footer.</li>
|
|
<li><span class="field">access:</span> private</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$print_header" id="$print_header"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">If</span>
|
|
<span class="var-name">$print_header</span>
|
|
= <span class="var-default"> true</span> (line <span class="line-number">528</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> true prints header</li>
|
|
<li><span class="field">access:</span> private</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$rMargin" id="$rMargin"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">right</span>
|
|
<span class="var-name">$rMargin</span>
|
|
(line <span class="line-number">220</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> margin</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$state" id="$state"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">current</span>
|
|
<span class="var-name">$state</span>
|
|
(line <span class="line-number">124</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> document state</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$subject" id="$subject"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">subject</span>
|
|
<span class="var-name">$subject</span>
|
|
(line <span class="line-number">406</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$tableborder" id="$tableborder"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">HTML</span>
|
|
<span class="var-name">$tableborder</span>
|
|
= <span class="var-default"> 0</span> (line <span class="line-number">615</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> PARSER: size of table border.</li>
|
|
<li><span class="field">access:</span> private</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$tdalign" id="$tdalign"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">HTML</span>
|
|
<span class="var-name">$tdalign</span>
|
|
= <span class="var-default"> "L"</span> (line <span class="line-number">639</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> PARSER: table align.</li>
|
|
<li><span class="field">access:</span> private</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$tdbegin" id="$tdbegin"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">HTML</span>
|
|
<span class="var-name">$tdbegin</span>
|
|
= <span class="var-default"> false</span> (line <span class="line-number">621</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> PARSER: true at the beginning of table.</li>
|
|
<li><span class="field">access:</span> private</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$tdbgcolor" id="$tdbgcolor"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">HTML</span>
|
|
<span class="var-name">$tdbgcolor</span>
|
|
= <span class="var-default"> false</span> (line <span class="line-number">645</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> PARSER: table background color.</li>
|
|
<li><span class="field">access:</span> private</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$tdheight" id="$tdheight"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">HTML</span>
|
|
<span class="var-name">$tdheight</span>
|
|
= <span class="var-default"> 0</span> (line <span class="line-number">633</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> PARSER: table height.</li>
|
|
<li><span class="field">access:</span> private</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$tdwidth" id="$tdwidth"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">HTML</span>
|
|
<span class="var-name">$tdwidth</span>
|
|
= <span class="var-default"> 0</span> (line <span class="line-number">627</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> PARSER: table width.</li>
|
|
<li><span class="field">access:</span> private</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$tempfontsize" id="$tempfontsize"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">Store</span>
|
|
<span class="var-name">$tempfontsize</span>
|
|
= <span class="var-default"> 10</span> (line <span class="line-number">651</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> temporary font size in points.</li>
|
|
<li><span class="field">access:</span> private</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$TextColor" id="$TextColor"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">commands</span>
|
|
<span class="var-name">$TextColor</span>
|
|
(line <span class="line-number">352</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> for text color</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$title" id="$title"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">title</span>
|
|
<span class="var-name">$title</span>
|
|
(line <span class="line-number">400</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$tMargin" id="$tMargin"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">top</span>
|
|
<span class="var-name">$tMargin</span>
|
|
(line <span class="line-number">214</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> margin</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$u" id="$u"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">Underlined</span>
|
|
<span class="var-name">$u</span>
|
|
(line <span class="line-number">663</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> font style status.</li>
|
|
<li><span class="field">access:</span> private</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$underline" id="$underline"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">underlining</span>
|
|
<span class="var-name">$underline</span>
|
|
(line <span class="line-number">316</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> flag</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$w" id="$w"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">current</span>
|
|
<span class="var-name">$w</span>
|
|
(line <span class="line-number">196</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> width of page in user unit</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$wPt" id="$wPt"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">current</span>
|
|
<span class="var-name">$wPt</span>
|
|
(line <span class="line-number">184</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> width of page in points</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$ws" id="$ws"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">word</span>
|
|
<span class="var-name">$ws</span>
|
|
(line <span class="line-number">364</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> spacing</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$x" id="$x"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">current</span>
|
|
<span class="var-name">$x</span>
|
|
(line <span class="line-number">238</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> horizontal position in user unit for cell positioning</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$y" id="$y"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">current</span>
|
|
<span class="var-name">$y</span>
|
|
(line <span class="line-number">244</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> vertical position in user unit for cell positioning</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$ZoomMode" id="$ZoomMode"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">zoom</span>
|
|
<span class="var-name">$ZoomMode</span>
|
|
(line <span class="line-number">388</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">var:</span> display mode</li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<a name="sec-methods"></a>
|
|
<div class="info-box">
|
|
<div class="info-box-title">Methods</div>
|
|
<div class="nav-bar">
|
|
<a href="#sec-description">Description</a> |
|
|
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
|
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
|
|
|
|
</div>
|
|
<div class="info-box-body">
|
|
<A NAME='method_detail'></A>
|
|
<a name="method__construct" id="__construct"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">Constructor __construct</span> (line <span class="line-number">735</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">This is the class constructor.</p>
|
|
<p class="description"><p>It allows to set up the page format, the orientation and the measure unit used in all the methods (except for the font sizes).</p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
<li><span class="field">since:</span> 1.0</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">TCPDF</span>
|
|
<span class="method-name">
|
|
__construct
|
|
</span>
|
|
([<span class="var-type">string</span> <span class="var-name">$orientation</span> = <span class="var-default">'P'</span>], [<span class="var-type">string</span> <span class="var-name">$unit</span> = <span class="var-default">'mm'</span>], [<span class="var-type">mixed</span> <span class="var-name">$format</span> = <span class="var-default">'A4'</span>], [<span class="var-type">boolean</span> <span class="var-name">$unicode</span> = <span class="var-default">true</span>], [<span class="var-type">String</span> <span class="var-name">$encoding</span> = <span class="var-default">"UTF-8"</span>])
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$orientation</span><span class="var-description">: page orientation. Possible values are (case insensitive):<ul><li>P or Portrait (default)</li><li>L or Landscape</li></ul></span> </li>
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$unit</span><span class="var-description">: User measure unit. Possible values are:<ul><li>pt: point</li><li>mm: millimeter (default)</li><li>cm: centimeter</li><li>in: inch</li></ul><br />A point equals 1/72 of inch, that is to say about 0.35 mm (an inch being 2.54 cm). This is a very common unit in typography; font sizes are expressed in that unit.</span> </li>
|
|
<li>
|
|
<span class="var-type">mixed</span>
|
|
<span class="var-name">$format</span><span class="var-description">: The format used for pages. It can be either one of the following values (case insensitive) or a custom format in the form of a two-element array containing the width and the height (expressed in the unit given by unit).<ul><li>4A0</li><li>2A0</li><li>A0</li><li>A1</li><li>A2</li><li>A3</li><li>A4 (default)</li><li>A5</li><li>A6</li><li>A7</li><li>A8</li><li>A9</li><li>A10</li><li>B0</li><li>B1</li><li>B2</li><li>B3</li><li>B4</li><li>B5</li><li>B6</li><li>B7</li><li>B8</li><li>B9</li><li>B10</li><li>C0</li><li>C1</li><li>C2</li><li>C3</li><li>C4</li><li>C5</li><li>C6</li><li>C7</li><li>C8</li><li>C9</li><li>C10</li><li>RA0</li><li>RA1</li><li>RA2</li><li>RA3</li><li>RA4</li><li>SRA0</li><li>SRA1</li><li>SRA2</li><li>SRA3</li><li>SRA4</li><li>LETTER</li><li>LEGAL</li><li>EXECUTIVE</li><li>FOLIO</li></ul></span> </li>
|
|
<li>
|
|
<span class="var-type">boolean</span>
|
|
<span class="var-name">$unicode</span><span class="var-description">: TRUE means that the input text is unicode (default = true)</span> </li>
|
|
<li>
|
|
<span class="var-type">String</span>
|
|
<span class="var-name">$encoding</span><span class="var-description">: charset encoding; default is UTF-8</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="method__destruct" id="__destruct"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">Destructor __destruct</span> (line <span class="line-number">921</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Default destructor.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
<li><span class="field">since:</span> 1.53.0.TC016</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
__destruct
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="methodAcceptPageBreak" id="AcceptPageBreak"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">AcceptPageBreak</span> (line <span class="line-number">1949</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Whenever a page break condition is met, the method is called, and the break is issued or not depending on the returned value. The default implementation returns a value according to the mode selected by SetAutoPageBreak().<br /></p>
|
|
<p class="description"><p>This method is called automatically and should not be called directly by the application.<br /> <strong>Example:</strong><br /> The method is overriden in an inherited class in order to obtain a 3 column layout:<br /> <pre> class PDF extends TCPDF {
|
|
var $col=0;
|
|
|
|
public function SetCol($col) {
|
|
//Move position to a column
|
|
$this->col=$col;
|
|
$x=10+$col*65;
|
|
$this->SetLeftMargin($x);
|
|
$this->SetX($x);
|
|
}
|
|
|
|
public function AcceptPageBreak() {
|
|
if($this->col<2) {
|
|
//Go to next column
|
|
$this->SetCol($this->col+1);
|
|
$this->SetY(10);
|
|
return false;
|
|
}
|
|
else {
|
|
//Go back to first column and issue page break
|
|
$this->SetCol(0);
|
|
return true;
|
|
}
|
|
}
|
|
}
|
|
|
|
$pdf=new PDF();
|
|
$pdf->Open();
|
|
$pdf->AddPage();
|
|
$pdf->SetFont('Arial','',12);
|
|
for($i=1;$i<=300;$i++) {
|
|
$pdf->Cell(0,5,"Line $i",0,1);
|
|
}
|
|
$pdf->Output();</pre></p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
<li><span class="field">see:</span> <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetAutoPageBreak">TCPDF::SetAutoPageBreak()</a></li>
|
|
<li><span class="field">since:</span> 1.4</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">boolean</span>
|
|
<span class="method-name">
|
|
AcceptPageBreak
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="methodAddFont" id="AddFont"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">AddFont</span> (line <span class="line-number">1627</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Imports a TrueType or Type1 font and makes it available. It is necessary to generate a font definition file first with the makefont.php utility. The definition file (and the font file itself when embedding) must be present either in the current directory or in the one indicated by FPDF_FONTPATH if the constant is defined. If it could not be found, the error "Could not include font definition file" is generated.</p>
|
|
<p class="description"><p>Support UTF-8 Unicode [Nicola Asuni, 2005-01-02]. <strong>Example</strong>:<br /> <pre> $pdf->AddFont('Comic','I');
|
|
// is equivalent to:
|
|
$pdf->AddFont('Comic','I','comici.php');</pre></p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
<li><span class="field">see:</span> <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetFont">TCPDF::SetFont()</a></li>
|
|
<li><span class="field">since:</span> 1.5</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
AddFont
|
|
</span>
|
|
(<span class="var-type">string</span> <span class="var-name">$family</span>, [<span class="var-type">string</span> <span class="var-name">$style</span> = <span class="var-default">''</span>], [<span class="var-type">string</span> <span class="var-name">$file</span> = <span class="var-default">''</span>])
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$family</span><span class="var-description">: Font family. The name can be chosen arbitrarily. If it is a standard family name, it will override the corresponding font.</span> </li>
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$style</span><span class="var-description">: Font style. Possible values are (case insensitive):<ul><li>empty string: regular (default)</li><li>B: bold</li><li>I: italic</li><li>BI or IB: bold italic</li></ul></span> </li>
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$file</span><span class="var-description">: The font definition file. By default, the name is built from the family and style, in lower case with no space.</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodaddHtmlLink" id="addHtmlLink"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">addHtmlLink</span> (line <span class="line-number">4150</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Output anchor link.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
addHtmlLink
|
|
</span>
|
|
(<span class="var-type">string</span> <span class="var-name">$url</span>, <span class="var-type">string</span> <span class="var-name">$name</span>, <span class="var-type">int</span> <span class="var-name">$fill</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$url</span><span class="var-description">: link URL</span> </li>
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$name</span><span class="var-description">: link name</span> </li>
|
|
<li>
|
|
<span class="var-type">int</span>
|
|
<span class="var-name">$fill</span><span class="var-description">: Indicates if the cell background must be painted (1) or transparent (0). Default value: 0.</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodAddLink" id="AddLink"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">AddLink</span> (line <span class="line-number">1843</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Creates a new internal link and returns its identifier. An internal link is a clickable area which directs to another place within the document.<br /> The identifier can then be passed to Cell(), Write(), Image() or Link(). The destination is defined with SetLink().</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
<li><span class="field">see:</span> <a href="../com.tecnick.tcpdf/TCPDF.html#methodCell">TCPDF::Cell()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodWrite">TCPDF::Write()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodImage">TCPDF::Image()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodLink">TCPDF::Link()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetLink">TCPDF::SetLink()</a></li>
|
|
<li><span class="field">since:</span> 1.5</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
AddLink
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="methodAddPage" id="AddPage"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">AddPage</span> (line <span class="line-number">1228</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Adds a new page to the document. If a page is already present, the Footer() method is called first to output the footer. Then the page is added, the current position set to the top-left corner according to the left and top margins, and Header() is called to display the header.</p>
|
|
<p class="description"><p>The font which was set before calling is automatically restored. There is no need to call SetFont() again if you want to continue with the same font. The same is true for colors and line width. The origin of the coordinate system is at the top-left corner and increasing ordinates go downwards.</p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
<li><span class="field">see:</span> TCPDF(), <a href="../com.tecnick.tcpdf/TCPDF.html#methodHeader">TCPDF::Header()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodFooter">TCPDF::Footer()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetMargins">TCPDF::SetMargins()</a></li>
|
|
<li><span class="field">since:</span> 1.0</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
AddPage
|
|
</span>
|
|
([<span class="var-type">string</span> <span class="var-name">$orientation</span> = <span class="var-default">''</span>])
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$orientation</span><span class="var-description">: Page orientation. Possible values are (case insensitive):<ul><li>P or Portrait</li><li>L or Landscape</li></ul> The default value is the one passed to the constructor.</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodAliasNbPages" id="AliasNbPages"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">AliasNbPages</span> (line <span class="line-number">1170</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Defines an alias for the total number of pages. It will be substituted as the document is closed.<br /></p>
|
|
<p class="description"><p><strong>Example:</strong><br /> <pre> class PDF extends TCPDF {
|
|
public function Footer() {
|
|
//Go to 1.5 cm from bottom
|
|
$this->SetY(-15);
|
|
//Select Arial italic 8
|
|
$this->SetFont('Arial','I',8);
|
|
//Print current and total page numbers
|
|
$this->Cell(0,10,'Page '.$this->PageNo().'/{nb}',0,0,'C');
|
|
}
|
|
}
|
|
$pdf=new PDF();
|
|
$pdf->AliasNbPages();</pre></p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
<li><span class="field">see:</span> <a href="../com.tecnick.tcpdf/TCPDF.html#methodPageNo">TCPDF::PageNo()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodFooter">TCPDF::Footer()</a></li>
|
|
<li><span class="field">since:</span> 1.4</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
AliasNbPages
|
|
</span>
|
|
([<span class="var-type">string</span> <span class="var-name">$alias</span> = <span class="var-default">'{nb}'</span>])
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$alias</span><span class="var-description">: The alias. Default value: {nb}.</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodCell" id="Cell"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">Cell</span> (line <span class="line-number">1969</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Prints a cell (rectangular area) with optional borders, background color and character string. The upper-left corner of the cell corresponds to the current position. The text can be aligned or centered. After the call, the current position moves to the right or to the next line. It is possible to put a link on the text.<br /> If automatic page breaking is enabled and the cell goes beyond the limit, a page break is done before outputting.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
<li><span class="field">see:</span> <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetFont">TCPDF::SetFont()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetDrawColor">TCPDF::SetDrawColor()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetFillColor">TCPDF::SetFillColor()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetTextColor">TCPDF::SetTextColor()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetLineWidth">TCPDF::SetLineWidth()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodAddLink">TCPDF::AddLink()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodLn">TCPDF::Ln()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodMultiCell">TCPDF::MultiCell()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodWrite">TCPDF::Write()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetAutoPageBreak">TCPDF::SetAutoPageBreak()</a></li>
|
|
<li><span class="field">since:</span> 1.0</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
Cell
|
|
</span>
|
|
(<span class="var-type">float</span> <span class="var-name">$w</span>, <span class="var-type">float</span> <span class="var-name">$h</span>, [<span class="var-type">string</span> <span class="var-name">$txt</span> = <span class="var-default">''</span>], <span class="var-type">mixed</span> <span class="var-name">$border</span>, <span class="var-type">int</span> <span class="var-name">$ln</span>, [<span class="var-type">string</span> <span class="var-name">$align</span> = <span class="var-default">''</span>], <span class="var-type">int</span> <span class="var-name">$fill</span>, [<span class="var-type">mixed</span> <span class="var-name">$link</span> = <span class="var-default">''</span>])
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">float</span>
|
|
<span class="var-name">$w</span><span class="var-description">: Cell width. If 0, the cell extends up to the right margin.</span> </li>
|
|
<li>
|
|
<span class="var-type">float</span>
|
|
<span class="var-name">$h</span><span class="var-description">: Cell height. Default value: 0.</span> </li>
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$txt</span><span class="var-description">: String to print. Default value: empty string.</span> </li>
|
|
<li>
|
|
<span class="var-type">mixed</span>
|
|
<span class="var-name">$border</span><span class="var-description">: Indicates if borders must be drawn around the cell. The value can be either a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul>or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul></span> </li>
|
|
<li>
|
|
<span class="var-type">int</span>
|
|
<span class="var-name">$ln</span><span class="var-description">: Indicates where the current position should go after the call. Possible values are:<ul><li>0: to the right</li><li>1: to the beginning of the next line</li><li>2: below</li></ul></span> </li>
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$align</span><span class="var-description">: Allows to center or align the text. Possible values are:<ul><li>L or empty string: left align (default value)</li><li>C: center</li><li>R: right align</li></ul></span> </li>
|
|
<li>
|
|
<span class="var-type">int</span>
|
|
<span class="var-name">$fill</span><span class="var-description">: Indicates if the cell background must be painted (1) or transparent (0). Default value: 0.</span> </li>
|
|
<li>
|
|
<span class="var-type">mixed</span>
|
|
<span class="var-name">$link</span><span class="var-description">: URL or identifier returned by AddLink().</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodClose" id="Close"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">Close</span> (line <span class="line-number">1202</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Terminates the PDF document. It is not necessary to call this method explicitly because Output() does it automatically. If the document contains no page, AddPage() is called to prevent from getting an invalid document.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
<li><span class="field">see:</span> <a href="../com.tecnick.tcpdf/TCPDF.html#methodOpen">TCPDF::Open()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodOutput">TCPDF::Output()</a></li>
|
|
<li><span class="field">since:</span> 1.0</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
Close
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="methodclosedHTMLTagHandler" id="closedHTMLTagHandler"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">closedHTMLTagHandler</span> (line <span class="line-number">4016</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Process closing tags.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> private</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
closedHTMLTagHandler
|
|
</span>
|
|
(<span class="var-type">string</span> <span class="var-name">$tag</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$tag</span><span class="var-description">: tag name (in uppercase)</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodconvertColorHexToDec" id="convertColorHexToDec"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">convertColorHexToDec</span> (line <span class="line-number">4166</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Returns an associative array (keys: R,G,B) from a hex html code (e.g. #3FE5AA).</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> private</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">array</span>
|
|
<span class="method-name">
|
|
convertColorHexToDec
|
|
</span>
|
|
([<span class="var-type">string</span> <span class="var-name">$color</span> = <span class="var-default">"#000000"</span>])
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$color</span><span class="var-description">: hexadecimal html color [#rrggbb]</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodError" id="Error"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">Error</span> (line <span class="line-number">1181</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">This method is automatically called in case of fatal error; it simply outputs the message and halts the execution. An inherited class may override it to customize the error handling but should always halt the script, or the resulting document would probably be invalid.</p>
|
|
<p class="description"><p>2004-06-11 :: Nicola Asuni : changed bold tag with strong</p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
<li><span class="field">since:</span> 1.0</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
Error
|
|
</span>
|
|
(<span class="var-type">string</span> <span class="var-name">$msg</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$msg</span><span class="var-description">: The error message</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodFooter" id="Footer"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">Footer</span> (line <span class="line-number">1400</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">This method is used to render the page footer.</p>
|
|
<p class="description"><p>It is automatically called by AddPage() and could be overwritten in your own inherited class.</p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
Footer
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="methodgetBreakMargin" id="getBreakMargin"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">getBreakMargin</span> (line <span class="line-number">974</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Returns the page break margin.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> page break margin.</li>
|
|
<li><span class="field">access:</span> public</li>
|
|
<li><span class="field">since:</span> 1.5.2</li>
|
|
<li><span class="field">author:</span> Nicola Asuni</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">int</span>
|
|
<span class="method-name">
|
|
getBreakMargin
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="methodgetImageScale" id="getImageScale"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">getImageScale</span> (line <span class="line-number">944</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Returns the image scale.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> image scale.</li>
|
|
<li><span class="field">access:</span> public</li>
|
|
<li><span class="field">since:</span> 1.5.2</li>
|
|
<li><span class="field">author:</span> Nicola Asuni</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">float</span>
|
|
<span class="method-name">
|
|
getImageScale
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="methodgetPageHeight" id="getPageHeight"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">getPageHeight</span> (line <span class="line-number">964</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Returns the page height in units.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> page height.</li>
|
|
<li><span class="field">access:</span> public</li>
|
|
<li><span class="field">since:</span> 1.5.2</li>
|
|
<li><span class="field">author:</span> Nicola Asuni</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">int</span>
|
|
<span class="method-name">
|
|
getPageHeight
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="methodgetPageWidth" id="getPageWidth"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">getPageWidth</span> (line <span class="line-number">954</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Returns the page width in units.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> page width.</li>
|
|
<li><span class="field">access:</span> public</li>
|
|
<li><span class="field">since:</span> 1.5.2</li>
|
|
<li><span class="field">author:</span> Nicola Asuni</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">int</span>
|
|
<span class="method-name">
|
|
getPageWidth
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="methodgetPDFData" id="getPDFData"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">getPDFData</span> (line <span class="line-number">3648</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Returns the PDF data.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
getPDFData
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="methodgetScaleFactor" id="getScaleFactor"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">getScaleFactor</span> (line <span class="line-number">984</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Returns the scale factor (number of points in user unit).</p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> scale factor.</li>
|
|
<li><span class="field">access:</span> public</li>
|
|
<li><span class="field">since:</span> 1.5.2</li>
|
|
<li><span class="field">author:</span> Nicola Asuni</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">int</span>
|
|
<span class="method-name">
|
|
getScaleFactor
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="methodGetStringWidth" id="GetStringWidth"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">GetStringWidth</span> (line <span class="line-number">1527</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Returns the length of a string in user unit. A font must be selected.<br /></p>
|
|
<p class="description"><p>Support UTF-8 Unicode [Nicola Asuni, 2005-01-02]</p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
<li><span class="field">since:</span> 1.2</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">int</span>
|
|
<span class="method-name">
|
|
GetStringWidth
|
|
</span>
|
|
(<span class="var-type">string</span> <span class="var-name">$s</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$s</span><span class="var-description">: The string whose length is to be computed</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodGetX" id="GetX"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">GetX</span> (line <span class="line-number">2409</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Returns the abscissa of the current position.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
<li><span class="field">see:</span> <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetX">TCPDF::SetX()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodGetY">TCPDF::GetY()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetY">TCPDF::SetY()</a></li>
|
|
<li><span class="field">since:</span> 1.2</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">float</span>
|
|
<span class="method-name">
|
|
GetX
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="methodGetY" id="GetY"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">GetY</span> (line <span class="line-number">2436</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Returns the ordinate of the current position.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
<li><span class="field">see:</span> <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetY">TCPDF::SetY()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodGetX">TCPDF::GetX()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetX">TCPDF::SetX()</a></li>
|
|
<li><span class="field">since:</span> 1.0</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">float</span>
|
|
<span class="method-name">
|
|
GetY
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="methodHeader" id="Header"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">Header</span> (line <span class="line-number">1347</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">This method is used to render the page header.</p>
|
|
<p class="description"><p>It is automatically called by AddPage() and could be overwritten in your own inherited class.</p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
Header
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="methodImage" id="Image"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">Image</span> (line <span class="line-number">2327</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Puts an image in the page. The upper-left corner must be given. The dimensions can be specified in different ways:<ul><li>explicit width and height (expressed in user unit)</li><li>one explicit dimension, the other being calculated automatically in order to keep the original proportions</li><li>no explicit dimension, in which case the image is put at 72 dpi</li></ul> Supported formats are JPEG and PNG.</p>
|
|
<p class="description"><p>For JPEG, all flavors are allowed:<ul><li>gray scales</li><li>true colors (24 bits)</li><li>CMYK (32 bits)</li></ul> For PNG, are allowed:<ul><li>gray scales on at most 8 bits (256 levels)</li><li>indexed colors</li><li>true colors (24 bits)</li></ul> but are not supported:<ul><li>Interlacing</li><li>Alpha channel</li></ul> If a transparent color is defined, it will be taken into account (but will be only interpreted by Acrobat 4 and above).<br /> The format can be specified explicitly or inferred from the file extension.<br /> It is possible to put a link on the image.<br /> Remark: if an image is used several times, only one copy will be embedded in the file.<br /></p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
<li><span class="field">see:</span> <a href="../com.tecnick.tcpdf/TCPDF.html#methodAddLink">TCPDF::AddLink()</a></li>
|
|
<li><span class="field">since:</span> 1.1</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
Image
|
|
</span>
|
|
(<span class="var-type">string</span> <span class="var-name">$file</span>, <span class="var-type">float</span> <span class="var-name">$x</span>, <span class="var-type">float</span> <span class="var-name">$y</span>, <span class="var-type">float</span> <span class="var-name">$w</span>, <span class="var-type">float</span> <span class="var-name">$h</span>, [<span class="var-type">string</span> <span class="var-name">$type</span> = <span class="var-default">''</span>], [<span class="var-type">mixed</span> <span class="var-name">$link</span> = <span class="var-default">''</span>])
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$file</span><span class="var-description">: Name of the file containing the image.</span> </li>
|
|
<li>
|
|
<span class="var-type">float</span>
|
|
<span class="var-name">$x</span><span class="var-description">: Abscissa of the upper-left corner.</span> </li>
|
|
<li>
|
|
<span class="var-type">float</span>
|
|
<span class="var-name">$y</span><span class="var-description">: Ordinate of the upper-left corner.</span> </li>
|
|
<li>
|
|
<span class="var-type">float</span>
|
|
<span class="var-name">$w</span><span class="var-description">: Width of the image in the page. If not specified or equal to zero, it is automatically calculated.</span> </li>
|
|
<li>
|
|
<span class="var-type">float</span>
|
|
<span class="var-name">$h</span><span class="var-description">: Height of the image in the page. If not specified or equal to zero, it is automatically calculated.</span> </li>
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$type</span><span class="var-description">: Image format. Possible values are (case insensitive): JPG, JPEG, PNG. If not specified, the type is inferred from the file extension.</span> </li>
|
|
<li>
|
|
<span class="var-type">mixed</span>
|
|
<span class="var-name">$link</span><span class="var-description">: URL or identifier returned by AddLink().</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodLine" id="Line"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">Line</span> (line <span class="line-number">1583</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Draws a line between two points.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
<li><span class="field">see:</span> <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetLineWidth">TCPDF::SetLineWidth()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetDrawColor">TCPDF::SetDrawColor()</a></li>
|
|
<li><span class="field">since:</span> 1.0</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
Line
|
|
</span>
|
|
(<span class="var-type">float</span> <span class="var-name">$x1</span>, <span class="var-type">float</span> <span class="var-name">$y1</span>, <span class="var-type">float</span> <span class="var-name">$x2</span>, <span class="var-type">float</span> <span class="var-name">$y2</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">float</span>
|
|
<span class="var-name">$x1</span><span class="var-description">: Abscissa of first point</span> </li>
|
|
<li>
|
|
<span class="var-type">float</span>
|
|
<span class="var-name">$y1</span><span class="var-description">: Ordinate of first point</span> </li>
|
|
<li>
|
|
<span class="var-type">float</span>
|
|
<span class="var-name">$x2</span><span class="var-description">: Abscissa of second point</span> </li>
|
|
<li>
|
|
<span class="var-type">float</span>
|
|
<span class="var-name">$y2</span><span class="var-description">: Ordinate of second point</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodLink" id="Link"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">Link</span> (line <span class="line-number">1879</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Puts a link on a rectangular area of the page. Text or image links are generally put via Cell(), Write() or Image(), but this method can be useful for instance to define a clickable area inside an image.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
<li><span class="field">see:</span> <a href="../com.tecnick.tcpdf/TCPDF.html#methodAddLink">TCPDF::AddLink()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodCell">TCPDF::Cell()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodWrite">TCPDF::Write()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodImage">TCPDF::Image()</a></li>
|
|
<li><span class="field">since:</span> 1.5</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
Link
|
|
</span>
|
|
(<span class="var-type">float</span> <span class="var-name">$x</span>, <span class="var-type">float</span> <span class="var-name">$y</span>, <span class="var-type">float</span> <span class="var-name">$w</span>, <span class="var-type">float</span> <span class="var-name">$h</span>, <span class="var-type">mixed</span> <span class="var-name">$link</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">float</span>
|
|
<span class="var-name">$x</span><span class="var-description">: Abscissa of the upper-left corner of the rectangle</span> </li>
|
|
<li>
|
|
<span class="var-type">float</span>
|
|
<span class="var-name">$y</span><span class="var-description">: Ordinate of the upper-left corner of the rectangle</span> </li>
|
|
<li>
|
|
<span class="var-type">float</span>
|
|
<span class="var-name">$w</span><span class="var-description">: Width of the rectangle</span> </li>
|
|
<li>
|
|
<span class="var-type">float</span>
|
|
<span class="var-name">$h</span><span class="var-description">: Height of the rectangle</span> </li>
|
|
<li>
|
|
<span class="var-type">mixed</span>
|
|
<span class="var-name">$link</span><span class="var-description">: URL or identifier returned by AddLink()</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodLn" id="Ln"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">Ln</span> (line <span class="line-number">2392</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Performs a line break. The current abscissa goes back to the left margin and the ordinate increases by the amount passed in parameter.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
<li><span class="field">see:</span> <a href="../com.tecnick.tcpdf/TCPDF.html#methodCell">TCPDF::Cell()</a></li>
|
|
<li><span class="field">since:</span> 1.0</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
Ln
|
|
</span>
|
|
([<span class="var-type">float</span> <span class="var-name">$h</span> = <span class="var-default">''</span>])
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">float</span>
|
|
<span class="var-name">$h</span><span class="var-description">: The height of the break. By default, the value equals the height of the last printed cell.</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodMultiCell" id="MultiCell"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">MultiCell</span> (line <span class="line-number">2071</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">This method allows printing text with line breaks. They can be automatic (as soon as the text reaches the right border of the cell) or explicit (via the \n character). As many cells as necessary are output, one below the other.<br /> Text can be aligned, centered or justified. The cell block can be framed and the background painted.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
<li><span class="field">see:</span> <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetFont">TCPDF::SetFont()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetDrawColor">TCPDF::SetDrawColor()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetFillColor">TCPDF::SetFillColor()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetTextColor">TCPDF::SetTextColor()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetLineWidth">TCPDF::SetLineWidth()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodCell">TCPDF::Cell()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodWrite">TCPDF::Write()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetAutoPageBreak">TCPDF::SetAutoPageBreak()</a></li>
|
|
<li><span class="field">since:</span> 1.3</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
MultiCell
|
|
</span>
|
|
(<span class="var-type">float</span> <span class="var-name">$w</span>, <span class="var-type">float</span> <span class="var-name">$h</span>, <span class="var-type">string</span> <span class="var-name">$txt</span>, <span class="var-type">mixed</span> <span class="var-name">$border</span>, [<span class="var-type">string</span> <span class="var-name">$align</span> = <span class="var-default">'J'</span>], <span class="var-type">int</span> <span class="var-name">$fill</span>, [<span class="var-type">int</span> <span class="var-name">$ln</span> = <span class="var-default">1</span>])
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">float</span>
|
|
<span class="var-name">$w</span><span class="var-description">: Width of cells. If 0, they extend up to the right margin of the page.</span> </li>
|
|
<li>
|
|
<span class="var-type">float</span>
|
|
<span class="var-name">$h</span><span class="var-description">: Height of cells.</span> </li>
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$txt</span><span class="var-description">: String to print</span> </li>
|
|
<li>
|
|
<span class="var-type">mixed</span>
|
|
<span class="var-name">$border</span><span class="var-description">: Indicates if borders must be drawn around the cell block. The value can be either a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul>or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul></span> </li>
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$align</span><span class="var-description">: Allows to center or align the text. Possible values are:<ul><li>L or empty string: left align</li><li>C: center</li><li>R: right align</li><li>J: justification (default value)</li></ul></span> </li>
|
|
<li>
|
|
<span class="var-type">int</span>
|
|
<span class="var-name">$fill</span><span class="var-description">: Indicates if the cell background must be painted (1) or transparent (0). Default value: 0.</span> </li>
|
|
<li>
|
|
<span class="var-type">int</span>
|
|
<span class="var-name">$ln</span><span class="var-description">: Indicates where the current position should go after the call. Possible values are:<ul><li>0: to the right</li><li>1: to the beginning of the next line [DEFAULT]</li><li>2: below</li></ul></span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodOpen" id="Open"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">Open</span> (line <span class="line-number">1192</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">This method begins the generation of the PDF document. It is not necessary to call it explicitly because AddPage() does it automatically.</p>
|
|
<p class="description"><p>Note: no page is created by this method</p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
<li><span class="field">see:</span> <a href="../com.tecnick.tcpdf/TCPDF.html#methodAddPage">TCPDF::AddPage()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodClose">TCPDF::Close()</a></li>
|
|
<li><span class="field">since:</span> 1.0</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
Open
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="methodopenHTMLTagHandler" id="openHTMLTagHandler"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">openHTMLTagHandler</span> (line <span class="line-number">3811</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Process opening tags.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> private</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
openHTMLTagHandler
|
|
</span>
|
|
(<span class="var-type">string</span> <span class="var-name">$tag</span>, <span class="var-type">string</span> <span class="var-name">$attr</span>, <span class="var-type">int</span> <span class="var-name">$fill</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$tag</span><span class="var-description">: tag name (in uppercase)</span> </li>
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$attr</span><span class="var-description">: tag attribute (in uppercase)</span> </li>
|
|
<li>
|
|
<span class="var-type">int</span>
|
|
<span class="var-name">$fill</span><span class="var-description">: Indicates if the cell background must be painted (1) or transparent (0). Default value: 0.</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodOutput" id="Output"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">Output</span> (line <span class="line-number">2479</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Send the document to a given destination: string, local file or browser. In the last case, the plug-in may be used (if present) or a download ("Save as" dialog box) may be forced.<br /> The method first calls Close() if necessary to terminate the document.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
<li><span class="field">see:</span> <a href="../com.tecnick.tcpdf/TCPDF.html#methodClose">TCPDF::Close()</a></li>
|
|
<li><span class="field">since:</span> 1.0</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
Output
|
|
</span>
|
|
([<span class="var-type">string</span> <span class="var-name">$name</span> = <span class="var-default">''</span>], [<span class="var-type">string</span> <span class="var-name">$dest</span> = <span class="var-default">''</span>])
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$name</span><span class="var-description">: The name of the file. If not given, the document will be sent to the browser (destination I) with the name doc.pdf.</span> </li>
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$dest</span><span class="var-description">: Destination where to send the document. It can take one of the following values:<ul><li>I: send the file inline to the browser. The plug-in is used if available. The name given by name is used when one selects the "Save as" option on the link generating the PDF.</li><li>D: send to the browser and force a file download with the name given by name.</li><li>F: save to a local file with the name given by name.</li><li>S: return the document as a string. name is ignored.</li></ul>If the parameter is not specified but a name is given, destination is F. If no parameter is specified at all, destination is I.<br />Note: for compatibility with previous versions, a boolean value is also accepted (false for F and true for D).</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodPageNo" id="PageNo"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">PageNo</span> (line <span class="line-number">1443</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Returns the current page number.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> page number</li>
|
|
<li><span class="field">access:</span> public</li>
|
|
<li><span class="field">see:</span> <a href="../com.tecnick.tcpdf/TCPDF.html#methodAliasNbPages">TCPDF::AliasNbPages()</a></li>
|
|
<li><span class="field">since:</span> 1.0</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">int</span>
|
|
<span class="method-name">
|
|
PageNo
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="methodpixelsToMillimeters" id="pixelsToMillimeters"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">pixelsToMillimeters</span> (line <span class="line-number">4180</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Converts pixels to millimeters in 72 dpi.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> millimeters</li>
|
|
<li><span class="field">access:</span> private</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">float</span>
|
|
<span class="method-name">
|
|
pixelsToMillimeters
|
|
</span>
|
|
(<span class="var-type">int</span> <span class="var-name">$px</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">int</span>
|
|
<span class="var-name">$px</span><span class="var-description">: pixels</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodRect" id="Rect"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">Rect</span> (line <span class="line-number">1598</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Outputs a rectangle. It can be drawn (border only), filled (with no border) or both.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
<li><span class="field">see:</span> <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetLineWidth">TCPDF::SetLineWidth()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetDrawColor">TCPDF::SetDrawColor()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetFillColor">TCPDF::SetFillColor()</a></li>
|
|
<li><span class="field">since:</span> 1.0</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
Rect
|
|
</span>
|
|
(<span class="var-type">float</span> <span class="var-name">$x</span>, <span class="var-type">float</span> <span class="var-name">$y</span>, <span class="var-type">float</span> <span class="var-name">$w</span>, <span class="var-type">float</span> <span class="var-name">$h</span>, [<span class="var-type">string</span> <span class="var-name">$style</span> = <span class="var-default">''</span>])
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">float</span>
|
|
<span class="var-name">$x</span><span class="var-description">: Abscissa of upper-left corner</span> </li>
|
|
<li>
|
|
<span class="var-type">float</span>
|
|
<span class="var-name">$y</span><span class="var-description">: Ordinate of upper-left corner</span> </li>
|
|
<li>
|
|
<span class="var-type">float</span>
|
|
<span class="var-name">$w</span><span class="var-description">: Width</span> </li>
|
|
<li>
|
|
<span class="var-type">float</span>
|
|
<span class="var-name">$h</span><span class="var-description">: Height</span> </li>
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$style</span><span class="var-description">: Style of rendering. Possible values are:<ul><li>D or empty string: draw (default)</li><li>F: fill</li><li>DF or FD: draw and fill</li></ul></span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodSetAuthor" id="SetAuthor"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">SetAuthor</span> (line <span class="line-number">1122</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Defines the author of the document.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
<li><span class="field">see:</span> <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetCreator">TCPDF::SetCreator()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetKeywords">TCPDF::SetKeywords()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetSubject">TCPDF::SetSubject()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetTitle">TCPDF::SetTitle()</a></li>
|
|
<li><span class="field">since:</span> 1.2</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
SetAuthor
|
|
</span>
|
|
(<span class="var-type">string</span> <span class="var-name">$author</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$author</span><span class="var-description">: The name of the author.</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodSetAutoPageBreak" id="SetAutoPageBreak"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">SetAutoPageBreak</span> (line <span class="line-number">1049</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Enables or disables the automatic page breaking mode. When enabling, the second parameter is the distance from the bottom of the page that defines the triggering limit. By default, the mode is on and the margin is 2 cm.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
<li><span class="field">see:</span> <a href="../com.tecnick.tcpdf/TCPDF.html#methodCell">TCPDF::Cell()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodMultiCell">TCPDF::MultiCell()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodAcceptPageBreak">TCPDF::AcceptPageBreak()</a></li>
|
|
<li><span class="field">since:</span> 1.0</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
SetAutoPageBreak
|
|
</span>
|
|
(<span class="var-type">boolean</span> <span class="var-name">$auto</span>, <span class="var-type">float</span> <span class="var-name">$margin</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">boolean</span>
|
|
<span class="var-name">$auto</span><span class="var-description">: Boolean indicating if mode should be on or off.</span> </li>
|
|
<li>
|
|
<span class="var-type">float</span>
|
|
<span class="var-name">$margin</span><span class="var-description">: Distance from the bottom of the page.</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodsetBarcode" id="setBarcode"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">setBarcode</span> (line <span class="line-number">3565</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Set document barcode.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
setBarcode
|
|
</span>
|
|
([<span class="var-type">string</span> <span class="var-name">$bc</span> = <span class="var-default">""</span>])
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$bc</span><span class="var-description">: barcode</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodSetCompression" id="SetCompression"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">SetCompression</span> (line <span class="line-number">1084</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Activates or deactivates page compression. When activated, the internal representation of each page is compressed, which leads to a compression ratio of about 2 for the resulting document. Compression is on by default.</p>
|
|
<p class="description"><p>Note: the Zlib extension is required for this feature. If not present, compression will be turned off.</p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
<li><span class="field">since:</span> 1.4</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
SetCompression
|
|
</span>
|
|
(<span class="var-type">boolean</span> <span class="var-name">$compress</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">boolean</span>
|
|
<span class="var-name">$compress</span><span class="var-description">: Boolean indicating if compression must be enabled.</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodSetCreator" id="SetCreator"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">SetCreator</span> (line <span class="line-number">1144</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Defines the creator of the document. This is typically the name of the application that generates the PDF.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
<li><span class="field">see:</span> <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetAuthor">TCPDF::SetAuthor()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetKeywords">TCPDF::SetKeywords()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetSubject">TCPDF::SetSubject()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetTitle">TCPDF::SetTitle()</a></li>
|
|
<li><span class="field">since:</span> 1.2</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
SetCreator
|
|
</span>
|
|
(<span class="var-type">string</span> <span class="var-name">$creator</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$creator</span><span class="var-description">: The name of the creator.</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodSetDisplayMode" id="SetDisplayMode"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">SetDisplayMode</span> (line <span class="line-number">1062</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Defines the way the document is to be displayed by the viewer. The zoom level can be set: pages can be displayed entirely on screen, occupy the full width of the window, use real size, be scaled by a specific zooming factor or use viewer default (configured in the Preferences menu of Acrobat). The page layout can be specified too: single at once, continuous display, two columns or viewer default. By default, documents use the full width mode with continuous display.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
<li><span class="field">since:</span> 1.2</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
SetDisplayMode
|
|
</span>
|
|
(<span class="var-type">mixed</span> <span class="var-name">$zoom</span>, [<span class="var-type">string</span> <span class="var-name">$layout</span> = <span class="var-default">'continuous'</span>])
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">mixed</span>
|
|
<span class="var-name">$zoom</span><span class="var-description">: The zoom to use. It can be one of the following string values or a number indicating the zooming factor to use. <ul><li>fullpage: displays the entire page on screen</li><li>fullwidth: uses maximum width of window</li><li>real: uses real size (equivalent to 100% zoom)</li><li>default: uses viewer default mode</li></ul></span> </li>
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$layout</span><span class="var-description">: The page layout. Possible values are:<ul><li>single: displays one page at once</li><li>continuous: displays pages continuously (default)</li><li>two: displays two pages on two columns</li><li>default: uses viewer default mode</li></ul></span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodSetDrawColor" id="SetDrawColor"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">SetDrawColor</span> (line <span class="line-number">1456</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Defines the color used for all drawing operations (lines, rectangles and cell borders). It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
<li><span class="field">see:</span> <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetFillColor">TCPDF::SetFillColor()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetTextColor">TCPDF::SetTextColor()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodLine">TCPDF::Line()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodRect">TCPDF::Rect()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodCell">TCPDF::Cell()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodMultiCell">TCPDF::MultiCell()</a></li>
|
|
<li><span class="field">since:</span> 1.3</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
SetDrawColor
|
|
</span>
|
|
(<span class="var-type">int</span> <span class="var-name">$r</span>, [<span class="var-type">int</span> <span class="var-name">$g</span> = <span class="var-default">-1</span>], [<span class="var-type">int</span> <span class="var-name">$b</span> = <span class="var-default">-1</span>])
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">int</span>
|
|
<span class="var-name">$r</span><span class="var-description">: If g et b are given, red component; if not, indicates the gray level. Value between 0 and 255</span> </li>
|
|
<li>
|
|
<span class="var-type">int</span>
|
|
<span class="var-name">$g</span><span class="var-description">: Green component (between 0 and 255)</span> </li>
|
|
<li>
|
|
<span class="var-type">int</span>
|
|
<span class="var-name">$b</span><span class="var-description">: Blue component (between 0 and 255)</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodSetFillColor" id="SetFillColor"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">SetFillColor</span> (line <span class="line-number">1478</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Defines the color used for all filling operations (filled rectangles and cell backgrounds). It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
<li><span class="field">see:</span> <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetDrawColor">TCPDF::SetDrawColor()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetTextColor">TCPDF::SetTextColor()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodRect">TCPDF::Rect()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodCell">TCPDF::Cell()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodMultiCell">TCPDF::MultiCell()</a></li>
|
|
<li><span class="field">since:</span> 1.3</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
SetFillColor
|
|
</span>
|
|
(<span class="var-type">int</span> <span class="var-name">$r</span>, [<span class="var-type">int</span> <span class="var-name">$g</span> = <span class="var-default">-1</span>], [<span class="var-type">int</span> <span class="var-name">$b</span> = <span class="var-default">-1</span>], [<span class="var-type">boolean</span> <span class="var-name">$storeprev</span> = <span class="var-default">false</span>])
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">int</span>
|
|
<span class="var-name">$r</span><span class="var-description">: If g et b are given, red component; if not, indicates the gray level. Value between 0 and 255</span> </li>
|
|
<li>
|
|
<span class="var-type">int</span>
|
|
<span class="var-name">$g</span><span class="var-description">: Green component (between 0 and 255)</span> </li>
|
|
<li>
|
|
<span class="var-type">int</span>
|
|
<span class="var-name">$b</span><span class="var-description">: Blue component (between 0 and 255)</span> </li>
|
|
<li>
|
|
<span class="var-type">boolean</span>
|
|
<span class="var-name">$storeprev</span><span class="var-description">: if true stores the RGB array on $prevFillColor variable.</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodSetFont" id="SetFont"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">SetFont</span> (line <span class="line-number">1726</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Sets the font used to print character strings. It is mandatory to call this method at least once before printing text or the resulting document would not be valid.</p>
|
|
<p class="description"><p>The font can be either a standard one or a font added via the AddFont() method. Standard fonts use Windows encoding cp1252 (Western Europe). The method can be called before the first page is created and the font is retained from page to page. Note: for the standard fonts, the font metric files must be accessible. There are three possibilities for this:<ul><li>They are in the current directory (the one where the running script lies)</li><li>They are in one of the directories defined by the include_path parameter</li><li>They are in the directory defined by the FPDF_FONTPATH constant</li></ul><br /> Example for the last case (note the trailing slash):<br /> <pre> define('FPDF_FONTPATH','/home/www/font/');
|
|
require('tcpdf.php');
|
|
|
|
//Times regular 12
|
|
$pdf->SetFont('Times');
|
|
//Arial bold 14
|
|
$pdf->SetFont('Arial','B',14);
|
|
//Removes bold
|
|
$pdf->SetFont('');
|
|
//Times bold, italic and underlined 14
|
|
$pdf->SetFont('Times','BIU');</pre><br /> If the file corresponding to the requested font is not found, the error "Could not include font metric file" is generated.</p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
<li><span class="field">see:</span> <a href="../com.tecnick.tcpdf/TCPDF.html#methodAddFont">TCPDF::AddFont()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetFontSize">TCPDF::SetFontSize()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodCell">TCPDF::Cell()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodMultiCell">TCPDF::MultiCell()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodWrite">TCPDF::Write()</a></li>
|
|
<li><span class="field">since:</span> 1.0</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
SetFont
|
|
</span>
|
|
(<span class="var-type">string</span> <span class="var-name">$family</span>, [<span class="var-type">string</span> <span class="var-name">$style</span> = <span class="var-default">''</span>], <span class="var-type">float</span> <span class="var-name">$size</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$family</span><span class="var-description">: Family font. It can be either a name defined by AddFont() or one of the standard families (case insensitive):<ul><li>Courier (fixed-width)</li><li>Helvetica or Arial (synonymous; sans serif)</li><li>Times (serif)</li><li>Symbol (symbolic)</li><li>ZapfDingbats (symbolic)</li></ul>It is also possible to pass an empty string. In that case, the current family is retained.</span> </li>
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$style</span><span class="var-description">: Font style. Possible values are (case insensitive):<ul><li>empty string: regular</li><li>B: bold</li><li>I: italic</li><li>U: underline</li></ul>or any combination. The default value is regular. Bold and italic styles do not apply to Symbol and ZapfDingbats</span> </li>
|
|
<li>
|
|
<span class="var-type">float</span>
|
|
<span class="var-name">$size</span><span class="var-description">: Font size in points. The default value is the current size. If no size has been specified since the beginning of the document, the value taken is 12</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodSetFontSize" id="SetFontSize"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">SetFontSize</span> (line <span class="line-number">1825</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Defines the size of the current font.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
<li><span class="field">see:</span> <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetFont">TCPDF::SetFont()</a></li>
|
|
<li><span class="field">since:</span> 1.0</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
SetFontSize
|
|
</span>
|
|
(<span class="var-type">float</span> <span class="var-name">$size</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">float</span>
|
|
<span class="var-name">$size</span><span class="var-description">: The size (in points)</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodsetFooterFont" id="setFooterFont"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">setFooterFont</span> (line <span class="line-number">3548</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Set footer font.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
<li><span class="field">since:</span> 1.1</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
setFooterFont
|
|
</span>
|
|
(<span class="var-type">array</span> <span class="var-name">$font</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">array</span>
|
|
<span class="var-name">$font</span><span class="var-description">: font</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodsetFooterMargin" id="setFooterMargin"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">setFooterMargin</span> (line <span class="line-number">1323</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Set footer margin.</p>
|
|
<p class="description"><p>(minimum distance between footer and bottom page margin)</p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
setFooterMargin
|
|
</span>
|
|
([<span class="var-type">int</span> <span class="var-name">$fm</span> = <span class="var-default">10</span>])
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">int</span>
|
|
<span class="var-name">$fm</span><span class="var-description">: distance in millimeters</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodsetHeaderData" id="setHeaderData"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">setHeaderData</span> (line <span class="line-number">1302</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Set header data.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
setHeaderData
|
|
</span>
|
|
([<span class="var-type">string</span> <span class="var-name">$ln</span> = <span class="var-default">""</span>], <span class="var-type">string</span> <span class="var-name">$lw</span>, [<span class="var-type">string</span> <span class="var-name">$ht</span> = <span class="var-default">""</span>], [<span class="var-type">string</span> <span class="var-name">$hs</span> = <span class="var-default">""</span>])
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$ln</span><span class="var-description">: header image logo</span> </li>
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$lw</span><span class="var-description">: header image logo width in mm</span> </li>
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$ht</span><span class="var-description">: string to print as title on document header</span> </li>
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$hs</span><span class="var-description">: string to print on document header</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodsetHeaderFont" id="setHeaderFont"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">setHeaderFont</span> (line <span class="line-number">3539</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Set header font.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
<li><span class="field">since:</span> 1.1</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
setHeaderFont
|
|
</span>
|
|
(<span class="var-type">array</span> <span class="var-name">$font</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">array</span>
|
|
<span class="var-name">$font</span><span class="var-description">: font</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodsetHeaderMargin" id="setHeaderMargin"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">setHeaderMargin</span> (line <span class="line-number">1314</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Set header margin.</p>
|
|
<p class="description"><p>(minimum distance between header and top page margin)</p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
setHeaderMargin
|
|
</span>
|
|
([<span class="var-type">int</span> <span class="var-name">$hm</span> = <span class="var-default">10</span>])
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">int</span>
|
|
<span class="var-name">$hm</span><span class="var-description">: distance in millimeters</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodsetImageScale" id="setImageScale"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">setImageScale</span> (line <span class="line-number">934</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Set the image scale.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
<li><span class="field">since:</span> 1.5.2</li>
|
|
<li><span class="field">author:</span> Nicola Asuni</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
setImageScale
|
|
</span>
|
|
(<span class="var-type">float</span> <span class="var-name">$scale</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">float</span>
|
|
<span class="var-name">$scale</span><span class="var-description">: image scale.</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodSetKeywords" id="SetKeywords"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">SetKeywords</span> (line <span class="line-number">1133</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Associates keywords with the document, generally in the form 'keyword1 keyword2 ...'.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
<li><span class="field">see:</span> <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetAuthor">TCPDF::SetAuthor()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetCreator">TCPDF::SetCreator()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetSubject">TCPDF::SetSubject()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetTitle">TCPDF::SetTitle()</a></li>
|
|
<li><span class="field">since:</span> 1.2</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
SetKeywords
|
|
</span>
|
|
(<span class="var-type">string</span> <span class="var-name">$keywords</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$keywords</span><span class="var-description">: The list of keywords.</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodsetLanguageArray" id="setLanguageArray"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">setLanguageArray</span> (line <span class="line-number">3557</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Set language array.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
<li><span class="field">since:</span> 1.1</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
setLanguageArray
|
|
</span>
|
|
(<span class="var-type">array</span> <span class="var-name">$language</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">array</span>
|
|
<span class="var-name">$language</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodSetLeftMargin" id="SetLeftMargin"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">SetLeftMargin</span> (line <span class="line-number">1012</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Defines the left margin. The method can be called before creating the first page. If the current abscissa gets out of page, it is brought back to the margin.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
<li><span class="field">see:</span> <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetTopMargin">TCPDF::SetTopMargin()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetRightMargin">TCPDF::SetRightMargin()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetAutoPageBreak">TCPDF::SetAutoPageBreak()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetMargins">TCPDF::SetMargins()</a></li>
|
|
<li><span class="field">since:</span> 1.4</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
SetLeftMargin
|
|
</span>
|
|
(<span class="var-type">float</span> <span class="var-name">$margin</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">float</span>
|
|
<span class="var-name">$margin</span><span class="var-description">: The margin.</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodSetLineWidth" id="SetLineWidth"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">SetLineWidth</span> (line <span class="line-number">1566</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Defines the line width. By default, the value equals 0.2 mm. The method can be called before the first page is created and the value is retained from page to page.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
<li><span class="field">see:</span> <a href="../com.tecnick.tcpdf/TCPDF.html#methodLine">TCPDF::Line()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodRect">TCPDF::Rect()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodCell">TCPDF::Cell()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodMultiCell">TCPDF::MultiCell()</a></li>
|
|
<li><span class="field">since:</span> 1.0</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
SetLineWidth
|
|
</span>
|
|
(<span class="var-type">float</span> <span class="var-name">$width</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">float</span>
|
|
<span class="var-name">$width</span><span class="var-description">: The width.</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodSetLink" id="SetLink"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">SetLink</span> (line <span class="line-number">1858</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Defines the page and position a link points to</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
<li><span class="field">see:</span> <a href="../com.tecnick.tcpdf/TCPDF.html#methodAddLink">TCPDF::AddLink()</a></li>
|
|
<li><span class="field">since:</span> 1.5</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
SetLink
|
|
</span>
|
|
(<span class="var-type">int</span> <span class="var-name">$link</span>, <span class="var-type">float</span> <span class="var-name">$y</span>, [<span class="var-type">int</span> <span class="var-name">$page</span> = <span class="var-default">-1</span>])
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">int</span>
|
|
<span class="var-name">$link</span><span class="var-description">: The link identifier returned by AddLink()</span> </li>
|
|
<li>
|
|
<span class="var-type">float</span>
|
|
<span class="var-name">$y</span><span class="var-description">: Ordinate of target position; -1 indicates the current position. The default value is 0 (top of page)</span> </li>
|
|
<li>
|
|
<span class="var-type">int</span>
|
|
<span class="var-name">$page</span><span class="var-description">: Number of target page; -1 indicates the current page. This is the default value</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodSetMargins" id="SetMargins"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">SetMargins</span> (line <span class="line-number">996</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Defines the left, top and right margins. By default, they equal 1 cm. Call this method to change them.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
<li><span class="field">see:</span> <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetLeftMargin">TCPDF::SetLeftMargin()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetTopMargin">TCPDF::SetTopMargin()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetRightMargin">TCPDF::SetRightMargin()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetAutoPageBreak">TCPDF::SetAutoPageBreak()</a></li>
|
|
<li><span class="field">since:</span> 1.0</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
SetMargins
|
|
</span>
|
|
(<span class="var-type">float</span> <span class="var-name">$left</span>, <span class="var-type">float</span> <span class="var-name">$top</span>, [<span class="var-type">float</span> <span class="var-name">$right</span> = <span class="var-default">-1</span>])
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">float</span>
|
|
<span class="var-name">$left</span><span class="var-description">: Left margin.</span> </li>
|
|
<li>
|
|
<span class="var-type">float</span>
|
|
<span class="var-name">$top</span><span class="var-description">: Top margin.</span> </li>
|
|
<li>
|
|
<span class="var-type">float</span>
|
|
<span class="var-name">$right</span><span class="var-description">: Right margin. Default value is the left one.</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodsetPrintFooter" id="setPrintFooter"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">setPrintFooter</span> (line <span class="line-number">1339</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Set a flag to print page footer.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
setPrintFooter
|
|
</span>
|
|
([<span class="var-type">mixed</span> <span class="var-name">$val</span> = <span class="var-default">true</span>], <span class="var-type">boolean</span> <span class="var-name">$value</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">boolean</span>
|
|
<span class="var-name">$value</span><span class="var-description">: set to true to print the page footer (default), false otherwise.</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodsetPrintHeader" id="setPrintHeader"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">setPrintHeader</span> (line <span class="line-number">1331</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Set a flag to print page header.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
setPrintHeader
|
|
</span>
|
|
([<span class="var-type">boolean</span> <span class="var-name">$val</span> = <span class="var-default">true</span>])
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">boolean</span>
|
|
<span class="var-name">$val</span><span class="var-description">: set to true to print the page header (default), false otherwise.</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodSetRightMargin" id="SetRightMargin"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">SetRightMargin</span> (line <span class="line-number">1037</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Defines the right margin. The method can be called before creating the first page.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
<li><span class="field">see:</span> <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetLeftMargin">TCPDF::SetLeftMargin()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetTopMargin">TCPDF::SetTopMargin()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetAutoPageBreak">TCPDF::SetAutoPageBreak()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetMargins">TCPDF::SetMargins()</a></li>
|
|
<li><span class="field">since:</span> 1.5</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
SetRightMargin
|
|
</span>
|
|
(<span class="var-type">float</span> <span class="var-name">$margin</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">float</span>
|
|
<span class="var-name">$margin</span><span class="var-description">: The margin.</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodsetStyle" id="setStyle"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">setStyle</span> (line <span class="line-number">4131</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Sets font style.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> private</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
setStyle
|
|
</span>
|
|
(<span class="var-type">string</span> <span class="var-name">$tag</span>, <span class="var-type">boolean</span> <span class="var-name">$enable</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$tag</span><span class="var-description">: tag name (in lowercase)</span> </li>
|
|
<li>
|
|
<span class="var-type">boolean</span>
|
|
<span class="var-name">$enable</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodSetSubject" id="SetSubject"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">SetSubject</span> (line <span class="line-number">1111</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Defines the subject of the document.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
<li><span class="field">see:</span> <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetAuthor">TCPDF::SetAuthor()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetCreator">TCPDF::SetCreator()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetKeywords">TCPDF::SetKeywords()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetTitle">TCPDF::SetTitle()</a></li>
|
|
<li><span class="field">since:</span> 1.2</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
SetSubject
|
|
</span>
|
|
(<span class="var-type">string</span> <span class="var-name">$subject</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$subject</span><span class="var-description">: The subject.</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodSetTextColor" id="SetTextColor"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">SetTextColor</span> (line <span class="line-number">1505</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Defines the color used for text. It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
<li><span class="field">see:</span> <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetDrawColor">TCPDF::SetDrawColor()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetFillColor">TCPDF::SetFillColor()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodText">TCPDF::Text()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodCell">TCPDF::Cell()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodMultiCell">TCPDF::MultiCell()</a></li>
|
|
<li><span class="field">since:</span> 1.3</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
SetTextColor
|
|
</span>
|
|
(<span class="var-type">int</span> <span class="var-name">$r</span>, [<span class="var-type">int</span> <span class="var-name">$g</span> = <span class="var-default">-1</span>], [<span class="var-type">int</span> <span class="var-name">$b</span> = <span class="var-default">-1</span>], [<span class="var-type">boolean</span> <span class="var-name">$storeprev</span> = <span class="var-default">false</span>])
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">int</span>
|
|
<span class="var-name">$r</span><span class="var-description">: If g et b are given, red component; if not, indicates the gray level. Value between 0 and 255</span> </li>
|
|
<li>
|
|
<span class="var-type">int</span>
|
|
<span class="var-name">$g</span><span class="var-description">: Green component (between 0 and 255)</span> </li>
|
|
<li>
|
|
<span class="var-type">int</span>
|
|
<span class="var-name">$b</span><span class="var-description">: Blue component (between 0 and 255)</span> </li>
|
|
<li>
|
|
<span class="var-type">boolean</span>
|
|
<span class="var-name">$storeprev</span><span class="var-description">: if true stores the RGB array on $prevTextColor variable.</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodSetTitle" id="SetTitle"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">SetTitle</span> (line <span class="line-number">1100</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Defines the title of the document.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
<li><span class="field">see:</span> <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetAuthor">TCPDF::SetAuthor()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetCreator">TCPDF::SetCreator()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetKeywords">TCPDF::SetKeywords()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetSubject">TCPDF::SetSubject()</a></li>
|
|
<li><span class="field">since:</span> 1.2</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
SetTitle
|
|
</span>
|
|
(<span class="var-type">string</span> <span class="var-name">$title</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$title</span><span class="var-description">: The title.</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodSetTopMargin" id="SetTopMargin"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">SetTopMargin</span> (line <span class="line-number">1026</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Defines the top margin. The method can be called before creating the first page.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
<li><span class="field">see:</span> <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetLeftMargin">TCPDF::SetLeftMargin()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetRightMargin">TCPDF::SetRightMargin()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetAutoPageBreak">TCPDF::SetAutoPageBreak()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetMargins">TCPDF::SetMargins()</a></li>
|
|
<li><span class="field">since:</span> 1.5</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
SetTopMargin
|
|
</span>
|
|
(<span class="var-type">float</span> <span class="var-name">$margin</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">float</span>
|
|
<span class="var-name">$margin</span><span class="var-description">: The margin.</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodSetX" id="SetX"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">SetX</span> (line <span class="line-number">2420</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Defines the abscissa of the current position. If the passed value is negative, it is relative to the right of the page.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
<li><span class="field">see:</span> <a href="../com.tecnick.tcpdf/TCPDF.html#methodGetX">TCPDF::GetX()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodGetY">TCPDF::GetY()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetY">TCPDF::SetY()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetXY">TCPDF::SetXY()</a></li>
|
|
<li><span class="field">since:</span> 1.2</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
SetX
|
|
</span>
|
|
(<span class="var-type">float</span> <span class="var-name">$x</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">float</span>
|
|
<span class="var-name">$x</span><span class="var-description">: The value of the abscissa.</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodSetXY" id="SetXY"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">SetXY</span> (line <span class="line-number">2465</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Defines the abscissa and ordinate of the current position. If the passed values are negative, they are relative respectively to the right and bottom of the page.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
<li><span class="field">see:</span> <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetX">TCPDF::SetX()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetY">TCPDF::SetY()</a></li>
|
|
<li><span class="field">since:</span> 1.2</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
SetXY
|
|
</span>
|
|
(<span class="var-type">float</span> <span class="var-name">$x</span>, <span class="var-type">float</span> <span class="var-name">$y</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">float</span>
|
|
<span class="var-name">$x</span><span class="var-description">: The value of the abscissa</span> </li>
|
|
<li>
|
|
<span class="var-type">float</span>
|
|
<span class="var-name">$y</span><span class="var-description">: The value of the ordinate</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodSetY" id="SetY"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">SetY</span> (line <span class="line-number">2447</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Moves the current abscissa back to the left margin and sets the ordinate. If the passed value is negative, it is relative to the bottom of the page.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
<li><span class="field">see:</span> <a href="../com.tecnick.tcpdf/TCPDF.html#methodGetX">TCPDF::GetX()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodGetY">TCPDF::GetY()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetY">TCPDF::SetY()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetXY">TCPDF::SetXY()</a></li>
|
|
<li><span class="field">since:</span> 1.0</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
SetY
|
|
</span>
|
|
(<span class="var-type">float</span> <span class="var-name">$y</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">float</span>
|
|
<span class="var-name">$y</span><span class="var-description">: The value of the ordinate.</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodText" id="Text"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">Text</span> (line <span class="line-number">1892</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Prints a character string. The origin is on the left of the first charcter, on the baseline. This method allows to place a string precisely on the page, but it is usually easier to use Cell(), MultiCell() or Write() which are the standard methods to print text.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
<li><span class="field">see:</span> <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetFont">TCPDF::SetFont()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetTextColor">TCPDF::SetTextColor()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodCell">TCPDF::Cell()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodMultiCell">TCPDF::MultiCell()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodWrite">TCPDF::Write()</a></li>
|
|
<li><span class="field">since:</span> 1.0</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
Text
|
|
</span>
|
|
(<span class="var-type">float</span> <span class="var-name">$x</span>, <span class="var-type">float</span> <span class="var-name">$y</span>, <span class="var-type">string</span> <span class="var-name">$txt</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">float</span>
|
|
<span class="var-name">$x</span><span class="var-description">: Abscissa of the origin</span> </li>
|
|
<li>
|
|
<span class="var-type">float</span>
|
|
<span class="var-name">$y</span><span class="var-description">: Ordinate of the origin</span> </li>
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$txt</span><span class="var-description">: String to print</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodunhtmlentities" id="unhtmlentities"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">unhtmlentities</span> (line <span class="line-number">4191</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Reverse function for htmlentities.</p>
|
|
<p class="description"><p>Convert entities in UTF-8.</p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> converted</li>
|
|
<li><span class="field">access:</span> public</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">string</span>
|
|
<span class="method-name">
|
|
unhtmlentities
|
|
</span>
|
|
(<span class="var-type">$text_to_convert</span> <span class="var-name">$text_to_convert</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">$text_to_convert</span>
|
|
<span class="var-name">$text_to_convert</span><span class="var-description">: Text to convert.</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodUTF8StringToArray" id="UTF8StringToArray"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">UTF8StringToArray</span> (line <span class="line-number">3400</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Converts UTF-8 strings to codepoints array.<br /></p>
|
|
<p class="description"><p>Invalid byte sequences will be replaced with 0xFFFD (replacement character)<br /> Based on: http://www.faqs.org/rfcs/rfc3629.html <pre> Char. number range | UTF-8 octet sequence
|
|
(hexadecimal) | (binary)
|
|
--------------------+-----------------------------------------------
|
|
0000 0000-0000 007F | 0xxxxxxx
|
|
0000 0080-0000 07FF | 110xxxxx 10xxxxxx
|
|
0000 0800-0000 FFFF | 1110xxxx 10xxxxxx 10xxxxxx
|
|
0001 0000-0010 FFFF | 11110xxx 10xxxxxx 10xxxxxx 10xxxxxx
|
|
---------------------------------------------------------------------
|
|
|
|
ABFN notation:
|
|
---------------------------------------------------------------------
|
|
UTF8-octets = *( UTF8-char )
|
|
UTF8-char = UTF8-1 / UTF8-2 / UTF8-3 / UTF8-4
|
|
UTF8-1 = %x00-7F
|
|
UTF8-2 = %xC2-DF UTF8-tail
|
|
|
|
UTF8-3 = %xE0 %xA0-BF UTF8-tail / %xE1-EC 2( UTF8-tail ) /
|
|
%xED %x80-9F UTF8-tail / %xEE-EF 2( UTF8-tail )
|
|
UTF8-4 = %xF0 %x90-BF 2( UTF8-tail ) / %xF1-F3 3( UTF8-tail ) /
|
|
%xF4 %x80-8F 2( UTF8-tail )
|
|
UTF8-tail = %x80-BF
|
|
---------------------------------------------------------------------</pre></p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> containing codepoints (UTF-8 characters values)</li>
|
|
<li><span class="field">usedby:</span> <a href="../com.tecnick.tcpdf/TCPDF.html#methodUTF8ToUTF16BE">TCPDF::UTF8ToUTF16BE()</a></li>
|
|
<li><span class="field">access:</span> protected</li>
|
|
<li><span class="field">since:</span> 1.53.0.TC005 (2005-01-05)</li>
|
|
<li><span class="field">author:</span> Nicola Asuni</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">array</span>
|
|
<span class="method-name">
|
|
UTF8StringToArray
|
|
</span>
|
|
(<span class="var-type">string</span> <span class="var-name">$str</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$str</span><span class="var-description">: string to process.</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodUTF8ToUTF16BE" id="UTF8ToUTF16BE"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">UTF8ToUTF16BE</span> (line <span class="line-number">3502</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Converts UTF-8 strings to UTF16-BE.<br /></p>
|
|
<p class="description"><p>Based on: http://www.faqs.org/rfcs/rfc2781.html <pre> Encoding UTF-16:
|
|
|
|
Encoding of a single character from an ISO 10646 character value to
|
|
UTF-16 proceeds as follows. Let U be the character number, no greater
|
|
than 0x10FFFF.
|
|
|
|
1) If U < 0x10000, encode U as a 16-bit unsigned integer and
|
|
terminate.
|
|
|
|
2) Let U' = U - 0x10000. Because U is less than or equal to 0x10FFFF,
|
|
U' must be less than or equal to 0xFFFFF. That is, U' can be
|
|
represented in 20 bits.
|
|
|
|
3) Initialize two 16-bit unsigned integers, W1 and W2, to 0xD800 and
|
|
0xDC00, respectively. These integers each have 10 bits free to
|
|
encode the character value, for a total of 20 bits.
|
|
|
|
4) Assign the 10 high-order bits of the 20-bit U' to the 10 low-order
|
|
bits of W1 and the 10 low-order bits of U' to the 10 low-order
|
|
bits of W2. Terminate.
|
|
|
|
Graphically, steps 2 through 4 look like:
|
|
U' = yyyyyyyyyyxxxxxxxxxx
|
|
W1 = 110110yyyyyyyyyy
|
|
W2 = 110111xxxxxxxxxx</pre></p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> protected</li>
|
|
<li><span class="field">uses:</span> <a href="../com.tecnick.tcpdf/TCPDF.html#methodUTF8StringToArray">TCPDF::UTF8StringToArray()</a></li>
|
|
<li><span class="field">since:</span> 1.53.0.TC005 (2005-01-05)</li>
|
|
<li><span class="field">author:</span> Nicola Asuni</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">string</span>
|
|
<span class="method-name">
|
|
UTF8ToUTF16BE
|
|
</span>
|
|
(<span class="var-type">string</span> <span class="var-name">$str</span>, [<span class="var-type">boolean</span> <span class="var-name">$setbom</span> = <span class="var-default">true</span>])
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$str</span><span class="var-description">: string to process.</span> </li>
|
|
<li>
|
|
<span class="var-type">boolean</span>
|
|
<span class="var-name">$setbom</span><span class="var-description">: if true set the Byte Order Mark (BOM = 0xFEFF)</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodWrite" id="Write"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">Write</span> (line <span class="line-number">2219</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">This method prints text from the current position. When the right margin is reached (or the \n character is met) a line break occurs and text continues from the left margin. Upon method exit, the current position is left just at the end of the text. It is possible to put a link on the text.<br /></p>
|
|
<p class="description"><p><strong>Example:</strong><br /> <pre> //Begin with regular font
|
|
$pdf->SetFont('Arial','',14);
|
|
$pdf->Write(5,'Visit ');
|
|
//Then put a blue underlined link
|
|
$pdf->SetTextColor(0,0,255);
|
|
$pdf->SetFont('','U');
|
|
$pdf->Write(5,'www.tecnick.com','http://www.tecnick.com');</pre></p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
<li><span class="field">see:</span> <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetFont">TCPDF::SetFont()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetTextColor">TCPDF::SetTextColor()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodAddLink">TCPDF::AddLink()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodMultiCell">TCPDF::MultiCell()</a>, <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetAutoPageBreak">TCPDF::SetAutoPageBreak()</a></li>
|
|
<li><span class="field">since:</span> 1.5</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
Write
|
|
</span>
|
|
(<span class="var-type">float</span> <span class="var-name">$h</span>, <span class="var-type">string</span> <span class="var-name">$txt</span>, [<span class="var-type">mixed</span> <span class="var-name">$link</span> = <span class="var-default">''</span>], <span class="var-type">int</span> <span class="var-name">$fill</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">float</span>
|
|
<span class="var-name">$h</span><span class="var-description">: Line height</span> </li>
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$txt</span><span class="var-description">: String to print</span> </li>
|
|
<li>
|
|
<span class="var-type">mixed</span>
|
|
<span class="var-name">$link</span><span class="var-description">: URL or identifier returned by AddLink()</span> </li>
|
|
<li>
|
|
<span class="var-type">int</span>
|
|
<span class="var-name">$fill</span><span class="var-description">: Indicates if the background must be painted (1) or transparent (0). Default value: 0.</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodwriteBarcode" id="writeBarcode"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">writeBarcode</span> (line <span class="line-number">3581</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Print Barcode.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
writeBarcode
|
|
</span>
|
|
(<span class="var-type">int</span> <span class="var-name">$x</span>, <span class="var-type">int</span> <span class="var-name">$y</span>, <span class="var-type">int</span> <span class="var-name">$w</span>, <span class="var-type">int</span> <span class="var-name">$h</span>, <span class="var-type">string</span> <span class="var-name">$type</span>, <span class="var-type">string</span> <span class="var-name">$style</span>, <span class="var-type">string</span> <span class="var-name">$font</span>, <span class="var-type">int</span> <span class="var-name">$xres</span>, <span class="var-type">string</span> <span class="var-name">$code</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">int</span>
|
|
<span class="var-name">$x</span><span class="var-description">: x position in user units</span> </li>
|
|
<li>
|
|
<span class="var-type">int</span>
|
|
<span class="var-name">$y</span><span class="var-description">: y position in user units</span> </li>
|
|
<li>
|
|
<span class="var-type">int</span>
|
|
<span class="var-name">$w</span><span class="var-description">: width in user units</span> </li>
|
|
<li>
|
|
<span class="var-type">int</span>
|
|
<span class="var-name">$h</span><span class="var-description">: height position in user units</span> </li>
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$type</span><span class="var-description">: type of barcode (I25, C128A, C128B, C128C, C39)</span> </li>
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$style</span><span class="var-description">: barcode style</span> </li>
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$font</span><span class="var-description">: font for text</span> </li>
|
|
<li>
|
|
<span class="var-type">int</span>
|
|
<span class="var-name">$xres</span><span class="var-description">: x resolution</span> </li>
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$code</span><span class="var-description">: code to print</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodwriteHTML" id="writeHTML"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">writeHTML</span> (line <span class="line-number">3664</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Allows to preserve some HTML formatting.<br /></p>
|
|
<p class="description"><p>Supports: h1, h2, h3, h4, h5, h6, b, u, i, a, img, p, br, strong, em, font, blockquote, li, ul, ol, hr, td, th, tr, table, sup, sub, small</p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
writeHTML
|
|
</span>
|
|
(<span class="var-type">string</span> <span class="var-name">$html</span>, [<span class="var-type">boolean</span> <span class="var-name">$ln</span> = <span class="var-default">true</span>], <span class="var-type">int</span> <span class="var-name">$fill</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$html</span><span class="var-description">: text to display</span> </li>
|
|
<li>
|
|
<span class="var-type">boolean</span>
|
|
<span class="var-name">$ln</span><span class="var-description">: if true add a new line after text (default = true)</span> </li>
|
|
<li>
|
|
<span class="var-type">int</span>
|
|
<span class="var-name">$fill</span><span class="var-description">: Indicates if the background must be painted (1) or transparent (0). Default value: 0.</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodwriteHTMLCell" id="writeHTMLCell"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">writeHTMLCell</span> (line <span class="line-number">3736</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Prints a cell (rectangular area) with optional borders, background color and html text string. The upper-left corner of the cell corresponds to the current position. After the call, the current position moves to the right or to the next line.<br /> If automatic page breaking is enabled and the cell goes beyond the limit, a page break is done before outputting.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
<li><span class="field">see:</span> <a href="../com.tecnick.tcpdf/TCPDF.html#methodCell">TCPDF::Cell()</a></li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
writeHTMLCell
|
|
</span>
|
|
(<span class="var-type">float</span> <span class="var-name">$w</span>, <span class="var-type">float</span> <span class="var-name">$h</span>, <span class="var-type">float</span> <span class="var-name">$x</span>, <span class="var-type">float</span> <span class="var-name">$y</span>, [<span class="var-type">string</span> <span class="var-name">$html</span> = <span class="var-default">''</span>], <span class="var-type">mixed</span> <span class="var-name">$border</span>, <span class="var-type">int</span> <span class="var-name">$ln</span>, <span class="var-type">int</span> <span class="var-name">$fill</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">float</span>
|
|
<span class="var-name">$w</span><span class="var-description">: Cell width. If 0, the cell extends up to the right margin.</span> </li>
|
|
<li>
|
|
<span class="var-type">float</span>
|
|
<span class="var-name">$h</span><span class="var-description">: Cell minimum height. The cell extends automatically if needed.</span> </li>
|
|
<li>
|
|
<span class="var-type">float</span>
|
|
<span class="var-name">$x</span><span class="var-description">: upper-left corner X coordinate</span> </li>
|
|
<li>
|
|
<span class="var-type">float</span>
|
|
<span class="var-name">$y</span><span class="var-description">: upper-left corner Y coordinate</span> </li>
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$html</span><span class="var-description">: html text to print. Default value: empty string.</span> </li>
|
|
<li>
|
|
<span class="var-type">mixed</span>
|
|
<span class="var-name">$border</span><span class="var-description">: Indicates if borders must be drawn around the cell. The value can be either a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul>or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul></span> </li>
|
|
<li>
|
|
<span class="var-type">int</span>
|
|
<span class="var-name">$ln</span><span class="var-description">: Indicates where the current position should go after the call. Possible values are:<ul><li>0: to the right</li><li>1: to the beginning of the next line</li><li>2: below</li></ul></span> </li>
|
|
<li>
|
|
<span class="var-type">int</span>
|
|
<span class="var-name">$fill</span><span class="var-description">: Indicates if the cell background must be painted (1) or transparent (0). Default value: 0.</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="method_begindoc" id="_begindoc"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">_begindoc</span> (line <span class="line-number">2587</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Start document</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
_begindoc
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="method_beginpage" id="_beginpage"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">_beginpage</span> (line <span class="line-number">2993</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">_beginpage</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
_beginpage
|
|
</span>
|
|
(<span class="var-type">mixed</span> <span class="var-name">$orientation</span>)
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="method_dochecks" id="_dochecks"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">_dochecks</span> (line <span class="line-number">2561</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Check for locale-related bug</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
_dochecks
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="method_dounderline" id="_dounderline"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">_dounderline</span> (line <span class="line-number">3051</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Underline text</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
_dounderline
|
|
</span>
|
|
(<span class="var-type">mixed</span> <span class="var-name">$x</span>, <span class="var-type">mixed</span> <span class="var-name">$y</span>, <span class="var-type">mixed</span> <span class="var-name">$txt</span>)
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="method_enddoc" id="_enddoc"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">_enddoc</span> (line <span class="line-number">2954</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">_enddoc</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
_enddoc
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="method_endpage" id="_endpage"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">_endpage</span> (line <span class="line-number">3033</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">End of page contents</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
_endpage
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="method_escape" id="_escape"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">_escape</span> (line <span class="line-number">3225</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Add \ before \, ( and )</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
_escape
|
|
</span>
|
|
(<span class="var-type">mixed</span> <span class="var-name">$s</span>)
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="method_escapetext" id="_escapetext"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">_escapetext</span> (line <span class="line-number">3213</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Format a text string</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
_escapetext
|
|
</span>
|
|
(<span class="var-type">mixed</span> <span class="var-name">$s</span>)
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="method_freadint" id="_freadint"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">_freadint</span> (line <span class="line-number">3191</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Read a 4-byte integer from file</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
_freadint
|
|
</span>
|
|
(<span class="var-type">mixed</span> <span class="var-name">$f</span>)
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="method_getfontpath" id="_getfontpath"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">_getfontpath</span> (line <span class="line-number">2576</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Return fonts path</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
_getfontpath
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="method_newobj" id="_newobj"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">_newobj</span> (line <span class="line-number">3041</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Begin a new object</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
_newobj
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="method_out" id="_out"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">_out</span> (line <span class="line-number">3244</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Add a line to the document</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
_out
|
|
</span>
|
|
(<span class="var-type">mixed</span> <span class="var-name">$s</span>)
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="method_parsejpg" id="_parsejpg"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">_parsejpg</span> (line <span class="line-number">3062</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Extract info from a JPEG file</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
_parsejpg
|
|
</span>
|
|
(<span class="var-type">mixed</span> <span class="var-name">$file</span>)
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="method_parsepng" id="_parsepng"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">_parsepng</span> (line <span class="line-number">3094</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Extract info from a PNG file</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
_parsepng
|
|
</span>
|
|
(<span class="var-type">mixed</span> <span class="var-name">$file</span>)
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="method_putcatalog" id="_putcatalog"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">_putcatalog</span> (line <span class="line-number">2906</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">_putcatalog</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
_putcatalog
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="method_putfonts" id="_putfonts"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">_putfonts</span> (line <span class="line-number">2670</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Adds fonts</p>
|
|
<p class="description"><p>_putfonts</p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
_putfonts
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="method_putheader" id="_putheader"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">_putheader</span> (line <span class="line-number">2946</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">_putheader</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
_putheader
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="method_putimages" id="_putimages"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">_putimages</span> (line <span class="line-number">2788</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">_putimages</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
_putimages
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="method_putinfo" id="_putinfo"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">_putinfo</span> (line <span class="line-number">2882</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">_putinfo</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
_putinfo
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="method_putpages" id="_putpages"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">_putpages</span> (line <span class="line-number">2597</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">_putpages</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
_putpages
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="method_putresourcedict" id="_putresourcedict"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">_putresourcedict</span> (line <span class="line-number">2850</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">_putresourcedict</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
_putresourcedict
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="method_putresources" id="_putresources"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">_putresources</span> (line <span class="line-number">2866</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">_putresources</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
_putresources
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="method_putstream" id="_putstream"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">_putstream</span> (line <span class="line-number">3234</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
_putstream
|
|
</span>
|
|
(<span class="var-type">mixed</span> <span class="var-name">$s</span>)
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="method_puttrailer" id="_puttrailer"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">_puttrailer</span> (line <span class="line-number">2936</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">_puttrailer</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
_puttrailer
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="method_puttruetypeunicode" id="_puttruetypeunicode"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">_puttruetypeunicode</span> (line <span class="line-number">3260</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Adds unicode fonts.<br /></p>
|
|
<p class="description"><p>Based on PDF Reference 1.3 (section 5)</p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> protected</li>
|
|
<li><span class="field">since:</span> 1.52.0.TC005 (2005-01-05)</li>
|
|
<li><span class="field">author:</span> Nicola Asuni</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
_puttruetypeunicode
|
|
</span>
|
|
(<span class="var-type">mixed</span> <span class="var-name">$font</span>)
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="method_putxobjectdict" id="_putxobjectdict"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">_putxobjectdict</span> (line <span class="line-number">2840</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">_putxobjectdict</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
_putxobjectdict
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="method_textstring" id="_textstring"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">_textstring</span> (line <span class="line-number">3201</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Format a text string</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
_textstring
|
|
</span>
|
|
(<span class="var-type">mixed</span> <span class="var-name">$s</span>)
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<p class="notes" id="credit">
|
|
Documentation generated on Tue, 20 Mar 2007 13:24:42 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC3</a>
|
|
</p>
|
|
</div></body>
|
|
</html> |