Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32) Standard preamble: ========================================================================
NAMEFont::TTF::Table - Superclass for tables and used for tables we don't have a class for
DESCRIPTIONLooks after the purely table aspects of a
INSTANCE VARIABLESInstance variables start with a space
- Flag which indicates that the table has already been read from file.
- Allows the creation of unspecific tables. Data is simply output to any font file being created.
If set, overrides the font default for WOFFtable compression. Is a scalar integer specifying a table size threshold below which this table will not be compressed. Set to -1 to never compress; 0 to always compress.
- The read file handle
- Location of the file in the input file
- Length in the input directory
Compressed length of the table if a WOFFfont. 0 <ZLENGTH<LENGTHimplies table is compressed.
- Checksum read from the input file's directory
- The Font::TTF::Font that table is part of
Font::TTF::Table->new(%parms)Creates a new table or subclass. Table instance variables are passed in at this point as an associative array.
$t->readReads the table from the input file. Acts as a superclass to all true tables. This method marks the table as read and then just sets the input file pointer but does not read any data. If the table has already been read, then returns "undef" else returns $self
For WOFF-compressed tables, the table is first decompressed and a replacement file handle is created for reading the decompressed data. In this case
$t->read_datReads the table into the "dat" instance variable for those tables which don't know any better
$t->out($fh)Writes out the table to the font file. If there is anything in the "dat" instance variable then this is output, otherwise the data is copied from the input file to the output
$t->out_xml($context)Outputs this table in
$t->XML_elementOutput a particular element based on its contents.
$t->XML_end($context, $tag, %attrs)Handles the default type of <data> for those tables which aren't subclassed
$t->minsize()Returns the minimum size this table can be. If it is smaller than this, then the table must be bad and should be deleted or whatever.
$t->dirty($val)This sets the dirty flag to the given value or 1 if no given value. It returns the value of the flag
$t->updateEach table knows how to update itself. This consists of doing whatever work is required to ensure that the memory version of the table is consistent and that other parameters in other tables have been updated accordingly. I.e. by the end of sending "update" to all the tables, the memory version of the font should be entirely consistent.
Some tables which do no work indicate to themselves the need to update themselves by setting isDirty above 1. This method resets that accordingly.
$t->emptyClears a table of all data to the level of not having been read
Developer note: As part of the brute-force cleanup done here, this method will throw a warning message whenever unexpected key values are found within the "Font::TTF::Table" object. This is done to help ensure that any unexpected and unfreed values are brought to your attention so that you can bug us to keep the module updated properly; otherwise the potential for memory leaks due to dangling circular references will exist.
BUGSNo known bugs
AUTHORMartin Hosken <scripts.sil.org/FontUtils>.
LICENSINGCopyright (c) 1998-2014,
This module is released under the terms of the Artistic License 2.0. For details, see the full text of the license in the file