| [ Index ] |
PHP Cross Reference of vtigercrm-6.1.0 |
[Summary view] [Print] [Text view]
1 <?xml version="1.0" encoding="iso-8859-1"?> 2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 3 <html xmlns="http://www.w3.org/1999/xhtml"> 4 <head> 5 <!-- template designed by Marco Von Ballmoos --> 6 <title>Docs For Class TCPDF</title> 7 <link rel="stylesheet" href="../media/stylesheet.css" /> 8 <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/> 9 </head> 10 <body> 11 <div class="page-body"> 12 <h2 class="class-name">Class TCPDF</h2> 13 14 <a name="sec-description"></a> 15 <div class="info-box"> 16 <div class="info-box-title">Description</div> 17 <div class="nav-bar"> 18 <span class="disabled">Description</span> | 19 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) 20 | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) 21 22 </div> 23 <div class="info-box-body"> 24 <!-- ========== Info from phpDoc block ========= --> 25 <p class="short-description">This is a PHP5 class for generating PDF files on-the-fly without requiring external extensions.<br /></p> 26 <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> 27 <ul class="tags"> 28 <li><span class="field">license:</span> <a href="http://www.gnu.org/copyleft/lesser.html">LGPL</a></li> 29 <li><span class="field">link:</span> <a href="http://tcpdf.sourceforge.net">http://tcpdf.sourceforge.net</a></li> 30 <li><span class="field">author:</span> Nicola Asuni</li> 31 <li><span class="field">version:</span> 1.53.0.TC031</li> 32 <li><span class="field">name:</span> TCPDF</li> 33 </ul> 34 <p class="notes"> 35 Located in <a class="field" href="_tcpdf_tcpdf_php.html">/tcpdf.php</a> (line <span class="field">87</span>) 36 </p> 37 38 39 <pre></pre> 40 41 </div> 42 </div> 43 44 45 46 <a name="sec-var-summary"></a> 47 <div class="info-box"> 48 <div class="info-box-title">Variable Summary</span></div> 49 <div class="nav-bar"> 50 <a href="#sec-description">Description</a> | 51 <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>) 52 | 53 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) 54 55 </div> 56 <div class="info-box-body"> 57 <div class="var-summary"> 58 <div class="var-title"> 59 <span class="var-type">alias</span> 60 <a href="#$AliasNbPages" title="details" class="var-name">$AliasNbPages</a> 61 </div> 62 <div class="var-title"> 63 <span class="var-type">author</span> 64 <a href="#$author" title="details" class="var-name">$author</a> 65 </div> 66 <div class="var-title"> 67 <span class="var-type">automatic</span> 68 <a href="#$AutoPageBreak" title="details" class="var-name">$AutoPageBreak</a> 69 </div> 70 <div class="var-title"> 71 <span class="var-type">Bold</span> 72 <a href="#$b" title="details" class="var-name">$b</a> 73 </div> 74 <div class="var-title"> 75 <span class="var-type">Barcode</span> 76 <a href="#$barcode" title="details" class="var-name">$barcode</a> 77 </div> 78 <div class="var-title"> 79 <span class="var-type">page</span> 80 <a href="#$bMargin" title="details" class="var-name">$bMargin</a> 81 </div> 82 <div class="var-title"> 83 <span class="var-type">buffer</span> 84 <a href="#$buffer" title="details" class="var-name">$buffer</a> 85 </div> 86 <div class="var-title"> 87 <span class="var-type">cell</span> 88 <a href="#$cMargin" title="details" class="var-name">$cMargin</a> 89 </div> 90 <div class="var-title"> 91 <span class="var-type">indicates</span> 92 <a href="#$ColorFlag" title="details" class="var-name">$ColorFlag</a> 93 </div> 94 <div class="var-title"> 95 <span class="var-type">compression</span> 96 <a href="#$compress" title="details" class="var-name">$compress</a> 97 </div> 98 <div class="var-title"> 99 <span class="var-type">array</span> 100 <a href="#$CoreFonts" title="details" class="var-name">$CoreFonts</a> 101 </div> 102 <div class="var-title"> 103 <span class="var-type">creator</span> 104 <a href="#$creator" title="details" class="var-name">$creator</a> 105 </div> 106 <div class="var-title"> 107 <span class="var-type">current</span> 108 <a href="#$CurOrientation" title="details" class="var-name">$CurOrientation</a> 109 </div> 110 <div class="var-title"> 111 <span class="var-type">current</span> 112 <a href="#$CurrentFont" title="details" class="var-name">$CurrentFont</a> 113 </div> 114 <div class="var-title"> 115 <span class="var-type">Default</span> 116 <a href="#$default_table_columns" title="details" class="var-name">$default_table_columns</a> 117 </div> 118 <div class="var-title"> 119 <span class="var-type">default</span> 120 <a href="#$DefOrientation" title="details" class="var-name">$DefOrientation</a> 121 </div> 122 <div class="var-title"> 123 <span class="var-type">array</span> 124 <a href="#$diffs" title="details" class="var-name">$diffs</a> 125 </div> 126 <div class="var-title"> 127 <span class="var-type">commands</span> 128 <a href="#$DrawColor" title="details" class="var-name">$DrawColor</a> 129 </div> 130 <div class="var-title"> 131 <span class="var-type">default</span> 132 <a href="#$encoding" title="details" class="var-name">$encoding</a> 133 </div> 134 <div class="var-title"> 135 <span class="var-type">height</span> 136 <a href="#$fh" title="details" class="var-name">$fh</a> 137 </div> 138 <div class="var-title"> 139 <span class="var-type">height</span> 140 <a href="#$fhPt" title="details" class="var-name">$fhPt</a> 141 </div> 142 <div class="var-title"> 143 <span class="var-type">commands</span> 144 <a href="#$FillColor" title="details" class="var-name">$FillColor</a> 145 </div> 146 <div class="var-title"> 147 <span class="var-type">current</span> 148 <a href="#$FontFamily" title="details" class="var-name">$FontFamily</a> 149 </div> 150 <div class="var-title"> 151 <span class="var-type">array</span> 152 <a href="#$FontFiles" title="details" class="var-name">$FontFiles</a> 153 </div> 154 <div class="var-title"> 155 <span class="var-type">HTML</span> 156 <a href="#$fontList" title="details" class="var-name">$fontList</a> 157 </div> 158 <div class="var-title"> 159 <span class="var-type">array</span> 160 <a href="#$fonts" title="details" class="var-name">$fonts</a> 161 </div> 162 <div class="var-title"> 163 <span class="var-type">current</span> 164 <a href="#$FontSize" title="details" class="var-name">$FontSize</a> 165 </div> 166 <div class="var-title"> 167 <span class="var-type">current</span> 168 <a href="#$FontSizePt" title="details" class="var-name">$FontSizePt</a> 169 </div> 170 <div class="var-title"> 171 <span class="var-type">current</span> 172 <a href="#$FontStyle" title="details" class="var-name">$FontStyle</a> 173 </div> 174 <div class="var-title"> 175 <span class="var-type">Footer</span> 176 <a href="#$footer_font" title="details" class="var-name">$footer_font</a> 177 </div> 178 <div class="var-title"> 179 <span class="var-type">Minimum</span> 180 <a href="#$footer_margin" title="details" class="var-name">$footer_margin</a> 181 </div> 182 <div class="var-title"> 183 <span class="var-type">width</span> 184 <a href="#$fw" title="details" class="var-name">$fw</a> 185 </div> 186 <div class="var-title"> 187 <span class="var-type">width</span> 188 <a href="#$fwPt" title="details" class="var-name">$fwPt</a> 189 </div> 190 <div class="var-title"> 191 <span class="var-type">current</span> 192 <a href="#$h" title="details" class="var-name">$h</a> 193 </div> 194 <div class="var-title"> 195 <span class="var-type">Header</span> 196 <a href="#$header_font" title="details" class="var-name">$header_font</a> 197 </div> 198 <div class="var-title"> 199 <span class="var-type">Header</span> 200 <a href="#$header_logo" title="details" class="var-name">$header_logo</a> 201 </div> 202 <div class="var-title"> 203 <span class="var-type">Header</span> 204 <a href="#$header_logo_width" title="details" class="var-name">$header_logo_width</a> 205 </div> 206 <div class="var-title"> 207 <span class="var-type">Minimum</span> 208 <a href="#$header_margin" title="details" class="var-name">$header_margin</a> 209 </div> 210 <div class="var-title"> 211 <span class="var-type">String</span> 212 <a href="#$header_string" title="details" class="var-name">$header_string</a> 213 </div> 214 <div class="var-title"> 215 <span class="var-type">String</span> 216 <a href="#$header_title" title="details" class="var-name">$header_title</a> 217 </div> 218 <div class="var-title"> 219 <span class="var-type">Header</span> 220 <a href="#$header_width" title="details" class="var-name">$header_width</a> 221 </div> 222 <div class="var-title"> 223 <span class="var-type">current</span> 224 <a href="#$hPt" title="details" class="var-name">$hPt</a> 225 </div> 226 <div class="var-title"> 227 <span class="var-type">HTML</span> 228 <a href="#$HREF" title="details" class="var-name">$HREF</a> 229 </div> 230 <div class="var-title"> 231 <span class="var-type">Italic</span> 232 <a href="#$i" title="details" class="var-name">$i</a> 233 </div> 234 <div class="var-title"> 235 <span class="var-type">array</span> 236 <a href="#$images" title="details" class="var-name">$images</a> 237 </div> 238 <div class="var-title"> 239 <span class="var-type">image</span> 240 <a href="#$imgscale" title="details" class="var-name">$imgscale</a> 241 </div> 242 <div class="var-title"> 243 <span class="var-type">right-bottom</span> 244 <a href="#$img_rb_x" title="details" class="var-name">$img_rb_x</a> 245 </div> 246 <div class="var-title"> 247 <span class="var-type">right-bottom</span> 248 <a href="#$img_rb_y" title="details" class="var-name">$img_rb_y</a> 249 </div> 250 <div class="var-title"> 251 <span class="var-type">flag</span> 252 <a href="#$InFooter" title="details" class="var-name">$InFooter</a> 253 </div> 254 <div class="var-title"> 255 <span class="var-type">PHP</span> 256 <a href="#$internal_encoding" title="details" class="var-name">$internal_encoding</a> 257 </div> 258 <div class="var-title"> 259 <span class="var-type">HTML</span> 260 <a href="#$issetcolor" title="details" class="var-name">$issetcolor</a> 261 </div> 262 <div class="var-title"> 263 <span class="var-type">HTML</span> 264 <a href="#$issetfont" title="details" class="var-name">$issetfont</a> 265 </div> 266 <div class="var-title"> 267 <span class="var-type">boolean</span> 268 <a href="#$isunicode" title="details" class="var-name">$isunicode</a> 269 </div> 270 <div class="var-title"> 271 <span class="var-type">scale</span> 272 <a href="#$k" title="details" class="var-name">$k</a> 273 </div> 274 <div class="var-title"> 275 <span class="var-type">keywords</span> 276 <a href="#$keywords" title="details" class="var-name">$keywords</a> 277 </div> 278 <div class="var-title"> 279 <span class="var-type">Language</span> 280 <a href="#$l" title="details" class="var-name">$l</a> 281 </div> 282 <div class="var-title"> 283 <span class="var-type">height</span> 284 <a href="#$lasth" title="details" class="var-name">$lasth</a> 285 </div> 286 <div class="var-title"> 287 <span class="var-type">layout</span> 288 <a href="#$LayoutMode" title="details" class="var-name">$LayoutMode</a> 289 </div> 290 <div class="var-title"> 291 <span class="var-type">line</span> 292 <a href="#$LineWidth" title="details" class="var-name">$LineWidth</a> 293 </div> 294 <div class="var-title"> 295 <span class="var-type">array</span> 296 <a href="#$links" title="details" class="var-name">$links</a> 297 </div> 298 <div class="var-title"> 299 <span class="var-type">spacer</span> 300 <a href="#$lispacer" title="details" class="var-name">$lispacer</a> 301 </div> 302 <div class="var-title"> 303 <span class="var-type">HTML</span> 304 <a href="#$listcount" title="details" class="var-name">$listcount</a> 305 </div> 306 <div class="var-title"> 307 <span class="var-type">HTML</span> 308 <a href="#$listordered" title="details" class="var-name">$listordered</a> 309 </div> 310 <div class="var-title"> 311 <span class="var-type">left</span> 312 <a href="#$lMargin" title="details" class="var-name">$lMargin</a> 313 </div> 314 <div class="var-title"> 315 <span class="var-type">current</span> 316 <a href="#$n" title="details" class="var-name">$n</a> 317 </div> 318 <div class="var-title"> 319 <span class="var-type">array</span> 320 <a href="#$offsets" title="details" class="var-name">$offsets</a> 321 </div> 322 <div class="var-title"> 323 <span class="var-type">array</span> 324 <a href="#$OrientationChanges" title="details" class="var-name">$OrientationChanges</a> 325 </div> 326 <div class="var-title"> 327 <span class="var-type">original</span> 328 <a href="#$original_lMargin" title="details" class="var-name">$original_lMargin</a> 329 </div> 330 <div class="var-title"> 331 <span class="var-type">original</span> 332 <a href="#$original_rMargin" title="details" class="var-name">$original_rMargin</a> 333 </div> 334 <div class="var-title"> 335 <span class="var-type">current</span> 336 <a href="#$page" title="details" class="var-name">$page</a> 337 </div> 338 <div class="var-title"> 339 <span class="var-type">threshold</span> 340 <a href="#$PageBreakTrigger" title="details" class="var-name">$PageBreakTrigger</a> 341 </div> 342 <div class="var-title"> 343 <span class="var-type">array</span> 344 <a href="#$PageLinks" title="details" class="var-name">$PageLinks</a> 345 </div> 346 <div class="var-title"> 347 <span class="var-type">array</span> 348 <a href="#$pages" title="details" class="var-name">$pages</a> 349 </div> 350 <div class="var-title"> 351 <span class="var-type">PDF</span> 352 <a href="#$PDFVersion" title="details" class="var-name">$PDFVersion</a> 353 </div> 354 <div class="var-title"> 355 <span class="var-type">store</span> 356 <a href="#$prevFillColor" title="details" class="var-name">$prevFillColor</a> 357 </div> 358 <div class="var-title"> 359 <span class="var-type">store</span> 360 <a href="#$prevFontFamily" title="details" class="var-name">$prevFontFamily</a> 361 </div> 362 <div class="var-title"> 363 <span class="var-type">store</span> 364 <a href="#$prevFontStyle" title="details" class="var-name">$prevFontStyle</a> 365 </div> 366 <div class="var-title"> 367 <span class="var-type">store</span> 368 <a href="#$prevTextColor" title="details" class="var-name">$prevTextColor</a> 369 </div> 370 <div class="var-title"> 371 <span class="var-type">If</span> 372 <a href="#$print_footer" title="details" class="var-name">$print_footer</a> 373 </div> 374 <div class="var-title"> 375 <span class="var-type">If</span> 376 <a href="#$print_header" title="details" class="var-name">$print_header</a> 377 </div> 378 <div class="var-title"> 379 <span class="var-type">right</span> 380 <a href="#$rMargin" title="details" class="var-name">$rMargin</a> 381 </div> 382 <div class="var-title"> 383 <span class="var-type">current</span> 384 <a href="#$state" title="details" class="var-name">$state</a> 385 </div> 386 <div class="var-title"> 387 <span class="var-type">subject</span> 388 <a href="#$subject" title="details" class="var-name">$subject</a> 389 </div> 390 <div class="var-title"> 391 <span class="var-type">HTML</span> 392 <a href="#$tableborder" title="details" class="var-name">$tableborder</a> 393 </div> 394 <div class="var-title"> 395 <span class="var-type">HTML</span> 396 <a href="#$tdalign" title="details" class="var-name">$tdalign</a> 397 </div> 398 <div class="var-title"> 399 <span class="var-type">HTML</span> 400 <a href="#$tdbegin" title="details" class="var-name">$tdbegin</a> 401 </div> 402 <div class="var-title"> 403 <span class="var-type">HTML</span> 404 <a href="#$tdbgcolor" title="details" class="var-name">$tdbgcolor</a> 405 </div> 406 <div class="var-title"> 407 <span class="var-type">HTML</span> 408 <a href="#$tdheight" title="details" class="var-name">$tdheight</a> 409 </div> 410 <div class="var-title"> 411 <span class="var-type">HTML</span> 412 <a href="#$tdwidth" title="details" class="var-name">$tdwidth</a> 413 </div> 414 <div class="var-title"> 415 <span class="var-type">Store</span> 416 <a href="#$tempfontsize" title="details" class="var-name">$tempfontsize</a> 417 </div> 418 <div class="var-title"> 419 <span class="var-type">commands</span> 420 <a href="#$TextColor" title="details" class="var-name">$TextColor</a> 421 </div> 422 <div class="var-title"> 423 <span class="var-type">title</span> 424 <a href="#$title" title="details" class="var-name">$title</a> 425 </div> 426 <div class="var-title"> 427 <span class="var-type">top</span> 428 <a href="#$tMargin" title="details" class="var-name">$tMargin</a> 429 </div> 430 <div class="var-title"> 431 <span class="var-type">Underlined</span> 432 <a href="#$u" title="details" class="var-name">$u</a> 433 </div> 434 <div class="var-title"> 435 <span class="var-type">underlining</span> 436 <a href="#$underline" title="details" class="var-name">$underline</a> 437 </div> 438 <div class="var-title"> 439 <span class="var-type">current</span> 440 <a href="#$w" title="details" class="var-name">$w</a> 441 </div> 442 <div class="var-title"> 443 <span class="var-type">current</span> 444 <a href="#$wPt" title="details" class="var-name">$wPt</a> 445 </div> 446 <div class="var-title"> 447 <span class="var-type">word</span> 448 <a href="#$ws" title="details" class="var-name">$ws</a> 449 </div> 450 <div class="var-title"> 451 <span class="var-type">current</span> 452 <a href="#$x" title="details" class="var-name">$x</a> 453 </div> 454 <div class="var-title"> 455 <span class="var-type">current</span> 456 <a href="#$y" title="details" class="var-name">$y</a> 457 </div> 458 <div class="var-title"> 459 <span class="var-type">zoom</span> 460 <a href="#$ZoomMode" title="details" class="var-name">$ZoomMode</a> 461 </div> 462 </div> 463 </div> 464 </div> 465 466 <a name="sec-method-summary"></a> 467 <div class="info-box"> 468 <div class="info-box-title">Method Summary</span></div> 469 <div class="nav-bar"> 470 <a href="#sec-description">Description</a> | 471 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) 472 473 | 474 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>) 475 </div> 476 <div class="info-box-body"> 477 <div class="method-summary"> 478 479 <div class="method-definition"> 480 <span class="method-result">TCPDF</span> 481 <a href="#__construct" title="details" class="method-name">__construct</a> 482 ([<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>]) 483 </div> 484 485 <div class="method-definition"> 486 <span class="method-result">void</span> 487 <a href="#__destruct" title="details" class="method-name">__destruct</a> 488 () 489 </div> 490 491 <div class="method-definition"> 492 <span class="method-result">boolean</span> 493 <a href="#AcceptPageBreak" title="details" class="method-name">AcceptPageBreak</a> 494 () 495 </div> 496 497 <div class="method-definition"> 498 <span class="method-result">void</span> 499 <a href="#AddFont" title="details" class="method-name">AddFont</a> 500 (<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>]) 501 </div> 502 503 <div class="method-definition"> 504 <span class="method-result">void</span> 505 <a href="#addHtmlLink" title="details" class="method-name">addHtmlLink</a> 506 (<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>) 507 </div> 508 509 <div class="method-definition"> 510 <span class="method-result">void</span> 511 <a href="#AddLink" title="details" class="method-name">AddLink</a> 512 () 513 </div> 514 515 <div class="method-definition"> 516 <span class="method-result">void</span> 517 <a href="#AddPage" title="details" class="method-name">AddPage</a> 518 ([<span class="var-type">string</span> <span class="var-name">$orientation</span> = <span class="var-default">''</span>]) 519 </div> 520 521 <div class="method-definition"> 522 <span class="method-result">void</span> 523 <a href="#AliasNbPages" title="details" class="method-name">AliasNbPages</a> 524 ([<span class="var-type">string</span> <span class="var-name">$alias</span> = <span class="var-default">'{nb}'</span>]) 525 </div> 526 527 <div class="method-definition"> 528 <span class="method-result">void</span> 529 <a href="#Cell" title="details" class="method-name">Cell</a> 530 (<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>]) 531 </div> 532 533 <div class="method-definition"> 534 <span class="method-result">void</span> 535 <a href="#Close" title="details" class="method-name">Close</a> 536 () 537 </div> 538 539 <div class="method-definition"> 540 <span class="method-result">void</span> 541 <a href="#closedHTMLTagHandler" title="details" class="method-name">closedHTMLTagHandler</a> 542 (<span class="var-type">string</span> <span class="var-name">$tag</span>) 543 </div> 544 545 <div class="method-definition"> 546 <span class="method-result">array</span> 547 <a href="#convertColorHexToDec" title="details" class="method-name">convertColorHexToDec</a> 548 ([<span class="var-type">string</span> <span class="var-name">$color</span> = <span class="var-default">"#000000"</span>]) 549 </div> 550 551 <div class="method-definition"> 552 <span class="method-result">void</span> 553 <a href="#Error" title="details" class="method-name">Error</a> 554 (<span class="var-type">string</span> <span class="var-name">$msg</span>) 555 </div> 556 557 <div class="method-definition"> 558 <span class="method-result">void</span> 559 <a href="#Footer" title="details" class="method-name">Footer</a> 560 () 561 </div> 562 563 <div class="method-definition"> 564 <span class="method-result">int</span> 565 <a href="#getBreakMargin" title="details" class="method-name">getBreakMargin</a> 566 () 567 </div> 568 569 <div class="method-definition"> 570 <span class="method-result">float</span> 571 <a href="#getImageScale" title="details" class="method-name">getImageScale</a> 572 () 573 </div> 574 575 <div class="method-definition"> 576 <span class="method-result">int</span> 577 <a href="#getPageHeight" title="details" class="method-name">getPageHeight</a> 578 () 579 </div> 580 581 <div class="method-definition"> 582 <span class="method-result">int</span> 583 <a href="#getPageWidth" title="details" class="method-name">getPageWidth</a> 584 () 585 </div> 586 587 <div class="method-definition"> 588 <span class="method-result">void</span> 589 <a href="#getPDFData" title="details" class="method-name">getPDFData</a> 590 () 591 </div> 592 593 <div class="method-definition"> 594 <span class="method-result">int</span> 595 <a href="#getScaleFactor" title="details" class="method-name">getScaleFactor</a> 596 () 597 </div> 598 599 <div class="method-definition"> 600 <span class="method-result">int</span> 601 <a href="#GetStringWidth" title="details" class="method-name">GetStringWidth</a> 602 (<span class="var-type">string</span> <span class="var-name">$s</span>) 603 </div> 604 605 <div class="method-definition"> 606 <span class="method-result">float</span> 607 <a href="#GetX" title="details" class="method-name">GetX</a> 608 () 609 </div> 610 611 <div class="method-definition"> 612 <span class="method-result">float</span> 613 <a href="#GetY" title="details" class="method-name">GetY</a> 614 () 615 </div> 616 617 <div class="method-definition"> 618 <span class="method-result">void</span> 619 <a href="#Header" title="details" class="method-name">Header</a> 620 () 621 </div> 622 623 <div class="method-definition"> 624 <span class="method-result">void</span> 625 <a href="#Image" title="details" class="method-name">Image</a> 626 (<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>]) 627 </div> 628 629 <div class="method-definition"> 630 <span class="method-result">void</span> 631 <a href="#Line" title="details" class="method-name">Line</a> 632 (<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>) 633 </div> 634 635 <div class="method-definition"> 636 <span class="method-result">void</span> 637 <a href="#Link" title="details" class="method-name">Link</a> 638 (<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>) 639 </div> 640 641 <div class="method-definition"> 642 <span class="method-result">void</span> 643 <a href="#Ln" title="details" class="method-name">Ln</a> 644 ([<span class="var-type">float</span> <span class="var-name">$h</span> = <span class="var-default">''</span>]) 645 </div> 646 647 <div class="method-definition"> 648 <span class="method-result">void</span> 649 <a href="#MultiCell" title="details" class="method-name">MultiCell</a> 650 (<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>]) 651 </div> 652 653 <div class="method-definition"> 654 <span class="method-result">void</span> 655 <a href="#Open" title="details" class="method-name">Open</a> 656 () 657 </div> 658 659 <div class="method-definition"> 660 <span class="method-result">void</span> 661 <a href="#openHTMLTagHandler" title="details" class="method-name">openHTMLTagHandler</a> 662 (<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>) 663 </div> 664 665 <div class="method-definition"> 666 <span class="method-result">void</span> 667 <a href="#Output" title="details" class="method-name">Output</a> 668 ([<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>]) 669 </div> 670 671 <div class="method-definition"> 672 <span class="method-result">int</span> 673 <a href="#PageNo" title="details" class="method-name">PageNo</a> 674 () 675 </div> 676 677 <div class="method-definition"> 678 <span class="method-result">float</span> 679 <a href="#pixelsToMillimeters" title="details" class="method-name">pixelsToMillimeters</a> 680 (<span class="var-type">int</span> <span class="var-name">$px</span>) 681 </div> 682 683 <div class="method-definition"> 684 <span class="method-result">void</span> 685 <a href="#Rect" title="details" class="method-name">Rect</a> 686 (<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>]) 687 </div> 688 689 <div class="method-definition"> 690 <span class="method-result">void</span> 691 <a href="#SetAuthor" title="details" class="method-name">SetAuthor</a> 692 (<span class="var-type">string</span> <span class="var-name">$author</span>) 693 </div> 694 695 <div class="method-definition"> 696 <span class="method-result">void</span> 697 <a href="#SetAutoPageBreak" title="details" class="method-name">SetAutoPageBreak</a> 698 (<span class="var-type">boolean</span> <span class="var-name">$auto</span>, <span class="var-type">float</span> <span class="var-name">$margin</span>) 699 </div> 700 701 <div class="method-definition"> 702 <span class="method-result">void</span> 703 <a href="#setBarcode" title="details" class="method-name">setBarcode</a> 704 ([<span class="var-type">string</span> <span class="var-name">$bc</span> = <span class="var-default">""</span>]) 705 </div> 706 707 <div class="method-definition"> 708 <span class="method-result">void</span> 709 <a href="#SetCompression" title="details" class="method-name">SetCompression</a> 710 (<span class="var-type">boolean</span> <span class="var-name">$compress</span>) 711 </div> 712 713 <div class="method-definition"> 714 <span class="method-result">void</span> 715 <a href="#SetCreator" title="details" class="method-name">SetCreator</a> 716 (<span class="var-type">string</span> <span class="var-name">$creator</span>) 717 </div> 718 719 <div class="method-definition"> 720 <span class="method-result">void</span> 721 <a href="#SetDisplayMode" title="details" class="method-name">SetDisplayMode</a> 722 (<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>]) 723 </div> 724 725 <div class="method-definition"> 726 <span class="method-result">void</span> 727 <a href="#SetDrawColor" title="details" class="method-name">SetDrawColor</a> 728 (<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>]) 729 </div> 730 731 <div class="method-definition"> 732 <span class="method-result">void</span> 733 <a href="#SetFillColor" title="details" class="method-name">SetFillColor</a> 734 (<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>]) 735 </div> 736 737 <div class="method-definition"> 738 <span class="method-result">void</span> 739 <a href="#SetFont" title="details" class="method-name">SetFont</a> 740 (<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>) 741 </div> 742 743 <div class="method-definition"> 744 <span class="method-result">void</span> 745 <a href="#SetFontSize" title="details" class="method-name">SetFontSize</a> 746 (<span class="var-type">float</span> <span class="var-name">$size</span>) 747 </div> 748 749 <div class="method-definition"> 750 <span class="method-result">void</span> 751 <a href="#setFooterFont" title="details" class="method-name">setFooterFont</a> 752 (<span class="var-type">array</span> <span class="var-name">$font</span>) 753 </div> 754 755 <div class="method-definition"> 756 <span class="method-result">void</span> 757 <a href="#setFooterMargin" title="details" class="method-name">setFooterMargin</a> 758 ([<span class="var-type">int</span> <span class="var-name">$fm</span> = <span class="var-default">10</span>]) 759 </div> 760 761 <div class="method-definition"> 762 <span class="method-result">void</span> 763 <a href="#setHeaderData" title="details" class="method-name">setHeaderData</a> 764 ([<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>]) 765 </div> 766 767 <div class="method-definition"> 768 <span class="method-result">void</span> 769 <a href="#setHeaderFont" title="details" class="method-name">setHeaderFont</a> 770 (<span class="var-type">array</span> <span class="var-name">$font</span>) 771 </div> 772 773 <div class="method-definition"> 774 <span class="method-result">void</span> 775 <a href="#setHeaderMargin" title="details" class="method-name">setHeaderMargin</a> 776 ([<span class="var-type">int</span> <span class="var-name">$hm</span> = <span class="var-default">10</span>]) 777 </div> 778 779 <div class="method-definition"> 780 <span class="method-result">void</span> 781 <a href="#setImageScale" title="details" class="method-name">setImageScale</a> 782 (<span class="var-type">float</span> <span class="var-name">$scale</span>) 783 </div> 784 785 <div class="method-definition"> 786 <span class="method-result">void</span> 787 <a href="#SetKeywords" title="details" class="method-name">SetKeywords</a> 788 (<span class="var-type">string</span> <span class="var-name">$keywords</span>) 789 </div> 790 791 <div class="method-definition"> 792 <span class="method-result">void</span> 793 <a href="#setLanguageArray" title="details" class="method-name">setLanguageArray</a> 794 (<span class="var-type">array</span> <span class="var-name">$language</span>) 795 </div> 796 797 <div class="method-definition"> 798 <span class="method-result">void</span> 799 <a href="#SetLeftMargin" title="details" class="method-name">SetLeftMargin</a> 800 (<span class="var-type">float</span> <span class="var-name">$margin</span>) 801 </div> 802 803 <div class="method-definition"> 804 <span class="method-result">void</span> 805 <a href="#SetLineWidth" title="details" class="method-name">SetLineWidth</a> 806 (<span class="var-type">float</span> <span class="var-name">$width</span>) 807 </div> 808 809 <div class="method-definition"> 810 <span class="method-result">void</span> 811 <a href="#SetLink" title="details" class="method-name">SetLink</a> 812 (<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>]) 813 </div> 814 815 <div class="method-definition"> 816 <span class="method-result">void</span> 817 <a href="#SetMargins" title="details" class="method-name">SetMargins</a> 818 (<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>]) 819 </div> 820 821 <div class="method-definition"> 822 <span class="method-result">void</span> 823 <a href="#setPrintFooter" title="details" class="method-name">setPrintFooter</a> 824 ([<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>) 825 </div> 826 827 <div class="method-definition"> 828 <span class="method-result">void</span> 829 <a href="#setPrintHeader" title="details" class="method-name">setPrintHeader</a> 830 ([<span class="var-type">boolean</span> <span class="var-name">$val</span> = <span class="var-default">true</span>]) 831 </div> 832 833 <div class="method-definition"> 834 <span class="method-result">void</span> 835 <a href="#SetRightMargin" title="details" class="method-name">SetRightMargin</a> 836 (<span class="var-type">float</span> <span class="var-name">$margin</span>) 837 </div> 838 839 <div class="method-definition"> 840 <span class="method-result">void</span> 841 <a href="#setStyle" title="details" class="method-name">setStyle</a> 842 (<span class="var-type">string</span> <span class="var-name">$tag</span>, <span class="var-type">boolean</span> <span class="var-name">$enable</span>) 843 </div> 844 845 <div class="method-definition"> 846 <span class="method-result">void</span> 847 <a href="#SetSubject" title="details" class="method-name">SetSubject</a> 848 (<span class="var-type">string</span> <span class="var-name">$subject</span>) 849 </div> 850 851 <div class="method-definition"> 852 <span class="method-result">void</span> 853 <a href="#SetTextColor" title="details" class="method-name">SetTextColor</a> 854 (<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>]) 855 </div> 856 857 <div class="method-definition"> 858 <span class="method-result">void</span> 859 <a href="#SetTitle" title="details" class="method-name">SetTitle</a> 860 (<span class="var-type">string</span> <span class="var-name">$title</span>) 861 </div> 862 863 <div class="method-definition"> 864 <span class="method-result">void</span> 865 <a href="#SetTopMargin" title="details" class="method-name">SetTopMargin</a> 866 (<span class="var-type">float</span> <span class="var-name">$margin</span>) 867 </div> 868 869 <div class="method-definition"> 870 <span class="method-result">void</span> 871 <a href="#SetX" title="details" class="method-name">SetX</a> 872 (<span class="var-type">float</span> <span class="var-name">$x</span>) 873 </div> 874 875 <div class="method-definition"> 876 <span class="method-result">void</span> 877 <a href="#SetXY" title="details" class="method-name">SetXY</a> 878 (<span class="var-type">float</span> <span class="var-name">$x</span>, <span class="var-type">float</span> <span class="var-name">$y</span>) 879 </div> 880 881 <div class="method-definition"> 882 <span class="method-result">void</span> 883 <a href="#SetY" title="details" class="method-name">SetY</a> 884 (<span class="var-type">float</span> <span class="var-name">$y</span>) 885 </div> 886 887 <div class="method-definition"> 888 <span class="method-result">void</span> 889 <a href="#Text" title="details" class="method-name">Text</a> 890 (<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>) 891 </div> 892 893 <div class="method-definition"> 894 <span class="method-result">string</span> 895 <a href="#unhtmlentities" title="details" class="method-name">unhtmlentities</a> 896 (<span class="var-type">$text_to_convert</span> <span class="var-name">$text_to_convert</span>) 897 </div> 898 899 <div class="method-definition"> 900 <span class="method-result">array</span> 901 <a href="#UTF8StringToArray" title="details" class="method-name">UTF8StringToArray</a> 902 (<span class="var-type">string</span> <span class="var-name">$str</span>) 903 </div> 904 905 <div class="method-definition"> 906 <span class="method-result">string</span> 907 <a href="#UTF8ToUTF16BE" title="details" class="method-name">UTF8ToUTF16BE</a> 908 (<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>]) 909 </div> 910 911 <div class="method-definition"> 912 <span class="method-result">void</span> 913 <a href="#Write" title="details" class="method-name">Write</a> 914 (<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>) 915 </div> 916 917 <div class="method-definition"> 918 <span class="method-result">void</span> 919 <a href="#writeBarcode" title="details" class="method-name">writeBarcode</a> 920 (<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>) 921 </div> 922 923 <div class="method-definition"> 924 <span class="method-result">void</span> 925 <a href="#writeHTML" title="details" class="method-name">writeHTML</a> 926 (<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>) 927 </div> 928 929 <div class="method-definition"> 930 <span class="method-result">void</span> 931 <a href="#writeHTMLCell" title="details" class="method-name">writeHTMLCell</a> 932 (<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>) 933 </div> 934 935 <div class="method-definition"> 936 <span class="method-result">void</span> 937 <a href="#_begindoc" title="details" class="method-name">_begindoc</a> 938 () 939 </div> 940 941 <div class="method-definition"> 942 <span class="method-result">void</span> 943 <a href="#_beginpage" title="details" class="method-name">_beginpage</a> 944 (<span class="var-type">mixed</span> <span class="var-name">$orientation</span>) 945 </div> 946 947 <div class="method-definition"> 948 <span class="method-result">void</span> 949 <a href="#_dochecks" title="details" class="method-name">_dochecks</a> 950 () 951 </div> 952 953 <div class="method-definition"> 954 <span class="method-result">void</span> 955 <a href="#_dounderline" title="details" class="method-name">_dounderline</a> 956 (<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>) 957 </div> 958 959 <div class="method-definition"> 960 <span class="method-result">void</span> 961 <a href="#_enddoc" title="details" class="method-name">_enddoc</a> 962 () 963 </div> 964 965 <div class="method-definition"> 966 <span class="method-result">void</span> 967 <a href="#_endpage" title="details" class="method-name">_endpage</a> 968 () 969 </div> 970 971 <div class="method-definition"> 972 <span class="method-result">void</span> 973 <a href="#_escape" title="details" class="method-name">_escape</a> 974 (<span class="var-type">mixed</span> <span class="var-name">$s</span>) 975 </div> 976 977 <div class="method-definition"> 978 <span class="method-result">void</span> 979 <a href="#_escapetext" title="details" class="method-name">_escapetext</a> 980 (<span class="var-type">mixed</span> <span class="var-name">$s</span>) 981 </div> 982 983 <div class="method-definition"> 984 <span class="method-result">void</span> 985 <a href="#_freadint" title="details" class="method-name">_freadint</a> 986 (<span class="var-type">mixed</span> <span class="var-name">$f</span>) 987 </div> 988 989 <div class="method-definition"> 990 <span class="method-result">void</span> 991 <a href="#_getfontpath" title="details" class="method-name">_getfontpath</a> 992 () 993 </div> 994 995 <div class="method-definition"> 996 <span class="method-result">void</span> 997 <a href="#_newobj" title="details" class="method-name">_newobj</a> 998 () 999 </div> 1000 1001 <div class="method-definition"> 1002 <span class="method-result">void</span> 1003 <a href="#_out" title="details" class="method-name">_out</a> 1004 (<span class="var-type">mixed</span> <span class="var-name">$s</span>) 1005 </div> 1006 1007 <div class="method-definition"> 1008 <span class="method-result">void</span> 1009 <a href="#_parsejpg" title="details" class="method-name">_parsejpg</a> 1010 (<span class="var-type">mixed</span> <span class="var-name">$file</span>) 1011 </div> 1012 1013 <div class="method-definition"> 1014 <span class="method-result">void</span> 1015 <a href="#_parsepng" title="details" class="method-name">_parsepng</a> 1016 (<span class="var-type">mixed</span> <span class="var-name">$file</span>) 1017 </div> 1018 1019 <div class="method-definition"> 1020 <span class="method-result">void</span> 1021 <a href="#_putcatalog" title="details" class="method-name">_putcatalog</a> 1022 () 1023 </div> 1024 1025 <div class="method-definition"> 1026 <span class="method-result">void</span> 1027 <a href="#_putfonts" title="details" class="method-name">_putfonts</a> 1028 () 1029 </div> 1030 1031 <div class="method-definition"> 1032 <span class="method-result">void</span> 1033 <a href="#_putheader" title="details" class="method-name">_putheader</a> 1034 () 1035 </div> 1036 1037 <div class="method-definition"> 1038 <span class="method-result">void</span> 1039 <a href="#_putimages" title="details" class="method-name">_putimages</a> 1040 () 1041 </div> 1042 1043 <div class="method-definition"> 1044 <span class="method-result">void</span> 1045 <a href="#_putinfo" title="details" class="method-name">_putinfo</a> 1046 () 1047 </div> 1048 1049 <div class="method-definition"> 1050 <span class="method-result">void</span> 1051 <a href="#_putpages" title="details" class="method-name">_putpages</a> 1052 () 1053 </div> 1054 1055 <div class="method-definition"> 1056 <span class="method-result">void</span> 1057 <a href="#_putresourcedict" title="details" class="method-name">_putresourcedict</a> 1058 () 1059 </div> 1060 1061 <div class="method-definition"> 1062 <span class="method-result">void</span> 1063 <a href="#_putresources" title="details" class="method-name">_putresources</a> 1064 () 1065 </div> 1066 1067 <div class="method-definition"> 1068 <span class="method-result">void</span> 1069 <a href="#_putstream" title="details" class="method-name">_putstream</a> 1070 (<span class="var-type">mixed</span> <span class="var-name">$s</span>) 1071 </div> 1072 1073 <div class="method-definition"> 1074 <span class="method-result">void</span> 1075 <a href="#_puttrailer" title="details" class="method-name">_puttrailer</a> 1076 () 1077 </div> 1078 1079 <div class="method-definition"> 1080 <span class="method-result">void</span> 1081 <a href="#_puttruetypeunicode" title="details" class="method-name">_puttruetypeunicode</a> 1082 (<span class="var-type">mixed</span> <span class="var-name">$font</span>) 1083 </div> 1084 1085 <div class="method-definition"> 1086 <span class="method-result">void</span> 1087 <a href="#_putxobjectdict" title="details" class="method-name">_putxobjectdict</a> 1088 () 1089 </div> 1090 1091 <div class="method-definition"> 1092 <span class="method-result">void</span> 1093 <a href="#_textstring" title="details" class="method-name">_textstring</a> 1094 (<span class="var-type">mixed</span> <span class="var-name">$s</span>) 1095 </div> 1096 </div> 1097 </div> 1098 </div> 1099 1100 <a name="sec-vars"></a> 1101 <div class="info-box"> 1102 <div class="info-box-title">Variables</div> 1103 <div class="nav-bar"> 1104 <a href="#sec-description">Description</a> | 1105 <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>) 1106 1107 1108 | 1109 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) 1110 1111 </div> 1112 <div class="info-box-body"> 1113 <a name="var$AliasNbPages" id="$AliasNbPages"><!-- --></A> 1114 <div class="oddrow"> 1115 1116 <div class="var-header"> 1117 <span class="var-title"> 1118 <span class="var-type">alias</span> 1119 <span class="var-name">$AliasNbPages</span> 1120 (line <span class="line-number">430</span>) 1121 </span> 1122 </div> 1123 1124 <!-- ========== Info from phpDoc block ========= --> 1125 <ul class="tags"> 1126 <li><span class="field">var:</span> for total number of pages</li> 1127 <li><span class="field">access:</span> protected</li> 1128 </ul> 1129 1130 1131 1132 1133 1134 </div> 1135 <a name="var$author" id="$author"><!-- --></A> 1136 <div class="evenrow"> 1137 1138 <div class="var-header"> 1139 <span class="var-title"> 1140 <span class="var-type">author</span> 1141 <span class="var-name">$author</span> 1142 (line <span class="line-number">412</span>) 1143 </span> 1144 </div> 1145 1146 <!-- ========== Info from phpDoc block ========= --> 1147 <ul class="tags"> 1148 <li><span class="field">access:</span> protected</li> 1149 </ul> 1150 1151 1152 1153 1154 1155 </div> 1156 <a name="var$AutoPageBreak" id="$AutoPageBreak"><!-- --></A> 1157 <div class="oddrow"> 1158 1159 <div class="var-header"> 1160 <span class="var-title"> 1161 <span class="var-type">automatic</span> 1162 <span class="var-name">$AutoPageBreak</span> 1163 (line <span class="line-number">370</span>) 1164 </span> 1165 </div> 1166 1167 <!-- ========== Info from phpDoc block ========= --> 1168 <ul class="tags"> 1169 <li><span class="field">var:</span> page breaking</li> 1170 <li><span class="field">access:</span> protected</li> 1171 </ul> 1172 1173 1174 1175 1176 1177 </div> 1178 <a name="var$b" id="$b"><!-- --></A> 1179 <div class="evenrow"> 1180 1181 <div class="var-header"> 1182 <span class="var-title"> 1183 <span class="var-type">Bold</span> 1184 <span class="var-name">$b</span> 1185 (line <span class="line-number">657</span>) 1186 </span> 1187 </div> 1188 1189 <!-- ========== Info from phpDoc block ========= --> 1190 <ul class="tags"> 1191 <li><span class="field">var:</span> font style status.</li> 1192 <li><span class="field">access:</span> private</li> 1193 </ul> 1194 1195 1196 1197 1198 1199 </div> 1200 <a name="var$barcode" id="$barcode"><!-- --></A> 1201 <div class="oddrow"> 1202 1203 <div class="var-header"> 1204 <span class="var-title"> 1205 <span class="var-type">Barcode</span> 1206 <span class="var-name">$barcode</span> 1207 = <span class="var-default"> false</span> (line <span class="line-number">522</span>) 1208 </span> 1209 </div> 1210 1211 <!-- ========== Info from phpDoc block ========= --> 1212 <ul class="tags"> 1213 <li><span class="field">var:</span> to print on page footer (only if set).</li> 1214 <li><span class="field">access:</span> private</li> 1215 </ul> 1216 1217 1218 1219 1220 1221 </div> 1222 <a name="var$bMargin" id="$bMargin"><!-- --></A> 1223 <div class="evenrow"> 1224 1225 <div class="var-header"> 1226 <span class="var-title"> 1227 <span class="var-type">page</span> 1228 <span class="var-name">$bMargin</span> 1229 (line <span class="line-number">226</span>) 1230 </span> 1231 </div> 1232 1233 <!-- ========== Info from phpDoc block ========= --> 1234 <ul class="tags"> 1235 <li><span class="field">var:</span> break margin</li> 1236 <li><span class="field">access:</span> protected</li> 1237 </ul> 1238 1239 1240 1241 1242 1243 </div> 1244 <a name="var$buffer" id="$buffer"><!-- --></A> 1245 <div class="oddrow"> 1246 1247 <div class="var-header"> 1248 <span class="var-title"> 1249 <span class="var-type">buffer</span> 1250 <span class="var-name">$buffer</span> 1251 (line <span class="line-number">112</span>) 1252 </span> 1253 </div> 1254 1255 <!-- ========== Info from phpDoc block ========= --> 1256 <ul class="tags"> 1257 <li><span class="field">var:</span> holding in-memory PDF</li> 1258 <li><span class="field">access:</span> protected</li> 1259 </ul> 1260 1261 1262 1263 1264 1265 </div> 1266 <a name="var$cMargin" id="$cMargin"><!-- --></A> 1267 <div class="evenrow"> 1268 1269 <div class="var-header"> 1270 <span class="var-title"> 1271 <span class="var-type">cell</span> 1272 <span class="var-name">$cMargin</span> 1273 (line <span class="line-number">232</span>) 1274 </span> 1275 </div> 1276 1277 <!-- ========== Info from phpDoc block ========= --> 1278 <ul class="tags"> 1279 <li><span class="field">var:</span> margin</li> 1280 <li><span class="field">access:</span> protected</li> 1281 </ul> 1282 1283 1284 1285 1286 1287 </div> 1288 <a name="var$ColorFlag" id="$ColorFlag"><!-- --></A> 1289 <div class="oddrow"> 1290 1291 <div class="var-header"> 1292 <span class="var-title"> 1293 <span class="var-type">indicates</span> 1294 <span class="var-name">$ColorFlag</span> 1295 (line <span class="line-number">358</span>) 1296 </span> 1297 </div> 1298 1299 <!-- ========== Info from phpDoc block ========= --> 1300 <ul class="tags"> 1301 <li><span class="field">var:</span> whether fill and text colors are different</li> 1302 <li><span class="field">access:</span> protected</li> 1303 </ul> 1304 1305 1306 1307 1308 1309 </div> 1310 <a name="var$compress" id="$compress"><!-- --></A> 1311 <div class="evenrow"> 1312 1313 <div class="var-header"> 1314 <span class="var-title"> 1315 <span class="var-type">compression</span> 1316 <span class="var-name">$compress</span> 1317 (line <span class="line-number">130</span>) 1318 </span> 1319 </div> 1320 1321 <!-- ========== Info from phpDoc block ========= --> 1322 <ul class="tags"> 1323 <li><span class="field">var:</span> flag</li> 1324 <li><span class="field">access:</span> protected</li> 1325 </ul> 1326 1327 1328 1329 1330 1331 </div> 1332 <a name="var$CoreFonts" id="$CoreFonts"><!-- --></A> 1333 <div class="oddrow"> 1334 1335 <div class="var-header"> 1336 <span class="var-title"> 1337 <span class="var-type">array</span> 1338 <span class="var-name">$CoreFonts</span> 1339 (line <span class="line-number">262</span>) 1340 </span> 1341 </div> 1342 1343 <!-- ========== Info from phpDoc block ========= --> 1344 <ul class="tags"> 1345 <li><span class="field">var:</span> of standard font names</li> 1346 <li><span class="field">access:</span> protected</li> 1347 </ul> 1348 1349 1350 1351 1352 1353 </div> 1354 <a name="var$creator" id="$creator"><!-- --></A> 1355 <div class="evenrow"> 1356 1357 <div class="var-header"> 1358 <span class="var-title"> 1359 <span class="var-type">creator</span> 1360 <span class="var-name">$creator</span> 1361 (line <span class="line-number">424</span>) 1362 </span> 1363 </div> 1364 1365 <!-- ========== Info from phpDoc block ========= --> 1366 <ul class="tags"> 1367 <li><span class="field">access:</span> protected</li> 1368 </ul> 1369 1370 1371 1372 1373 1374 </div> 1375 <a name="var$CurOrientation" id="$CurOrientation"><!-- --></A> 1376 <div class="oddrow"> 1377 1378 <div class="var-header"> 1379 <span class="var-title"> 1380 <span class="var-type">current</span> 1381 <span class="var-name">$CurOrientation</span> 1382 (line <span class="line-number">142</span>) 1383 </span> 1384 </div> 1385 1386 <!-- ========== Info from phpDoc block ========= --> 1387 <ul class="tags"> 1388 <li><span class="field">var:</span> orientation</li> 1389 <li><span class="field">access:</span> protected</li> 1390 </ul> 1391 1392 1393 1394 1395 1396 </div> 1397 <a name="var$CurrentFont" id="$CurrentFont"><!-- --></A> 1398 <div class="evenrow"> 1399 1400 <div class="var-header"> 1401 <span class="var-title"> 1402 <span class="var-type">current</span> 1403 <span class="var-name">$CurrentFont</span> 1404 (line <span class="line-number">322</span>) 1405 </span> 1406 </div> 1407 1408 <!-- ========== Info from phpDoc block ========= --> 1409 <ul class="tags"> 1410 <li><span class="field">var:</span> font info</li> 1411 <li><span class="field">access:</span> protected</li> 1412 </ul> 1413 1414 1415 1416 1417 1418 </div> 1419 <a name="var$default_table_columns" id="$default_table_columns"><!-- --></A> 1420 <div class="oddrow"> 1421 1422 <div class="var-header"> 1423 <span class="var-title"> 1424 <span class="var-type">Default</span> 1425 <span class="var-name">$default_table_columns</span> 1426 = <span class="var-default"> 4</span> (line <span class="line-number">570</span>) 1427 </span> 1428 </div> 1429 1430 <!-- ========== Info from phpDoc block ========= --> 1431 <ul class="tags"> 1432 <li><span class="field">var:</span> number of columns for html table.</li> 1433 <li><span class="field">access:</span> private</li> 1434 </ul> 1435 1436 1437 1438 1439 1440 </div> 1441 <a name="var$DefOrientation" id="$DefOrientation"><!-- --></A> 1442 <div class="evenrow"> 1443 1444 <div class="var-header"> 1445 <span class="var-title"> 1446 <span class="var-type">default</span> 1447 <span class="var-name">$DefOrientation</span> 1448 (line <span class="line-number">136</span>) 1449 </span> 1450 </div> 1451 1452 <!-- ========== Info from phpDoc block ========= --> 1453 <ul class="tags"> 1454 <li><span class="field">var:</span> orientation</li> 1455 <li><span class="field">access:</span> protected</li> 1456 </ul> 1457 1458 1459 1460 1461 1462 </div> 1463 <a name="var$diffs" id="$diffs"><!-- --></A> 1464 <div class="oddrow"> 1465 1466 <div class="var-header"> 1467 <span class="var-title"> 1468 <span class="var-type">array</span> 1469 <span class="var-name">$diffs</span> 1470 (line <span class="line-number">280</span>) 1471 </span> 1472 </div> 1473 1474 <!-- ========== Info from phpDoc block ========= --> 1475 <ul class="tags"> 1476 <li><span class="field">var:</span> of encoding differences</li> 1477 <li><span class="field">access:</span> protected</li> 1478 </ul> 1479 1480 1481 1482 1483 1484 </div> 1485 <a name="var$DrawColor" id="$DrawColor"><!-- --></A> 1486 <div class="evenrow"> 1487 1488 <div class="var-header"> 1489 <span class="var-title"> 1490 <span class="var-type">commands</span> 1491 <span class="var-name">$DrawColor</span> 1492 (line <span class="line-number">340</span>) 1493 </span> 1494 </div> 1495 1496 <!-- ========== Info from phpDoc block ========= --> 1497 <ul class="tags"> 1498 <li><span class="field">var:</span> for drawing color</li> 1499 <li><span class="field">access:</span> protected</li> 1500 </ul> 1501 1502 1503 1504 1505 1506 </div> 1507 <a name="var$encoding" id="$encoding"><!-- --></A> 1508 <div class="oddrow"> 1509 1510 <div class="var-header"> 1511 <span class="var-title"> 1512 <span class="var-type">default</span> 1513 <span class="var-name">$encoding</span> 1514 = <span class="var-default"> "UTF-8"</span> (line <span class="line-number">682</span>) 1515 </span> 1516 </div> 1517 1518 <!-- ========== Info from phpDoc block ========= --> 1519 <ul class="tags"> 1520 <li><span class="field">var:</span> encoding</li> 1521 <li><span class="field">access:</span> private</li> 1522 <li><span class="field">since:</span> 1.53.0.TC010</li> 1523 </ul> 1524 1525 1526 1527 1528 1529 </div> 1530 <a name="var$fh" id="$fh"><!-- --></A> 1531 <div class="evenrow"> 1532 1533 <div class="var-header"> 1534 <span class="var-title"> 1535 <span class="var-type">height</span> 1536 <span class="var-name">$fh</span> 1537 (line <span class="line-number">178</span>) 1538 </span> 1539 </div> 1540 1541 <!-- ========== Info from phpDoc block ========= --> 1542 <ul class="tags"> 1543 <li><span class="field">var:</span> of page format in user unit</li> 1544 <li><span class="field">access:</span> protected</li> 1545 </ul> 1546 1547 1548 1549 1550 1551 </div> 1552 <a name="var$fhPt" id="$fhPt"><!-- --></A> 1553 <div class="oddrow"> 1554 1555 <div class="var-header"> 1556 <span class="var-title"> 1557 <span class="var-type">height</span> 1558 <span class="var-name">$fhPt</span> 1559 (line <span class="line-number">166</span>) 1560 </span> 1561 </div> 1562 1563 <!-- ========== Info from phpDoc block ========= --> 1564 <ul class="tags"> 1565 <li><span class="field">var:</span> of page format in points</li> 1566 <li><span class="field">access:</span> protected</li> 1567 </ul> 1568 1569 1570 1571 1572 1573 </div> 1574 <a name="var$FillColor" id="$FillColor"><!-- --></A> 1575 <div class="evenrow"> 1576 1577 <div class="var-header"> 1578 <span class="var-title"> 1579 <span class="var-type">commands</span> 1580 <span class="var-name">$FillColor</span> 1581 (line <span class="line-number">346</span>) 1582 </span> 1583 </div> 1584 1585 <!-- ========== Info from phpDoc block ========= --> 1586 <ul class="tags"> 1587 <li><span class="field">var:</span> for filling color</li> 1588 <li><span class="field">access:</span> protected</li> 1589 </ul> 1590 1591 1592 1593 1594 1595 </div> 1596 <a name="var$FontFamily" id="$FontFamily"><!-- --></A> 1597 <div class="oddrow"> 1598 1599 <div class="var-header"> 1600 <span class="var-title"> 1601 <span class="var-type">current</span> 1602 <span class="var-name">$FontFamily</span> 1603 (line <span class="line-number">304</span>) 1604 </span> 1605 </div> 1606 1607 <!-- ========== Info from phpDoc block ========= --> 1608 <ul class="tags"> 1609 <li><span class="field">var:</span> font family</li> 1610 <li><span class="field">access:</span> protected</li> 1611 </ul> 1612 1613 1614 1615 1616 1617 </div> 1618 <a name="var$FontFiles" id="$FontFiles"><!-- --></A> 1619 <div class="evenrow"> 1620 1621 <div class="var-header"> 1622 <span class="var-title"> 1623 <span class="var-type">array</span> 1624 <span class="var-name">$FontFiles</span> 1625 (line <span class="line-number">274</span>) 1626 </span> 1627 </div> 1628 1629 <!-- ========== Info from phpDoc block ========= --> 1630 <ul class="tags"> 1631 <li><span class="field">var:</span> of font files</li> 1632 <li><span class="field">access:</span> protected</li> 1633 </ul> 1634 1635 1636 1637 1638 1639 </div> 1640 <a name="var$fontList" id="$fontList"><!-- --></A> 1641 <div class="oddrow"> 1642 1643 <div class="var-header"> 1644 <span class="var-title"> 1645 <span class="var-type">HTML</span> 1646 <span class="var-name">$fontList</span> 1647 (line <span class="line-number">585</span>) 1648 </span> 1649 </div> 1650 1651 <!-- ========== Info from phpDoc block ========= --> 1652 <ul class="tags"> 1653 <li><span class="field">var:</span> PARSER: store font list.</li> 1654 <li><span class="field">access:</span> private</li> 1655 </ul> 1656 1657 1658 1659 1660 1661 </div> 1662 <a name="var$fonts" id="$fonts"><!-- --></A> 1663 <div class="evenrow"> 1664 1665 <div class="var-header"> 1666 <span class="var-title"> 1667 <span class="var-type">array</span> 1668 <span class="var-name">$fonts</span> 1669 (line <span class="line-number">268</span>) 1670 </span> 1671 </div> 1672 1673 <!-- ========== Info from phpDoc block ========= --> 1674 <ul class="tags"> 1675 <li><span class="field">var:</span> of used fonts</li> 1676 <li><span class="field">access:</span> protected</li> 1677 </ul> 1678 1679 1680 1681 1682 1683 </div> 1684 <a name="var$FontSize" id="$FontSize"><!-- --></A> 1685 <div class="oddrow"> 1686 1687 <div class="var-header"> 1688 <span class="var-title"> 1689 <span class="var-type">current</span> 1690 <span class="var-name">$FontSize</span> 1691 (line <span class="line-number">334</span>) 1692 </span> 1693 </div> 1694 1695 <!-- ========== Info from phpDoc block ========= --> 1696 <ul class="tags"> 1697 <li><span class="field">var:</span> font size in user unit</li> 1698 <li><span class="field">access:</span> protected</li> 1699 </ul> 1700 1701 1702 1703 1704 1705 </div> 1706 <a name="var$FontSizePt" id="$FontSizePt"><!-- --></A> 1707 <div class="evenrow"> 1708 1709 <div class="var-header"> 1710 <span class="var-title"> 1711 <span class="var-type">current</span> 1712 <span class="var-name">$FontSizePt</span> 1713 (line <span class="line-number">328</span>) 1714 </span> 1715 </div> 1716 1717 <!-- ========== Info from phpDoc block ========= --> 1718 <ul class="tags"> 1719 <li><span class="field">var:</span> font size in points</li> 1720 <li><span class="field">access:</span> protected</li> 1721 </ul> 1722 1723 1724 1725 1726 1727 </div> 1728 <a name="var$FontStyle" id="$FontStyle"><!-- --></A> 1729 <div class="oddrow"> 1730 1731 <div class="var-header"> 1732 <span class="var-title"> 1733 <span class="var-type">current</span> 1734 <span class="var-name">$FontStyle</span> 1735 (line <span class="line-number">310</span>) 1736 </span> 1737 </div> 1738 1739 <!-- ========== Info from phpDoc block ========= --> 1740 <ul class="tags"> 1741 <li><span class="field">var:</span> font style</li> 1742 <li><span class="field">access:</span> protected</li> 1743 </ul> 1744 1745 1746 1747 1748 1749 </div> 1750 <a name="var$footer_font" id="$footer_font"><!-- --></A> 1751 <div class="evenrow"> 1752 1753 <div class="var-header"> 1754 <span class="var-title"> 1755 <span class="var-type">Footer</span> 1756 <span class="var-name">$footer_font</span> 1757 (line <span class="line-number">510</span>) 1758 </span> 1759 </div> 1760 1761 <!-- ========== Info from phpDoc block ========= --> 1762 <ul class="tags"> 1763 <li><span class="field">var:</span> font.</li> 1764 <li><span class="field">access:</span> private</li> 1765 </ul> 1766 1767 1768 1769 1770 1771 </div> 1772 <a name="var$footer_margin" id="$footer_margin"><!-- --></A> 1773 <div class="oddrow"> 1774 1775 <div class="var-header"> 1776 <span class="var-title"> 1777 <span class="var-type">Minimum</span> 1778 <span class="var-name">$footer_margin</span> 1779 (line <span class="line-number">484</span>) 1780 </span> 1781 </div> 1782 1783 <!-- ========== Info from phpDoc block ========= --> 1784 <ul class="tags"> 1785 <li><span class="field">var:</span> distance between footer and bottom page margin.</li> 1786 <li><span class="field">access:</span> private</li> 1787 </ul> 1788 1789 1790 1791 1792 1793 </div> 1794 <a name="var$fw" id="$fw"><!-- --></A> 1795 <div class="evenrow"> 1796 1797 <div class="var-header"> 1798 <span class="var-title"> 1799 <span class="var-type">width</span> 1800 <span class="var-name">$fw</span> 1801 (line <span class="line-number">172</span>) 1802 </span> 1803 </div> 1804 1805 <!-- ========== Info from phpDoc block ========= --> 1806 <ul class="tags"> 1807 <li><span class="field">var:</span> of page format in user unit</li> 1808 <li><span class="field">access:</span> protected</li> 1809 </ul> 1810 1811 1812 1813 1814 1815 </div> 1816 <a name="var$fwPt" id="$fwPt"><!-- --></A> 1817 <div class="oddrow"> 1818 1819 <div class="var-header"> 1820 <span class="var-title"> 1821 <span class="var-type">width</span> 1822 <span class="var-name">$fwPt</span> 1823 (line <span class="line-number">160</span>) 1824 </span> 1825 </div> 1826 1827 <!-- ========== Info from phpDoc block ========= --> 1828 <ul class="tags"> 1829 <li><span class="field">var:</span> of page format in points</li> 1830 <li><span class="field">access:</span> protected</li> 1831 </ul> 1832 1833 1834 1835 1836 1837 </div> 1838 <a name="var$h" id="$h"><!-- --></A> 1839 <div class="evenrow"> 1840 1841 <div class="var-header"> 1842 <span class="var-title"> 1843 <span class="var-type">current</span> 1844 <span class="var-name">$h</span> 1845 (line <span class="line-number">202</span>) 1846 </span> 1847 </div> 1848 1849 <!-- ========== Info from phpDoc block ========= --> 1850 <ul class="tags"> 1851 <li><span class="field">var:</span> height of page in user unit</li> 1852 <li><span class="field">access:</span> protected</li> 1853 </ul> 1854 1855 1856 1857 1858 1859 </div> 1860 <a name="var$header_font" id="$header_font"><!-- --></A> 1861 <div class="oddrow"> 1862 1863 <div class="var-header"> 1864 <span class="var-title"> 1865 <span class="var-type">Header</span> 1866 <span class="var-name">$header_font</span> 1867 (line <span class="line-number">504</span>) 1868 </span> 1869 </div> 1870 1871 <!-- ========== Info from phpDoc block ========= --> 1872 <ul class="tags"> 1873 <li><span class="field">var:</span> font.</li> 1874 <li><span class="field">access:</span> private</li> 1875 </ul> 1876 1877 1878 1879 1880 1881 </div> 1882 <a name="var$header_logo" id="$header_logo"><!-- --></A> 1883 <div class="evenrow"> 1884 1885 <div class="var-header"> 1886 <span class="var-title"> 1887 <span class="var-type">Header</span> 1888 <span class="var-name">$header_logo</span> 1889 = <span class="var-default"> ""</span> (line <span class="line-number">546</span>) 1890 </span> 1891 </div> 1892 1893 <!-- ========== Info from phpDoc block ========= --> 1894 <ul class="tags"> 1895 <li><span class="field">var:</span> image logo.</li> 1896 <li><span class="field">access:</span> private</li> 1897 </ul> 1898 1899 1900 1901 1902 1903 </div> 1904 <a name="var$header_logo_width" id="$header_logo_width"><!-- --></A> 1905 <div class="oddrow"> 1906 1907 <div class="var-header"> 1908 <span class="var-title"> 1909 <span class="var-type">Header</span> 1910 <span class="var-name">$header_logo_width</span> 1911 = <span class="var-default"> 30</span> (line <span class="line-number">552</span>) 1912 </span> 1913 </div> 1914 1915 <!-- ========== Info from phpDoc block ========= --> 1916 <ul class="tags"> 1917 <li><span class="field">var:</span> image logo width in mm.</li> 1918 <li><span class="field">access:</span> private</li> 1919 </ul> 1920 1921 1922 1923 1924 1925 </div> 1926 <a name="var$header_margin" id="$header_margin"><!-- --></A> 1927 <div class="evenrow"> 1928 1929 <div class="var-header"> 1930 <span class="var-title"> 1931 <span class="var-type">Minimum</span> 1932 <span class="var-name">$header_margin</span> 1933 (line <span class="line-number">478</span>) 1934 </span> 1935 </div> 1936 1937 <!-- ========== Info from phpDoc block ========= --> 1938 <ul class="tags"> 1939 <li><span class="field">var:</span> distance between header and top page margin.</li> 1940 <li><span class="field">access:</span> private</li> 1941 </ul> 1942 1943 1944 1945 1946 1947 </div> 1948 <a name="var$header_string" id="$header_string"><!-- --></A> 1949 <div class="oddrow"> 1950 1951 <div class="var-header"> 1952 <span class="var-title"> 1953 <span class="var-type">String</span> 1954 <span class="var-name">$header_string</span> 1955 = <span class="var-default"> ""</span> (line <span class="line-number">564</span>) 1956 </span> 1957 </div> 1958 1959 <!-- ========== Info from phpDoc block ========= --> 1960 <ul class="tags"> 1961 <li><span class="field">var:</span> to print on document header.</li> 1962 <li><span class="field">access:</span> private</li> 1963 </ul> 1964 1965 1966 1967 1968 1969 </div> 1970 <a name="var$header_title" id="$header_title"><!-- --></A> 1971 <div class="evenrow"> 1972 1973 <div class="var-header"> 1974 <span class="var-title"> 1975 <span class="var-type">String</span> 1976 <span class="var-name">$header_title</span> 1977 = <span class="var-default"> ""</span> (line <span class="line-number">558</span>) 1978 </span> 1979 </div> 1980 1981 <!-- ========== Info from phpDoc block ========= --> 1982 <ul class="tags"> 1983 <li><span class="field">var:</span> to print as title on document header.</li> 1984 <li><span class="field">access:</span> private</li> 1985 </ul> 1986 1987 1988 1989 1990 1991 </div> 1992 <a name="var$header_width" id="$header_width"><!-- --></A> 1993 <div class="oddrow"> 1994 1995 <div class="var-header"> 1996 <span class="var-title"> 1997 <span class="var-type">Header</span> 1998 <span class="var-name">$header_width</span> 1999 = <span class="var-default"> 0</span> (line <span class="line-number">540</span>) 2000 </span> 2001 </div> 2002 2003 <!-- ========== Info from phpDoc block ========= --> 2004 <ul class="tags"> 2005 <li><span class="field">var:</span> width (0 = full page width).</li> 2006 <li><span class="field">access:</span> private</li> 2007 </ul> 2008 2009 2010 2011 2012 2013 </div> 2014 <a name="var$hPt" id="$hPt"><!-- --></A> 2015 <div class="evenrow"> 2016 2017 <div class="var-header"> 2018 <span class="var-title"> 2019 <span class="var-type">current</span> 2020 <span class="var-name">$hPt</span> 2021 (line <span class="line-number">190</span>) 2022 </span> 2023 </div> 2024 2025 <!-- ========== Info from phpDoc block ========= --> 2026 <ul class="tags"> 2027 <li><span class="field">var:</span> height of page in points</li> 2028 <li><span class="field">access:</span> protected</li> 2029 </ul> 2030 2031 2032 2033 2034 2035 </div> 2036 <a name="var$HREF" id="$HREF"><!-- --></A> 2037 <div class="oddrow"> 2038 2039 <div class="var-header"> 2040 <span class="var-title"> 2041 <span class="var-type">HTML</span> 2042 <span class="var-name">$HREF</span> 2043 (line <span class="line-number">579</span>) 2044 </span> 2045 </div> 2046 2047 <!-- ========== Info from phpDoc block ========= --> 2048 <ul class="tags"> 2049 <li><span class="field">var:</span> PARSER: store current link.</li> 2050 <li><span class="field">access:</span> private</li> 2051 </ul> 2052 2053 2054 2055 2056 2057 </div> 2058 <a name="var$i" id="$i"><!-- --></A> 2059 <div class="evenrow"> 2060 2061 <div class="var-header"> 2062 <span class="var-title"> 2063 <span class="var-type">Italic</span> 2064 <span class="var-name">$i</span> 2065 (line <span class="line-number">669</span>) 2066 </span> 2067 </div> 2068 2069 <!-- ========== Info from phpDoc block ========= --> 2070 <ul class="tags"> 2071 <li><span class="field">var:</span> font style status.</li> 2072 <li><span class="field">access:</span> private</li> 2073 </ul> 2074 2075 2076 2077 2078 2079 </div> 2080 <a name="var$images" id="$images"><!-- --></A> 2081 <div class="oddrow"> 2082 2083 <div class="var-header"> 2084 <span class="var-title"> 2085 <span class="var-type">array</span> 2086 <span class="var-name">$images</span> 2087 (line <span class="line-number">286</span>) 2088 </span> 2089 </div> 2090 2091 <!-- ========== Info from phpDoc block ========= --> 2092 <ul class="tags"> 2093 <li><span class="field">var:</span> of used images</li> 2094 <li><span class="field">access:</span> protected</li> 2095 </ul> 2096 2097 2098 2099 2100 2101 </div> 2102 <a name="var$imgscale" id="$imgscale"><!-- --></A> 2103 <div class="evenrow"> 2104 2105 <div class="var-header"> 2106 <span class="var-title"> 2107 <span class="var-type">image</span> 2108 <span class="var-name">$imgscale</span> 2109 = <span class="var-default"> 1</span> (line <span class="line-number">454</span>) 2110 </span> 2111 </div> 2112 2113 <!-- ========== Info from phpDoc block ========= --> 2114 <ul class="tags"> 2115 <li><span class="field">var:</span> scale factor</li> 2116 <li><span class="field">access:</span> protected</li> 2117 <li><span class="field">author:</span> Nicola Asuni</li> 2118 <li><span class="field">since:</span> 2004-06-14</li> 2119 </ul> 2120 2121 2122 2123 2124 2125 </div> 2126 <a name="var$img_rb_x" id="$img_rb_x"><!-- --></A> 2127 <div class="oddrow"> 2128 2129 <div class="var-header"> 2130 <span class="var-title"> 2131 <span class="var-type">right-bottom</span> 2132 <span class="var-name">$img_rb_x</span> 2133 (line <span class="line-number">438</span>) 2134 </span> 2135 </div> 2136 2137 <!-- ========== Info from phpDoc block ========= --> 2138 <ul class="tags"> 2139 <li><span class="field">var:</span> corner X coordinate of inserted image</li> 2140 <li><span class="field">access:</span> protected</li> 2141 <li><span class="field">author:</span> Nicola Asuni</li> 2142 <li><span class="field">since:</span> 2002-07-31</li> 2143 </ul> 2144 2145 2146 2147 2148 2149 </div> 2150 <a name="var$img_rb_y" id="$img_rb_y"><!-- --></A> 2151 <div class="evenrow"> 2152 2153 <div class="var-header"> 2154 <span class="var-title"> 2155 <span class="var-type">right-bottom</span> 2156 <span class="var-name">$img_rb_y</span> 2157 (line <span class="line-number">446</span>) 2158 </span> 2159 </div> 2160 2161 <!-- ========== Info from phpDoc block ========= --> 2162 <ul class="tags"> 2163 <li><span class="field">var:</span> corner Y coordinate of inserted image</li> 2164 <li><span class="field">access:</span> protected</li> 2165 <li><span class="field">author:</span> Nicola Asuni</li> 2166 <li><span class="field">since:</span> 2002-07-31</li> 2167 </ul> 2168 2169 2170 2171 2172 2173 </div> 2174 <a name="var$InFooter" id="$InFooter"><!-- --></A> 2175 <div class="oddrow"> 2176 2177 <div class="var-header"> 2178 <span class="var-title"> 2179 <span class="var-type">flag</span> 2180 <span class="var-name">$InFooter</span> 2181 (line <span class="line-number">382</span>) 2182 </span> 2183 </div> 2184 2185 <!-- ========== Info from phpDoc block ========= --> 2186 <ul class="tags"> 2187 <li><span class="field">var:</span> set when processing footer</li> 2188 <li><span class="field">access:</span> protected</li> 2189 </ul> 2190 2191 2192 2193 2194 2195 </div> 2196 <a name="var$internal_encoding" id="$internal_encoding"><!-- --></A> 2197 <div class="evenrow"> 2198 2199 <div class="var-header"> 2200 <span class="var-title"> 2201 <span class="var-type">PHP</span> 2202 <span class="var-name">$internal_encoding</span> 2203 (line <span class="line-number">689</span>) 2204 </span> 2205 </div> 2206 2207 <!-- ========== Info from phpDoc block ========= --> 2208 <ul class="tags"> 2209 <li><span class="field">var:</span> internal encoding</li> 2210 <li><span class="field">access:</span> private</li> 2211 <li><span class="field">since:</span> 1.53.0.TC016</li> 2212 </ul> 2213 2214 2215 2216 2217 2218 </div> 2219 <a name="var$issetcolor" id="$issetcolor"><!-- --></A> 2220 <div class="oddrow"> 2221 2222 <div class="var-header"> 2223 <span class="var-title"> 2224 <span class="var-type">HTML</span> 2225 <span class="var-name">$issetcolor</span> 2226 (line <span class="line-number">597</span>) 2227 </span> 2228 </div> 2229 2230 <!-- ========== Info from phpDoc block ========= --> 2231 <ul class="tags"> 2232 <li><span class="field">var:</span> PARSER: true when color attribute is set.</li> 2233 <li><span class="field">access:</span> private</li> 2234 </ul> 2235 2236 2237 2238 2239 2240 </div> 2241 <a name="var$issetfont" id="$issetfont"><!-- --></A> 2242 <div class="evenrow"> 2243 2244 <div class="var-header"> 2245 <span class="var-title"> 2246 <span class="var-type">HTML</span> 2247 <span class="var-name">$issetfont</span> 2248 (line <span class="line-number">591</span>) 2249 </span> 2250 </div> 2251 2252 <!-- ========== Info from phpDoc block ========= --> 2253 <ul class="tags"> 2254 <li><span class="field">var:</span> PARSER: true when font attribute is set.</li> 2255 <li><span class="field">access:</span> private</li> 2256 </ul> 2257 2258 2259 2260 2261 2262 </div> 2263 <a name="var$isunicode" id="$isunicode"><!-- --></A> 2264 <div class="oddrow"> 2265 2266 <div class="var-header"> 2267 <span class="var-title"> 2268 <span class="var-type">boolean</span> 2269 <span class="var-name">$isunicode</span> 2270 = <span class="var-default"> false</span> (line <span class="line-number">462</span>) 2271 </span> 2272 </div> 2273 2274 <!-- ========== Info from phpDoc block ========= --> 2275 <ul class="tags"> 2276 <li><span class="field">var:</span> set to true when the input text is unicode (require unicode fonts)</li> 2277 <li><span class="field">access:</span> protected</li> 2278 <li><span class="field">author:</span> Nicola Asuni</li> 2279 <li><span class="field">since:</span> 2005-01-02</li> 2280 </ul> 2281 2282 2283 2284 2285 2286 </div> 2287 <a name="var$k" id="$k"><!-- --></A> 2288 <div class="evenrow"> 2289 2290 <div class="var-header"> 2291 <span class="var-title"> 2292 <span class="var-type">scale</span> 2293 <span class="var-name">$k</span> 2294 (line <span class="line-number">154</span>) 2295 </span> 2296 </div> 2297 2298 <!-- ========== Info from phpDoc block ========= --> 2299 <ul class="tags"> 2300 <li><span class="field">var:</span> factor (number of points in user unit)</li> 2301 <li><span class="field">access:</span> protected</li> 2302 </ul> 2303 2304 2305 2306 2307 2308 </div> 2309 <a name="var$keywords" id="$keywords"><!-- --></A> 2310 <div class="oddrow"> 2311 2312 <div class="var-header"> 2313 <span class="var-title"> 2314 <span class="var-type">keywords</span> 2315 <span class="var-name">$keywords</span> 2316 (line <span class="line-number">418</span>) 2317 </span> 2318 </div> 2319 2320 <!-- ========== Info from phpDoc block ========= --> 2321 <ul class="tags"> 2322 <li><span class="field">access:</span> protected</li> 2323 </ul> 2324 2325 2326 2327 2328 2329 </div> 2330 <a name="var$l" id="$l"><!-- --></A> 2331 <div class="evenrow"> 2332 2333 <div class="var-header"> 2334 <span class="var-title"> 2335 <span class="var-type">Language</span> 2336 <span class="var-name">$l</span> 2337 (line <span class="line-number">516</span>) 2338 </span> 2339 </div> 2340 2341 <!-- ========== Info from phpDoc block ========= --> 2342 <ul class="tags"> 2343 <li><span class="field">var:</span> templates.</li> 2344 <li><span class="field">access:</span> private</li> 2345 </ul> 2346 2347 2348 2349 2350 2351 </div> 2352 <a name="var$lasth" id="$lasth"><!-- --></A> 2353 <div class="oddrow"> 2354 2355 <div class="var-header"> 2356 <span class="var-title"> 2357 <span class="var-type">height</span> 2358 <span class="var-name">$lasth</span> 2359 (line <span class="line-number">250</span>) 2360 </span> 2361 </div> 2362 2363 <!-- ========== Info from phpDoc block ========= --> 2364 <ul class="tags"> 2365 <li><span class="field">var:</span> of last cell printed</li> 2366 <li><span class="field">access:</span> protected</li> 2367 </ul> 2368 2369 2370 2371 2372 2373 </div> 2374 <a name="var$LayoutMode" id="$LayoutMode"><!-- --></A> 2375 <div class="evenrow"> 2376 2377 <div class="var-header"> 2378 <span class="var-title"> 2379 <span class="var-type">layout</span> 2380 <span class="var-name">$LayoutMode</span> 2381 (line <span class="line-number">394</span>) 2382 </span> 2383 </div> 2384 2385 <!-- ========== Info from phpDoc block ========= --> 2386 <ul class="tags"> 2387 <li><span class="field">var:</span> display mode</li> 2388 <li><span class="field">access:</span> protected</li> 2389 </ul> 2390 2391 2392 2393 2394 2395 </div> 2396 <a name="var$LineWidth" id="$LineWidth"><!-- --></A> 2397 <div class="oddrow"> 2398 2399 <div class="var-header"> 2400 <span class="var-title"> 2401 <span class="var-type">line</span> 2402 <span class="var-name">$LineWidth</span> 2403 (line <span class="line-number">256</span>) 2404 </span> 2405 </div> 2406 2407 <!-- ========== Info from phpDoc block ========= --> 2408 <ul class="tags"> 2409 <li><span class="field">var:</span> width in user unit</li> 2410 <li><span class="field">access:</span> protected</li> 2411 </ul> 2412 2413 2414 2415 2416 2417 </div> 2418 <a name="var$links" id="$links"><!-- --></A> 2419 <div class="evenrow"> 2420 2421 <div class="var-header"> 2422 <span class="var-title"> 2423 <span class="var-type">array</span> 2424 <span class="var-name">$links</span> 2425 (line <span class="line-number">298</span>) 2426 </span> 2427 </div> 2428 2429 <!-- ========== Info from phpDoc block ========= --> 2430 <ul class="tags"> 2431 <li><span class="field">var:</span> of internal links</li> 2432 <li><span class="field">access:</span> protected</li> 2433 </ul> 2434 2435 2436 2437 2438 2439 </div> 2440 <a name="var$lispacer" id="$lispacer"><!-- --></A> 2441 <div class="oddrow"> 2442 2443 <div class="var-header"> 2444 <span class="var-title"> 2445 <span class="var-type">spacer</span> 2446 <span class="var-name">$lispacer</span> 2447 = <span class="var-default"> ""</span> (line <span class="line-number">675</span>) 2448 </span> 2449 </div> 2450 2451 <!-- ========== Info from phpDoc block ========= --> 2452 <ul class="tags"> 2453 <li><span class="field">var:</span> for LI tags.</li> 2454 <li><span class="field">access:</span> private</li> 2455 </ul> 2456 2457 2458 2459 2460 2461 </div> 2462 <a name="var$listcount" id="$listcount"><!-- --></A> 2463 <div class="evenrow"> 2464 2465 <div class="var-header"> 2466 <span class="var-title"> 2467 <span class="var-type">HTML</span> 2468 <span class="var-name">$listcount</span> 2469 = <span class="var-default"> 0</span> (line <span class="line-number">609</span>) 2470 </span> 2471 </div> 2472 2473 <!-- ========== Info from phpDoc block ========= --> 2474 <ul class="tags"> 2475 <li><span class="field">var:</span> PARSER: count list items.</li> 2476 <li><span class="field">access:</span> private</li> 2477 </ul> 2478 2479 2480 2481 2482 2483 </div> 2484 <a name="var$listordered" id="$listordered"><!-- --></A> 2485 <div class="oddrow"> 2486 2487 <div class="var-header"> 2488 <span class="var-title"> 2489 <span class="var-type">HTML</span> 2490 <span class="var-name">$listordered</span> 2491 = <span class="var-default"> false</span> (line <span class="line-number">603</span>) 2492 </span> 2493 </div> 2494 2495 <!-- ========== Info from phpDoc block ========= --> 2496 <ul class="tags"> 2497 <li><span class="field">var:</span> PARSER: true in case of ordered list (OL), false otherwise.</li> 2498 <li><span class="field">access:</span> private</li> 2499 </ul> 2500 2501 2502 2503 2504 2505 </div> 2506 <a name="var$lMargin" id="$lMargin"><!-- --></A> 2507 <div class="evenrow"> 2508 2509 <div class="var-header"> 2510 <span class="var-title"> 2511 <span class="var-type">left</span> 2512 <span class="var-name">$lMargin</span> 2513 (line <span class="line-number">208</span>) 2514 </span> 2515 </div> 2516 2517 <!-- ========== Info from phpDoc block ========= --> 2518 <ul class="tags"> 2519 <li><span class="field">var:</span> margin</li> 2520 <li><span class="field">access:</span> protected</li> 2521 </ul> 2522 2523 2524 2525 2526 2527 </div> 2528 <a name="var$n" id="$n"><!-- --></A> 2529 <div class="oddrow"> 2530 2531 <div class="var-header"> 2532 <span class="var-title"> 2533 <span class="var-type">current</span> 2534 <span class="var-name">$n</span> 2535 (line <span class="line-number">100</span>) 2536 </span> 2537 </div> 2538 2539 <!-- ========== Info from phpDoc block ========= --> 2540 <ul class="tags"> 2541 <li><span class="field">var:</span> object number</li> 2542 <li><span class="field">access:</span> protected</li> 2543 </ul> 2544 2545 2546 2547 2548 2549 </div> 2550 <a name="var$offsets" id="$offsets"><!-- --></A> 2551 <div class="evenrow"> 2552 2553 <div class="var-header"> 2554 <span class="var-title"> 2555 <span class="var-type">array</span> 2556 <span class="var-name">$offsets</span> 2557 (line <span class="line-number">106</span>) 2558 </span> 2559 </div> 2560 2561 <!-- ========== Info from phpDoc block ========= --> 2562 <ul class="tags"> 2563 <li><span class="field">var:</span> of object offsets</li> 2564 <li><span class="field">access:</span> protected</li> 2565 </ul> 2566 2567 2568 2569 2570 2571 </div> 2572 <a name="var$OrientationChanges" id="$OrientationChanges"><!-- --></A> 2573 <div class="oddrow"> 2574 2575 <div class="var-header"> 2576 <span class="var-title"> 2577 <span class="var-type">array</span> 2578 <span class="var-name">$OrientationChanges</span> 2579 (line <span class="line-number">148</span>) 2580 </span> 2581 </div> 2582 2583 <!-- ========== Info from phpDoc block ========= --> 2584 <ul class="tags"> 2585 <li><span class="field">var:</span> indicating orientation changes</li> 2586 <li><span class="field">access:</span> protected</li> 2587 </ul> 2588 2589 2590 2591 2592 2593 </div> 2594 <a name="var$original_lMargin" id="$original_lMargin"><!-- --></A> 2595 <div class="evenrow"> 2596 2597 <div class="var-header"> 2598 <span class="var-title"> 2599 <span class="var-type">original</span> 2600 <span class="var-name">$original_lMargin</span> 2601 (line <span class="line-number">491</span>) 2602 </span> 2603 </div> 2604 2605 <!-- ========== Info from phpDoc block ========= --> 2606 <ul class="tags"> 2607 <li><span class="field">var:</span> left margin value</li> 2608 <li><span class="field">access:</span> private</li> 2609 <li><span class="field">since:</span> 1.53.0.TC013</li> 2610 </ul> 2611 2612 2613 2614 2615 2616 </div> 2617 <a name="var$original_rMargin" id="$original_rMargin"><!-- --></A> 2618 <div class="oddrow"> 2619 2620 <div class="var-header"> 2621 <span class="var-title"> 2622 <span class="var-type">original</span> 2623 <span class="var-name">$original_rMargin</span> 2624 (line <span class="line-number">498</span>) 2625 </span> 2626 </div> 2627 2628 <!-- ========== Info from phpDoc block ========= --> 2629 <ul class="tags"> 2630 <li><span class="field">var:</span> right margin value</li> 2631 <li><span class="field">access:</span> private</li> 2632 <li><span class="field">since:</span> 1.53.0.TC013</li> 2633 </ul> 2634 2635 2636 2637 2638 2639 </div> 2640 <a name="var$page" id="$page"><!-- --></A> 2641 <div class="evenrow"> 2642 2643 <div class="var-header"> 2644 <span class="var-title"> 2645 <span class="var-type">current</span> 2646 <span class="var-name">$page</span> 2647 (line <span class="line-number">94</span>) 2648 </span> 2649 </div> 2650 2651 <!-- ========== Info from phpDoc block ========= --> 2652 <ul class="tags"> 2653 <li><span class="field">var:</span> page number</li> 2654 <li><span class="field">access:</span> protected</li> 2655 </ul> 2656 2657 2658 2659 2660 2661 </div> 2662 <a name="var$PageBreakTrigger" id="$PageBreakTrigger"><!-- --></A> 2663 <div class="oddrow"> 2664 2665 <div class="var-header"> 2666 <span class="var-title"> 2667 <span class="var-type">threshold</span> 2668 <span class="var-name">$PageBreakTrigger</span> 2669 (line <span class="line-number">376</span>) 2670 </span> 2671 </div> 2672 2673 <!-- ========== Info from phpDoc block ========= --> 2674 <ul class="tags"> 2675 <li><span class="field">var:</span> used to trigger page breaks</li> 2676 <li><span class="field">access:</span> protected</li> 2677 </ul> 2678 2679 2680 2681 2682 2683 </div> 2684 <a name="var$PageLinks" id="$PageLinks"><!-- --></A> 2685 <div class="evenrow"> 2686 2687 <div class="var-header"> 2688 <span class="var-title"> 2689 <span class="var-type">array</span> 2690 <span class="var-name">$PageLinks</span> 2691 (line <span class="line-number">292</span>) 2692 </span> 2693 </div> 2694 2695 <!-- ========== Info from phpDoc block ========= --> 2696 <ul class="tags"> 2697 <li><span class="field">var:</span> of links in pages</li> 2698 <li><span class="field">access:</span> protected</li> 2699 </ul> 2700 2701 2702 2703 2704 2705 </div> 2706 <a name="var$pages" id="$pages"><!-- --></A> 2707 <div class="oddrow"> 2708 2709 <div class="var-header"> 2710 <span class="var-title"> 2711 <span class="var-type">array</span> 2712 <span class="var-name">$pages</span> 2713 (line <span class="line-number">118</span>) 2714 </span> 2715 </div> 2716 2717 <!-- ========== Info from phpDoc block ========= --> 2718 <ul class="tags"> 2719 <li><span class="field">var:</span> containing pages</li> 2720 <li><span class="field">access:</span> protected</li> 2721 </ul> 2722 2723 2724 2725 2726 2727 </div> 2728 <a name="var$PDFVersion" id="$PDFVersion"><!-- --></A> 2729 <div class="evenrow"> 2730 2731 <div class="var-header"> 2732 <span class="var-title"> 2733 <span class="var-type">PDF</span> 2734 <span class="var-name">$PDFVersion</span> 2735 = <span class="var-default"> "1.3"</span> (line <span class="line-number">469</span>) 2736 </span> 2737 </div> 2738 2739 <!-- ========== Info from phpDoc block ========= --> 2740 <ul class="tags"> 2741 <li><span class="field">var:</span> version</li> 2742 <li><span class="field">access:</span> protected</li> 2743 <li><span class="field">since:</span> 1.5.3</li> 2744 </ul> 2745 2746 2747 2748 2749 2750 </div> 2751 <a name="var$prevFillColor" id="$prevFillColor"><!-- --></A> 2752 <div class="oddrow"> 2753 2754 <div class="var-header"> 2755 <span class="var-title"> 2756 <span class="var-type">store</span> 2757 <span class="var-name">$prevFillColor</span> 2758 = <span class="var-default">array(255,255,255)</span> (line <span class="line-number">696</span>) 2759 </span> 2760 </div> 2761 2762 <!-- ========== Info from phpDoc block ========= --> 2763 <ul class="tags"> 2764 <li><span class="field">var:</span> previous fill color as RGB array</li> 2765 <li><span class="field">access:</span> private</li> 2766 <li><span class="field">since:</span> 1.53.0.TC017</li> 2767 </ul> 2768 2769 2770 2771 2772 2773 </div> 2774 <a name="var$prevFontFamily" id="$prevFontFamily"><!-- --></A> 2775 <div class="evenrow"> 2776 2777 <div class="var-header"> 2778 <span class="var-title"> 2779 <span class="var-type">store</span> 2780 <span class="var-name">$prevFontFamily</span> 2781 (line <span class="line-number">710</span>) 2782 </span> 2783 </div> 2784 2785 <!-- ========== Info from phpDoc block ========= --> 2786 <ul class="tags"> 2787 <li><span class="field">var:</span> previous font family</li> 2788 <li><span class="field">access:</span> private</li> 2789 <li><span class="field">since:</span> 1.53.0.TC017</li> 2790 </ul> 2791 2792 2793 2794 2795 2796 </div> 2797 <a name="var$prevFontStyle" id="$prevFontStyle"><!-- --></A> 2798 <div class="oddrow"> 2799 2800 <div class="var-header"> 2801 <span class="var-title"> 2802 <span class="var-type">store</span> 2803 <span class="var-name">$prevFontStyle</span> 2804 (line <span class="line-number">717</span>) 2805 </span> 2806 </div> 2807 2808 <!-- ========== Info from phpDoc block ========= --> 2809 <ul class="tags"> 2810 <li><span class="field">var:</span> previous font style</li> 2811 <li><span class="field">access:</span> private</li> 2812 <li><span class="field">since:</span> 1.53.0.TC017</li> 2813 </ul> 2814 2815 2816 2817 2818 2819 </div> 2820 <a name="var$prevTextColor" id="$prevTextColor"><!-- --></A> 2821 <div class="evenrow"> 2822 2823 <div class="var-header"> 2824 <span class="var-title"> 2825 <span class="var-type">store</span> 2826 <span class="var-name">$prevTextColor</span> 2827 = <span class="var-default">array(0,0,0)</span> (line <span class="line-number">703</span>) 2828 </span> 2829 </div> 2830 2831 <!-- ========== Info from phpDoc block ========= --> 2832 <ul class="tags"> 2833 <li><span class="field">var:</span> previous text color as RGB array</li> 2834 <li><span class="field">access:</span> private</li> 2835 <li><span class="field">since:</span> 1.53.0.TC017</li> 2836 </ul> 2837 2838 2839 2840 2841 2842 </div> 2843 <a name="var$print_footer" id="$print_footer"><!-- --></A> 2844 <div class="oddrow"> 2845 2846 <div class="var-header"> 2847 <span class="var-title"> 2848 <span class="var-type">If</span> 2849 <span class="var-name">$print_footer</span> 2850 = <span class="var-default"> true</span> (line <span class="line-number">534</span>) 2851 </span> 2852 </div> 2853 2854 <!-- ========== Info from phpDoc block ========= --> 2855 <ul class="tags"> 2856 <li><span class="field">var:</span> true prints footer.</li> 2857 <li><span class="field">access:</span> private</li> 2858 </ul> 2859 2860 2861 2862 2863 2864 </div> 2865 <a name="var$print_header" id="$print_header"><!-- --></A> 2866 <div class="evenrow"> 2867 2868 <div class="var-header"> 2869 <span class="var-title"> 2870 <span class="var-type">If</span> 2871 <span class="var-name">$print_header</span> 2872 = <span class="var-default"> true</span> (line <span class="line-number">528</span>) 2873 </span> 2874 </div> 2875 2876 <!-- ========== Info from phpDoc block ========= --> 2877 <ul class="tags"> 2878 <li><span class="field">var:</span> true prints header</li> 2879 <li><span class="field">access:</span> private</li> 2880 </ul> 2881 2882 2883 2884 2885 2886 </div> 2887 <a name="var$rMargin" id="$rMargin"><!-- --></A> 2888 <div class="oddrow"> 2889 2890 <div class="var-header"> 2891 <span class="var-title"> 2892 <span class="var-type">right</span> 2893 <span class="var-name">$rMargin</span> 2894 (line <span class="line-number">220</span>) 2895 </span> 2896 </div> 2897 2898 <!-- ========== Info from phpDoc block ========= --> 2899 <ul class="tags"> 2900 <li><span class="field">var:</span> margin</li> 2901 <li><span class="field">access:</span> protected</li> 2902 </ul> 2903 2904 2905 2906 2907 2908 </div> 2909 <a name="var$state" id="$state"><!-- --></A> 2910 <div class="evenrow"> 2911 2912 <div class="var-header"> 2913 <span class="var-title"> 2914 <span class="var-type">current</span> 2915 <span class="var-name">$state</span> 2916 (line <span class="line-number">124</span>) 2917 </span> 2918 </div> 2919 2920 <!-- ========== Info from phpDoc block ========= --> 2921 <ul class="tags"> 2922 <li><span class="field">var:</span> document state</li> 2923 <li><span class="field">access:</span> protected</li> 2924 </ul> 2925 2926 2927 2928 2929 2930 </div> 2931 <a name="var$subject" id="$subject"><!-- --></A> 2932 <div class="oddrow"> 2933 2934 <div class="var-header"> 2935 <span class="var-title"> 2936 <span class="var-type">subject</span> 2937 <span class="var-name">$subject</span> 2938 (line <span class="line-number">406</span>) 2939 </span> 2940 </div> 2941 2942 <!-- ========== Info from phpDoc block ========= --> 2943 <ul class="tags"> 2944 <li><span class="field">access:</span> protected</li> 2945 </ul> 2946 2947 2948 2949 2950 2951 </div> 2952 <a name="var$tableborder" id="$tableborder"><!-- --></A> 2953 <div class="evenrow"> 2954 2955 <div class="var-header"> 2956 <span class="var-title"> 2957 <span class="var-type">HTML</span> 2958 <span class="var-name">$tableborder</span> 2959 = <span class="var-default"> 0</span> (line <span class="line-number">615</span>) 2960 </span> 2961 </div> 2962 2963 <!-- ========== Info from phpDoc block ========= --> 2964 <ul class="tags"> 2965 <li><span class="field">var:</span> PARSER: size of table border.</li> 2966 <li><span class="field">access:</span> private</li> 2967 </ul> 2968 2969 2970 2971 2972 2973 </div> 2974 <a name="var$tdalign" id="$tdalign"><!-- --></A> 2975 <div class="oddrow"> 2976 2977 <div class="var-header"> 2978 <span class="var-title"> 2979 <span class="var-type">HTML</span> 2980 <span class="var-name">$tdalign</span> 2981 = <span class="var-default"> "L"</span> (line <span class="line-number">639</span>) 2982 </span> 2983 </div> 2984 2985 <!-- ========== Info from phpDoc block ========= --> 2986 <ul class="tags"> 2987 <li><span class="field">var:</span> PARSER: table align.</li> 2988 <li><span class="field">access:</span> private</li> 2989 </ul> 2990 2991 2992 2993 2994 2995 </div> 2996 <a name="var$tdbegin" id="$tdbegin"><!-- --></A> 2997 <div class="evenrow"> 2998 2999 <div class="var-header"> 3000 <span class="var-title"> 3001 <span class="var-type">HTML</span> 3002 <span class="var-name">$tdbegin</span> 3003 = <span class="var-default"> false</span> (line <span class="line-number">621</span>) 3004 </span> 3005 </div> 3006 3007 <!-- ========== Info from phpDoc block ========= --> 3008 <ul class="tags"> 3009 <li><span class="field">var:</span> PARSER: true at the beginning of table.</li> 3010 <li><span class="field">access:</span> private</li> 3011 </ul> 3012 3013 3014 3015 3016 3017 </div> 3018 <a name="var$tdbgcolor" id="$tdbgcolor"><!-- --></A> 3019 <div class="oddrow"> 3020 3021 <div class="var-header"> 3022 <span class="var-title"> 3023 <span class="var-type">HTML</span> 3024 <span class="var-name">$tdbgcolor</span> 3025 = <span class="var-default"> false</span> (line <span class="line-number">645</span>) 3026 </span> 3027 </div> 3028 3029 <!-- ========== Info from phpDoc block ========= --> 3030 <ul class="tags"> 3031 <li><span class="field">var:</span> PARSER: table background color.</li> 3032 <li><span class="field">access:</span> private</li> 3033 </ul> 3034 3035 3036 3037 3038 3039 </div> 3040 <a name="var$tdheight" id="$tdheight"><!-- --></A> 3041 <div class="evenrow"> 3042 3043 <div class="var-header"> 3044 <span class="var-title"> 3045 <span class="var-type">HTML</span> 3046 <span class="var-name">$tdheight</span> 3047 = <span class="var-default"> 0</span> (line <span class="line-number">633</span>) 3048 </span> 3049 </div> 3050 3051 <!-- ========== Info from phpDoc block ========= --> 3052 <ul class="tags"> 3053 <li><span class="field">var:</span> PARSER: table height.</li> 3054 <li><span class="field">access:</span> private</li> 3055 </ul> 3056 3057 3058 3059 3060 3061 </div> 3062 <a name="var$tdwidth" id="$tdwidth"><!-- --></A> 3063 <div class="oddrow"> 3064 3065 <div class="var-header"> 3066 <span class="var-title"> 3067 <span class="var-type">HTML</span> 3068 <span class="var-name">$tdwidth</span> 3069 = <span class="var-default"> 0</span> (line <span class="line-number">627</span>) 3070 </span> 3071 </div> 3072 3073 <!-- ========== Info from phpDoc block ========= --> 3074 <ul class="tags"> 3075 <li><span class="field">var:</span> PARSER: table width.</li> 3076 <li><span class="field">access:</span> private</li> 3077 </ul> 3078 3079 3080 3081 3082 3083 </div> 3084 <a name="var$tempfontsize" id="$tempfontsize"><!-- --></A> 3085 <div class="evenrow"> 3086 3087 <div class="var-header"> 3088 <span class="var-title"> 3089 <span class="var-type">Store</span> 3090 <span class="var-name">$tempfontsize</span> 3091 = <span class="var-default"> 10</span> (line <span class="line-number">651</span>) 3092 </span> 3093 </div> 3094 3095 <!-- ========== Info from phpDoc block ========= --> 3096 <ul class="tags"> 3097 <li><span class="field">var:</span> temporary font size in points.</li> 3098 <li><span class="field">access:</span> private</li> 3099 </ul> 3100 3101 3102 3103 3104 3105 </div> 3106 <a name="var$TextColor" id="$TextColor"><!-- --></A> 3107 <div class="oddrow"> 3108 3109 <div class="var-header"> 3110 <span class="var-title"> 3111 <span class="var-type">commands</span> 3112 <span class="var-name">$TextColor</span> 3113 (line <span class="line-number">352</span>) 3114 </span> 3115 </div> 3116 3117 <!-- ========== Info from phpDoc block ========= --> 3118 <ul class="tags"> 3119 <li><span class="field">var:</span> for text color</li> 3120 <li><span class="field">access:</span> protected</li> 3121 </ul> 3122 3123 3124 3125 3126 3127 </div> 3128 <a name="var$title" id="$title"><!-- --></A> 3129 <div class="evenrow"> 3130 3131 <div class="var-header"> 3132 <span class="var-title"> 3133 <span class="var-type">title</span> 3134 <span class="var-name">$title</span> 3135 (line <span class="line-number">400</span>) 3136 </span> 3137 </div> 3138 3139 <!-- ========== Info from phpDoc block ========= --> 3140 <ul class="tags"> 3141 <li><span class="field">access:</span> protected</li> 3142 </ul> 3143 3144 3145 3146 3147 3148 </div> 3149 <a name="var$tMargin" id="$tMargin"><!-- --></A> 3150 <div class="oddrow"> 3151 3152 <div class="var-header"> 3153 <span class="var-title"> 3154 <span class="var-type">top</span> 3155 <span class="var-name">$tMargin</span> 3156 (line <span class="line-number">214</span>) 3157 </span> 3158 </div> 3159 3160 <!-- ========== Info from phpDoc block ========= --> 3161 <ul class="tags"> 3162 <li><span class="field">var:</span> margin</li> 3163 <li><span class="field">access:</span> protected</li> 3164 </ul> 3165 3166 3167 3168 3169 3170 </div> 3171 <a name="var$u" id="$u"><!-- --></A> 3172 <div class="evenrow"> 3173 3174 <div class="var-header"> 3175 <span class="var-title"> 3176 <span class="var-type">Underlined</span> 3177 <span class="var-name">$u</span> 3178 (line <span class="line-number">663</span>) 3179 </span> 3180 </div> 3181 3182 <!-- ========== Info from phpDoc block ========= --> 3183 <ul class="tags"> 3184 <li><span class="field">var:</span> font style status.</li> 3185 <li><span class="field">access:</span> private</li> 3186 </ul> 3187 3188 3189 3190 3191 3192 </div> 3193 <a name="var$underline" id="$underline"><!-- --></A> 3194 <div class="oddrow"> 3195 3196 <div class="var-header"> 3197 <span class="var-title"> 3198 <span class="var-type">underlining</span> 3199 <span class="var-name">$underline</span> 3200 (line <span class="line-number">316</span>) 3201 </span> 3202 </div> 3203 3204 <!-- ========== Info from phpDoc block ========= --> 3205 <ul class="tags"> 3206 <li><span class="field">var:</span> flag</li> 3207 <li><span class="field">access:</span> protected</li> 3208 </ul> 3209 3210 3211 3212 3213 3214 </div> 3215 <a name="var$w" id="$w"><!-- --></A> 3216 <div class="evenrow"> 3217 3218 <div class="var-header"> 3219 <span class="var-title"> 3220 <span class="var-type">current</span> 3221 <span class="var-name">$w</span> 3222 (line <span class="line-number">196</span>) 3223 </span> 3224 </div> 3225 3226 <!-- ========== Info from phpDoc block ========= --> 3227 <ul class="tags"> 3228 <li><span class="field">var:</span> width of page in user unit</li> 3229 <li><span class="field">access:</span> protected</li> 3230 </ul> 3231 3232 3233 3234 3235 3236 </div> 3237 <a name="var$wPt" id="$wPt"><!-- --></A> 3238 <div class="oddrow"> 3239 3240 <div class="var-header"> 3241 <span class="var-title"> 3242 <span class="var-type">current</span> 3243 <span class="var-name">$wPt</span> 3244 (line <span class="line-number">184</span>) 3245 </span> 3246 </div> 3247 3248 <!-- ========== Info from phpDoc block ========= --> 3249 <ul class="tags"> 3250 <li><span class="field">var:</span> width of page in points</li> 3251 <li><span class="field">access:</span> protected</li> 3252 </ul> 3253 3254 3255 3256 3257 3258 </div> 3259 <a name="var$ws" id="$ws"><!-- --></A> 3260 <div class="evenrow"> 3261 3262 <div class="var-header"> 3263 <span class="var-title"> 3264 <span class="var-type">word</span> 3265 <span class="var-name">$ws</span> 3266 (line <span class="line-number">364</span>) 3267 </span> 3268 </div> 3269 3270 <!-- ========== Info from phpDoc block ========= --> 3271 <ul class="tags"> 3272 <li><span class="field">var:</span> spacing</li> 3273 <li><span class="field">access:</span> protected</li> 3274 </ul> 3275 3276 3277 3278 3279 3280 </div> 3281 <a name="var$x" id="$x"><!-- --></A> 3282 <div class="oddrow"> 3283 3284 <div class="var-header"> 3285 <span class="var-title"> 3286 <span class="var-type">current</span> 3287 <span class="var-name">$x</span> 3288 (line <span class="line-number">238</span>) 3289 </span> 3290 </div> 3291 3292 <!-- ========== Info from phpDoc block ========= --> 3293 <ul class="tags"> 3294 <li><span class="field">var:</span> horizontal position in user unit for cell positioning</li> 3295 <li><span class="field">access:</span> protected</li> 3296 </ul> 3297 3298 3299 3300 3301 3302 </div> 3303 <a name="var$y" id="$y"><!-- --></A> 3304 <div class="evenrow"> 3305 3306 <div class="var-header"> 3307 <span class="var-title"> 3308 <span class="var-type">current</span> 3309 <span class="var-name">$y</span> 3310 (line <span class="line-number">244</span>) 3311 </span> 3312 </div> 3313 3314 <!-- ========== Info from phpDoc block ========= --> 3315 <ul class="tags"> 3316 <li><span class="field">var:</span> vertical position in user unit for cell positioning</li> 3317 <li><span class="field">access:</span> protected</li> 3318 </ul> 3319 3320 3321 3322 3323 3324 </div> 3325 <a name="var$ZoomMode" id="$ZoomMode"><!-- --></A> 3326 <div class="oddrow"> 3327 3328 <div class="var-header"> 3329 <span class="var-title"> 3330 <span class="var-type">zoom</span> 3331 <span class="var-name">$ZoomMode</span> 3332 (line <span class="line-number">388</span>) 3333 </span> 3334 </div> 3335 3336 <!-- ========== Info from phpDoc block ========= --> 3337 <ul class="tags"> 3338 <li><span class="field">var:</span> display mode</li> 3339 <li><span class="field">access:</span> protected</li> 3340 </ul> 3341 3342 3343 3344 3345 3346 </div> 3347 3348 </div> 3349 </div> 3350 3351 <a name="sec-methods"></a> 3352 <div class="info-box"> 3353 <div class="info-box-title">Methods</div> 3354 <div class="nav-bar"> 3355 <a href="#sec-description">Description</a> | 3356 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) 3357 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>) 3358 3359 </div> 3360 <div class="info-box-body"> 3361 <A NAME='method_detail'></A> 3362 <a name="method__construct" id="__construct"><!-- --></a> 3363 <div class="evenrow"> 3364 3365 <div class="method-header"> 3366 <span class="method-title">Constructor __construct</span> (line <span class="line-number">735</span>) 3367 </div> 3368 3369 <!-- ========== Info from phpDoc block ========= --> 3370 <p class="short-description">This is the class constructor.</p> 3371 <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> 3372 <ul class="tags"> 3373 <li><span class="field">access:</span> public</li> 3374 <li><span class="field">since:</span> 1.0</li> 3375 </ul> 3376 3377 <div class="method-signature"> 3378 <span class="method-result">TCPDF</span> 3379 <span class="method-name"> 3380 __construct 3381 </span> 3382 ([<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>]) 3383 </div> 3384 3385 <ul class="parameters"> 3386 <li> 3387 <span class="var-type">string</span> 3388 <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> 3389 <li> 3390 <span class="var-type">string</span> 3391 <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> 3392 <li> 3393 <span class="var-type">mixed</span> 3394 <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> 3395 <li> 3396 <span class="var-type">boolean</span> 3397 <span class="var-name">$unicode</span><span class="var-description">: TRUE means that the input text is unicode (default = true)</span> </li> 3398 <li> 3399 <span class="var-type">String</span> 3400 <span class="var-name">$encoding</span><span class="var-description">: charset encoding; default is UTF-8</span> </li> 3401 </ul> 3402 3403 3404 </div> 3405 <a name="method__destruct" id="__destruct"><!-- --></a> 3406 <div class="oddrow"> 3407 3408 <div class="method-header"> 3409 <span class="method-title">Destructor __destruct</span> (line <span class="line-number">921</span>) 3410 </div> 3411 3412 <!-- ========== Info from phpDoc block ========= --> 3413 <p class="short-description">Default destructor.</p> 3414 <ul class="tags"> 3415 <li><span class="field">access:</span> public</li> 3416 <li><span class="field">since:</span> 1.53.0.TC016</li> 3417 </ul> 3418 3419 <div class="method-signature"> 3420 <span class="method-result">void</span> 3421 <span class="method-name"> 3422 __destruct 3423 </span> 3424 () 3425 </div> 3426 3427 3428 3429 </div> 3430 <a name="methodAcceptPageBreak" id="AcceptPageBreak"><!-- --></a> 3431 <div class="evenrow"> 3432 3433 <div class="method-header"> 3434 <span class="method-title">AcceptPageBreak</span> (line <span class="line-number">1949</span>) 3435 </div> 3436 3437 <!-- ========== Info from phpDoc block ========= --> 3438 <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> 3439 <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 { 3440 var $col=0; 3441 3442 public function SetCol($col) { 3443 //Move position to a column 3444 $this->col=$col; 3445 $x=10+$col*65; 3446 $this->SetLeftMargin($x); 3447 $this->SetX($x); 3448 } 3449 3450 public function AcceptPageBreak() { 3451 if($this->col<2) { 3452 //Go to next column 3453 $this->SetCol($this->col+1); 3454 $this->SetY(10); 3455 return false; 3456 } 3457 else { 3458 //Go back to first column and issue page break 3459 $this->SetCol(0); 3460 return true; 3461 } 3462 } 3463 } 3464 3465 $pdf=new PDF(); 3466 $pdf->Open(); 3467 $pdf->AddPage(); 3468 $pdf->SetFont('Arial','',12); 3469 for($i=1;$i<=300;$i++) { 3470 $pdf->Cell(0,5,"Line $i",0,1); 3471 } 3472 $pdf->Output();</pre></p></p> 3473 <ul class="tags"> 3474 <li><span class="field">access:</span> public</li> 3475 <li><span class="field">see:</span> <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetAutoPageBreak">TCPDF::SetAutoPageBreak()</a></li> 3476 <li><span class="field">since:</span> 1.4</li> 3477 </ul> 3478 3479 <div class="method-signature"> 3480 <span class="method-result">boolean</span> 3481 <span class="method-name"> 3482 AcceptPageBreak 3483 </span> 3484 () 3485 </div> 3486 3487 3488 3489 </div> 3490 <a name="methodAddFont" id="AddFont"><!-- --></a> 3491 <div class="oddrow"> 3492 3493 <div class="method-header"> 3494 <span class="method-title">AddFont</span> (line <span class="line-number">1627</span>) 3495 </div> 3496 3497 <!-- ========== Info from phpDoc block ========= --> 3498 <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> 3499 <p class="description"><p>Support UTF-8 Unicode [Nicola Asuni, 2005-01-02]. <strong>Example</strong>:<br /> <pre> $pdf->AddFont('Comic','I'); 3500 // is equivalent to: 3501 $pdf->AddFont('Comic','I','comici.php');</pre></p></p> 3502 <ul class="tags"> 3503 <li><span class="field">access:</span> public</li> 3504 <li><span class="field">see:</span> <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetFont">TCPDF::SetFont()</a></li> 3505 <li><span class="field">since:</span> 1.5</li> 3506 </ul> 3507 3508 <div class="method-signature"> 3509 <span class="method-result">void</span> 3510 <span class="method-name"> 3511 AddFont 3512 </span> 3513 (<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>]) 3514 </div> 3515 3516 <ul class="parameters"> 3517 <li> 3518 <span class="var-type">string</span> 3519 <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> 3520 <li> 3521 <span class="var-type">string</span> 3522 <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> 3523 <li> 3524 <span class="var-type">string</span> 3525 <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> 3526 </ul> 3527 3528 3529 </div> 3530 <a name="methodaddHtmlLink" id="addHtmlLink"><!-- --></a> 3531 <div class="evenrow"> 3532 3533 <div class="method-header"> 3534 <span class="method-title">addHtmlLink</span> (line <span class="line-number">4150</span>) 3535 </div> 3536 3537 <!-- ========== Info from phpDoc block ========= --> 3538 <p class="short-description">Output anchor link.</p> 3539 <ul class="tags"> 3540 <li><span class="field">access:</span> public</li> 3541 </ul> 3542 3543 <div class="method-signature"> 3544 <span class="method-result">void</span> 3545 <span class="method-name"> 3546 addHtmlLink 3547 </span> 3548 (<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>) 3549 </div> 3550 3551 <ul class="parameters"> 3552 <li> 3553 <span class="var-type">string</span> 3554 <span class="var-name">$url</span><span class="var-description">: link URL</span> </li> 3555 <li> 3556 <span class="var-type">string</span> 3557 <span class="var-name">$name</span><span class="var-description">: link name</span> </li> 3558 <li> 3559 <span class="var-type">int</span> 3560 <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> 3561 </ul> 3562 3563 3564 </div> 3565 <a name="methodAddLink" id="AddLink"><!-- --></a> 3566 <div class="oddrow"> 3567 3568 <div class="method-header"> 3569 <span class="method-title">AddLink</span> (line <span class="line-number">1843</span>) 3570 </div> 3571 3572 <!-- ========== Info from phpDoc block ========= --> 3573 <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> 3574 <ul class="tags"> 3575 <li><span class="field">access:</span> public</li> 3576 <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> 3577 <li><span class="field">since:</span> 1.5</li> 3578 </ul> 3579 3580 <div class="method-signature"> 3581 <span class="method-result">void</span> 3582 <span class="method-name"> 3583 AddLink 3584 </span> 3585 () 3586 </div> 3587 3588 3589 3590 </div> 3591 <a name="methodAddPage" id="AddPage"><!-- --></a> 3592 <div class="evenrow"> 3593 3594 <div class="method-header"> 3595 <span class="method-title">AddPage</span> (line <span class="line-number">1228</span>) 3596 </div> 3597 3598 <!-- ========== Info from phpDoc block ========= --> 3599 <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> 3600 <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> 3601 <ul class="tags"> 3602 <li><span class="field">access:</span> public</li> 3603 <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> 3604 <li><span class="field">since:</span> 1.0</li> 3605 </ul> 3606 3607 <div class="method-signature"> 3608 <span class="method-result">void</span> 3609 <span class="method-name"> 3610 AddPage 3611 </span> 3612 ([<span class="var-type">string</span> <span class="var-name">$orientation</span> = <span class="var-default">''</span>]) 3613 </div> 3614 3615 <ul class="parameters"> 3616 <li> 3617 <span class="var-type">string</span> 3618 <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> 3619 </ul> 3620 3621 3622 </div> 3623 <a name="methodAliasNbPages" id="AliasNbPages"><!-- --></a> 3624 <div class="oddrow"> 3625 3626 <div class="method-header"> 3627 <span class="method-title">AliasNbPages</span> (line <span class="line-number">1170</span>) 3628 </div> 3629 3630 <!-- ========== Info from phpDoc block ========= --> 3631 <p class="short-description">Defines an alias for the total number of pages. It will be substituted as the document is closed.<br /></p> 3632 <p class="description"><p><strong>Example:</strong><br /> <pre> class PDF extends TCPDF { 3633 public function Footer() { 3634 //Go to 1.5 cm from bottom 3635 $this->SetY(-15); 3636 //Select Arial italic 8 3637 $this->SetFont('Arial','I',8); 3638 //Print current and total page numbers 3639 $this->Cell(0,10,'Page '.$this->PageNo().'/{nb}',0,0,'C'); 3640 } 3641 } 3642 $pdf=new PDF(); 3643 $pdf->AliasNbPages();</pre></p></p> 3644 <ul class="tags"> 3645 <li><span class="field">access:</span> public</li> 3646 <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> 3647 <li><span class="field">since:</span> 1.4</li> 3648 </ul> 3649 3650 <div class="method-signature"> 3651 <span class="method-result">void</span> 3652 <span class="method-name"> 3653 AliasNbPages 3654 </span> 3655 ([<span class="var-type">string</span> <span class="var-name">$alias</span> = <span class="var-default">'{nb}'</span>]) 3656 </div> 3657 3658 <ul class="parameters"> 3659 <li> 3660 <span class="var-type">string</span> 3661 <span class="var-name">$alias</span><span class="var-description">: The alias. Default value: {nb}.</span> </li> 3662 </ul> 3663 3664 3665 </div> 3666 <a name="methodCell" id="Cell"><!-- --></a> 3667 <div class="evenrow"> 3668 3669 <div class="method-header"> 3670 <span class="method-title">Cell</span> (line <span class="line-number">1969</span>) 3671 </div> 3672 3673 <!-- ========== Info from phpDoc block ========= --> 3674 <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> 3675 <ul class="tags"> 3676 <li><span class="field">access:</span> public</li> 3677 <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> 3678 <li><span class="field">since:</span> 1.0</li> 3679 </ul> 3680 3681 <div class="method-signature"> 3682 <span class="method-result">void</span> 3683 <span class="method-name"> 3684 Cell 3685 </span> 3686 (<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>]) 3687 </div> 3688 3689 <ul class="parameters"> 3690 <li> 3691 <span class="var-type">float</span> 3692 <span class="var-name">$w</span><span class="var-description">: Cell width. If 0, the cell extends up to the right margin.</span> </li> 3693 <li> 3694 <span class="var-type">float</span> 3695 <span class="var-name">$h</span><span class="var-description">: Cell height. Default value: 0.</span> </li> 3696 <li> 3697 <span class="var-type">string</span> 3698 <span class="var-name">$txt</span><span class="var-description">: String to print. Default value: empty string.</span> </li> 3699 <li> 3700 <span class="var-type">mixed</span> 3701 <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> 3702 <li> 3703 <span class="var-type">int</span> 3704 <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> 3705 <li> 3706 <span class="var-type">string</span> 3707 <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> 3708 <li> 3709 <span class="var-type">int</span> 3710 <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> 3711 <li> 3712 <span class="var-type">mixed</span> 3713 <span class="var-name">$link</span><span class="var-description">: URL or identifier returned by AddLink().</span> </li> 3714 </ul> 3715 3716 3717 </div> 3718 <a name="methodClose" id="Close"><!-- --></a> 3719 <div class="oddrow"> 3720 3721 <div class="method-header"> 3722 <span class="method-title">Close</span> (line <span class="line-number">1202</span>) 3723 </div> 3724 3725 <!-- ========== Info from phpDoc block ========= --> 3726 <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> 3727 <ul class="tags"> 3728 <li><span class="field">access:</span> public</li> 3729 <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> 3730 <li><span class="field">since:</span> 1.0</li> 3731 </ul> 3732 3733 <div class="method-signature"> 3734 <span class="method-result">void</span> 3735 <span class="method-name"> 3736 Close 3737 </span> 3738 () 3739 </div> 3740 3741 3742 3743 </div> 3744 <a name="methodclosedHTMLTagHandler" id="closedHTMLTagHandler"><!-- --></a> 3745 <div class="evenrow"> 3746 3747 <div class="method-header"> 3748 <span class="method-title">closedHTMLTagHandler</span> (line <span class="line-number">4016</span>) 3749 </div> 3750 3751 <!-- ========== Info from phpDoc block ========= --> 3752 <p class="short-description">Process closing tags.</p> 3753 <ul class="tags"> 3754 <li><span class="field">access:</span> private</li> 3755 </ul> 3756 3757 <div class="method-signature"> 3758 <span class="method-result">void</span> 3759 <span class="method-name"> 3760 closedHTMLTagHandler 3761 </span> 3762 (<span class="var-type">string</span> <span class="var-name">$tag</span>) 3763 </div> 3764 3765 <ul class="parameters"> 3766 <li> 3767 <span class="var-type">string</span> 3768 <span class="var-name">$tag</span><span class="var-description">: tag name (in uppercase)</span> </li> 3769 </ul> 3770 3771 3772 </div> 3773 <a name="methodconvertColorHexToDec" id="convertColorHexToDec"><!-- --></a> 3774 <div class="oddrow"> 3775 3776 <div class="method-header"> 3777 <span class="method-title">convertColorHexToDec</span> (line <span class="line-number">4166</span>) 3778 </div> 3779 3780 <!-- ========== Info from phpDoc block ========= --> 3781 <p class="short-description">Returns an associative array (keys: R,G,B) from a hex html code (e.g. #3FE5AA).</p> 3782 <ul class="tags"> 3783 <li><span class="field">access:</span> private</li> 3784 </ul> 3785 3786 <div class="method-signature"> 3787 <span class="method-result">array</span> 3788 <span class="method-name"> 3789 convertColorHexToDec 3790 </span> 3791 ([<span class="var-type">string</span> <span class="var-name">$color</span> = <span class="var-default">"#000000"</span>]) 3792 </div> 3793 3794 <ul class="parameters"> 3795 <li> 3796 <span class="var-type">string</span> 3797 <span class="var-name">$color</span><span class="var-description">: hexadecimal html color [#rrggbb]</span> </li> 3798 </ul> 3799 3800 3801 </div> 3802 <a name="methodError" id="Error"><!-- --></a> 3803 <div class="evenrow"> 3804 3805 <div class="method-header"> 3806 <span class="method-title">Error</span> (line <span class="line-number">1181</span>) 3807 </div> 3808 3809 <!-- ========== Info from phpDoc block ========= --> 3810 <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> 3811 <p class="description"><p>2004-06-11 :: Nicola Asuni : changed bold tag with strong</p></p> 3812 <ul class="tags"> 3813 <li><span class="field">access:</span> public</li> 3814 <li><span class="field">since:</span> 1.0</li> 3815 </ul> 3816 3817 <div class="method-signature"> 3818 <span class="method-result">void</span> 3819 <span class="method-name"> 3820 Error 3821 </span> 3822 (<span class="var-type">string</span> <span class="var-name">$msg</span>) 3823 </div> 3824 3825 <ul class="parameters"> 3826 <li> 3827 <span class="var-type">string</span> 3828 <span class="var-name">$msg</span><span class="var-description">: The error message</span> </li> 3829 </ul> 3830 3831 3832 </div> 3833 <a name="methodFooter" id="Footer"><!-- --></a> 3834 <div class="oddrow"> 3835 3836 <div class="method-header"> 3837 <span class="method-title">Footer</span> (line <span class="line-number">1400</span>) 3838 </div> 3839 3840 <!-- ========== Info from phpDoc block ========= --> 3841 <p class="short-description">This method is used to render the page footer.</p> 3842 <p class="description"><p>It is automatically called by AddPage() and could be overwritten in your own inherited class.</p></p> 3843 <ul class="tags"> 3844 <li><span class="field">access:</span> public</li> 3845 </ul> 3846 3847 <div class="method-signature"> 3848 <span class="method-result">void</span> 3849 <span class="method-name"> 3850 Footer 3851 </span> 3852 () 3853 </div> 3854 3855 3856 3857 </div> 3858 <a name="methodgetBreakMargin" id="getBreakMargin"><!-- --></a> 3859 <div class="evenrow"> 3860 3861 <div class="method-header"> 3862 <span class="method-title">getBreakMargin</span> (line <span class="line-number">974</span>) 3863 </div> 3864 3865 <!-- ========== Info from phpDoc block ========= --> 3866 <p class="short-description">Returns the page break margin.</p> 3867 <ul class="tags"> 3868 <li><span class="field">return:</span> page break margin.</li> 3869 <li><span class="field">access:</span> public</li> 3870 <li><span class="field">since:</span> 1.5.2</li> 3871 <li><span class="field">author:</span> Nicola Asuni</li> 3872 </ul> 3873 3874 <div class="method-signature"> 3875 <span class="method-result">int</span> 3876 <span class="method-name"> 3877 getBreakMargin 3878 </span> 3879 () 3880 </div> 3881 3882 3883 3884 </div> 3885 <a name="methodgetImageScale" id="getImageScale"><!-- --></a> 3886 <div class="oddrow"> 3887 3888 <div class="method-header"> 3889 <span class="method-title">getImageScale</span> (line <span class="line-number">944</span>) 3890 </div> 3891 3892 <!-- ========== Info from phpDoc block ========= --> 3893 <p class="short-description">Returns the image scale.</p> 3894 <ul class="tags"> 3895 <li><span class="field">return:</span> image scale.</li> 3896 <li><span class="field">access:</span> public</li> 3897 <li><span class="field">since:</span> 1.5.2</li> 3898 <li><span class="field">author:</span> Nicola Asuni</li> 3899 </ul> 3900 3901 <div class="method-signature"> 3902 <span class="method-result">float</span> 3903 <span class="method-name"> 3904 getImageScale 3905 </span> 3906 () 3907 </div> 3908 3909 3910 3911 </div> 3912 <a name="methodgetPageHeight" id="getPageHeight"><!-- --></a> 3913 <div class="evenrow"> 3914 3915 <div class="method-header"> 3916 <span class="method-title">getPageHeight</span> (line <span class="line-number">964</span>) 3917 </div> 3918 3919 <!-- ========== Info from phpDoc block ========= --> 3920 <p class="short-description">Returns the page height in units.</p> 3921 <ul class="tags"> 3922 <li><span class="field">return:</span> page height.</li> 3923 <li><span class="field">access:</span> public</li> 3924 <li><span class="field">since:</span> 1.5.2</li> 3925 <li><span class="field">author:</span> Nicola Asuni</li> 3926 </ul> 3927 3928 <div class="method-signature"> 3929 <span class="method-result">int</span> 3930 <span class="method-name"> 3931 getPageHeight 3932 </span> 3933 () 3934 </div> 3935 3936 3937 3938 </div> 3939 <a name="methodgetPageWidth" id="getPageWidth"><!-- --></a> 3940 <div class="oddrow"> 3941 3942 <div class="method-header"> 3943 <span class="method-title">getPageWidth</span> (line <span class="line-number">954</span>) 3944 </div> 3945 3946 <!-- ========== Info from phpDoc block ========= --> 3947 <p class="short-description">Returns the page width in units.</p> 3948 <ul class="tags"> 3949 <li><span class="field">return:</span> page width.</li> 3950 <li><span class="field">access:</span> public</li> 3951 <li><span class="field">since:</span> 1.5.2</li> 3952 <li><span class="field">author:</span> Nicola Asuni</li> 3953 </ul> 3954 3955 <div class="method-signature"> 3956 <span class="method-result">int</span> 3957 <span class="method-name"> 3958 getPageWidth 3959 </span> 3960 () 3961 </div> 3962 3963 3964 3965 </div> 3966 <a name="methodgetPDFData" id="getPDFData"><!-- --></a> 3967 <div class="evenrow"> 3968 3969 <div class="method-header"> 3970 <span class="method-title">getPDFData</span> (line <span class="line-number">3648</span>) 3971 </div> 3972 3973 <!-- ========== Info from phpDoc block ========= --> 3974 <p class="short-description">Returns the PDF data.</p> 3975 <ul class="tags"> 3976 <li><span class="field">access:</span> public</li> 3977 </ul> 3978 3979 <div class="method-signature"> 3980 <span class="method-result">void</span> 3981 <span class="method-name"> 3982 getPDFData 3983 </span> 3984 () 3985 </div> 3986 3987 3988 3989 </div> 3990 <a name="methodgetScaleFactor" id="getScaleFactor"><!-- --></a> 3991 <div class="oddrow"> 3992 3993 <div class="method-header"> 3994 <span class="method-title">getScaleFactor</span> (line <span class="line-number">984</span>) 3995 </div> 3996 3997 <!-- ========== Info from phpDoc block ========= --> 3998 <p class="short-description">Returns the scale factor (number of points in user unit).</p> 3999 <ul class="tags"> 4000 <li><span class="field">return:</span> scale factor.</li> 4001 <li><span class="field">access:</span> public</li> 4002 <li><span class="field">since:</span> 1.5.2</li> 4003 <li><span class="field">author:</span> Nicola Asuni</li> 4004 </ul> 4005 4006 <div class="method-signature"> 4007 <span class="method-result">int</span> 4008 <span class="method-name"> 4009 getScaleFactor 4010 </span> 4011 () 4012 </div> 4013 4014 4015 4016 </div> 4017 <a name="methodGetStringWidth" id="GetStringWidth"><!-- --></a> 4018 <div class="evenrow"> 4019 4020 <div class="method-header"> 4021 <span class="method-title">GetStringWidth</span> (line <span class="line-number">1527</span>) 4022 </div> 4023 4024 <!-- ========== Info from phpDoc block ========= --> 4025 <p class="short-description">Returns the length of a string in user unit. A font must be selected.<br /></p> 4026 <p class="description"><p>Support UTF-8 Unicode [Nicola Asuni, 2005-01-02]</p></p> 4027 <ul class="tags"> 4028 <li><span class="field">access:</span> public</li> 4029 <li><span class="field">since:</span> 1.2</li> 4030 </ul> 4031 4032 <div class="method-signature"> 4033 <span class="method-result">int</span> 4034 <span class="method-name"> 4035 GetStringWidth 4036 </span> 4037 (<span class="var-type">string</span> <span class="var-name">$s</span>) 4038 </div> 4039 4040 <ul class="parameters"> 4041 <li> 4042 <span class="var-type">string</span> 4043 <span class="var-name">$s</span><span class="var-description">: The string whose length is to be computed</span> </li> 4044 </ul> 4045 4046 4047 </div> 4048 <a name="methodGetX" id="GetX"><!-- --></a> 4049 <div class="oddrow"> 4050 4051 <div class="method-header"> 4052 <span class="method-title">GetX</span> (line <span class="line-number">2409</span>) 4053 </div> 4054 4055 <!-- ========== Info from phpDoc block ========= --> 4056 <p class="short-description">Returns the abscissa of the current position.</p> 4057 <ul class="tags"> 4058 <li><span class="field">access:</span> public</li> 4059 <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> 4060 <li><span class="field">since:</span> 1.2</li> 4061 </ul> 4062 4063 <div class="method-signature"> 4064 <span class="method-result">float</span> 4065 <span class="method-name"> 4066 GetX 4067 </span> 4068 () 4069 </div> 4070 4071 4072 4073 </div> 4074 <a name="methodGetY" id="GetY"><!-- --></a> 4075 <div class="evenrow"> 4076 4077 <div class="method-header"> 4078 <span class="method-title">GetY</span> (line <span class="line-number">2436</span>) 4079 </div> 4080 4081 <!-- ========== Info from phpDoc block ========= --> 4082 <p class="short-description">Returns the ordinate of the current position.</p> 4083 <ul class="tags"> 4084 <li><span class="field">access:</span> public</li> 4085 <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> 4086 <li><span class="field">since:</span> 1.0</li> 4087 </ul> 4088 4089 <div class="method-signature"> 4090 <span class="method-result">float</span> 4091 <span class="method-name"> 4092 GetY 4093 </span> 4094 () 4095 </div> 4096 4097 4098 4099 </div> 4100 <a name="methodHeader" id="Header"><!-- --></a> 4101 <div class="oddrow"> 4102 4103 <div class="method-header"> 4104 <span class="method-title">Header</span> (line <span class="line-number">1347</span>) 4105 </div> 4106 4107 <!-- ========== Info from phpDoc block ========= --> 4108 <p class="short-description">This method is used to render the page header.</p> 4109 <p class="description"><p>It is automatically called by AddPage() and could be overwritten in your own inherited class.</p></p> 4110 <ul class="tags"> 4111 <li><span class="field">access:</span> public</li> 4112 </ul> 4113 4114 <div class="method-signature"> 4115 <span class="method-result">void</span> 4116 <span class="method-name"> 4117 Header 4118 </span> 4119 () 4120 </div> 4121 4122 4123 4124 </div> 4125 <a name="methodImage" id="Image"><!-- --></a> 4126 <div class="evenrow"> 4127 4128 <div class="method-header"> 4129 <span class="method-title">Image</span> (line <span class="line-number">2327</span>) 4130 </div> 4131 4132 <!-- ========== Info from phpDoc block ========= --> 4133 <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> 4134 <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> 4135 <ul class="tags"> 4136 <li><span class="field">access:</span> public</li> 4137 <li><span class="field">see:</span> <a href="../com.tecnick.tcpdf/TCPDF.html#methodAddLink">TCPDF::AddLink()</a></li> 4138 <li><span class="field">since:</span> 1.1</li> 4139 </ul> 4140 4141 <div class="method-signature"> 4142 <span class="method-result">void</span> 4143 <span class="method-name"> 4144 Image 4145 </span> 4146 (<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>]) 4147 </div> 4148 4149 <ul class="parameters"> 4150 <li> 4151 <span class="var-type">string</span> 4152 <span class="var-name">$file</span><span class="var-description">: Name of the file containing the image.</span> </li> 4153 <li> 4154 <span class="var-type">float</span> 4155 <span class="var-name">$x</span><span class="var-description">: Abscissa of the upper-left corner.</span> </li> 4156 <li> 4157 <span class="var-type">float</span> 4158 <span class="var-name">$y</span><span class="var-description">: Ordinate of the upper-left corner.</span> </li> 4159 <li> 4160 <span class="var-type">float</span> 4161 <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> 4162 <li> 4163 <span class="var-type">float</span> 4164 <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> 4165 <li> 4166 <span class="var-type">string</span> 4167 <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> 4168 <li> 4169 <span class="var-type">mixed</span> 4170 <span class="var-name">$link</span><span class="var-description">: URL or identifier returned by AddLink().</span> </li> 4171 </ul> 4172 4173 4174 </div> 4175 <a name="methodLine" id="Line"><!-- --></a> 4176 <div class="oddrow"> 4177 4178 <div class="method-header"> 4179 <span class="method-title">Line</span> (line <span class="line-number">1583</span>) 4180 </div> 4181 4182 <!-- ========== Info from phpDoc block ========= --> 4183 <p class="short-description">Draws a line between two points.</p> 4184 <ul class="tags"> 4185 <li><span class="field">access:</span> public</li> 4186 <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> 4187 <li><span class="field">since:</span> 1.0</li> 4188 </ul> 4189 4190 <div class="method-signature"> 4191 <span class="method-result">void</span> 4192 <span class="method-name"> 4193 Line 4194 </span> 4195 (<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>) 4196 </div> 4197 4198 <ul class="parameters"> 4199 <li> 4200 <span class="var-type">float</span> 4201 <span class="var-name">$x1</span><span class="var-description">: Abscissa of first point</span> </li> 4202 <li> 4203 <span class="var-type">float</span> 4204 <span class="var-name">$y1</span><span class="var-description">: Ordinate of first point</span> </li> 4205 <li> 4206 <span class="var-type">float</span> 4207 <span class="var-name">$x2</span><span class="var-description">: Abscissa of second point</span> </li> 4208 <li> 4209 <span class="var-type">float</span> 4210 <span class="var-name">$y2</span><span class="var-description">: Ordinate of second point</span> </li> 4211 </ul> 4212 4213 4214 </div> 4215 <a name="methodLink" id="Link"><!-- --></a> 4216 <div class="evenrow"> 4217 4218 <div class="method-header"> 4219 <span class="method-title">Link</span> (line <span class="line-number">1879</span>) 4220 </div> 4221 4222 <!-- ========== Info from phpDoc block ========= --> 4223 <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> 4224 <ul class="tags"> 4225 <li><span class="field">access:</span> public</li> 4226 <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> 4227 <li><span class="field">since:</span> 1.5</li> 4228 </ul> 4229 4230 <div class="method-signature"> 4231 <span class="method-result">void</span> 4232 <span class="method-name"> 4233 Link 4234 </span> 4235 (<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>) 4236 </div> 4237 4238 <ul class="parameters"> 4239 <li> 4240 <span class="var-type">float</span> 4241 <span class="var-name">$x</span><span class="var-description">: Abscissa of the upper-left corner of the rectangle</span> </li> 4242 <li> 4243 <span class="var-type">float</span> 4244 <span class="var-name">$y</span><span class="var-description">: Ordinate of the upper-left corner of the rectangle</span> </li> 4245 <li> 4246 <span class="var-type">float</span> 4247 <span class="var-name">$w</span><span class="var-description">: Width of the rectangle</span> </li> 4248 <li> 4249 <span class="var-type">float</span> 4250 <span class="var-name">$h</span><span class="var-description">: Height of the rectangle</span> </li> 4251 <li> 4252 <span class="var-type">mixed</span> 4253 <span class="var-name">$link</span><span class="var-description">: URL or identifier returned by AddLink()</span> </li> 4254 </ul> 4255 4256 4257 </div> 4258 <a name="methodLn" id="Ln"><!-- --></a> 4259 <div class="oddrow"> 4260 4261 <div class="method-header"> 4262 <span class="method-title">Ln</span> (line <span class="line-number">2392</span>) 4263 </div> 4264 4265 <!-- ========== Info from phpDoc block ========= --> 4266 <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> 4267 <ul class="tags"> 4268 <li><span class="field">access:</span> public</li> 4269 <li><span class="field">see:</span> <a href="../com.tecnick.tcpdf/TCPDF.html#methodCell">TCPDF::Cell()</a></li> 4270 <li><span class="field">since:</span> 1.0</li> 4271 </ul> 4272 4273 <div class="method-signature"> 4274 <span class="method-result">void</span> 4275 <span class="method-name"> 4276 Ln 4277 </span> 4278 ([<span class="var-type">float</span> <span class="var-name">$h</span> = <span class="var-default">''</span>]) 4279 </div> 4280 4281 <ul class="parameters"> 4282 <li> 4283 <span class="var-type">float</span> 4284 <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> 4285 </ul> 4286 4287 4288 </div> 4289 <a name="methodMultiCell" id="MultiCell"><!-- --></a> 4290 <div class="evenrow"> 4291 4292 <div class="method-header"> 4293 <span class="method-title">MultiCell</span> (line <span class="line-number">2071</span>) 4294 </div> 4295 4296 <!-- ========== Info from phpDoc block ========= --> 4297 <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> 4298 <ul class="tags"> 4299 <li><span class="field">access:</span> public</li> 4300 <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> 4301 <li><span class="field">since:</span> 1.3</li> 4302 </ul> 4303 4304 <div class="method-signature"> 4305 <span class="method-result">void</span> 4306 <span class="method-name"> 4307 MultiCell 4308 </span> 4309 (<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>]) 4310 </div> 4311 4312 <ul class="parameters"> 4313 <li> 4314 <span class="var-type">float</span> 4315 <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> 4316 <li> 4317 <span class="var-type">float</span> 4318 <span class="var-name">$h</span><span class="var-description">: Height of cells.</span> </li> 4319 <li> 4320 <span class="var-type">string</span> 4321 <span class="var-name">$txt</span><span class="var-description">: String to print</span> </li> 4322 <li> 4323 <span class="var-type">mixed</span> 4324 <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> 4325 <li> 4326 <span class="var-type">string</span> 4327 <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> 4328 <li> 4329 <span class="var-type">int</span> 4330 <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> 4331 <li> 4332 <span class="var-type">int</span> 4333 <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> 4334 </ul> 4335 4336 4337 </div> 4338 <a name="methodOpen" id="Open"><!-- --></a> 4339 <div class="oddrow"> 4340 4341 <div class="method-header"> 4342 <span class="method-title">Open</span> (line <span class="line-number">1192</span>) 4343 </div> 4344 4345 <!-- ========== Info from phpDoc block ========= --> 4346 <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> 4347 <p class="description"><p>Note: no page is created by this method</p></p> 4348 <ul class="tags"> 4349 <li><span class="field">access:</span> public</li> 4350 <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> 4351 <li><span class="field">since:</span> 1.0</li> 4352 </ul> 4353 4354 <div class="method-signature"> 4355 <span class="method-result">void</span> 4356 <span class="method-name"> 4357 Open 4358 </span> 4359 () 4360 </div> 4361 4362 4363 4364 </div> 4365 <a name="methodopenHTMLTagHandler" id="openHTMLTagHandler"><!-- --></a> 4366 <div class="evenrow"> 4367 4368 <div class="method-header"> 4369 <span class="method-title">openHTMLTagHandler</span> (line <span class="line-number">3811</span>) 4370 </div> 4371 4372 <!-- ========== Info from phpDoc block ========= --> 4373 <p class="short-description">Process opening tags.</p> 4374 <ul class="tags"> 4375 <li><span class="field">access:</span> private</li> 4376 </ul> 4377 4378 <div class="method-signature"> 4379 <span class="method-result">void</span> 4380 <span class="method-name"> 4381 openHTMLTagHandler 4382 </span> 4383 (<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>) 4384 </div> 4385 4386 <ul class="parameters"> 4387 <li> 4388 <span class="var-type">string</span> 4389 <span class="var-name">$tag</span><span class="var-description">: tag name (in uppercase)</span> </li> 4390 <li> 4391 <span class="var-type">string</span> 4392 <span class="var-name">$attr</span><span class="var-description">: tag attribute (in uppercase)</span> </li> 4393 <li> 4394 <span class="var-type">int</span> 4395 <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> 4396 </ul> 4397 4398 4399 </div> 4400 <a name="methodOutput" id="Output"><!-- --></a> 4401 <div class="oddrow"> 4402 4403 <div class="method-header"> 4404 <span class="method-title">Output</span> (line <span class="line-number">2479</span>) 4405 </div> 4406 4407 <!-- ========== Info from phpDoc block ========= --> 4408 <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> 4409 <ul class="tags"> 4410 <li><span class="field">access:</span> public</li> 4411 <li><span class="field">see:</span> <a href="../com.tecnick.tcpdf/TCPDF.html#methodClose">TCPDF::Close()</a></li> 4412 <li><span class="field">since:</span> 1.0</li> 4413 </ul> 4414 4415 <div class="method-signature"> 4416 <span class="method-result">void</span> 4417 <span class="method-name"> 4418 Output 4419 </span> 4420 ([<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>]) 4421 </div> 4422 4423 <ul class="parameters"> 4424 <li> 4425 <span class="var-type">string</span> 4426 <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> 4427 <li> 4428 <span class="var-type">string</span> 4429 <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> 4430 </ul> 4431 4432 4433 </div> 4434 <a name="methodPageNo" id="PageNo"><!-- --></a> 4435 <div class="evenrow"> 4436 4437 <div class="method-header"> 4438 <span class="method-title">PageNo</span> (line <span class="line-number">1443</span>) 4439 </div> 4440 4441 <!-- ========== Info from phpDoc block ========= --> 4442 <p class="short-description">Returns the current page number.</p> 4443 <ul class="tags"> 4444 <li><span class="field">return:</span> page number</li> 4445 <li><span class="field">access:</span> public</li> 4446 <li><span class="field">see:</span> <a href="../com.tecnick.tcpdf/TCPDF.html#methodAliasNbPages">TCPDF::AliasNbPages()</a></li> 4447 <li><span class="field">since:</span> 1.0</li> 4448 </ul> 4449 4450 <div class="method-signature"> 4451 <span class="method-result">int</span> 4452 <span class="method-name"> 4453 PageNo 4454 </span> 4455 () 4456 </div> 4457 4458 4459 4460 </div> 4461 <a name="methodpixelsToMillimeters" id="pixelsToMillimeters"><!-- --></a> 4462 <div class="oddrow"> 4463 4464 <div class="method-header"> 4465 <span class="method-title">pixelsToMillimeters</span> (line <span class="line-number">4180</span>) 4466 </div> 4467 4468 <!-- ========== Info from phpDoc block ========= --> 4469 <p class="short-description">Converts pixels to millimeters in 72 dpi.</p> 4470 <ul class="tags"> 4471 <li><span class="field">return:</span> millimeters</li> 4472 <li><span class="field">access:</span> private</li> 4473 </ul> 4474 4475 <div class="method-signature"> 4476 <span class="method-result">float</span> 4477 <span class="method-name"> 4478 pixelsToMillimeters 4479 </span> 4480 (<span class="var-type">int</span> <span class="var-name">$px</span>) 4481 </div> 4482 4483 <ul class="parameters"> 4484 <li> 4485 <span class="var-type">int</span> 4486 <span class="var-name">$px</span><span class="var-description">: pixels</span> </li> 4487 </ul> 4488 4489 4490 </div> 4491 <a name="methodRect" id="Rect"><!-- --></a> 4492 <div class="evenrow"> 4493 4494 <div class="method-header"> 4495 <span class="method-title">Rect</span> (line <span class="line-number">1598</span>) 4496 </div> 4497 4498 <!-- ========== Info from phpDoc block ========= --> 4499 <p class="short-description">Outputs a rectangle. It can be drawn (border only), filled (with no border) or both.</p> 4500 <ul class="tags"> 4501 <li><span class="field">access:</span> public</li> 4502 <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> 4503 <li><span class="field">since:</span> 1.0</li> 4504 </ul> 4505 4506 <div class="method-signature"> 4507 <span class="method-result">void</span> 4508 <span class="method-name"> 4509 Rect 4510 </span> 4511 (<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>]) 4512 </div> 4513 4514 <ul class="parameters"> 4515 <li> 4516 <span class="var-type">float</span> 4517 <span class="var-name">$x</span><span class="var-description">: Abscissa of upper-left corner</span> </li> 4518 <li> 4519 <span class="var-type">float</span> 4520 <span class="var-name">$y</span><span class="var-description">: Ordinate of upper-left corner</span> </li> 4521 <li> 4522 <span class="var-type">float</span> 4523 <span class="var-name">$w</span><span class="var-description">: Width</span> </li> 4524 <li> 4525 <span class="var-type">float</span> 4526 <span class="var-name">$h</span><span class="var-description">: Height</span> </li> 4527 <li> 4528 <span class="var-type">string</span> 4529 <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> 4530 </ul> 4531 4532 4533 </div> 4534 <a name="methodSetAuthor" id="SetAuthor"><!-- --></a> 4535 <div class="oddrow"> 4536 4537 <div class="method-header"> 4538 <span class="method-title">SetAuthor</span> (line <span class="line-number">1122</span>) 4539 </div> 4540 4541 <!-- ========== Info from phpDoc block ========= --> 4542 <p class="short-description">Defines the author of the document.</p> 4543 <ul class="tags"> 4544 <li><span class="field">access:</span> public</li> 4545 <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> 4546 <li><span class="field">since:</span> 1.2</li> 4547 </ul> 4548 4549 <div class="method-signature"> 4550 <span class="method-result">void</span> 4551 <span class="method-name"> 4552 SetAuthor 4553 </span> 4554 (<span class="var-type">string</span> <span class="var-name">$author</span>) 4555 </div> 4556 4557 <ul class="parameters"> 4558 <li> 4559 <span class="var-type">string</span> 4560 <span class="var-name">$author</span><span class="var-description">: The name of the author.</span> </li> 4561 </ul> 4562 4563 4564 </div> 4565 <a name="methodSetAutoPageBreak" id="SetAutoPageBreak"><!-- --></a> 4566 <div class="evenrow"> 4567 4568 <div class="method-header"> 4569 <span class="method-title">SetAutoPageBreak</span> (line <span class="line-number">1049</span>) 4570 </div> 4571 4572 <!-- ========== Info from phpDoc block ========= --> 4573 <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> 4574 <ul class="tags"> 4575 <li><span class="field">access:</span> public</li> 4576 <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> 4577 <li><span class="field">since:</span> 1.0</li> 4578 </ul> 4579 4580 <div class="method-signature"> 4581 <span class="method-result">void</span> 4582 <span class="method-name"> 4583 SetAutoPageBreak 4584 </span> 4585 (<span class="var-type">boolean</span> <span class="var-name">$auto</span>, <span class="var-type">float</span> <span class="var-name">$margin</span>) 4586 </div> 4587 4588 <ul class="parameters"> 4589 <li> 4590 <span class="var-type">boolean</span> 4591 <span class="var-name">$auto</span><span class="var-description">: Boolean indicating if mode should be on or off.</span> </li> 4592 <li> 4593 <span class="var-type">float</span> 4594 <span class="var-name">$margin</span><span class="var-description">: Distance from the bottom of the page.</span> </li> 4595 </ul> 4596 4597 4598 </div> 4599 <a name="methodsetBarcode" id="setBarcode"><!-- --></a> 4600 <div class="oddrow"> 4601 4602 <div class="method-header"> 4603 <span class="method-title">setBarcode</span> (line <span class="line-number">3565</span>) 4604 </div> 4605 4606 <!-- ========== Info from phpDoc block ========= --> 4607 <p class="short-description">Set document barcode.</p> 4608 <ul class="tags"> 4609 <li><span class="field">access:</span> public</li> 4610 </ul> 4611 4612 <div class="method-signature"> 4613 <span class="method-result">void</span> 4614 <span class="method-name"> 4615 setBarcode 4616 </span> 4617 ([<span class="var-type">string</span> <span class="var-name">$bc</span> = <span class="var-default">""</span>]) 4618 </div> 4619 4620 <ul class="parameters"> 4621 <li> 4622 <span class="var-type">string</span> 4623 <span class="var-name">$bc</span><span class="var-description">: barcode</span> </li> 4624 </ul> 4625 4626 4627 </div> 4628 <a name="methodSetCompression" id="SetCompression"><!-- --></a> 4629 <div class="evenrow"> 4630 4631 <div class="method-header"> 4632 <span class="method-title">SetCompression</span> (line <span class="line-number">1084</span>) 4633 </div> 4634 4635 <!-- ========== Info from phpDoc block ========= --> 4636 <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> 4637 <p class="description"><p>Note: the Zlib extension is required for this feature. If not present, compression will be turned off.</p></p> 4638 <ul class="tags"> 4639 <li><span class="field">access:</span> public</li> 4640 <li><span class="field">since:</span> 1.4</li> 4641 </ul> 4642 4643 <div class="method-signature"> 4644 <span class="method-result">void</span> 4645 <span class="method-name"> 4646 SetCompression 4647 </span> 4648 (<span class="var-type">boolean</span> <span class="var-name">$compress</span>) 4649 </div> 4650 4651 <ul class="parameters"> 4652 <li> 4653 <span class="var-type">boolean</span> 4654 <span class="var-name">$compress</span><span class="var-description">: Boolean indicating if compression must be enabled.</span> </li> 4655 </ul> 4656 4657 4658 </div> 4659 <a name="methodSetCreator" id="SetCreator"><!-- --></a> 4660 <div class="oddrow"> 4661 4662 <div class="method-header"> 4663 <span class="method-title">SetCreator</span> (line <span class="line-number">1144</span>) 4664 </div> 4665 4666 <!-- ========== Info from phpDoc block ========= --> 4667 <p class="short-description">Defines the creator of the document. This is typically the name of the application that generates the PDF.</p> 4668 <ul class="tags"> 4669 <li><span class="field">access:</span> public</li> 4670 <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> 4671 <li><span class="field">since:</span> 1.2</li> 4672 </ul> 4673 4674 <div class="method-signature"> 4675 <span class="method-result">void</span> 4676 <span class="method-name"> 4677 SetCreator 4678 </span> 4679 (<span class="var-type">string</span> <span class="var-name">$creator</span>) 4680 </div> 4681 4682 <ul class="parameters"> 4683 <li> 4684 <span class="var-type">string</span> 4685 <span class="var-name">$creator</span><span class="var-description">: The name of the creator.</span> </li> 4686 </ul> 4687 4688 4689 </div> 4690 <a name="methodSetDisplayMode" id="SetDisplayMode"><!-- --></a> 4691 <div class="evenrow"> 4692 4693 <div class="method-header"> 4694 <span class="method-title">SetDisplayMode</span> (line <span class="line-number">1062</span>) 4695 </div> 4696 4697 <!-- ========== Info from phpDoc block ========= --> 4698 <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> 4699 <ul class="tags"> 4700 <li><span class="field">access:</span> public</li> 4701 <li><span class="field">since:</span> 1.2</li> 4702 </ul> 4703 4704 <div class="method-signature"> 4705 <span class="method-result">void</span> 4706 <span class="method-name"> 4707 SetDisplayMode 4708 </span> 4709 (<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>]) 4710 </div> 4711 4712 <ul class="parameters"> 4713 <li> 4714 <span class="var-type">mixed</span> 4715 <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> 4716 <li> 4717 <span class="var-type">string</span> 4718 <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> 4719 </ul> 4720 4721 4722 </div> 4723 <a name="methodSetDrawColor" id="SetDrawColor"><!-- --></a> 4724 <div class="oddrow"> 4725 4726 <div class="method-header"> 4727 <span class="method-title">SetDrawColor</span> (line <span class="line-number">1456</span>) 4728 </div> 4729 4730 <!-- ========== Info from phpDoc block ========= --> 4731 <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> 4732 <ul class="tags"> 4733 <li><span class="field">access:</span> public</li> 4734 <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> 4735 <li><span class="field">since:</span> 1.3</li> 4736 </ul> 4737 4738 <div class="method-signature"> 4739 <span class="method-result">void</span> 4740 <span class="method-name"> 4741 SetDrawColor 4742 </span> 4743 (<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>]) 4744 </div> 4745 4746 <ul class="parameters"> 4747 <li> 4748 <span class="var-type">int</span> 4749 <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> 4750 <li> 4751 <span class="var-type">int</span> 4752 <span class="var-name">$g</span><span class="var-description">: Green component (between 0 and 255)</span> </li> 4753 <li> 4754 <span class="var-type">int</span> 4755 <span class="var-name">$b</span><span class="var-description">: Blue component (between 0 and 255)</span> </li> 4756 </ul> 4757 4758 4759 </div> 4760 <a name="methodSetFillColor" id="SetFillColor"><!-- --></a> 4761 <div class="evenrow"> 4762 4763 <div class="method-header"> 4764 <span class="method-title">SetFillColor</span> (line <span class="line-number">1478</span>) 4765 </div> 4766 4767 <!-- ========== Info from phpDoc block ========= --> 4768 <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> 4769 <ul class="tags"> 4770 <li><span class="field">access:</span> public</li> 4771 <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> 4772 <li><span class="field">since:</span> 1.3</li> 4773 </ul> 4774 4775 <div class="method-signature"> 4776 <span class="method-result">void</span> 4777 <span class="method-name"> 4778 SetFillColor 4779 </span> 4780 (<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>]) 4781 </div> 4782 4783 <ul class="parameters"> 4784 <li> 4785 <span class="var-type">int</span> 4786 <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> 4787 <li> 4788 <span class="var-type">int</span> 4789 <span class="var-name">$g</span><span class="var-description">: Green component (between 0 and 255)</span> </li> 4790 <li> 4791 <span class="var-type">int</span> 4792 <span class="var-name">$b</span><span class="var-description">: Blue component (between 0 and 255)</span> </li> 4793 <li> 4794 <span class="var-type">boolean</span> 4795 <span class="var-name">$storeprev</span><span class="var-description">: if true stores the RGB array on $prevFillColor variable.</span> </li> 4796 </ul> 4797 4798 4799 </div> 4800 <a name="methodSetFont" id="SetFont"><!-- --></a> 4801 <div class="oddrow"> 4802 4803 <div class="method-header"> 4804 <span class="method-title">SetFont</span> (line <span class="line-number">1726</span>) 4805 </div> 4806 4807 <!-- ========== Info from phpDoc block ========= --> 4808 <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> 4809 <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/'); 4810 require ('tcpdf.php'); 4811 4812 //Times regular 12 4813 $pdf->SetFont('Times'); 4814 //Arial bold 14 4815 $pdf->SetFont('Arial','B',14); 4816 //Removes bold 4817 $pdf->SetFont(''); 4818 //Times bold, italic and underlined 14 4819 $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> 4820 <ul class="tags"> 4821 <li><span class="field">access:</span> public</li> 4822 <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> 4823 <li><span class="field">since:</span> 1.0</li> 4824 </ul> 4825 4826 <div class="method-signature"> 4827 <span class="method-result">void</span> 4828 <span class="method-name"> 4829 SetFont 4830 </span> 4831 (<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>) 4832 </div> 4833 4834 <ul class="parameters"> 4835 <li> 4836 <span class="var-type">string</span> 4837 <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> 4838 <li> 4839 <span class="var-type">string</span> 4840 <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> 4841 <li> 4842 <span class="var-type">float</span> 4843 <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> 4844 </ul> 4845 4846 4847 </div> 4848 <a name="methodSetFontSize" id="SetFontSize"><!-- --></a> 4849 <div class="evenrow"> 4850 4851 <div class="method-header"> 4852 <span class="method-title">SetFontSize</span> (line <span class="line-number">1825</span>) 4853 </div> 4854 4855 <!-- ========== Info from phpDoc block ========= --> 4856 <p class="short-description">Defines the size of the current font.</p> 4857 <ul class="tags"> 4858 <li><span class="field">access:</span> public</li> 4859 <li><span class="field">see:</span> <a href="../com.tecnick.tcpdf/TCPDF.html#methodSetFont">TCPDF::SetFont()</a></li> 4860 <li><span class="field">since:</span> 1.0</li> 4861 </ul> 4862 4863 <div class="method-signature"> 4864 <span class="method-result">void</span> 4865 <span class="method-name"> 4866 SetFontSize 4867 </span> 4868 (<span class="var-type">float</span> <span class="var-name">$size</span>) 4869 </div> 4870 4871 <ul class="parameters"> 4872 <li> 4873 <span class="var-type">float</span> 4874 <span class="var-name">$size</span><span class="var-description">: The size (in points)</span> </li> 4875 </ul> 4876 4877 4878 </div> 4879 <a name="methodsetFooterFont" id="setFooterFont"><!-- --></a> 4880 <div class="oddrow"> 4881 4882 <div class="method-header"> 4883 <span class="method-title">setFooterFont</span> (line <span class="line-number">3548</span>) 4884 </div> 4885 4886 <!-- ========== Info from phpDoc block ========= --> 4887 <p class="short-description">Set footer font.</p> 4888 <ul class="tags"> 4889 <li><span class="field">access:</span> public</li> 4890 <li><span class="field">since:</span> 1.1</li> 4891 </ul> 4892 4893 <div class="method-signature"> 4894 <span class="method-result">void</span> 4895 <span class="method-name"> 4896 setFooterFont 4897 </span> 4898 (<span class="var-type">array</span> <span class="var-name">$font</span>) 4899 </div> 4900 4901 <ul class="parameters"> 4902 <li> 4903 <span class="var-type">array</span> 4904 <span class="var-name">$font</span><span class="var-description">: font</span> </li> 4905 </ul> 4906 4907 4908 </div> 4909 <a name="methodsetFooterMargin" id="setFooterMargin"><!-- --></a> 4910 <div class="evenrow"> 4911 4912 <div class="method-header"> 4913 <span class="method-title">setFooterMargin</span> (line <span class="line-number">1323</span>) 4914 </div> 4915 4916 <!-- ========== Info from phpDoc block ========= --> 4917 <p class="short-description">Set footer margin.</p> 4918 <p class="description"><p>(minimum distance between footer and bottom page margin)</p></p> 4919 <ul class="tags"> 4920 <li><span class="field">access:</span> public</li> 4921 </ul> 4922 4923 <div class="method-signature"> 4924 <span class="method-result">void</span> 4925 <span class="method-name"> 4926 setFooterMargin 4927 </span> 4928 ([<span class="var-type">int</span> <span class="var-name">$fm</span> = <span class="var-default">10</span>]) 4929 </div> 4930 4931 <ul class="parameters"> 4932 <li> 4933 <span class="var-type">int</span> 4934 <span class="var-name">$fm</span><span class="var-description">: distance in millimeters</span> </li> 4935 </ul> 4936 4937 4938 </div> 4939 <a name="methodsetHeaderData" id="setHeaderData"><!-- --></a> 4940 <div class="oddrow"> 4941 4942 <div class="method-header"> 4943 <span class="method-title">setHeaderData</span> (line <span class="line-number">1302</span>) 4944 </div> 4945 4946 <!-- ========== Info from phpDoc block ========= --> 4947 <p class="short-description">Set header data.</p> 4948 <ul class="tags"> 4949 <li><span class="field">access:</span> public</li> 4950 </ul> 4951 4952 <div class="method-signature"> 4953 <span class="method-result">void</span> 4954 <span class="method-name"> 4955 setHeaderData 4956 </span> 4957 ([<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>]) 4958 </div> 4959 4960 <ul class="parameters"> 4961 <li> 4962 <span class="var-type">string</span> 4963 <span class="var-name">$ln</span><span class="var-description">: header image logo</span> </li> 4964 <li> 4965 <span class="var-type">string</span> 4966 <span class="var-name">$lw</span><span class="var-description">: header image logo width in mm</span> </li> 4967 <li> 4968 <span class="var-type">string</span> 4969 <span class="var-name">$ht</span><span class="var-description">: string to print as title on document header</span> </li> 4970 <li> 4971 <span class="var-type">string</span> 4972 <span class="var-name">$hs</span><span class="var-description">: string to print on document header</span> </li> 4973 </ul> 4974 4975 4976 </div> 4977 <a name="methodsetHeaderFont" id="setHeaderFont"><!-- --></a> 4978 <div class="evenrow"> 4979 4980 <div class="method-header"> 4981 <span class="method-title">setHeaderFont</span> (line <span class="line-number">3539</span>) 4982 </div> 4983 4984 <!-- ========== Info from phpDoc block ========= --> 4985 <p class="short-description">Set header font.</p> 4986 <ul class="tags"> 4987 <li><span class="field">access:</span> public</li> 4988 <li><span class="field">since:</span> 1.1</li> 4989 </ul> 4990 4991 <div class="method-signature"> 4992 <span class="method-result">void</span> 4993 <span class="method-name"> 4994 setHeaderFont 4995 </span> 4996 (<span class="var-type">array</span> <span class="var-name">$font</span>) 4997 </div> 4998 4999 <ul class="parameters"> 5000 <li> 5001 <span class="var-type">array</span> 5002 <span class="var-name">$font</span><span class="var-description">: font</span> </li> 5003 </ul> 5004 5005 5006 </div> 5007 <a name="methodsetHeaderMargin" id="setHeaderMargin"><!-- --></a> 5008 <div class="oddrow"> 5009 5010 <div class="method-header"> 5011 <span class="method-title">setHeaderMargin</span> (line <span class="line-number">1314</span>) 5012 </div> 5013 5014 <!-- ========== Info from phpDoc block ========= --> 5015 <p class="short-description">Set header margin.</p> 5016 <p class="description"><p>(minimum distance between header and top page margin)</p></p> 5017 <ul class="tags"> 5018 <li><span class="field">access:</span> public</li> 5019 </ul> 5020 5021 <div class="method-signature"> 5022 <span class="method-result">void</span> 5023 <span class="method-name"> 5024 setHeaderMargin 5025 </span> 5026 ([<span class="var-type">int</span> <span class="var-name">$hm</span> = <span class="var-default">10</span>]) 5027 </div> 5028 5029 <ul class="parameters"> 5030 <li> 5031 <span class="var-type">int</span> 5032 <span class="var-name">$hm</span><span class="var-description">: distance in millimeters</span> </li> 5033 </ul> 5034 5035 5036 </div> 5037 <a name="methodsetImageScale" id="setImageScale"><!-- --></a> 5038 <div class="evenrow"> 5039 5040 <div class="method-header"> 5041 <span class="method-title">setImageScale</span> (line <span class="line-number">934</span>) 5042 </div> 5043 5044 <!-- ========== Info from phpDoc block ========= --> 5045 <p class="short-description">Set the image scale.</p> 5046 <ul class="tags"> 5047 <li><span class="field">access:</span> public</li> 5048 <li><span class="field">since:</span> 1.5.2</li> 5049 <li><span class="field">author:</span> Nicola Asuni</li> 5050 </ul> 5051 5052 <div class="method-signature"> 5053 <span class="method-result">void</span> 5054 <span class="method-name"> 5055 setImageScale 5056 </span> 5057 (<span class="var-type">float</span> <span class="var-name">$scale</span>) 5058 </div> 5059 5060 <ul class="parameters"> 5061 <li> 5062 <span class="var-type">float</span> 5063 <span class="var-name">$scale</span><span class="var-description">: image scale.</span> </li> 5064 </ul> 5065 5066 5067 </div> 5068 <a name="methodSetKeywords" id="SetKeywords"><!-- --></a> 5069 <div class="oddrow"> 5070 5071 <div class="method-header"> 5072 <span class="method-title">SetKeywords</span> (line <span class="line-number">1133</span>) 5073 </div> 5074 5075 <!-- ========== Info from phpDoc block ========= --> 5076 <p class="short-description">Associates keywords with the document, generally in the form 'keyword1 keyword2 ...'.</p> 5077 <ul class="tags"> 5078 <li><span class="field">access:</span> public</li> 5079 <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> 5080 <li><span class="field">since:</span> 1.2</li> 5081 </ul> 5082 5083 <div class="method-signature"> 5084 <span class="method-result">void</span> 5085 <span class="method-name"> 5086 SetKeywords 5087 </span> 5088 (<span class="var-type">string</span> <span class="var-name">$keywords</span>) 5089 </div> 5090 5091 <ul class="parameters"> 5092 <li> 5093 <span class="var-type">string</span> 5094 <span class="var-name">$keywords</span><span class="var-description">: The list of keywords.</span> </li> 5095 </ul> 5096 5097 5098 </div> 5099 <a name="methodsetLanguageArray" id="setLanguageArray"><!-- --></a> 5100 <div class="evenrow"> 5101 5102 <div class="method-header"> 5103 <span class="method-title">setLanguageArray</span> (line <span class="line-number">3557</span>) 5104 </div> 5105 5106 <!-- ========== Info from phpDoc block ========= --> 5107 <p class="short-description">Set language array.</p> 5108 <ul class="tags"> 5109 <li><span class="field">access:</span> public</li> 5110 <li><span class="field">since:</span> 1.1</li> 5111 </ul> 5112 5113 <div class="method-signature"> 5114 <span class="method-result">void</span> 5115 <span class="method-name"> 5116 setLanguageArray 5117 </span> 5118 (<span class="var-type">array</span> <span class="var-name">$language</span>) 5119 </div> 5120 5121 <ul class="parameters"> 5122 <li> 5123 <span class="var-type">array</span> 5124 <span class="var-name">$language</span> </li> 5125 </ul> 5126 5127 5128 </div> 5129 <a name="methodSetLeftMargin" id="SetLeftMargin"><!-- --></a> 5130 <div class="oddrow"> 5131 5132 <div class="method-header"> 5133 <span class="method-title">SetLeftMargin</span> (line <span class="line-number">1012</span>) 5134 </div> 5135 5136 <!-- ========== Info from phpDoc block ========= --> 5137 <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> 5138 <ul class="tags"> 5139 <li><span class="field">access:</span> public</li> 5140 <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> 5141 <li><span class="field">since:</span> 1.4</li> 5142 </ul> 5143 5144 <div class="method-signature"> 5145 <span class="method-result">void</span> 5146 <span class="method-name"> 5147 SetLeftMargin 5148 </span> 5149 (<span class="var-type">float</span> <span class="var-name">$margin</span>) 5150 </div> 5151 5152 <ul class="parameters"> 5153 <li> 5154 <span class="var-type">float</span> 5155 <span class="var-name">$margin</span><span class="var-description">: The margin.</span> </li> 5156 </ul> 5157 5158 5159 </div> 5160 <a name="methodSetLineWidth" id="SetLineWidth"><!-- --></a> 5161 <div class="evenrow"> 5162 5163 <div class="method-header"> 5164 <span class="method-title">SetLineWidth</span> (line <span class="line-number">1566</span>) 5165 </div> 5166 5167 <!-- ========== Info from phpDoc block ========= --> 5168 <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> 5169 <ul class="tags"> 5170 <li><span class="field">access:</span> public</li> 5171 <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> 5172 <li><span class="field">since:</span> 1.0</li> 5173 </ul> 5174 5175 <div class="method-signature"> 5176 <span class="method-result">void</span> 5177 <span class="method-name"> 5178 SetLineWidth 5179 </span> 5180 (<span class="var-type">float</span> <span class="var-name">$width</span>) 5181 </div> 5182 5183 <ul class="parameters"> 5184 <li> 5185 <span class="var-type">float</span> 5186 <span class="var-name">$width</span><span class="var-description">: The width.</span> </li> 5187 </ul> 5188 5189 5190 </div> 5191 <a name="methodSetLink" id="SetLink"><!-- --></a> 5192 <div class="oddrow"> 5193 5194 <div class="method-header"> 5195 <span class="method-title">SetLink</span> (line <span class="line-number">1858</span>) 5196 </div> 5197 5198 <!-- ========== Info from phpDoc block ========= --> 5199 <p class="short-description">Defines the page and position a link points to</p> 5200 <ul class="tags"> 5201 <li><span class="field">access:</span> public</li> 5202 <li><span class="field">see:</span> <a href="../com.tecnick.tcpdf/TCPDF.html#methodAddLink">TCPDF::AddLink()</a></li> 5203 <li><span class="field">since:</span> 1.5</li> 5204 </ul> 5205 5206 <div class="method-signature"> 5207 <span class="method-result">void</span> 5208 <span class="method-name"> 5209 SetLink 5210 </span> 5211 (<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>]) 5212 </div> 5213 5214 <ul class="parameters"> 5215 <li> 5216 <span class="var-type">int</span> 5217 <span class="var-name">$link</span><span class="var-description">: The link identifier returned by AddLink()</span> </li> 5218 <li> 5219 <span class="var-type">float</span> 5220 <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> 5221 <li> 5222 <span class="var-type">int</span> 5223 <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> 5224 </ul> 5225 5226 5227 </div> 5228 <a name="methodSetMargins" id="SetMargins"><!-- --></a> 5229 <div class="evenrow"> 5230 5231 <div class="method-header"> 5232 <span class="method-title">SetMargins</span> (line <span class="line-number">996</span>) 5233 </div> 5234 5235 <!-- ========== Info from phpDoc block ========= --> 5236 <p class="short-description">Defines the left, top and right margins. By default, they equal 1 cm. Call this method to change them.</p> 5237 <ul class="tags"> 5238 <li><span class="field">access:</span> public</li> 5239 <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> 5240 <li><span class="field">since:</span> 1.0</li> 5241 </ul> 5242 5243 <div class="method-signature"> 5244 <span class="method-result">void</span> 5245 <span class="method-name"> 5246 SetMargins 5247 </span> 5248 (<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>]) 5249 </div> 5250 5251 <ul class="parameters"> 5252 <li> 5253 <span class="var-type">float</span> 5254 <span class="var-name">$left</span><span class="var-description">: Left margin.</span> </li> 5255 <li> 5256 <span class="var-type">float</span> 5257 <span class="var-name">$top</span><span class="var-description">: Top margin.</span> </li> 5258 <li> 5259 <span class="var-type">float</span> 5260 <span class="var-name">$right</span><span class="var-description">: Right margin. Default value is the left one.</span> </li> 5261 </ul> 5262 5263 5264 </div> 5265 <a name="methodsetPrintFooter" id="setPrintFooter"><!-- --></a> 5266 <div class="oddrow"> 5267 5268 <div class="method-header"> 5269 <span class="method-title">setPrintFooter</span> (line <span class="line-number">1339</span>) 5270 </div> 5271 5272 <!-- ========== Info from phpDoc block ========= --> 5273 <p class="short-description">Set a flag to print page footer.</p> 5274 <ul class="tags"> 5275 <li><span class="field">access:</span> public</li> 5276 </ul> 5277 5278 <div class="method-signature"> 5279 <span class="method-result">void</span> 5280 <span class="method-name"> 5281 setPrintFooter 5282 </span> 5283 ([<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>) 5284 </div> 5285 5286 <ul class="parameters"> 5287 <li> 5288 <span class="var-type">boolean</span> 5289 <span class="var-name">$value</span><span class="var-description">: set to true to print the page footer (default), false otherwise.</span> </li> 5290 </ul> 5291 5292 5293 </div> 5294 <a name="methodsetPrintHeader" id="setPrintHeader"><!-- --></a> 5295 <div class="evenrow"> 5296 5297 <div class="method-header"> 5298 <span class="method-title">setPrintHeader</span> (line <span class="line-number">1331</span>) 5299 </div> 5300 5301 <!-- ========== Info from phpDoc block ========= --> 5302 <p class="short-description">Set a flag to print page header.</p> 5303 <ul class="tags"> 5304 <li><span class="field">access:</span> public</li> 5305 </ul> 5306 5307 <div class="method-signature"> 5308 <span class="method-result">void</span> 5309 <span class="method-name"> 5310 setPrintHeader 5311 </span> 5312 ([<span class="var-type">boolean</span> <span class="var-name">$val</span> = <span class="var-default">true</span>]) 5313 </div> 5314 5315 <ul class="parameters"> 5316 <li> 5317 <span class="var-type">boolean</span> 5318 <span class="var-name">$val</span><span class="var-description">: set to true to print the page header (default), false otherwise.</span> </li> 5319 </ul> 5320 5321 5322 </div> 5323 <a name="methodSetRightMargin" id="SetRightMargin"><!-- --></a> 5324 <div class="oddrow"> 5325 5326 <div class="method-header"> 5327 <span class="method-title">SetRightMargin</span> (line <span class="line-number">1037</span>) 5328 </div> 5329 5330 <!-- ========== Info from phpDoc block ========= --> 5331 <p class="short-description">Defines the right margin. The method can be called before creating the first page.</p> 5332 <ul class="tags"> 5333 <li><span class="field">access:</span> public</li> 5334 <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> 5335 <li><span class="field">since:</span> 1.5</li> 5336 </ul> 5337 5338 <div class="method-signature"> 5339 <span class="method-result">void</span> 5340 <span class="method-name"> 5341 SetRightMargin 5342 </span> 5343 (<span class="var-type">float</span> <span class="var-name">$margin</span>) 5344 </div> 5345 5346 <ul class="parameters"> 5347 <li> 5348 <span class="var-type">float</span> 5349 <span class="var-name">$margin</span><span class="var-description">: The margin.</span> </li> 5350 </ul> 5351 5352 5353 </div> 5354 <a name="methodsetStyle" id="setStyle"><!-- --></a> 5355 <div class="evenrow"> 5356 5357 <div class="method-header"> 5358 <span class="method-title">setStyle</span> (line <span class="line-number">4131</span>) 5359 </div> 5360 5361 <!-- ========== Info from phpDoc block ========= --> 5362 <p class="short-description">Sets font style.</p> 5363 <ul class="tags"> 5364 <li><span class="field">access:</span> private</li> 5365 </ul> 5366 5367 <div class="method-signature"> 5368 <span class="method-result">void</span> 5369 <span class="method-name"> 5370 setStyle 5371 </span> 5372 (<span class="var-type">string</span> <span class="var-name">$tag</span>, <span class="var-type">boolean</span> <span class="var-name">$enable</span>) 5373 </div> 5374 5375 <ul class="parameters"> 5376 <li> 5377 <span class="var-type">string</span> 5378 <span class="var-name">$tag</span><span class="var-description">: tag name (in lowercase)</span> </li> 5379 <li> 5380 <span class="var-type">boolean</span> 5381 <span class="var-name">$enable</span> </li> 5382 </ul> 5383 5384 5385 </div> 5386 <a name="methodSetSubject" id="SetSubject"><!-- --></a> 5387 <div class="oddrow"> 5388 5389 <div class="method-header"> 5390 <span class="method-title">SetSubject</span> (line <span class="line-number">1111</span>) 5391 </div> 5392 5393 <!-- ========== Info from phpDoc block ========= --> 5394 <p class="short-description">Defines the subject of the document.</p> 5395 <ul class="tags"> 5396 <li><span class="field">access:</span> public</li> 5397 <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> 5398 <li><span class="field">since:</span> 1.2</li> 5399 </ul> 5400 5401 <div class="method-signature"> 5402 <span class="method-result">void</span> 5403 <span class="method-name"> 5404 SetSubject 5405 </span> 5406 (<span class="var-type">string</span> <span class="var-name">$subject</span>) 5407 </div> 5408 5409 <ul class="parameters"> 5410 <li> 5411 <span class="var-type">string</span> 5412 <span class="var-name">$subject</span><span class="var-description">: The subject.</span> </li> 5413 </ul> 5414 5415 5416 </div> 5417 <a name="methodSetTextColor" id="SetTextColor"><!-- --></a> 5418 <div class="evenrow"> 5419 5420 <div class="method-header"> 5421 <span class="method-title">SetTextColor</span> (line <span class="line-number">1505</span>) 5422 </div> 5423 5424 <!-- ========== Info from phpDoc block ========= --> 5425 <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> 5426 <ul class="tags"> 5427 <li><span class="field">access:</span> public</li> 5428 <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> 5429 <li><span class="field">since:</span> 1.3</li> 5430 </ul> 5431 5432 <div class="method-signature"> 5433 <span class="method-result">void</span> 5434 <span class="method-name"> 5435 SetTextColor 5436 </span> 5437 (<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>]) 5438 </div> 5439 5440 <ul class="parameters"> 5441 <li> 5442 <span class="var-type">int</span> 5443 <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> 5444 <li> 5445 <span class="var-type">int</span> 5446 <span class="var-name">$g</span><span class="var-description">: Green component (between 0 and 255)</span> </li> 5447 <li> 5448 <span class="var-type">int</span> 5449 <span class="var-name">$b</span><span class="var-description">: Blue component (between 0 and 255)</span> </li> 5450 <li> 5451 <span class="var-type">boolean</span> 5452 <span class="var-name">$storeprev</span><span class="var-description">: if true stores the RGB array on $prevTextColor variable.</span> </li> 5453 </ul> 5454 5455 5456 </div> 5457 <a name="methodSetTitle" id="SetTitle"><!-- --></a> 5458 <div class="oddrow"> 5459 5460 <div class="method-header"> 5461 <span class="method-title">SetTitle</span> (line <span class="line-number">1100</span>) 5462 </div> 5463 5464 <!-- ========== Info from phpDoc block ========= --> 5465 <p class="short-description">Defines the title of the document.</p> 5466 <ul class="tags"> 5467 <li><span class="field">access:</span> public</li> 5468 <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> 5469 <li><span class="field">since:</span> 1.2</li> 5470 </ul> 5471 5472 <div class="method-signature"> 5473 <span class="method-result">void</span> 5474 <span class="method-name"> 5475 SetTitle 5476 </span> 5477 (<span class="var-type">string</span> <span class="var-name">$title</span>) 5478 </div> 5479 5480 <ul class="parameters"> 5481 <li> 5482 <span class="var-type">string</span> 5483 <span class="var-name">$title</span><span class="var-description">: The title.</span> </li> 5484 </ul> 5485 5486 5487 </div> 5488 <a name="methodSetTopMargin" id="SetTopMargin"><!-- --></a> 5489 <div class="evenrow"> 5490 5491 <div class="method-header"> 5492 <span class="method-title">SetTopMargin</span> (line <span class="line-number">1026</span>) 5493 </div> 5494 5495 <!-- ========== Info from phpDoc block ========= --> 5496 <p class="short-description">Defines the top margin. The method can be called before creating the first page.</p> 5497 <ul class="tags"> 5498 <li><span class="field">access:</span> public</li> 5499 <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> 5500 <li><span class="field">since:</span> 1.5</li> 5501 </ul> 5502 5503 <div class="method-signature"> 5504 <span class="method-result">void</span> 5505 <span class="method-name"> 5506 SetTopMargin 5507 </span> 5508 (<span class="var-type">float</span> <span class="var-name">$margin</span>) 5509 </div> 5510 5511 <ul class="parameters"> 5512 <li> 5513 <span class="var-type">float</span> 5514 <span class="var-name">$margin</span><span class="var-description">: The margin.</span> </li> 5515 </ul> 5516 5517 5518 </div> 5519 <a name="methodSetX" id="SetX"><!-- --></a> 5520 <div class="oddrow"> 5521 5522 <div class="method-header"> 5523 <span class="method-title">SetX</span> (line <span class="line-number">2420</span>) 5524 </div> 5525 5526 <!-- ========== Info from phpDoc block ========= --> 5527 <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> 5528 <ul class="tags"> 5529 <li><span class="field">access:</span> public</li> 5530 <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> 5531 <li><span class="field">since:</span> 1.2</li> 5532 </ul> 5533 5534 <div class="method-signature"> 5535 <span class="method-result">void</span> 5536 <span class="method-name"> 5537 SetX 5538 </span> 5539 (<span class="var-type">float</span> <span class="var-name">$x</span>) 5540 </div> 5541 5542 <ul class="parameters"> 5543 <li> 5544 <span class="var-type">float</span> 5545 <span class="var-name">$x</span><span class="var-description">: The value of the abscissa.</span> </li> 5546 </ul> 5547 5548 5549 </div> 5550 <a name="methodSetXY" id="SetXY"><!-- --></a> 5551 <div class="evenrow"> 5552 5553 <div class="method-header"> 5554 <span class="method-title">SetXY</span> (line <span class="line-number">2465</span>) 5555 </div> 5556 5557 <!-- ========== Info from phpDoc block ========= --> 5558 <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> 5559 <ul class="tags"> 5560 <li><span class="field">access:</span> public</li> 5561 <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> 5562 <li><span class="field">since:</span> 1.2</li> 5563 </ul> 5564 5565 <div class="method-signature"> 5566 <span class="method-result">void</span> 5567 <span class="method-name"> 5568 SetXY 5569 </span> 5570 (<span class="var-type">float</span> <span class="var-name">$x</span>, <span class="var-type">float</span> <span class="var-name">$y</span>) 5571 </div> 5572 5573 <ul class="parameters"> 5574 <li> 5575 <span class="var-type">float</span> 5576 <span class="var-name">$x</span><span class="var-description">: The value of the abscissa</span> </li> 5577 <li> 5578 <span class="var-type">float</span> 5579 <span class="var-name">$y</span><span class="var-description">: The value of the ordinate</span> </li> 5580 </ul> 5581 5582 5583 </div> 5584 <a name="methodSetY" id="SetY"><!-- --></a> 5585 <div class="oddrow"> 5586 5587 <div class="method-header"> 5588 <span class="method-title">SetY</span> (line <span class="line-number">2447</span>) 5589 </div> 5590 5591 <!-- ========== Info from phpDoc block ========= --> 5592 <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> 5593 <ul class="tags"> 5594 <li><span class="field">access:</span> public</li> 5595 <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> 5596 <li><span class="field">since:</span> 1.0</li> 5597 </ul> 5598 5599 <div class="method-signature"> 5600 <span class="method-result">void</span> 5601 <span class="method-name"> 5602 SetY 5603 </span> 5604 (<span class="var-type">float</span> <span class="var-name">$y</span>) 5605 </div> 5606 5607 <ul class="parameters"> 5608 <li> 5609 <span class="var-type">float</span> 5610 <span class="var-name">$y</span><span class="var-description">: The value of the ordinate.</span> </li> 5611 </ul> 5612 5613 5614 </div> 5615 <a name="methodText" id="Text"><!-- --></a> 5616 <div class="evenrow"> 5617 5618 <div class="method-header"> 5619 <span class="method-title">Text</span> (line <span class="line-number">1892</span>) 5620 </div> 5621 5622 <!-- ========== Info from phpDoc block ========= --> 5623 <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> 5624 <ul class="tags"> 5625 <li><span class="field">access:</span> public</li> 5626 <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> 5627 <li><span class="field">since:</span> 1.0</li> 5628 </ul> 5629 5630 <div class="method-signature"> 5631 <span class="method-result">void</span> 5632 <span class="method-name"> 5633 Text 5634 </span> 5635 (<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>) 5636 </div> 5637 5638 <ul class="parameters"> 5639 <li> 5640 <span class="var-type">float</span> 5641 <span class="var-name">$x</span><span class="var-description">: Abscissa of the origin</span> </li> 5642 <li> 5643 <span class="var-type">float</span> 5644 <span class="var-name">$y</span><span class="var-description">: Ordinate of the origin</span> </li> 5645 <li> 5646 <span class="var-type">string</span> 5647 <span class="var-name">$txt</span><span class="var-description">: String to print</span> </li> 5648 </ul> 5649 5650 5651 </div> 5652 <a name="methodunhtmlentities" id="unhtmlentities"><!-- --></a> 5653 <div class="oddrow"> 5654 5655 <div class="method-header"> 5656 <span class="method-title">unhtmlentities</span> (line <span class="line-number">4191</span>) 5657 </div> 5658 5659 <!-- ========== Info from phpDoc block ========= --> 5660 <p class="short-description">Reverse function for htmlentities.</p> 5661 <p class="description"><p>Convert entities in UTF-8.</p></p> 5662 <ul class="tags"> 5663 <li><span class="field">return:</span> converted</li> 5664 <li><span class="field">access:</span> public</li> 5665 </ul> 5666 5667 <div class="method-signature"> 5668 <span class="method-result">string</span> 5669 <span class="method-name"> 5670 unhtmlentities 5671 </span> 5672 (<span class="var-type">$text_to_convert</span> <span class="var-name">$text_to_convert</span>) 5673 </div> 5674 5675 <ul class="parameters"> 5676 <li> 5677 <span class="var-type">$text_to_convert</span> 5678 <span class="var-name">$text_to_convert</span><span class="var-description">: Text to convert.</span> </li> 5679 </ul> 5680 5681 5682 </div> 5683 <a name="methodUTF8StringToArray" id="UTF8StringToArray"><!-- --></a> 5684 <div class="evenrow"> 5685 5686 <div class="method-header"> 5687 <span class="method-title">UTF8StringToArray</span> (line <span class="line-number">3400</span>) 5688 </div> 5689 5690 <!-- ========== Info from phpDoc block ========= --> 5691 <p class="short-description">Converts UTF-8 strings to codepoints array.<br /></p> 5692 <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 5693 (hexadecimal) | (binary) 5694 --------------------+----------------------------------------------- 5695 0000 0000-0000 007F | 0xxxxxxx 5696 0000 0080-0000 07FF | 110xxxxx 10xxxxxx 5697 0000 0800-0000 FFFF | 1110xxxx 10xxxxxx 10xxxxxx 5698 0001 0000-0010 FFFF | 11110xxx 10xxxxxx 10xxxxxx 10xxxxxx 5699 --------------------------------------------------------------------- 5700 5701 ABFN notation: 5702 --------------------------------------------------------------------- 5703 UTF8-octets = *( UTF8-char ) 5704 UTF8-char = UTF8-1 / UTF8-2 / UTF8-3 / UTF8-4 5705 UTF8-1 = %x00-7F 5706 UTF8-2 = %xC2-DF UTF8-tail 5707 5708 UTF8-3 = %xE0 %xA0-BF UTF8-tail / %xE1-EC 2( UTF8-tail ) / 5709 %xED %x80-9F UTF8-tail / %xEE-EF 2( UTF8-tail ) 5710 UTF8-4 = %xF0 %x90-BF 2( UTF8-tail ) / %xF1-F3 3( UTF8-tail ) / 5711 %xF4 %x80-8F 2( UTF8-tail ) 5712 UTF8-tail = %x80-BF 5713 ---------------------------------------------------------------------</pre></p></p> 5714 <ul class="tags"> 5715 <li><span class="field">return:</span> containing codepoints (UTF-8 characters values)</li> 5716 <li><span class="field">usedby:</span> <a href="../com.tecnick.tcpdf/TCPDF.html#methodUTF8ToUTF16BE">TCPDF::UTF8ToUTF16BE()</a></li> 5717 <li><span class="field">access:</span> protected</li> 5718 <li><span class="field">since:</span> 1.53.0.TC005 (2005-01-05)</li> 5719 <li><span class="field">author:</span> Nicola Asuni</li> 5720 </ul> 5721 5722 <div class="method-signature"> 5723 <span class="method-result">array</span> 5724 <span class="method-name"> 5725 UTF8StringToArray 5726 </span> 5727 (<span class="var-type">string</span> <span class="var-name">$str</span>) 5728 </div> 5729 5730 <ul class="parameters"> 5731 <li> 5732 <span class="var-type">string</span> 5733 <span class="var-name">$str</span><span class="var-description">: string to process.</span> </li> 5734 </ul> 5735 5736 5737 </div> 5738 <a name="methodUTF8ToUTF16BE" id="UTF8ToUTF16BE"><!-- --></a> 5739 <div class="oddrow"> 5740 5741 <div class="method-header"> 5742 <span class="method-title">UTF8ToUTF16BE</span> (line <span class="line-number">3502</span>) 5743 </div> 5744 5745 <!-- ========== Info from phpDoc block ========= --> 5746 <p class="short-description">Converts UTF-8 strings to UTF16-BE.<br /></p> 5747 <p class="description"><p>Based on: http://www.faqs.org/rfcs/rfc2781.html <pre> Encoding UTF-16: 5748 5749 Encoding of a single character from an ISO 10646 character value to 5750 UTF-16 proceeds as follows. Let U be the character number, no greater 5751 than 0x10FFFF. 5752 5753 1) If U < 0x10000, encode U as a 16-bit unsigned integer and 5754 terminate. 5755 5756 2) Let U' = U - 0x10000. Because U is less than or equal to 0x10FFFF, 5757 U' must be less than or equal to 0xFFFFF. That is, U' can be 5758 represented in 20 bits. 5759 5760 3) Initialize two 16-bit unsigned integers, W1 and W2, to 0xD800 and 5761 0xDC00, respectively. These integers each have 10 bits free to 5762 encode the character value, for a total of 20 bits. 5763 5764 4) Assign the 10 high-order bits of the 20-bit U' to the 10 low-order 5765 bits of W1 and the 10 low-order bits of U' to the 10 low-order 5766 bits of W2. Terminate. 5767 5768 Graphically, steps 2 through 4 look like: 5769 U' = yyyyyyyyyyxxxxxxxxxx 5770 W1 = 110110yyyyyyyyyy 5771 W2 = 110111xxxxxxxxxx</pre></p></p> 5772 <ul class="tags"> 5773 <li><span class="field">access:</span> protected</li> 5774 <li><span class="field">uses:</span> <a href="../com.tecnick.tcpdf/TCPDF.html#methodUTF8StringToArray">TCPDF::UTF8StringToArray()</a></li> 5775 <li><span class="field">since:</span> 1.53.0.TC005 (2005-01-05)</li> 5776 <li><span class="field">author:</span> Nicola Asuni</li> 5777 </ul> 5778 5779 <div class="method-signature"> 5780 <span class="method-result">string</span> 5781 <span class="method-name"> 5782 UTF8ToUTF16BE 5783 </span> 5784 (<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>]) 5785 </div> 5786 5787 <ul class="parameters"> 5788 <li> 5789 <span class="var-type">string</span> 5790 <span class="var-name">$str</span><span class="var-description">: string to process.</span> </li> 5791 <li> 5792 <span class="var-type">boolean</span> 5793 <span class="var-name">$setbom</span><span class="var-description">: if true set the Byte Order Mark (BOM = 0xFEFF)</span> </li> 5794 </ul> 5795 5796 5797 </div> 5798 <a name="methodWrite" id="Write"><!-- --></a> 5799 <div class="evenrow"> 5800 5801 <div class="method-header"> 5802 <span class="method-title">Write</span> (line <span class="line-number">2219</span>) 5803 </div> 5804 5805 <!-- ========== Info from phpDoc block ========= --> 5806 <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> 5807 <p class="description"><p><strong>Example:</strong><br /> <pre> //Begin with regular font 5808 $pdf->SetFont('Arial','',14); 5809 $pdf->Write(5,'Visit '); 5810 //Then put a blue underlined link 5811 $pdf->SetTextColor(0,0,255); 5812 $pdf->SetFont('','U'); 5813 $pdf->Write(5,'www.tecnick.com','http://www.tecnick.com');</pre></p></p> 5814 <ul class="tags"> 5815 <li><span class="field">access:</span> public</li> 5816 <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> 5817 <li><span class="field">since:</span> 1.5</li> 5818 </ul> 5819 5820 <div class="method-signature"> 5821 <span class="method-result">void</span> 5822 <span class="method-name"> 5823 Write 5824 </span> 5825 (<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>) 5826 </div> 5827 5828 <ul class="parameters"> 5829 <li> 5830 <span class="var-type">float</span> 5831 <span class="var-name">$h</span><span class="var-description">: Line height</span> </li> 5832 <li> 5833 <span class="var-type">string</span> 5834 <span class="var-name">$txt</span><span class="var-description">: String to print</span> </li> 5835 <li> 5836 <span class="var-type">mixed</span> 5837 <span class="var-name">$link</span><span class="var-description">: URL or identifier returned by AddLink()</span> </li> 5838 <li> 5839 <span class="var-type">int</span> 5840 <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> 5841 </ul> 5842 5843 5844 </div> 5845 <a name="methodwriteBarcode" id="writeBarcode"><!-- --></a> 5846 <div class="oddrow"> 5847 5848 <div class="method-header"> 5849 <span class="method-title">writeBarcode</span> (line <span class="line-number">3581</span>) 5850 </div> 5851 5852 <!-- ========== Info from phpDoc block ========= --> 5853 <p class="short-description">Print Barcode.</p> 5854 <ul class="tags"> 5855 <li><span class="field">access:</span> public</li> 5856 </ul> 5857 5858 <div class="method-signature"> 5859 <span class="method-result">void</span> 5860 <span class="method-name"> 5861 writeBarcode 5862 </span> 5863 (<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>) 5864 </div> 5865 5866 <ul class="parameters"> 5867 <li> 5868 <span class="var-type">int</span> 5869 <span class="var-name">$x</span><span class="var-description">: x position in user units</span> </li> 5870 <li> 5871 <span class="var-type">int</span> 5872 <span class="var-name">$y</span><span class="var-description">: y position in user units</span> </li> 5873 <li> 5874 <span class="var-type">int</span> 5875 <span class="var-name">$w</span><span class="var-description">: width in user units</span> </li> 5876 <li> 5877 <span class="var-type">int</span> 5878 <span class="var-name">$h</span><span class="var-description">: height position in user units</span> </li> 5879 <li> 5880 <span class="var-type">string</span> 5881 <span class="var-name">$type</span><span class="var-description">: type of barcode (I25, C128A, C128B, C128C, C39)</span> </li> 5882 <li> 5883 <span class="var-type">string</span> 5884 <span class="var-name">$style</span><span class="var-description">: barcode style</span> </li> 5885 <li> 5886 <span class="var-type">string</span> 5887 <span class="var-name">$font</span><span class="var-description">: font for text</span> </li> 5888 <li> 5889 <span class="var-type">int</span> 5890 <span class="var-name">$xres</span><span class="var-description">: x resolution</span> </li> 5891 <li> 5892 <span class="var-type">string</span> 5893 <span class="var-name">$code</span><span class="var-description">: code to print</span> </li> 5894 </ul> 5895 5896 5897 </div> 5898 <a name="methodwriteHTML" id="writeHTML"><!-- --></a> 5899 <div class="evenrow"> 5900 5901 <div class="method-header"> 5902 <span class="method-title">writeHTML</span> (line <span class="line-number">3664</span>) 5903 </div> 5904 5905 <!-- ========== Info from phpDoc block ========= --> 5906 <p class="short-description">Allows to preserve some HTML formatting.<br /></p> 5907 <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> 5908 <ul class="tags"> 5909 <li><span class="field">access:</span> public</li> 5910 </ul> 5911 5912 <div class="method-signature"> 5913 <span class="method-result">void</span> 5914 <span class="method-name"> 5915 writeHTML 5916 </span> 5917 (<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>) 5918 </div> 5919 5920 <ul class="parameters"> 5921 <li> 5922 <span class="var-type">string</span> 5923 <span class="var-name">$html</span><span class="var-description">: text to display</span> </li> 5924 <li> 5925 <span class="var-type">boolean</span> 5926 <span class="var-name">$ln</span><span class="var-description">: if true add a new line after text (default = true)</span> </li> 5927 <li> 5928 <span class="var-type">int</span> 5929 <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> 5930 </ul> 5931 5932 5933 </div> 5934 <a name="methodwriteHTMLCell" id="writeHTMLCell"><!-- --></a> 5935 <div class="oddrow"> 5936 5937 <div class="method-header"> 5938 <span class="method-title">writeHTMLCell</span> (line <span class="line-number">3736</span>) 5939 </div> 5940 5941 <!-- ========== Info from phpDoc block ========= --> 5942 <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> 5943 <ul class="tags"> 5944 <li><span class="field">access:</span> public</li> 5945 <li><span class="field">see:</span> <a href="../com.tecnick.tcpdf/TCPDF.html#methodCell">TCPDF::Cell()</a></li> 5946 </ul> 5947 5948 <div class="method-signature"> 5949 <span class="method-result">void</span> 5950 <span class="method-name"> 5951 writeHTMLCell 5952 </span> 5953 (<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>) 5954 </div> 5955 5956 <ul class="parameters"> 5957 <li> 5958 <span class="var-type">float</span> 5959 <span class="var-name">$w</span><span class="var-description">: Cell width. If 0, the cell extends up to the right margin.</span> </li> 5960 <li> 5961 <span class="var-type">float</span> 5962 <span class="var-name">$h</span><span class="var-description">: Cell minimum height. The cell extends automatically if needed.</span> </li> 5963 <li> 5964 <span class="var-type">float</span> 5965 <span class="var-name">$x</span><span class="var-description">: upper-left corner X coordinate</span> </li> 5966 <li> 5967 <span class="var-type">float</span> 5968 <span class="var-name">$y</span><span class="var-description">: upper-left corner Y coordinate</span> </li> 5969 <li> 5970 <span class="var-type">string</span> 5971 <span class="var-name">$html</span><span class="var-description">: html text to print. Default value: empty string.</span> </li> 5972 <li> 5973 <span class="var-type">mixed</span> 5974 <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> 5975 <li> 5976 <span class="var-type">int</span> 5977 <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> 5978 <li> 5979 <span class="var-type">int</span> 5980 <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> 5981 </ul> 5982 5983 5984 </div> 5985 <a name="method_begindoc" id="_begindoc"><!-- --></a> 5986 <div class="evenrow"> 5987 5988 <div class="method-header"> 5989 <span class="method-title">_begindoc</span> (line <span class="line-number">2587</span>) 5990 </div> 5991 5992 <!-- ========== Info from phpDoc block ========= --> 5993 <p class="short-description">Start document</p> 5994 <ul class="tags"> 5995 <li><span class="field">access:</span> protected</li> 5996 </ul> 5997 5998 <div class="method-signature"> 5999 <span class="method-result">void</span> 6000 <span class="method-name"> 6001 _begindoc 6002 </span> 6003 () 6004 </div> 6005 6006 6007 6008 </div> 6009 <a name="method_beginpage" id="_beginpage"><!-- --></a> 6010 <div class="oddrow"> 6011 6012 <div class="method-header"> 6013 <span class="method-title">_beginpage</span> (line <span class="line-number">2993</span>) 6014 </div> 6015 6016 <!-- ========== Info from phpDoc block ========= --> 6017 <p class="short-description">_beginpage</p> 6018 <ul class="tags"> 6019 <li><span class="field">access:</span> protected</li> 6020 </ul> 6021 6022 <div class="method-signature"> 6023 <span class="method-result">void</span> 6024 <span class="method-name"> 6025 _beginpage 6026 </span> 6027 (<span class="var-type">mixed</span> <span class="var-name">$orientation</span>) 6028 </div> 6029 6030 6031 6032 </div> 6033 <a name="method_dochecks" id="_dochecks"><!-- --></a> 6034 <div class="evenrow"> 6035 6036 <div class="method-header"> 6037 <span class="method-title">_dochecks</span> (line <span class="line-number">2561</span>) 6038 </div> 6039 6040 <!-- ========== Info from phpDoc block ========= --> 6041 <p class="short-description">Check for locale-related bug</p> 6042 <ul class="tags"> 6043 <li><span class="field">access:</span> protected</li> 6044 </ul> 6045 6046 <div class="method-signature"> 6047 <span class="method-result">void</span> 6048 <span class="method-name"> 6049 _dochecks 6050 </span> 6051 () 6052 </div> 6053 6054 6055 6056 </div> 6057 <a name="method_dounderline" id="_dounderline"><!-- --></a> 6058 <div class="oddrow"> 6059 6060 <div class="method-header"> 6061 <span class="method-title">_dounderline</span> (line <span class="line-number">3051</span>) 6062 </div> 6063 6064 <!-- ========== Info from phpDoc block ========= --> 6065 <p class="short-description">Underline text</p> 6066 <ul class="tags"> 6067 <li><span class="field">access:</span> protected</li> 6068 </ul> 6069 6070 <div class="method-signature"> 6071 <span class="method-result">void</span> 6072 <span class="method-name"> 6073 _dounderline 6074 </span> 6075 (<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>) 6076 </div> 6077 6078 6079 6080 </div> 6081 <a name="method_enddoc" id="_enddoc"><!-- --></a> 6082 <div class="evenrow"> 6083 6084 <div class="method-header"> 6085 <span class="method-title">_enddoc</span> (line <span class="line-number">2954</span>) 6086 </div> 6087 6088 <!-- ========== Info from phpDoc block ========= --> 6089 <p class="short-description">_enddoc</p> 6090 <ul class="tags"> 6091 <li><span class="field">access:</span> protected</li> 6092 </ul> 6093 6094 <div class="method-signature"> 6095 <span class="method-result">void</span> 6096 <span class="method-name"> 6097 _enddoc 6098 </span> 6099 () 6100 </div> 6101 6102 6103 6104 </div> 6105 <a name="method_endpage" id="_endpage"><!-- --></a> 6106 <div class="oddrow"> 6107 6108 <div class="method-header"> 6109 <span class="method-title">_endpage</span> (line <span class="line-number">3033</span>) 6110 </div> 6111 6112 <!-- ========== Info from phpDoc block ========= --> 6113 <p class="short-description">End of page contents</p> 6114 <ul class="tags"> 6115 <li><span class="field">access:</span> protected</li> 6116 </ul> 6117 6118 <div class="method-signature"> 6119 <span class="method-result">void</span> 6120 <span class="method-name"> 6121 _endpage 6122 </span> 6123 () 6124 </div> 6125 6126 6127 6128 </div> 6129 <a name="method_escape" id="_escape"><!-- --></a> 6130 <div class="evenrow"> 6131 6132 <div class="method-header"> 6133 <span class="method-title">_escape</span> (line <span class="line-number">3225</span>) 6134 </div> 6135 6136 <!-- ========== Info from phpDoc block ========= --> 6137 <p class="short-description">Add \ before \, ( and )</p> 6138 <ul class="tags"> 6139 <li><span class="field">access:</span> protected</li> 6140 </ul> 6141 6142 <div class="method-signature"> 6143 <span class="method-result">void</span> 6144 <span class="method-name"> 6145 _escape 6146 </span> 6147 (<span class="var-type">mixed</span> <span class="var-name">$s</span>) 6148 </div> 6149 6150 6151 6152 </div> 6153 <a name="method_escapetext" id="_escapetext"><!-- --></a> 6154 <div class="oddrow"> 6155 6156 <div class="method-header"> 6157 <span class="method-title">_escapetext</span> (line <span class="line-number">3213</span>) 6158 </div> 6159 6160 <!-- ========== Info from phpDoc block ========= --> 6161 <p class="short-description">Format a text string</p> 6162 <ul class="tags"> 6163 <li><span class="field">access:</span> protected</li> 6164 </ul> 6165 6166 <div class="method-signature"> 6167 <span class="method-result">void</span> 6168 <span class="method-name"> 6169 _escapetext 6170 </span> 6171 (<span class="var-type">mixed</span> <span class="var-name">$s</span>) 6172 </div> 6173 6174 6175 6176 </div> 6177 <a name="method_freadint" id="_freadint"><!-- --></a> 6178 <div class="evenrow"> 6179 6180 <div class="method-header"> 6181 <span class="method-title">_freadint</span> (line <span class="line-number">3191</span>) 6182 </div> 6183 6184 <!-- ========== Info from phpDoc block ========= --> 6185 <p class="short-description">Read a 4-byte integer from file</p> 6186 <ul class="tags"> 6187 <li><span class="field">access:</span> protected</li> 6188 </ul> 6189 6190 <div class="method-signature"> 6191 <span class="method-result">void</span> 6192 <span class="method-name"> 6193 _freadint 6194 </span> 6195 (<span class="var-type">mixed</span> <span class="var-name">$f</span>) 6196 </div> 6197 6198 6199 6200 </div> 6201 <a name="method_getfontpath" id="_getfontpath"><!-- --></a> 6202 <div class="oddrow"> 6203 6204 <div class="method-header"> 6205 <span class="method-title">_getfontpath</span> (line <span class="line-number">2576</span>) 6206 </div> 6207 6208 <!-- ========== Info from phpDoc block ========= --> 6209 <p class="short-description">Return fonts path</p> 6210 <ul class="tags"> 6211 <li><span class="field">access:</span> protected</li> 6212 </ul> 6213 6214 <div class="method-signature"> 6215 <span class="method-result">void</span> 6216 <span class="method-name"> 6217 _getfontpath 6218 </span> 6219 () 6220 </div> 6221 6222 6223 6224 </div> 6225 <a name="method_newobj" id="_newobj"><!-- --></a> 6226 <div class="evenrow"> 6227 6228 <div class="method-header"> 6229 <span class="method-title">_newobj</span> (line <span class="line-number">3041</span>) 6230 </div> 6231 6232 <!-- ========== Info from phpDoc block ========= --> 6233 <p class="short-description">Begin a new object</p> 6234 <ul class="tags"> 6235 <li><span class="field">access:</span> protected</li> 6236 </ul> 6237 6238 <div class="method-signature"> 6239 <span class="method-result">void</span> 6240 <span class="method-name"> 6241 _newobj 6242 </span> 6243 () 6244 </div> 6245 6246 6247 6248 </div> 6249 <a name="method_out" id="_out"><!-- --></a> 6250 <div class="oddrow"> 6251 6252 <div class="method-header"> 6253 <span class="method-title">_out</span> (line <span class="line-number">3244</span>) 6254 </div> 6255 6256 <!-- ========== Info from phpDoc block ========= --> 6257 <p class="short-description">Add a line to the document</p> 6258 <ul class="tags"> 6259 <li><span class="field">access:</span> protected</li> 6260 </ul> 6261 6262 <div class="method-signature"> 6263 <span class="method-result">void</span> 6264 <span class="method-name"> 6265 _out 6266 </span> 6267 (<span class="var-type">mixed</span> <span class="var-name">$s</span>) 6268 </div> 6269 6270 6271 6272 </div> 6273 <a name="method_parsejpg" id="_parsejpg"><!-- --></a> 6274 <div class="evenrow"> 6275 6276 <div class="method-header"> 6277 <span class="method-title">_parsejpg</span> (line <span class="line-number">3062</span>) 6278 </div> 6279 6280 <!-- ========== Info from phpDoc block ========= --> 6281 <p class="short-description">Extract info from a JPEG file</p> 6282 <ul class="tags"> 6283 <li><span class="field">access:</span> protected</li> 6284 </ul> 6285 6286 <div class="method-signature"> 6287 <span class="method-result">void</span> 6288 <span class="method-name"> 6289 _parsejpg 6290 </span> 6291 (<span class="var-type">mixed</span> <span class="var-name">$file</span>) 6292 </div> 6293 6294 6295 6296 </div> 6297 <a name="method_parsepng" id="_parsepng"><!-- --></a> 6298 <div class="oddrow"> 6299 6300 <div class="method-header"> 6301 <span class="method-title">_parsepng</span> (line <span class="line-number">3094</span>) 6302 </div> 6303 6304 <!-- ========== Info from phpDoc block ========= --> 6305 <p class="short-description">Extract info from a PNG file</p> 6306 <ul class="tags"> 6307 <li><span class="field">access:</span> protected</li> 6308 </ul> 6309 6310 <div class="method-signature"> 6311 <span class="method-result">void</span> 6312 <span class="method-name"> 6313 _parsepng 6314 </span> 6315 (<span class="var-type">mixed</span> <span class="var-name">$file</span>) 6316 </div> 6317 6318 6319 6320 </div> 6321 <a name="method_putcatalog" id="_putcatalog"><!-- --></a> 6322 <div class="evenrow"> 6323 6324 <div class="method-header"> 6325 <span class="method-title">_putcatalog</span> (line <span class="line-number">2906</span>) 6326 </div> 6327 6328 <!-- ========== Info from phpDoc block ========= --> 6329 <p class="short-description">_putcatalog</p> 6330 <ul class="tags"> 6331 <li><span class="field">access:</span> protected</li> 6332 </ul> 6333 6334 <div class="method-signature"> 6335 <span class="method-result">void</span> 6336 <span class="method-name"> 6337 _putcatalog 6338 </span> 6339 () 6340 </div> 6341 6342 6343 6344 </div> 6345 <a name="method_putfonts" id="_putfonts"><!-- --></a> 6346 <div class="oddrow"> 6347 6348 <div class="method-header"> 6349 <span class="method-title">_putfonts</span> (line <span class="line-number">2670</span>) 6350 </div> 6351 6352 <!-- ========== Info from phpDoc block ========= --> 6353 <p class="short-description">Adds fonts</p> 6354 <p class="description"><p>_putfonts</p></p> 6355 <ul class="tags"> 6356 <li><span class="field">access:</span> protected</li> 6357 </ul> 6358 6359 <div class="method-signature"> 6360 <span class="method-result">void</span> 6361 <span class="method-name"> 6362 _putfonts 6363 </span> 6364 () 6365 </div> 6366 6367 6368 6369 </div> 6370 <a name="method_putheader" id="_putheader"><!-- --></a> 6371 <div class="evenrow"> 6372 6373 <div class="method-header"> 6374 <span class="method-title">_putheader</span> (line <span class="line-number">2946</span>) 6375 </div> 6376 6377 <!-- ========== Info from phpDoc block ========= --> 6378 <p class="short-description">_putheader</p> 6379 <ul class="tags"> 6380 <li><span class="field">access:</span> protected</li> 6381 </ul> 6382 6383 <div class="method-signature"> 6384 <span class="method-result">void</span> 6385 <span class="method-name"> 6386 _putheader 6387 </span> 6388 () 6389 </div> 6390 6391 6392 6393 </div> 6394 <a name="method_putimages" id="_putimages"><!-- --></a> 6395 <div class="oddrow"> 6396 6397 <div class="method-header"> 6398 <span class="method-title">_putimages</span> (line <span class="line-number">2788</span>) 6399 </div> 6400 6401 <!-- ========== Info from phpDoc block ========= --> 6402 <p class="short-description">_putimages</p> 6403 <ul class="tags"> 6404 <li><span class="field">access:</span> protected</li> 6405 </ul> 6406 6407 <div class="method-signature"> 6408 <span class="method-result">void</span> 6409 <span class="method-name"> 6410 _putimages 6411 </span> 6412 () 6413 </div> 6414 6415 6416 6417 </div> 6418 <a name="method_putinfo" id="_putinfo"><!-- --></a> 6419 <div class="evenrow"> 6420 6421 <div class="method-header"> 6422 <span class="method-title">_putinfo</span> (line <span class="line-number">2882</span>) 6423 </div> 6424 6425 <!-- ========== Info from phpDoc block ========= --> 6426 <p class="short-description">_putinfo</p> 6427 <ul class="tags"> 6428 <li><span class="field">access:</span> protected</li> 6429 </ul> 6430 6431 <div class="method-signature"> 6432 <span class="method-result">void</span> 6433 <span class="method-name"> 6434 _putinfo 6435 </span> 6436 () 6437 </div> 6438 6439 6440 6441 </div> 6442 <a name="method_putpages" id="_putpages"><!-- --></a> 6443 <div class="oddrow"> 6444 6445 <div class="method-header"> 6446 <span class="method-title">_putpages</span> (line <span class="line-number">2597</span>) 6447 </div> 6448 6449 <!-- ========== Info from phpDoc block ========= --> 6450 <p class="short-description">_putpages</p> 6451 <ul class="tags"> 6452 <li><span class="field">access:</span> protected</li> 6453 </ul> 6454 6455 <div class="method-signature"> 6456 <span class="method-result">void</span> 6457 <span class="method-name"> 6458 _putpages 6459 </span> 6460 () 6461 </div> 6462 6463 6464 6465 </div> 6466 <a name="method_putresourcedict" id="_putresourcedict"><!-- --></a> 6467 <div class="evenrow"> 6468 6469 <div class="method-header"> 6470 <span class="method-title">_putresourcedict</span> (line <span class="line-number">2850</span>) 6471 </div> 6472 6473 <!-- ========== Info from phpDoc block ========= --> 6474 <p class="short-description">_putresourcedict</p> 6475 <ul class="tags"> 6476 <li><span class="field">access:</span> protected</li> 6477 </ul> 6478 6479 <div class="method-signature"> 6480 <span class="method-result">void</span> 6481 <span class="method-name"> 6482 _putresourcedict 6483 </span> 6484 () 6485 </div> 6486 6487 6488 6489 </div> 6490 <a name="method_putresources" id="_putresources"><!-- --></a> 6491 <div class="oddrow"> 6492 6493 <div class="method-header"> 6494 <span class="method-title">_putresources</span> (line <span class="line-number">2866</span>) 6495 </div> 6496 6497 <!-- ========== Info from phpDoc block ========= --> 6498 <p class="short-description">_putresources</p> 6499 <ul class="tags"> 6500 <li><span class="field">access:</span> protected</li> 6501 </ul> 6502 6503 <div class="method-signature"> 6504 <span class="method-result">void</span> 6505 <span class="method-name"> 6506 _putresources 6507 </span> 6508 () 6509 </div> 6510 6511 6512 6513 </div> 6514 <a name="method_putstream" id="_putstream"><!-- --></a> 6515 <div class="evenrow"> 6516 6517 <div class="method-header"> 6518 <span class="method-title">_putstream</span> (line <span class="line-number">3234</span>) 6519 </div> 6520 6521 <!-- ========== Info from phpDoc block ========= --> 6522 <ul class="tags"> 6523 <li><span class="field">access:</span> protected</li> 6524 </ul> 6525 6526 <div class="method-signature"> 6527 <span class="method-result">void</span> 6528 <span class="method-name"> 6529 _putstream 6530 </span> 6531 (<span class="var-type">mixed</span> <span class="var-name">$s</span>) 6532 </div> 6533 6534 6535 6536 </div> 6537 <a name="method_puttrailer" id="_puttrailer"><!-- --></a> 6538 <div class="oddrow"> 6539 6540 <div class="method-header"> 6541 <span class="method-title">_puttrailer</span> (line <span class="line-number">2936</span>) 6542 </div> 6543 6544 <!-- ========== Info from phpDoc block ========= --> 6545 <p class="short-description">_puttrailer</p> 6546 <ul class="tags"> 6547 <li><span class="field">access:</span> protected</li> 6548 </ul> 6549 6550 <div class="method-signature"> 6551 <span class="method-result">void</span> 6552 <span class="method-name"> 6553 _puttrailer 6554 </span> 6555 () 6556 </div> 6557 6558 6559 6560 </div> 6561 <a name="method_puttruetypeunicode" id="_puttruetypeunicode"><!-- --></a> 6562 <div class="evenrow"> 6563 6564 <div class="method-header"> 6565 <span class="method-title">_puttruetypeunicode</span> (line <span class="line-number">3260</span>) 6566 </div> 6567 6568 <!-- ========== Info from phpDoc block ========= --> 6569 <p class="short-description">Adds unicode fonts.<br /></p> 6570 <p class="description"><p>Based on PDF Reference 1.3 (section 5)</p></p> 6571 <ul class="tags"> 6572 <li><span class="field">access:</span> protected</li> 6573 <li><span class="field">since:</span> 1.52.0.TC005 (2005-01-05)</li> 6574 <li><span class="field">author:</span> Nicola Asuni</li> 6575 </ul> 6576 6577 <div class="method-signature"> 6578 <span class="method-result">void</span> 6579 <span class="method-name"> 6580 _puttruetypeunicode 6581 </span> 6582 (<span class="var-type">mixed</span> <span class="var-name">$font</span>) 6583 </div> 6584 6585 6586 6587 </div> 6588 <a name="method_putxobjectdict" id="_putxobjectdict"><!-- --></a> 6589 <div class="oddrow"> 6590 6591 <div class="method-header"> 6592 <span class="method-title">_putxobjectdict</span> (line <span class="line-number">2840</span>) 6593 </div> 6594 6595 <!-- ========== Info from phpDoc block ========= --> 6596 <p class="short-description">_putxobjectdict</p> 6597 <ul class="tags"> 6598 <li><span class="field">access:</span> protected</li> 6599 </ul> 6600 6601 <div class="method-signature"> 6602 <span class="method-result">void</span> 6603 <span class="method-name"> 6604 _putxobjectdict 6605 </span> 6606 () 6607 </div> 6608 6609 6610 6611 </div> 6612 <a name="method_textstring" id="_textstring"><!-- --></a> 6613 <div class="evenrow"> 6614 6615 <div class="method-header"> 6616 <span class="method-title">_textstring</span> (line <span class="line-number">3201</span>) 6617 </div> 6618 6619 <!-- ========== Info from phpDoc block ========= --> 6620 <p class="short-description">Format a text string</p> 6621 <ul class="tags"> 6622 <li><span class="field">access:</span> protected</li> 6623 </ul> 6624 6625 <div class="method-signature"> 6626 <span class="method-result">void</span> 6627 <span class="method-name"> 6628 _textstring 6629 </span> 6630 (<span class="var-type">mixed</span> <span class="var-name">$s</span>) 6631 </div> 6632 6633 6634 6635 </div> 6636 6637 </div> 6638 </div> 6639 6640 6641 <p class="notes" id="credit"> 6642 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> 6643 </p> 6644 </div></body> 6645 </html>
title
Description
Body
title
Description
Body
title
Description
Body
title
Body
| Generated: Fri Nov 28 20:08:37 2014 | Cross-referenced by PHPXref 0.7.1 |