|
|
| (20 intermediate revisions by one other user not shown) |
| Line 1: |
Line 1: |
| This article desrcibes the class ''I2CE_FontMetricTTF''.
| | #REDIRECT [[Class: I2CE_FontMetricTTF (4.1.12)]] |
| *Extends the class: [[Class: I2CE_FontMetricMultiDirection | I2CE_FontMetricMultiDirection]].
| |
| *Location: Part of the module [[iHRIS Module List#textlayout|textlayout]] in the package [https://launchpad.net/textlayout TextLayout Tools]
| |
| *Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/textlayout/4.0.0-release/annotate/head:/lib/I2CE_FontMetricTTF.php lib/I2CE_FontMetricTTF.php]
| |
| *Author: Carl Leitner <litlfred@ibiblio.org>
| |
| Class to contain information about font metrics. Data extracted from TTF files
| |
| ==Variables==
| |
| ===$ttf_file===
| |
| *Type: protected $ttf_file
| |
| | |
| ===$ttf_handle===
| |
| *Type: protected $ttf_handle
| |
| | |
| ===$directory===
| |
| *Type: protected $directory
| |
| | |
| ===$numOfLongHorMetrics===
| |
| *Type: protected $numOfLongHorMetrics
| |
| | |
| ===$num_glyphs===
| |
| *Type: protected $num_glyphs
| |
| | |
| ===$GIDtoCPs===
| |
| *Type: protected $GIDtoCPs
| |
| | |
| ===$indexToLocFormat===
| |
| *Type: protected $indexToLocFormat
| |
| | |
| ===$glyph_offsets===
| |
| *Type: protected $glyph_offsets
| |
| | |
| ===$units_per_em===
| |
| *Type: protected $units_per_em
| |
| | |
| ===$file_size===
| |
| *Type: protected $file_size
| |
| | |
| ===$fix===
| |
| Some common incorrect glyph names
| |
| *Type: static protected fix $fix
| |
| | |
| ==Methods==
| |
| ===__construct()===
| |
| *Signature: public function __construct($encoding,$ttf_file)
| |
| *Parameters:
| |
| **&$encoding
| |
| **$ttf_file
| |
| ===close()===
| |
| *Signature: protected function close()
| |
| ===generate_PDF_CMAP()===
| |
| *Signature: public function generate_PDF_CMAP($platform_id,$platform_specific_id)
| |
| *Parameters:
| |
| **$platform_id
| |
| ***Default Value: null
| |
| **$platform_specific_id
| |
| ***Default Value: null
| |
| ===getCIDtoGIDmap()===
| |
| $param int $platform_id is the Platform ID. Default is null which means we dont care. The platform ID follows this table <table> <tr><td>Platform ID</td><td> Platform </td><td>Specific encoding</td></tr> <tr><td>0</td><td> Unicode </td><td>Indicates Unicode version.</td></tr> <tr><td>1</td><td> Macintosh </td><td>Script Manager code.</td></tr> <tr><td>3</td><td> Microsoft</td><td> Microsoft encoding.</td></tr></table>
| |
| *Signature: public function getCIDtoGIDmap($platform_id,$platform_specific_id)
| |
| *Parameters:
| |
| **$platform_id
| |
| ***Default Value: null
| |
| ** [http://www.php.net/manual/en/language.types.integer.php int ] $platform_specific_id The platform specific id's identify languages used on a platform. Their values are outline in:http://developer.apple.com/textfonts/TTRefMan/RM06/Chap6name.html#ID. Set to null(default) if you dont care which one
| |
| ***Default Value: null
| |
| ===getEncodedCharactersFromGlyphID()===
| |
| *Signature: public function getEncodedCharactersFromGlyphID($gid)
| |
| *Parameters:
| |
| **$gid
| |
| ===getTTFFile()===
| |
| *Signature: public function getTTFFile()
| |
| ===getUnicodeCodepointsFromGlyphID()===
| |
| *Signature: public function getUnicodeCodepointsFromGlyphID($gid)
| |
| *Parameters:
| |
| **$gid
| |
| ===gotoTable()===
| |
| *Signature: protected function gotoTable($table)
| |
| *Parameters:
| |
| **$table
| |
| ===inDirectory()===
| |
| *Signature: protected function inDirectory($table)
| |
| *Parameters:
| |
| **$table
| |
| ===loadDirectory()===
| |
| Reference:http://developer.apple.com/textfonts/TTRefMan/RM06/Chap6.html
| |
| *Signature: protected function loadDirectory()
| |
| ===loadin()===
| |
| *Signature: protected function loadin($file)
| |
| *Parameters:
| |
| **$file
| |
| ===openForReading()===
| |
| *Signature: protected function openForReading()
| |
| ===read_FWord()===
| |
| *Signature: protected function read_FWord()
| |
| ===read_fixed_pieces()===
| |
| DATA TYPES: http://developer.apple.com/textfonts/TTRefMan/RM06/Chap6.html#Types Macintosh Data type OS/2 Data Type Description uint8 BYTE 8-bit unsigned integer int8 CHAR 8-bit signed integer uint16 USHORT 16-bit unsigned integer int16 SHORT 16-bit signed integer uint32 ULONG 32-bit unsigned integer int32 LONG 32-bit signed integer shortFrac - 16-bit signed fraction Fixed - 16.16-bit signed fixed-point number FWord - 16-bit signed integer that describes a quantity in FUnits, the smallest measurable distance in em space. uFWord - 16-bit unsigned integer that describes a quantity in FUnits, the smallest measurable distance in em space. F2Dot14 - 16-bit signed fixed number with the low 14 bits representing fraction. longDateTime - The long internal format of a date in seconds since 12:00 midnight, January 1, 1904. It is represented as a signed 64-bit integer. NOTE: We are Big-Endian here
| |
| *Signature: protected function read_fixed_pieces()
| |
| ===read_glyf()===
| |
| *Signature: protected function read_glyf()
| |
| ===read_head()===
| |
| *Signature: protected function read_head()
| |
| ===read_hhea()===
| |
| *Signature: protected function read_hhea()
| |
| ===read_hmtx()===
| |
| See http://developer.apple.com/textfonts/TTRefMan/RM06/Chap6hmtx.html
| |
| *Signature: protected function read_hmtx()
| |
| ===read_int16()===
| |
| *Signature: protected function read_int16()
| |
| ===read_int32()===
| |
| *Signature: protected function read_int32()
| |
| ===read_int8()===
| |
| *Signature: protected function read_int8()
| |
| ===read_kern()===
| |
| *Signature: public function read_kern($old_format)
| |
| *Parameters:
| |
| **$old_format
| |
| ***Default Value: true
| |
| ===read_loca()===
| |
| *Signature: protected function read_loca()
| |
| ===read_name()===
| |
| *Signature: protected function read_name()
| |
| ===read_numGlyphs()===
| |
| *Signature: protected function read_numGlyphs()
| |
| ===read_uFWord()===
| |
| *Signature: protected function read_uFWord()
| |
| ===read_uint16()===
| |
| *Signature: protected function read_uint16()
| |
| ===read_uint32()===
| |
| *Signature: protected function read_uint32()
| |
| ===read_uint8()===
| |
| *Signature: protected function read_uint8()
| |
| ===setCIDtoGID()===
| |
| *Signature: protected function setCIDtoGID($CIDtoGID,$cid,$gid,$warning,$try_unicode)
| |
| *Parameters:
| |
| **&$CIDtoGID
| |
| **$cid
| |
| **$gid
| |
| **$warning
| |
| **$try_unicode
| |
| ***Default Value: false
| |
| ===showCharacterInfo()===
| |
| *Signature: public function showCharacterInfo()
| |
| ==Inherited Methods==
| |
| ===__construct()===
| |
| This public method is inherited from [[Class: I2CE_FontMetricMultiDirection#__construct() | I2CE_FontMetricMultiDirection->__construct()]]
| |
| | |
| ===getAllFontCharacteristics()===
| |
| This public method is inherited from [[Class: I2CE_FontMetricMultiDirection#getAllFontCharacteristics() | I2CE_FontMetricMultiDirection->getAllFontCharacteristics()]]
| |
| | |
| ===getAscender()===
| |
| This public method is inherited from [[Class: I2CE_FontMetricMultiDirection#getAscender() | I2CE_FontMetricMultiDirection->getAscender()]]
| |
| | |
| ===getBoundingBox()===
| |
| This public method is inherited from [[Class: I2CE_FontMetricMultiDirection#getBoundingBox() | I2CE_FontMetricMultiDirection->getBoundingBox()]]
| |
| | |
| ===getCharacterHeight()===
| |
| This public method is inherited from [[Class: I2CE_FontMetricMultiDirection#getCharacterHeight() | I2CE_FontMetricMultiDirection->getCharacterHeight()]]
| |
| | |
| ===getCharacterHeights()===
| |
| This public method is inherited from [[Class: I2CE_FontMetricMultiDirection#getCharacterHeights() | I2CE_FontMetricMultiDirection->getCharacterHeights()]]
| |
| | |
| ===getCharacterInfo()===
| |
| This public method is inherited from [[Class: I2CE_FontMetricMultiDirection#getCharacterInfo() | I2CE_FontMetricMultiDirection->getCharacterInfo()]]
| |
| | |
| ===getCharacterWidth()===
| |
| This public method is inherited from [[Class: I2CE_FontMetricMultiDirection#getCharacterWidth() | I2CE_FontMetricMultiDirection->getCharacterWidth()]]
| |
| | |
| ===getCharacterWidths()===
| |
| This public method is inherited from [[Class: I2CE_FontMetricMultiDirection#getCharacterWidths() | I2CE_FontMetricMultiDirection->getCharacterWidths()]]
| |
| | |
| ===getDescender()===
| |
| This public method is inherited from [[Class: I2CE_FontMetricMultiDirection#getDescender() | I2CE_FontMetricMultiDirection->getDescender()]]
| |
| | |
| ===getDirection()===
| |
| This public method is inherited from [[Class: I2CE_FontMetricMultiDirection#getDirection() | I2CE_FontMetricMultiDirection->getDirection()]]
| |
| | |
| ===getDirections()===
| |
| This public method is inherited from [[Class: I2CE_FontMetricMultiDirection#getDirections() | I2CE_FontMetricMultiDirection->getDirections()]]
| |
| | |
| ===getEncoding()===
| |
| This public method is inherited from [[Class: I2CE_FontMetricMultiDirection#getEncoding() | I2CE_FontMetricMultiDirection->getEncoding()]]
| |
| | |
| ===getFixedWidth()===
| |
| This public method is inherited from [[Class: I2CE_FontMetricMultiDirection#getFixedWidth() | I2CE_FontMetricMultiDirection->getFixedWidth()]]
| |
| | |
| ===getFontCharacteristic()===
| |
| This public method is inherited from [[Class: I2CE_FontMetricMultiDirection#getFontCharacteristic() | I2CE_FontMetricMultiDirection->getFontCharacteristic()]]
| |
| | |
| ===getFontSize()===
| |
| This public method is inherited from [[Class: I2CE_FontMetricMultiDirection#getFontSize() | I2CE_FontMetricMultiDirection->getFontSize()]]
| |
| | |
| ===getKerningByGroup()===
| |
| This public method is inherited from [[Class: I2CE_FontMetricMultiDirection#getKerningByGroup() | I2CE_FontMetricMultiDirection->getKerningByGroup()]]
| |
| | |
| ===getKerningByPair()===
| |
| This public method is inherited from [[Class: I2CE_FontMetricMultiDirection#getKerningByPair() | I2CE_FontMetricMultiDirection->getKerningByPair()]]
| |
| | |
| ===getKerningGroup()===
| |
| This public method is inherited from [[Class: I2CE_FontMetricMultiDirection#getKerningGroup() | I2CE_FontMetricMultiDirection->getKerningGroup()]]
| |
| | |
| ===getKerningValue()===
| |
| This public method is inherited from [[Class: I2CE_FontMetricMultiDirection#getKerningValue() | I2CE_FontMetricMultiDirection->getKerningValue()]]
| |
| | |
| ===getLinegap()===
| |
| This public method is inherited from [[Class: I2CE_FontMetricMultiDirection#getLinegap() | I2CE_FontMetricMultiDirection->getLinegap()]]
| |
| | |
| ===getStringWidth()===
| |
| This public method is inherited from [[Class: I2CE_FontMetricMultiDirection#getStringWidth() | I2CE_FontMetricMultiDirection->getStringWidth()]]
| |
| | |
| ===getTrackingValues()===
| |
| This public method is inherited from [[Class: I2CE_FontMetricMultiDirection#getTrackingValues() | I2CE_FontMetricMultiDirection->getTrackingValues()]]
| |
| | |
| ===isFixedWidth()===
| |
| This public method is inherited from [[Class: I2CE_FontMetricMultiDirection#isFixedWidth() | I2CE_FontMetricMultiDirection->isFixedWidth()]]
| |
| | |
| ===setAscender()===
| |
| This public method is inherited from [[Class: I2CE_FontMetricMultiDirection#setAscender() | I2CE_FontMetricMultiDirection->setAscender()]]
| |
| | |
| ===setBoundingBox()===
| |
| This public method is inherited from [[Class: I2CE_FontMetricMultiDirection#setBoundingBox() | I2CE_FontMetricMultiDirection->setBoundingBox()]]
| |
| | |
| ===setCharacterHeight()===
| |
| This public method is inherited from [[Class: I2CE_FontMetricMultiDirection#setCharacterHeight() | I2CE_FontMetricMultiDirection->setCharacterHeight()]]
| |
| | |
| ===setCharacterInfo()===
| |
| This public method is inherited from [[Class: I2CE_FontMetricMultiDirection#setCharacterInfo() | I2CE_FontMetricMultiDirection->setCharacterInfo()]]
| |
| | |
| ===setCharacterWidth()===
| |
| This public method is inherited from [[Class: I2CE_FontMetricMultiDirection#setCharacterWidth() | I2CE_FontMetricMultiDirection->setCharacterWidth()]]
| |
| | |
| ===setDescender()===
| |
| This public method is inherited from [[Class: I2CE_FontMetricMultiDirection#setDescender() | I2CE_FontMetricMultiDirection->setDescender()]]
| |
| | |
| ===setDirection()===
| |
| This public method is inherited from [[Class: I2CE_FontMetricMultiDirection#setDirection() | I2CE_FontMetricMultiDirection->setDirection()]]
| |
| | |
| ===setFixedHeightSize()===
| |
| This public method is inherited from [[Class: I2CE_FontMetricMultiDirection#setFixedHeightSize() | I2CE_FontMetricMultiDirection->setFixedHeightSize()]]
| |
| | |
| ===setFixedWidth()===
| |
| This public method is inherited from [[Class: I2CE_FontMetricMultiDirection#setFixedWidth() | I2CE_FontMetricMultiDirection->setFixedWidth()]]
| |
| | |
| ===setFixedWidthSize()===
| |
| This public method is inherited from [[Class: I2CE_FontMetricMultiDirection#setFixedWidthSize() | I2CE_FontMetricMultiDirection->setFixedWidthSize()]]
| |
| | |
| ===setFontCharacteristic()===
| |
| This public method is inherited from [[Class: I2CE_FontMetricMultiDirection#setFontCharacteristic() | I2CE_FontMetricMultiDirection->setFontCharacteristic()]]
| |
| | |
| ===setFontSize()===
| |
| This public method is inherited from [[Class: I2CE_FontMetricMultiDirection#setFontSize() | I2CE_FontMetricMultiDirection->setFontSize()]]
| |
| | |
| ===setGlobal()===
| |
| This public method is inherited from [[Class: I2CE_FontMetricMultiDirection#setGlobal() | I2CE_FontMetricMultiDirection->setGlobal()]]
| |
| | |
| ===setKerningByGroup()===
| |
| This public method is inherited from [[Class: I2CE_FontMetricMultiDirection#setKerningByGroup() | I2CE_FontMetricMultiDirection->setKerningByGroup()]]
| |
| | |
| ===setKerningByPair()===
| |
| This public method is inherited from [[Class: I2CE_FontMetricMultiDirection#setKerningByPair() | I2CE_FontMetricMultiDirection->setKerningByPair()]]
| |
| | |
| ===setKerningGroup()===
| |
| This public method is inherited from [[Class: I2CE_FontMetricMultiDirection#setKerningGroup() | I2CE_FontMetricMultiDirection->setKerningGroup()]]
| |
| | |
| ===setLinegap()===
| |
| This public method is inherited from [[Class: I2CE_FontMetricMultiDirection#setLinegap() | I2CE_FontMetricMultiDirection->setLinegap()]]
| |
| | |
| ===getFixedStringWidth()===
| |
| This protected method is inherited from [[Class: I2CE_FontMetricMultiDirection#getFixedStringWidth() | I2CE_FontMetricMultiDirection->getFixedStringWidth()]]
| |
| | |
| ===getVariableStringWidth()===
| |
| This protected method is inherited from [[Class: I2CE_FontMetricMultiDirection#getVariableStringWidth() | I2CE_FontMetricMultiDirection->getVariableStringWidth()]]
| |
| ==Inherited Variables==
| |
| ===$font_metrics===
| |
| Theis protected variable is inherited from [[Class: I2CE_FontMetricMultiDirection#$font_metrics | I2CE_FontMetricMultiDirection->$font_metrics]]
| |
| | |
| ===$direction===
| |
| Theis protected variable is inherited from [[Class: I2CE_FontMetricMultiDirection#$direction | I2CE_FontMetricMultiDirection->$direction]]
| |
| | |
| ===$directions===
| |
| Theis protected variable is inherited from [[Class: I2CE_FontMetricMultiDirection#$directions | I2CE_FontMetricMultiDirection->$directions]]
| |
| | |
| ===$character_widths===
| |
| Theis public variable is inherited from [[Class: I2CE_FontMetric#$character_widths | I2CE_FontMetric->$character_widths]]
| |
| | |
| ===$character_heights===
| |
| Theis public variable is inherited from [[Class: I2CE_FontMetric#$character_heights | I2CE_FontMetric->$character_heights]]
| |
| | |
| ===$character_info===
| |
| Theis public variable is inherited from [[Class: I2CE_FontMetric#$character_info | I2CE_FontMetric->$character_info]]
| |
| | |
| ===$bbox===
| |
| Theis protected variable is inherited from [[Class: I2CE_FontMetric#$bbox | I2CE_FontMetric->$bbox]]
| |
| | |
| ===$ascender===
| |
| Theis protected variable is inherited from [[Class: I2CE_FontMetric#$ascender | I2CE_FontMetric->$ascender]]
| |
| | |
| ===$descender===
| |
| Theis protected variable is inherited from [[Class: I2CE_FontMetric#$descender | I2CE_FontMetric->$descender]]
| |
| | |
| ===$linegap===
| |
| Theis protected variable is inherited from [[Class: I2CE_FontMetric#$linegap | I2CE_FontMetric->$linegap]]
| |
| | |
| ===$is_fixed_width===
| |
| Theis protected variable is inherited from [[Class: I2CE_FontMetric#$is_fixed_width | I2CE_FontMetric->$is_fixed_width]]
| |
| | |
| ===$fixed_character_width===
| |
| Theis protected variable is inherited from [[Class: I2CE_FontMetric#$fixed_character_width | I2CE_FontMetric->$fixed_character_width]]
| |
| | |
| ===$fixed_character_height===
| |
| Theis protected variable is inherited from [[Class: I2CE_FontMetric#$fixed_character_height | I2CE_FontMetric->$fixed_character_height]]
| |
| | |
| ===$size===
| |
| Theis protected variable is inherited from [[Class: I2CE_FontMetric#$size | I2CE_FontMetric->$size]]
| |
| | |
| ===$encoding===
| |
| Theis protected variable is inherited from [[Class: I2CE_FontMetric#$encoding | I2CE_FontMetric->$encoding]]
| |
| | |
| ===$kerning_table_pairs===
| |
| Theis protected variable is inherited from [[Class: I2CE_FontMetric#$kerning_table_pairs | I2CE_FontMetric->$kerning_table_pairs]]
| |
| | |
| ===$kerning_table_groups===
| |
| Theis protected variable is inherited from [[Class: I2CE_FontMetric#$kerning_table_groups | I2CE_FontMetric->$kerning_table_groups]]
| |
| | |
| ===$kerning_groups===
| |
| Theis protected variable is inherited from [[Class: I2CE_FontMetric#$kerning_groups | I2CE_FontMetric->$kerning_groups]]
| |
| | |
| ===$font_info===
| |
| Theis protected variable is inherited from [[Class: I2CE_FontMetric#$font_info | I2CE_FontMetric->$font_info]]
| |
| | |
| | |
| [[Category:Class Documentation]]
| |
