<HTML>
<HEAD>
<!-- Created with AOLpress/2.0 -->
<!-- AP: Created on: 6-Apr-2007 -->
<!-- AP: Last modified: 28-Apr-2010 -->
<TITLE>Writing python scripts to change fonts in FontForge</TITLE>
<LINK REL="icon" href="fftype16.png">
<LINK REL="stylesheet" TYPE="text/css" HREF="FontForge.css">
</HEAD>
<BODY>
<DIV id="in">
<H1 ALIGN=Center>
Writing python scripts to change fonts in FontForge
</H1>
<P>
I assume you have a working knowledge of python (because I do not).
<A href="http://www.python.org/doc/">Python documentation may be found on
the web.</A> FontForge implements two python modules -- one great huge one
called <CODE><A HREF="python.html#fontforge">fontforge</A></CODE> which provides
access to as much of FontForge's functionality as I've had time to write,
and one tiny one called
<CODE><A HREF="python.html#psMat">psMat</A></CODE> which provides quick access
to some useful transformations expressed as PostScript matrices.
<P>
In python terms fontforge <EM>embeds</EM> python. It is possible to build
fontforge so that it is also a <A HREF="#Extension">python <EM>extension</EM>
</A>(<CODE>configure --enable-pyextension</CODE>)
<P>
The fontforge module also defines several types
<UL>
<LI>
<A href="#Point">point</A>
<LI>
<A href="#Contour">contour</A>
<LI>
<A href="#Layer">layer</A>
<LI>
<A href="#GlyphPen">glyphPen</A>
<LI>
<A href="#Glyph">glyph</A>
<LI>
<A href="#selection">selection</A>
<LI>
<A HREF="#private">private</A>
<LI>
<A HREF="#math">math</A>
<LI>
<A href="#Font">font</A>
</UL>
<TABLE id="module" border=1>
<CAPTION>
<A NAME="psMat">psMat</A>
</CAPTION>
<TR>
<TH span=3>Methods</TH>
</TR>
<TR>
<TH>method</TH>
<TH>args</TH>
<TH>comments</TH>
</TR>
<TR>
<TD><CODE>identity</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>returns an identity matrix as a 6 element tuple</TD>
</TR>
<TR>
<TD><CODE>compose</CODE></TD>
<TD><CODE>(mat1,mat2)</CODE></TD>
<TD>returns a matrix which is the composition of the two input transformations</TD>
</TR>
<TR>
<TD><CODE>inverse</CODE></TD>
<TD><CODE>(mat)</CODE></TD>
<TD>returns a matrix which is the inverse of the input transformation. (Note:
There will not always be an inverse)</TD>
</TR>
<TR>
<TD><CODE>rotate</CODE></TD>
<TD><CODE>(theta)</CODE></TD>
<TD>returns a matrix which will rotate by <CODE>theta</CODE>.
<CODE>Theta</CODE> is expressed in radians</TD>
</TR>
<TR>
<TD><CODE>scale</CODE></TD>
<TD><CODE>(x[,y])</CODE></TD>
<TD>returns a matrix which will scale by <CODE>x</CODE> in the horizontal
direction and <CODE>y</CODE> in the vertical. If <CODE>y</CODE> is omitted,
it will scale by the same amount (<CODE>x</CODE>) in both directions</TD>
</TR>
<TR>
<TD><CODE>skew</CODE></TD>
<TD><CODE>(theta)</CODE></TD>
<TD>returns a matrix which will skew by <CODE>theta</CODE> (to produce a
oblique font). <CODE>Theta</CODE> is expressed in radians</TD>
</TR>
<TR>
<TD><CODE>translate</CODE></TD>
<TD><CODE>(x,y)</CODE></TD>
<TD>returns a matrix which will translate by <CODE>x</CODE> in the horizontal
direction and <CODE>y</CODE> in the vertical</TD>
</TR>
<TR>
<TH colspan=3>Types</TH>
</TR>
<TR>
<TD colspan=3>None</TD>
</TR>
</TABLE>
<P>
<TABLE id="module" border=1>
<CAPTION>
<A NAME="fontforge">fontforge</A>
</CAPTION>
<TR>
<TH colspan=3>Global Variables</TH>
</TR>
<TR>
<TH>variable</TH>
<TH colspan=2>comments</TH>
</TR>
<TR>
<TD><CODE><A NAME="module-hooks">hooks</A></CODE></TD>
<TD colspan=2>A dictionary which the user may fill to associate certain fontforge
events with a python function to be run when those events happen. The function
will be passed the font (or possibly glyph) for which the relevant event
occurred.
<TABLE BORDER CELLPADDING="2">
<CAPTION>
Hook names
</CAPTION>
<TR>
<TD>newFontHook</TD>
<TD>This function will be called when a new font has been created.</TD>
</TR>
<TR>
<TD>loadFontHook</TD>
<TD>This function will be called when a font is loaded from disk.<BR>
(if a font has an "initScriptString" entry in its persistent dictionary,
that script will be invoked before this function).</TD>
</TR>
</TABLE>
<P>
Other hooks are defined in a font's own
<A HREF="#font-temporary">temporary</A> and
<A HREF="#font-persistent">persistent</A> dictionaries.</TD>
</TR>
<TR>
<TH colspan=3>Methods</TH>
</TR>
<TR>
<TH>method</TH>
<TH>args</TH>
<TH>comments</TH>
</TR>
<TR>
<TD><CODE>getPrefs</CODE></TD>
<TD><CODE>(pref-name)</CODE></TD>
<TD>returns the value of the named preference item</TD>
</TR>
<TR>
<TD><CODE>setPrefs</CODE></TD>
<TD><CODE>(pref-name,value)</CODE></TD>
<TD>sets the value of the named preference item</TD>
</TR>
<TR>
<TD><CODE><A NAME="ff-hasSpiro">hasSpiro</A></CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Returns a boolean, <CODE>True</CODE> if Raph Levien's spiro package is
available for use in FontForge.</TD>
</TR>
<TR>
<TD><CODE>savePrefs</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Saves the current preference settings</TD>
</TR>
<TR>
<TD><CODE>loadPrefs</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Loads the user's default preference settings. Not done automatically
in a script.</TD>
</TR>
<TR>
<TD><CODE>defaultOtherSubrs</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Sets the type1 PostScript OtherSubrs to the default value</TD>
</TR>
<TR>
<TD><CODE>readOtherSubrsFile</CODE></TD>
<TD><CODE>(filename)</CODE></TD>
<TD>Sets the type1 PostScript OtherSubrs to the stuff found in the file.</TD>
</TR>
<TR>
<TD><CODE>loadEncodingFile</CODE></TD>
<TD><CODE>(filename)</CODE></TD>
<TD>Loads an encoding file, returns the name of the encoding or None.</TD>
</TR>
<TR>
<TD><CODE>loadNamelist</CODE></TD>
<TD><CODE>(filename)</CODE></TD>
<TD>Loads a namelist</TD>
</TR>
<TR>
<TD><CODE>loadNamelistDir</CODE></TD>
<TD><CODE>(dirname)</CODE></TD>
<TD>Loads all namelist files in the directory</TD>
</TR>
<TR>
<TD><CODE>loadPlugin</CODE></TD>
<TD><CODE>(filename)</CODE></TD>
<TD>Loads a fontforge plugin</TD>
</TR>
<TR>
<TD><CODE>loadPluginDir</CODE></TD>
<TD><CODE>(dirname)</CODE></TD>
<TD>Loads all fontforge plugins in the directory</TD>
</TR>
<TR>
<TD><CODE>preloadCidmap</CODE></TD>
<TD><CODE>(filename,registry,order,supplement)</CODE></TD>
<TD>Loads a fontforge cidmap file (first three args are strings, last is
an integer)</TD>
</TR>
<TR>
<TD><CODE><A name="printSetup">printSetup</A></CODE></TD>
<TD><CODE>(type[,printer|cmd|file,<BR>
width,height])</CODE></TD>
<TD>Prepare to <A href="#f-print">print a font sample</A>. The first argument
may be one of:
<DL>
<DT>
lp
<DD>
Queues postscript output to the printer using <CODE>lp</CODE>. You may use
the optional second argument to specify the printer name.
<DT>
lpr
<DD>
Queues postscript output to the printer using <CODE>lpr</CODE>. You may use
the optional second argument to specify the printer name.
<DT>
ghostview
<DD>
Displays the output using ghostview (or gv). The second argument is ignored.
<DT>
command
<DD>
Use a custom shell command to print the output. The second argument should
contain the command and its arguments.
<DT>
ps-file
<DD>
Dump the postscript output to a file. The second argument specifies the filename.
<DT>
pdf-file
<DD>
Dump the output as pdf to a file. The second argument specifies the filename.
</DL>
<P>
The third and fourth arguments are optional and specify the page size (in
points) for the output. The third argument is the page width and the fourth
is the height.
<P>
These setting remain until changed</TD>
</TR>
<TR>
<TD><CODE>nameFromUnicode</CODE></TD>
<TD><CODE>(uni[,namelist])</CODE></TD>
<TD>Finds the glyph name associated with a given unicode codepoint. If a
namelist is specified the name will be taken from that.</TD>
</TR>
<TR>
<TD><CODE>unicodeFromName</CODE></TD>
<TD><CODE>(glyphname)</CODE></TD>
<TD>Looks up glyph name in its dictionary and if it is associated with a
unicode code point returns that number. Otherwise it returns -1</TD>
</TR>
<TR>
<TD><CODE>version</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Returns fontforge's version number. This will be a large number like
20070406.</TD>
</TR>
<TR>
<TD><CODE>fonts</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Returns a tuple of all fonts currently loaded into fontforge for editing</TD>
</TR>
<TR>
<TD><CODE>activeFont</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>If the script were invoked from the File->Execute Script... dialog,
or invoked by a menu item in the font view, this returns the font that was
active at the time. Otherwise it returns None.</TD>
</TR>
<TR>
<TD><CODE>activeGlyph</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>If the script were invoked from the File->Execute Script... dialog
or a menu item from an outline glyph window or a glyph import/export command
this returns the glyph that was active at the time. Otherwise it returns
None.</TD>
</TR>
<TR>
<TD><CODE>activeLayer</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>This returns the currently active layer as an integer between 0 (inclusive)
and the font/glyph's layer count (exclusive). It may also be set to -1 if
the current glyph window is displaying the font's guidline layer.</TD>
</TR>
<TR>
<TD><CODE>fontsInFile</CODE></TD>
<TD><CODE>(filename)</CODE></TD>
<TD>Returns a tuple of all fontnames found in the specified file. The tuple
may be empty if fontforge couldn't find any.</TD>
</TR>
<TR>
<TD><CODE>open</CODE></TD>
<TD><CODE>(filename[,flags])</CODE></TD>
<TD>Opens a filename and returns the font it contains. If it does.
<P>
If the flags argument is 4, then ff will load all glyphs in the 'glyf' table
of a ttc file (rather than just the glyphs used in the font picked). This
will not load all 'glyf' tables though.</TD>
</TR>
<TR>
<TD><CODE>parseTTInstrs</CODE></TD>
<TD><CODE>(string)</CODE></TD>
<TD>Returns a binary string each byte of which corresponds to a truetype
instruction. The input string should contain a set of instruction names as
"SRP0\nMIRP[min,rnd,black]"</TD>
</TR>
<TR>
<TD><CODE>unParseTTInstrs</CODE></TD>
<TD><CODE>(sequence)</CODE></TD>
<TD>Reverse of the above. Converts a binary string into a human (sort of)
readable string</TD>
</TR>
<TR>
<TD><CODE>unitShape</CODE></TD>
<TD><CODE>(n)</CODE></TD>
<TD>Returns a closed contour which is a regular n-gon. The contour will be
inscribed in the unit circle. If n is negative, then the contour will be
circumscribed around the unit circle. A value of 0 will produce a unit circle.
If n==1 it is treated as if n were -4 -- a circumscribed square where each
side is 2 units long (this is for historical reasons). Behavior is undefined
for n=2,-1,-2.</TD>
</TR>
<TR>
<TD><CODE>registerGlyphSeparationHook</CODE></TD>
<TD><CODE>(hook)</CODE></TD>
<TD>The GlpyphSeparationHook is a python routine which FontForge will call
when it wants to figure out the optical separation between two glyphs. If
you neve call this, or if you call it with a value of <CODE>None</CODE> FontForge
will use a built-in default. This routine gets called during AutoWidth, AutoKern,
and computing the optical left and right side bearings (for 'lfbd' and 'rtbd'
features). For more infomation see
<A HREF="autowidth.html#GlyphSeparationHook">its own section</A>.</TD>
</TR>
<TR>
<TH colspan=3>User Interface Methods</TH>
</TR>
<TR>
<TD colspan=3><A NAME="python-init-scripts">Users</A> may define scripts
to be run when menu items are invoked. Some of these scripts will want to
ask users questions, so this section provides routines to determine if fontforge
has a user interface, a command to add menu items, and various small standard
dialogs to interact with the user. I do not currently provide a mechanism
for allowing people to define special purpose dialogs (for example they might
want to ask more than one question in a dialog, and I don't support that).
<P>
When FontForge <A NAME="starts">starts</A> (if it's a fontforge with python)
it will look at the directories <CODE>$(PREFIX)/share/fontforge/python</CODE>
and <CODE>~/.FontForge/python</CODE> and attempt to run all files in those
directories which end in ".py". Presumably these files will allow people
to customize the user interface to suit their needs.
<P>
Currently it reads the files in directory order (which is generally somewhere
between creation order and totally random). It will read the system directory
before the user directory.
<H3>
Example
</H3>
<BLOCKQUOTE>
<PRE>import fontforge;
def nameGlyph(junk,glyph):
print glyph.glyphname;
fontforge.registerMenuItem(nameGlyph,None,None,"Glyph",None,"Print Glyph Name");
def neverEnableMe(junk,glyph):
return False;
fontforge.registerMenuItem(nameGlyph,neverEnableMe,None,"Glyph",None,"SubMenu","Print Glyph Name");
def importGlyph(junk,glyph,filename,toback):
print "Import";
print glyph.glyphname;
print filename;
def exportGlyph(junk,glyph,filename):
print "Import";
print glyph.glyphname;
print filename;
fontforge.registerImportExport(importGlyph,exportGlyph,None,"foosball","foo","foo,foobar")
</PRE>
</BLOCKQUOTE>
<P>
The first call will define a menu item in the Tools menu of the Glyph window.
The menu will be called "Print Glyph Name". It has no shortcut to invoke
it. It needs no external data. It is always enabled. And when activated it
will invoke the function "nameGlyph" whch prints the name of the glyph in
the window from which the command is invoked.
<P>
The second call defines a menu item in a submenu of the Tools menu. This
submenu is called "SubMenu". This item will never be enabled -- but if it
were enabled it would again call "nameGlyph" to print the name of the current
glyph.
<P>
The last provides a way to import and export files of type "foosball" (or
it would if the routines did anything).
<P>
Not a very useful example</TD>
</TR>
<TR>
<TD><CODE>hasUserInterface</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Returns True if this session of FontForge has a user interface</TD>
</TR>
<TR>
<TD><CODE>registerMenuItem</CODE></TD>
<TD><CODE>(menu-function,<BR>
enable_function,<BR>
data,<BR>
which_window,<BR>
shortcut_string,<BR>
{submenu-names,}<BR>
menu-name-string)</CODE></TD>
<TD>If fontforge has a user interface this will add this menu item to FontForge's
<A HREF="toolsmenu.html#Tools">Tool</A> menu, either in the font or the outline
glyph view (or both).
<DL>
<DT>
menu-function
<DD>
This is the function that will be called when the menu item is activated.
It will be passed two arguments, the first is the data value specified here
(which may be None, indeed will probably usually be None), and the second
is the glyph or font (depending on the window type) from which the menu item
was activated. Its return value is ignored.
<DT>
enable_function
<DD>
This may be None -- in which case the menu item will always be enabled. Otherwise
it will be called before the menu pops up on the screen to determine whether
this item should be enabled. It will be passed the same arguments as above.
It should return True if the item should be enabled and False otherwise.
<DT>
data
<DD>
This can be whatever you want (including None). FontForge keeps track of
it and passes it to both of the above functions. Use it if you need to provide
some context for the menu item.
<DT>
which_window
<DD>
May be either of the strings "Font" or "Glyph (or the tuple
<CODE>("Font","Glyph")</CODE>) and it determines which type of window will
have this menu item in its "Tools" menu.
<DT>
shortcut-string
<DD>
May be None if you do not wish to supply a shortcut. Otherwise should be
a string like "Menu Name|Cntl-H" (the syntax is defined in the
<A HREF="uitranslationnotes.html#HotKeys">translation section</A>).
<DT>
submenu-names
<DD>
You may specify as many of these as you wish (including leaving them out
altogether), this allows you to organize the Tools menu into submenus. (If
a submenu of this name does not currently exist, fontforge will create it).
<DT>
menu-name
<DD>
The name that will appear in the menu for this item.
</DL>
<P>
This will only affect windows created after this command is executed. Normally
the command will be executed at startup and so it will affect all windows.</TD>
</TR>
<TR>
<TD><CODE>registerImportExport</CODE></TD>
<TD><CODE>(import-function,<BR>
export_function,<BR>
data,<BR>
name,<BR>
extension,<BR>
[extension-list])</CODE></TD>
<TD>This will add the capability to import or export files of a given type,
presumably a way of specifying the splines in a given glyph.
<DL>
<DT>
import-function
<DD>
The function to call to import a file into a glyph. It will be called with:
The data argument (specified below), A pointer to the glyph into which the
import is to happen, A filename, A flag indicating whether the import should
go to the background layer or foreground.
<P>
This function may be None. In which case there is no import method for this
file type.
<DT>
export-function
<DD>
The function to call to export a glyph into a file. It will be called with:
The data argument (see below), a pointer to the glyph, and a filename.
<P>
This function may be None, in which case there is no export method for this
file type.
<DT>
data
<DD>
Anything you like (including None). It will be passed to the import/export
routines and can provide them with context if they need that.
<DT>
name
<DD>
The name to be displayed in the user interface for this file type. This may
just be the extension, or it might be something more informative.
<DT>
extension
<DD>
This is the default extension for this file type. It is used by the export
dialog to pick an extension for the generated filename.
<DT>
extension-list
<DD>
Some file types have more than one common extension (eps files are usually
named "eps", but I have also seen "ps" and "art" used). The import dialog
needs to filter all possible filenames of this file type. This argument should
be a comma separated list of extensions. It may be omitted, in which case
it defaults to being the same as the "extension" argument above.
</DL>
</TD>
</TR>
<TR>
<TD><CODE>logWarning</CODE></TD>
<TD><CODE>(msg)</CODE></TD>
<TD>Adds the message (a string) to FontForge's Warnings window. (if you wish
to display a % character you must represent it as two percents). If there
is no user interface the output will go to stderr.</TD>
</TR>
<TR>
<TD><CODE>postError</CODE></TD>
<TD><CODE>(win-title,msg)</CODE></TD>
<TD>Creates a popup dialog to display the message (a string) in that dlg.
(if you wish to display a % character you must represent it as two percents).
If there is no user interface the output will go to stderr.</TD>
</TR>
<TR>
<TD><CODE>postNotice</CODE></TD>
<TD><CODE>(win-title,msg)</CODE></TD>
<TD>Creates a little window which will silently vanish after a minute or
two and displays the message (a string) in that window. (if you wish to display
a % character you must represent it as two percents). If there is no user
interface the output will go to stderr.</TD>
</TR>
<TR>
<TD><CODE>openFilename</CODE></TD>
<TD><CODE>(question,[def-name,[filter]])</CODE></TD>
<TD>All arguments are strings. The first is a question asked to the user
(for which a filename to open is presumed to be the answer). The second is
optional and provides a default filename. The third is optional and provides
a filter (like "*.sfd")
<P>
The result is either a filename or None if the user canceled the dialog.
<P>
Throws an exception if there is no user interface.</TD>
</TR>
<TR>
<TD><CODE>saveFilename</CODE></TD>
<TD><CODE>(question,[def-name,[filter]])</CODE></TD>
<TD>All arguments are strings. The first is a question asked to the user
(for which a filename to save something to is presumed to be the answer).
The second is optional and provides a default filename. The third is optional
and provides a filter (like "*.sfd")
<P>
The result is either a filename or None if the user canceled the dialog.
<P>
Throws an exception if there is no user interface.</TD>
</TR>
<TR>
<TD><CODE>ask</CODE></TD>
<TD><CODE>(title,question,answers,<BR>
[def,cancel])</CODE></TD>
<TD>Allows you to ask the user a multiple choice question. It popups up a
dialog posing the question with a list of buttons ranged underneath it --
one for each answer.
<P>
The first argument is the dialog's title, the second is the question to be
asked, the third is a tuple of strings -- each string will become a button,
the fourth and fifth arguments are option, the fourth is the index in the
answer array that will be the default answer (the one invoked if the user
presses the [Return] key), and the fifth is the answer invoked if the user
presses the [Escape] key. If omitted the default answer will be the first,
and the cancel answer will be the last.
<P>
The function returns the index in the answer array of the answer choosen
by the user.
<P>
Throws an exception if there is no user interface.</TD>
</TR>
<TR>
<TD><CODE>askChoice</CODE>s</TD>
<TD><CODE>(title,question,answers,<BR>
[def])</CODE></TD>
<TD>Similar to the above allows you to ask the user a multiple choice question.
It popups up a dialog posing the question with a scrollable list of choices
-- one for each answer.
<P>
The first argument is the dialog's title, the second is the question to be
asked, the third is a tuple of strings -- each string will become a button,
the fourth and fifth arguments are option, the fourth is the index in the
answer array that will be the default answer (the one invoked if the user
presses the [Return] key). If omitted the default answer will be the first.
<P>
The function returns the index in the answer array of the answer choosen
by the user. If the user cancels the dialog, a -1 is returned.
<P>
Throws an exception if there is no user interface.</TD>
</TR>
<TR>
<TD><CODE>askString</CODE></TD>
<TD><CODE>(title,question,[def-string])</CODE></TD>
<TD>Allows you to as the user a question for which a string is the answer.
<P>
The first argument is the dialog's title, the second is the question to be
asked, the third is optional and specified a default answer.
<P>
The function returns the string the user typed or None if they cancelled
the dialog.
<P>
Throws an exception if there is no user interface.</TD>
</TR>
<TR>
<TH colspan=3>Types</TH>
</TR>
<TR>
<TD colspan=3><A href="#Point">point</A></TD>
</TR>
<TR>
<TD colspan=3><A href="#Contour">contour</A></TD>
</TR>
<TR>
<TD colspan=3><A href="#Layer">layer</A></TD>
</TR>
<TR>
<TD colspan=3><A href="#GlyphPen">glyphPen</A></TD>
</TR>
<TR>
<TD colspan=3><A href="#Glyph">glyph</A></TD>
</TR>
<TR>
<TD colspan=3><A href="#selection">selection</A></TD>
</TR>
<TR>
<TD colspan=3><A href="#Font">font</A></TD>
</TR>
</TABLE>
<P>
<TABLE id="type" border=1>
<CAPTION>
<A name="Point">point</A>
</CAPTION>
<TR>
<TH colspan=3>Creation</TH>
</TR>
<TR>
<TD><CODE>fontforge.point</CODE></TD>
<TD><CODE>([x,y,on-curve])</CODE></TD>
<TD>Creates a new point. Optionally specifying its location</TD>
</TR>
<TR>
<TH colspan=3>Members</TH>
</TR>
<TR>
<TH>member</TH>
<TH colspan=2>comments</TH>
</TR>
<TR>
<TD><CODE>x</CODE></TD>
<TD colspan=2>The x location of the point</TD>
</TR>
<TR>
<TD><CODE>y</CODE></TD>
<TD colspan=2>The y location of the point</TD>
</TR>
<TR>
<TD><CODE>on_curve</CODE></TD>
<TD colspan=2>Whether this is an on curve point or an off curve point (a
control point)</TD>
</TR>
<TR>
<TD><CODE>selected</CODE></TD>
<TD colspan=2>Whether this point is selected in the UI. If an off-curve point
is selected in means the preceding (interpolated) on-curve point is selected.</TD>
</TR>
<TR>
</TR>
<TR>
<TH colspan=3>Methods</TH>
</TR>
<TR>
<TH>method</TH>
<TH>args</TH>
<TH>comments</TH>
</TR>
<TR>
<TD><CODE>dup</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Returns a copy of the current point.</TD>
</TR>
<TR>
<TD><CODE>transform</CODE></TD>
<TD><CODE>(tuple)</CODE></TD>
<TD>Transforms the point by the transformation matrix</TD>
</TR>
<TR>
<TH colspan=3>Pickling Methods</TH>
</TR>
<TR>
<TD><CODE>__reduce__</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>This function allows the pickler to work on this type. I don't think
it is useful for anything else.</TD>
</TR>
</TABLE>
<P>
<TABLE id="type" border=1>
<CAPTION>
<A name="Contour">contour</A>
</CAPTION>
<TR>
<TH colspan=3>Description</TH>
</TR>
<TR>
<TD colspan=3>A contour is a collection of points. A contour may be either
based on cubic or quadratic splines.
<P>
If based on cubic splines there should be either 0 or 2 off-curve points
between every two on-curve points. If there are no off-curve points then
we have a line between those two points. If there are 2 off-curve points
we have a cubic bezier curve between the two end points.
<P>
If based on quadratic splines things are more complex. Again, two adjacent
on-curve points yield a line between those points. Two on-curve points with
an off-curve point between them yields a quadratic bezier curve. However
if there are two adjacent off-curve points then an on-curve point will be
interpolated between them. (This should be familiar to anyone who has read
the truetype 'glyf' table docs).
<P>
For examples of what these splines can look like see the
<A HREF="bezier.html">section on bezier curves</A>.
<P>
A contour may be open in which case it is just a long wiggly line, or closed
when it is more like a circle with an inside and an outside. Unless you are
making stroked fonts all your contours should eventually be closed.
<P>
Contours may also be expressed in terms of Raph Levien's spiro points. This
is an alternate representation for the contour, and is not always available
(Only if <CODE><A HREF="python.html#ff-hasSpiro">fontforge.hasSpiro</A>()
</CODE>is<CODE> True</CODE>. If available the spiro member will return a
tuple of spiro control points, while assigning to this member will change
the shape of the contour to match the new spiros.
<P>
Two contours may be compared to see if they describe similar paths.</TD>
</TR>
<TR>
<TH colspan=3>Creation</TH>
</TR>
<TR>
<TD><CODE>fontforge.contour</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Creates a new contour</TD>
</TR>
<TR>
<TH colspan=3>Members</TH>
</TR>
<TR>
<TH>member</TH>
<TH colspan=2>comments</TH>
</TR>
<TR>
<TD><CODE>is_quadratic</CODE></TD>
<TD colspan=2>Whether the contour should be interpretted as a set of quadratic
or cubic splines. Setting this value has the side effect of converting the
point list to the appropriate format</TD>
</TR>
<TR>
<TD><CODE>closed</CODE></TD>
<TD colspan=2>Whether the contour is open or closed</TD>
</TR>
<TR>
<TD><CODE>name</CODE></TD>
<TD colspan=2>The contour name (generally there is no name)</TD>
</TR>
<TR>
<TD><CODE>spiros</CODE></TD>
<TD colspan=2>This is an alternate representation of a curve. This member
is only available if <A HREF="#ff-hasSpiro">fontforge.hasSpiro()</A> is True.
Returns a tuple of spiro control points. Each of these is itself a tuple
of four elements, an x,y location, a type field, and a set of flags. The
type field takes on values (which are predefined constants in the fontforge
module):
<TABLE>
<TR>
<TD>fontforge.spiroG4</TD>
<TD>1</TD>
<TD>A Spiro G4 curve point</TD>
</TR>
<TR>
<TD>fontforge.spiroG2</TD>
<TD>2</TD>
<TD>A Spiro G2 curve point</TD>
</TR>
<TR>
<TD>fontforge.spiroCorner</TD>
<TD>3</TD>
<TD>A Spiro corner point</TD>
</TR>
<TR>
<TD>fontforge.spiroLeft</TD>
<TD>4</TD>
<TD>A Spiro left "tangent" point</TD>
</TR>
<TR>
<TD>fontforge.spiroRight</TD>
<TD>5</TD>
<TD>A Spiro right "tangent" point</TD>
</TR>
<TR>
<TD>fontforge.spiroOpen</TD>
<TD>6</TD>
<TD>This may only be used on the first point in a spiro tuple. It indicates
that the tuple describes an open contour.</TD>
</TR>
</TABLE>
<P>
For more information on what these point types mean see
<A HREF="http://www.levien.com/spiro/">Raph Levien's work</A>.
<P>
The flags argument is treated as a bitmap of which currently on one bit (0x1)
is defined. This indicates that this point is selected in the UI.
<P>
When you assign a tuple of spiro control points to this member, the point
list for the Bezier interpretation of the contour will change. And when you
change the Bezier interpretation the set of spiro points will change.</TD>
</TR>
<TR>
<TH colspan=3>Sequence Protocol</TH>
</TR>
<TR>
<TD colspan=2><CODE>len(c)</CODE></TD>
<TD>The number of points in the contour</TD>
</TR>
<TR>
<TD colspan=2><CODE>c[i]</CODE></TD>
<TD>The <EM>i</EM>th point on the contour. You may assign to this</TD>
</TR>
<TR>
<TD colspan=2><CODE>c[i:j]</CODE></TD>
<TD>The contour containing points between i and j. You may assign to this</TD>
</TR>
<TR>
<TD colspan=2><CODE>c + d</CODE></TD>
<TD>A contour concatenating c and d. D may be either another contour or a
point.</TD>
</TR>
<TR>
<TD colspan=2><CODE>c += d</CODE></TD>
<TD>Appends d to c. D may be either another contour or a point.</TD>
</TR>
<TR>
<TD colspan=2><CODE>p in c</CODE></TD>
<TD>Returns whether the point p is in the contour c. p may be either a point
or a tuple of two numbers</TD>
</TR>
<TR>
<TD colspan=3>Does not support the repeat concept</TD>
</TR>
<TR>
<TH colspan=3>Iterator Protocol</TH>
</TR>
<TR>
<TD><CODE>__iter__</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Returns an iterator for the contour which will return the points in order.</TD>
</TR>
<TR>
<TH colspan=3>Methods</TH>
</TR>
<TR>
<TH>method</TH>
<TH>args</TH>
<TH>comments</TH>
</TR>
<TR>
<TD><CODE>dup</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Returns a deep copy of the contour. That is, it copies the points that
make up the contour.</TD>
</TR>
<TR>
<TD><CODE>isEmpty</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Returns whether the contour is empty (contains no points)</TD>
</TR>
<TR>
<TD> </TD>
<TH colspan=2>Contour construction</TH>
</TR>
<TR>
<TD><CODE>moveTo</CODE></TD>
<TD><CODE>(x,y)</CODE></TD>
<TD>Adds an initial, on-curve point at (x,y) to the contour</TD>
</TR>
<TR>
<TD><CODE>lineTo</CODE></TD>
<TD><CODE>(x,y[,pos])</CODE></TD>
<TD>Adds an line to the contour. If the optional third argument is give,
the line will be added after the pos'th point, otherwise it will be at the
end of the contour.</TD>
</TR>
<TR>
<TD><CODE>cubicTo</CODE></TD>
<TD><CODE>((cp1x,cp1y)(cp2x,cp2y)(x,y)[,pos])</CODE></TD>
<TD>Adds a cubic curve to the contour. If the optional third argument is
give, the line will be added after the pos'th point, otherwise it will be
at the end of the contour.</TD>
</TR>
<TR>
<TD><CODE>quadraticTo</CODE></TD>
<TD><CODE>((cpx,cpy)(x,y)[,pos])</CODE></TD>
<TD>Adds a quadratic curve to the contour. If the optional third argument
is give, the line will be added after the pos'th point, otherwise it will
be at the end of the contour.</TD>
</TR>
<TR>
<TD><CODE>insertPoint</CODE></TD>
<TD><CODE>(point[,pos])</CODE></TD>
<TD>Adds point to the contour. If the optional third argument is give, the
line will be added after the pos'th point, otherwise it will be at the end
of the contour. The point may be either a point or a tuple with three members
(x,y,on_curve)</TD>
</TR>
<TR>
<TD><CODE>makeFirst</CODE></TD>
<TD><CODE>(pos)</CODE></TD>
<TD>Rotate the point list so that the pos'th point becomes the first point</TD>
</TR>
<TR>
<TD><CODE><A name="#cnt-isClockwise">isClockwise</A></CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Returns whether the contour is drawn in a clockwise direction. A return
value of -1 indicates that no consistant direction could be found (the contour
self-intersects).</TD>
</TR>
<TR>
<TD><CODE>reverseDirection</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Reverse the order in which the contour is drawn (turns a clockwise contour
into a counter-clockwise one). See also
<A href="#l-correctDirection">layer.correctDirection</A>.</TD>
</TR>
<TR>
<TD><CODE>similar</CODE></TD>
<TD><CODE>(other-contour[,error])</CODE></TD>
<TD>Checks whether this contour is similar to the other one where error is
the maximum distance (in em-units) allowed for the two contours to diverge.
<P>
This is like the comparison operator, but that doesn't allow you to specify
an error bound.</TD>
</TR>
<TR>
<TD><CODE>xBoundsAtY</CODE></TD>
<TD><CODE>(ybottom[,ytop])</CODE></TD>
<TD>Finds the minimum and maximum x positions attained by the contour when
y is between ybottom and ytop (if ytop is not specified it is assumed the
same as ybottom). If the contour does not have any y values in the specified
range then ff will return None.</TD>
</TR>
<TR>
<TD><CODE>yBoundsAtX</CODE></TD>
<TD><CODE>(xleft[,xright])</CODE></TD>
<TD>Finds the minimum and maximum y positions attained by the contour when
x is between xleft and xright (if xright is not specified it is assumed the
same as xleft). If the contour does not have any x values in the specified
range then ff will return None.</TD>
</TR>
<TR>
<TD> </TD>
<TH colspan=2>Contour manipulation</TH>
</TR>
<TR>
<TD><CODE>addExtrema</CODE></TD>
<TD><CODE>([flags,emsize])</CODE></TD>
<TD>Extrema should be marked by on-curve points. If a curve lacks a point
at an extrema this command will add one. Flags may be one of the following
strings
<DL>
<DT>
all
<DD>
Add all missing extrema
<DT>
only_good
<DD>
Only add extrema on longer splines (with respect to the em-size)
<DT>
only_good_rm
<DD>
As above but also merge away on-curve points which are very close to, but
not on, an added extremum
</DL>
</TD>
</TR>
<TR>
<TD><CODE><A name="cnt-cluster">cluster</A></CODE></TD>
<TD><CODE>([within,max])</CODE></TD>
<TD>Moves clustered coordinates to a standard central value. See Also
<A href="#cnt-round">round</A></TD>
</TR>
<TR>
<TD><CODE><A name="cnt-merge">merge</A></CODE></TD>
<TD><CODE>(pos)</CODE></TD>
<TD>Removes the on-curve point a the given position and rearranges the other
points to make the curve as similar to the original as possible. (pos may
also be a tuple of positions, all of which will be removed) See Also
<A href="#cnt-simplify">simplify</A></TD>
</TR>
<TR>
<TD><CODE><A name="cnt-round">round</A></CODE></TD>
<TD><CODE>([factor])</CODE></TD>
<TD>Rounds the x and y coordinates. If factor is specified then new-coord
= round(factor*old-coord)/factor. See Also <A href="#cnt-cluster">cluster</A></TD>
</TR>
<TR>
<TD><CODE>selfIntersects</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Returns whether this contour intersects itself.</TD>
</TR>
<TR>
<TD><CODE><A name="cnt-simplify">simplify</A></CODE></TD>
<TD><CODE>([error-bound,flags,tan_bounds,<BR>
linefixup,linelenmax])</CODE></TD>
<TD>Tries to remove excess points on the contour if doing so will not perturb
the curve by more than <CODE>error-bound</CODE>. Flags is a tuple of the
following strings
<DL>
<DT>
ignoreslopes
<DD>
Allow slopes to change
<DT>
ignoreextrema
<DD>
Allow removal of extrema
<DT>
smoothcurves
<DD>
Allow curve smoothing
<DT>
choosehv
<DD>
Snap to horizontal or vertical
<DT>
forcelines
<DD>
flatten bumps on lines
<DT>
nearlyhvlines
<DD>
Make nearly horizontal/vertical lines be so
<DT>
mergelines
<DD>
Merge adjacent lines into one
<DT>
setstarttoextremum
<DD>
Rotate the point list so that the start point is on an extremum
<DT>
removesingletonpoints
<DD>
If the contour contains just one point then remove it
</DL>
<P>
See Also <A href="#cnt-merge">merge</A></TD>
</TR>
<TR>
<TD><CODE>transform</CODE></TD>
<TD><CODE>(matrix)</CODE></TD>
<TD>Transforms the contour by the matrix</TD>
</TR>
<TR>
<TD></TD>
<TH colspan=2>random stuff about contours</TH>
</TR>
<TR>
<TD><CODE>boundingBox</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Returns a tuple representing a rectangle (xmin,ymin, xmax,ymax) into
which the contour fits. It is not guaranteed to be the smallest such rectangle,
but it will often be.</TD>
</TR>
<TR>
<TD><CODE>getSplineAfterPoint</CODE></TD>
<TD><CODE>(pos)</CODE></TD>
<TD>Returns a tuple of two four-element tuples. These tuples are x and y
splines for the curve after the specified point.</TD>
</TR>
<TR>
<TD><CODE>draw</CODE></TD>
<TD><CODE>(pen)</CODE></TD>
<TD>Draw the contour to the
<A href="http://www.robofab.org/objects/pen.html">pen argument.</A></TD>
</TR>
<TR>
<TH colspan=3>Pickling Methods</TH>
</TR>
<TR>
<TD><CODE>__reduce__</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>This function allows the pickler to work on this type. I don't think
it is useful for anything else.</TD>
</TR>
</TABLE>
<P>
<TABLE id="type" border=1>
<CAPTION>
<A name="Layer">layer</A>
</CAPTION>
<TR>
<TH colspan=3>Description</TH>
</TR>
<TR>
<TD colspan=3>A layer is a collection of contours. All the contours must
be the same order (all quadratic or all cubic). Currently layers do not contain
references.
<P>
Layers may be compared to see if their contours are similar.</TD>
</TR>
<TR>
<TH colspan=3>Creation</TH>
</TR>
<TR>
<TD><CODE>fontforge.layer</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Creates a new layer</TD>
</TR>
<TR>
<TH colspan=3>Members</TH>
</TR>
<TR>
<TH>member</TH>
<TH colspan=2>comments</TH>
</TR>
<TR>
<TD><CODE>is_quadratic</CODE></TD>
<TD colspan=2>Whether the contours should be interpretted as a set of quadratic
or cubic splines. Setting this value has the side effect of converting the
contour list to the appropriate format</TD>
</TR>
<TR>
<TH colspan=3>Sequence Protocol</TH>
</TR>
<TR>
<TD colspan=2><CODE>len(c)</CODE></TD>
<TD>The number of contours in the layer</TD>
</TR>
<TR>
<TD colspan=2><CODE>c[i]</CODE></TD>
<TD>The <EM>i</EM>th contour on the layer. You may assign to this</TD>
</TR>
<TR>
<TD colspan=2><CODE>c + d</CODE></TD>
<TD>A layer concatenating c and d. D may be either another layer or a contour.</TD>
</TR>
<TR>
<TD colspan=2><CODE>c += d</CODE></TD>
<TD>Appends d to c. D may be either another layer or a contour.</TD>
</TR>
<TR>
<TD colspan=3>Does not support the repeat, slice and contains concepts</TD>
</TR>
<TR>
<TH colspan=3>Iterator Protocol</TH>
</TR>
<TR>
<TD><CODE>__iter__</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Returns an iterator for the layer which will return the contours in order.</TD>
</TR>
<TR>
<TH colspan=3>Methods</TH>
</TR>
<TR>
<TH>method</TH>
<TH>args</TH>
<TH>comments</TH>
</TR>
<TR>
<TD><CODE>dup</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Returns a deep copy of the layer. That is, it will copy all the contours
and all the points as well as copying the layer object itself.</TD>
</TR>
<TR>
<TD><CODE>isEmpty</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Returns whether the layer is empty (contains no contour)</TD>
</TR>
<TR>
<TD><CODE>addExtrema</CODE></TD>
<TD><CODE>([flags,emsize])</CODE></TD>
<TD>Extrema should be marked by on-curve points. If a curve lacks a point
at an extrema this command will add one. Flags may be one of the following
strings
<DL>
<DT>
all
<DD>
Add all missing extrema
<DT>
only_good
<DD>
Only add extrema on longer splines (with respect to the em-size)
<DT>
only_good_rm
<DD>
As above but also merge away on-curve points which are very close to, but
not on, an added extremum
</DL>
</TD>
</TR>
<TR>
<TD><CODE><A name="l-cluster">cluster</A></CODE></TD>
<TD><CODE>([within,max])</CODE></TD>
<TD>Moves clustered coordinates to a standard central value. See also
<A href="#l-round">round</A>.</TD>
</TR>
<TR>
<TD><CODE><A name="l-correctDirection">correctDirection</A></CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Orients all contours so that external ones are clockwise and internal
counter-clockwise. See also
<A href="#cnt-isClockwise">contour.isClockwise</A>.</TD>
</TR>
<TR>
<TD><CODE><A name="l-export">export</A></CODE></TD>
<TD><CODE>(filename)</CODE></TD>
<TD>Exports the current layer (in outline format) to a file. The type of
file is determined by the extension.</TD>
</TR>
<TR>
<TD><CODE><A name="l-exclude">exclude</A></CODE></TD>
<TD><CODE>(excluded-layer)</CODE></TD>
<TD>Removes the excluded area from the current contours. See also
<A href="#l-removeOverlap">removeOverlap</A> and
<A href="#l-intersect">intersect</A>.</TD>
</TR>
<TR>
<TD><CODE><A name="l-intersect">intersect</A></CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Leaves only areas in the intersection of contours. See also
<A href="#l-removeOverlap">removeOverlap</A> and
<A href="#l-exclude">exclude</A>.</TD>
</TR>
<TR>
<TD><CODE><A name="l-removeOverlap">removeOverlap</A></CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Removes overlapping areas. See also <A href="#l-intersect">intersect</A>
and <A href="#l-exclude">exclude</A>.</TD>
</TR>
<TR>
<TD><CODE>interpolateNewLayer</CODE></TD>
<TD><CODE>(other-layer,amount)</CODE></TD>
<TD>Creates (and returns) a new layer which contains splines interpolated
from the current layer and the first argument. If amount is 0 the result
will look like the current layer, if 1 then like the first argument.</TD>
</TR>
<TR>
<TD><CODE><A name="l-round">round</A></CODE></TD>
<TD><CODE>([factor])</CODE></TD>
<TD>Rounds the x and y coordinates. If factor is specified then new-coord
= round(factor*old-coord)/factor. See also <A href="#l-cluster">cluster</A>.</TD>
</TR>
<TR>
<TD><CODE>selfIntersects</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Returns whether any of the contours on this layer intersects any other
contour (including itself).</TD>
</TR>
<TR>
<TD><CODE>similar</CODE></TD>
<TD><CODE>(other-layer[,error])</CODE></TD>
<TD>Checks whether this layer is similar to the other one where error is
the maximum distance (in em-units) allowed for any two corresponding contours
in the layers to diverge.
<P>
This is like the comparison operator, but that doesn't allow you to specify
an error bound.</TD>
</TR>
<TR>
<TD><CODE>simplify</CODE></TD>
<TD><CODE>([error-bound,flags,tan_bounds,<BR>
linefixup,linelenmax])</CODE></TD>
<TD>Tries to remove excess points on the layer if doing so will not perturb
the curve by more than <CODE>error-bound</CODE>. Flags is a tuple of the
following strings
<DL>
<DT>
ignoreslopes
<DD>
Allow slopes to change
<DT>
ignoreextrema
<DD>
Allow removal of extrema
<DT>
smoothcurves
<DD>
Allow curve smoothing
<DT>
choosehv
<DD>
Snap to horizontal or vertical
<DT>
forcelines
<DD>
flatten bumps on lines
<DT>
nearlyhvlines
<DD>
Make nearly horizontal/vertical lines be so
<DT>
mergelines
<DD>
Merge adjacent lines into one
<DT>
setstarttoextremum
<DD>
Rotate the point list so that the start point is on an extremum
<DT>
removesingletonpoints
<DD>
If the contour contains just one point then remove it
</DL>
</TD>
</TR>
<TR>
<TD><CODE>stemControl</CODE></TD>
<TD><CODE>(stem_width_scale, [hscale, stem_height_scale, vscale,
xheight])</CODE></TD>
<TD>Allows you to scale counters and stems independently of each other.
<CODE>Stem_width_scale</CODE> specifies by how much the widths of stems should
be scaled (this should be a number around 1). If omitted <CODE>hscale</CODE>
defaults to 1, otherwise it will indicate the horizontal scaling factor for
the glyph as a whole. If omitted <CODE>stem_height_scale</CODE> defaults
to <CODE>stem_width_scale</CODE>, otherwise it specifies the scaling for
stem heights. If omitted <CODE>vscale</CODE> defaults to <CODE>hscale</CODE>,
otherwise it specifies the vertical scale factor for the glyph as a whole.
<P>
<CODE>Xheight</CODE> is optional, if specified it will fix the points at
that height so that they will be at the same level across glyphs.</TD>
</TR>
<TR>
<TD><CODE>stroke</CODE></TD>
<TD><CODE>("circular",width[,linecap,linejoin,flags])<BR>
("eliptical",width,minor-width,angle<BR>
[,linecap,linejoin,flags])<BR>
("caligraphic",width,height,angle[,flags])<BR>
("polygon",contour[,flags])</CODE></TD>
<TD>Strokes the current line using one of the indicated pens. Line cap may
be one of
<UL>
<LI>
butt
<LI>
round
<LI>
square
</UL>
<P>
line join may be
<UL>
<LI>
miter
<LI>
round
<LI>
bevel
</UL>
<P>
flags is a tuple containing some of the following strings
<UL>
<LI>
removeinternal
<LI>
removeexternal
<LI>
cleanup
</UL>
<P>
If a polygonal pen is specified the contour must be a closed, convex polygon
(no curved edges) with fewer than 100 vertices.</TD>
</TR>
<TR>
<TD><CODE>transform</CODE></TD>
<TD><CODE>(matrix)</CODE></TD>
<TD>Transforms the layer by the matrix</TD>
</TR>
<TR>
<TD><CODE>nltransform</CODE></TD>
<TD><CODE>(xexpr,yexpr)</CODE></TD>
<TD>xexpr and yexpr are strings specifying non-linear transformations that
will be applied to all points in the layer (with xexpr being applied to x
values, and yexpr to y values, of course). The syntax for the expressions
is explained in the <A HREF="transform.html#Non-Linear">non-linear transform
dialog</A>.</TD>
</TR>
<TR>
<TD><CODE>boundingBox</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Returns a tuple representing a rectangle (xmin,ymin, xmax,ymax) into
which the layer fits. It is not guaranteed to be the smallest such rectangle,
but it will often be.</TD>
</TR>
<TR>
<TD><CODE>xBoundsAtY</CODE></TD>
<TD><CODE>(ybottom[,ytop])</CODE></TD>
<TD>Finds the minimum and maximum x positions attained by the contour when
y is between ybottom and ytop (if ytop is not specified it is assumed the
same as ybottom). If the layer does not have any y values in the specified
range then ff will return None.</TD>
</TR>
<TR>
<TD><CODE>yBoundsAtX</CODE></TD>
<TD><CODE>(xleft[,xright])</CODE></TD>
<TD>Finds the minimum and maximum y positions attained by the contour when
x is between xleft and xright (if xright is not specified it is assumed the
same as xleft). If the layer does not have any x values in the specified
range then ff will return None.</TD>
</TR>
<TR>
<TD><CODE>draw</CODE></TD>
<TD><CODE>(pen)</CODE></TD>
<TD>Draw the layer to the <A href="http://www.robofab.org/objects/pen.html">pen
argument.</A></TD>
</TR>
<TR>
<TH colspan=3>Pickling Methods</TH>
</TR>
<TR>
<TD><CODE>__reduce__</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>This function allows the pickler to work on this type. I don't think
it is useful for anything else.</TD>
</TR>
</TABLE>
<P>
<TABLE id="type" border=1>
<CAPTION>
<A name="GlyphPen">glyphPen</A>
</CAPTION>
<TR>
<TD colspan=3>This implements the
<A href="http://www.robofab.org/objects/pen.html">Pen Protocol</A> to draw
into a FontForge glyph. You create a glyphPen with the
<A href="#glyph-glyphPen">glyphPen</A> attribute of a glyph. You then draw
into it with the operators below.
<BLOCKQUOTE>
<PRE>
import fontforge;
font = fontforge.open("Ambrosia.sfd"); #Open a font
pen = font["B"].glyphPen(); # Create a pen to draw into glyph "B"
pen.moveTo((100,100)); # draw a square
pen.lineTo((100,200));
pen.lineTo((200,200));
pen.lineTo((200,100));
pen.closePath(); # end the contour
font["A"].draw(pen); # or you can copy from one glyph to another
# by having a glyph draw itself into the pen
pen = None; # Finalize the pen. This tells FontForge
# that the drawing is done and causes
# it to refresh the display (if a UI is active).
</PRE>
</BLOCKQUOTE>
<P>
This type may not be pickled.</TD>
</TR>
<TR>
<TH colspan=3>Members</TH>
</TR>
<TR>
<TD colspan=3>None</TD>
</TR>
<TR>
<TH colspan=3>Methods</TH>
</TR>
<TR>
<TH>method</TH>
<TH>args</TH>
<TH>comments</TH>
</TR>
<TR>
<TD><CODE>moveTo</CODE></TD>
<TD><CODE>((x,y))</CODE></TD>
<TD>With one exception this call begins every contor and creates an on curve
point at (x,y) as the start point of that contour. This should be the first
call after a pen has been created and the call that follows a closePath,
endPath.</TD>
</TR>
<TR>
<TD><CODE>lineTo</CODE></TD>
<TD><CODE>((x,y))</CODE></TD>
<TD>Draws a line from the last point to (x,y) and adds that to the contour.</TD>
</TR>
<TR>
<TD><CODE>curveTo</CODE></TD>
<TD><CODE>((cp1.x,cp1.y),(cp2.x,cp2.y),(x,y))<BR>
((cp.x,cp.y),(x,y))</CODE></TD>
<TD>This routine has slightly different arguments depending on the type of
the font. When drawing into a cubic font (PostScript) use the first set of
arguments (with two control points -- off curve points -- between each on
curve point). When drawing into a quadratic font (TrueType) use the second
format with one control point between adjacent on-curve points.
<P>
The standard appears to support super-bezier curves with more than two control
points between on-curve points. FontForge does not. Nor does FontForge allow
you to draw a quadratic spline into a cubic font, nor vice versa.</TD>
</TR>
<TR>
<TD><CODE>qCurveTo</CODE></TD>
<TD><CODE>([(cp.x,cp.y)]*,(x,y))<BR>
([(cp.x,cp.y)]*,None))</CODE></TD>
<TD>This routine may only be used in quadratic (TrueType) fonts and has two
different formats. It is used to express the TrueType idiom where an on-curve
point mid-way between its control points may be omitted, leading to a run
of off-curve points (with implied but unspecified on-curve points between
them).
<P>
The first format allows an arbetary number of off-curve points followed by
one on-curve point.
<P>
It is possible to have a contour which consists solely of off-curve points.
When this happens the contour is NOT started with a moveTo, instead the entire
contour, all the off curve points, are listed in one call, and the argument
list is terminated by a <CODE>None</CODE> to indicate there are no on-curve
points.</TD>
</TR>
<TR>
<TD><CODE>closePath</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Closes the contour (connects the last point to the first point to make
a loop) and ends it.</TD>
</TR>
<TR>
<TD><CODE>endPath</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Ends the contour without closing it. This is only relevant if you are
stroking contours.</TD>
</TR>
<TR>
<TD><CODE>addComponent</CODE></TD>
<TD><CODE>(glypn-name,transform)</CODE></TD>
<TD>Adds a reference (a component) to the glyph. The PostScript transformation
matrix is a 6 element tuple.</TD>
</TR>
</TABLE>
<P>
<TABLE id="type" border=1>
<CAPTION>
<A name="Glyph">glyph</A>
</CAPTION>
<TR>
<TH colspan=3>Description</TH>
</TR>
<TR>
<TD colspan=3>The glyph type refers to a fontforge Glyph object. It has no
independent life of its own, it always lives within a font. It has all the
things you expect to be associated with a glyph: a glyph name, a unicode
encoding, a drawing layer, GPOS/GSUB features...
<P>
This type may not be pickled.
<P>
This type may not be created directly -- all glyphs are bound to a font and
must be created through the font.</TD>
</TR>
<TR>
<TH colspan=3>Members</TH>
</TR>
<TR>
<TH>member</TH>
<TH colspan=2>comments</TH>
</TR>
<TR>
<TD><CODE>activeLayer</CODE></TD>
<TD colspan=2>Returns currently active layer in the glyph (as an integer).
May be set to an integer or a layer name to change the active layer.</TD>
</TR>
<TR>
<TD><CODE><A name="g-altuni">altuni</A></CODE></TD>
<TD colspan=2>Returns additional unicode code points for this glyph.
For a primary code point, see <A HREF="#g-unicode">unicode</A>.
<P>
Returns either None or a tuple of alternate encodings. Each alternate
encoding is a tuple of<BR>
<CODE>(unicode-value, variation-selector, reserved-field)</CODE><BR>
The first is an unicode value of this alternate code point.
The second is an integer for variation selector and can be set to -1
if not used. The third is an empty field reserved for future use
and currently must be set to zero.
<P>
<CODE>glyph.altuni<?CODE> can be set to None to clear all alternates,
or to a tuple. The elements of the tuple may be either integers
(an alternate unicode value with no variation selector)
or a tuple with up to 3 values in it as explained above.</TD>
</TR>
<TR>
<TD><CODE>anchorPoints</CODE></TD>
<TD colspan=2>Returns the list of anchor points in the glyph. Each anchor
point is a tuple of<BR>
<CODE>(anchor-class-name, type, x,y [,ligature-index])</CODE><BR>
The first two are strings, the next two doubles, and the last (which is only
present if type=="ligature") is an integer. Type may be
<UL>
<LI>
mark
<LI>
base
<LI>
ligature
<LI>
basemark
<LI>
entry
<LI>
exit
</UL>
</TD>
</TR>
<TR>
<TD><CODE>anchorPointsWithSel</CODE></TD>
<TD colspan=2>Same as the above, except also includes whether the anchor
point is selected in the UI. Returns a tuple of all anchor points in the
glyph. Each anchor point is a tuple of<BR>
<CODE>(anchor-class-name, type, x,y, selected [,ligature-index])</CODE><BR>
The first two are strings, the next two doubles, then a boolean, and the
last (which is only present if type=="ligature") is an integer. Type may
be
<UL>
<LI>
mark
<LI>
base
<LI>
ligature
<LI>
basemark
<LI>
entry
<LI>
exit
</UL>
</TD>
</TR>
<TR>
<TD><CODE><A name="g-background">background</A></CODE></TD>
<TD colspan=2>The glyph's background layer. This is a <EM>copy</EM> of the
glyph's data. See also <A href="#g-foreground">foreground</A>, and
<A HREF="python.html#glyph-layers">layers</A>.</TD>
</TR>
<TR>
<TD><CODE>changed</CODE></TD>
<TD colspan=2>Whether this glyph has been modified. This is (should be)
maintained automatically, but you may set it if you wish.</TD>
</TR>
<TR>
<TD><CODE>color</CODE></TD>
<TD colspan=2>The color of the glyph in the fontview. A 6 hex-digit RGB number
or -1 for default. 0xffffff is white, 0x0000ff is blue, etc.</TD>
</TR>
<TR>
<TD><CODE>comment</CODE></TD>
<TD colspan=2>Any comment you wish to associate with the glyph. UTF-8</TD>
</TR>
<TR>
<TD><CODE>dhints</CODE></TD>
<TD colspan=2>A tuple with one entry for each diagonal stem hint. Each stem
hint is itself represented by a tuple of three coordinate pairs (themselves
tuples of two numbers), these three are: a point on one side of the stem,
a point on the other side, and a unit vector pointing in the stem's direction.</TD>
</TR>
<TR>
<TD><CODE>encoding</CODE></TD>
<TD colspan=2>Returns the glyph's encoding in the font's encoding. (readonly)
<P>
If the glyph has multiple encodings, one will be picked at random.<BR>
If the glyph is not in the font's encoding then a number will be returned
beyond the encoding size (or in some cases -1 will be returned).</TD>
</TR>
<TR>
<TD><CODE>font</CODE></TD>
<TD colspan=2>The font containing this glyph. (readonly)</TD>
</TR>
<TR>
<TD><CODE><A name="g-foreground">foreground</A></CODE></TD>
<TD colspan=2>The glyph's foreground layer. This is a <EM>copy</EM> of the
glyph's data. See also <A href="#g-background">background</A>,
<A HREF="python.html#glyph-layers">layers</A> and
<A href="#g-references">references</A>.</TD>
</TR>
<TR>
<TD><CODE>glyphclass</CODE></TD>
<TD colspan=2>An opentype glyphclass, one of automatic, noclass, baseglyph,
baseligature, mark, component</TD>
</TR>
<TR>
<TD><CODE>glyphname</CODE></TD>
<TD colspan=2>The name of the glyph</TD>
</TR>
<TR>
<TD><CODE>hhints</CODE></TD>
<TD colspan=2>A tuple of all horizontal postscript hints. Each hint is itself
a tuple of starting locations and widths.</TD>
</TR>
<TR>
<TD><CODE>horizontalComponents</CODE></TD>
<TD colspan=2>A tuple of tuples.
<P>
This allows <A href="math.html#GlyphConstruction">constructing</A> very large
versions of the glyph by stacking the componants together. Some components
may be repeated so there is no bound on the size.
<P>
This is different from horizontalVariants which expects prebuilt glyphs of
various fixed sizes.
<P>
The components are stacked in the order they appear in the (top-level) tuple.
Each sub-tuple represents information on one component. The subtuple should
contain: (String glyph-name, Boolean is-extender, Int startConnectorLength,
Int endConnectorLength, Int fullAdvance). Any of these may be omitted (except
the glyph name) and will be assumed to be 0 if so.</TD>
</TR>
<TR>
<TD><CODE>horizontalComponentItalicCorrection</CODE></TD>
<TD colspan=2>The italic correction for any composite glyph made with the
horizontalComponents.</TD>
</TR>
<TR>
<TD><CODE>horizontalVariants</CODE></TD>
<TD colspan=2>A string containing a list of glyph names. These are
<A href="math.html#Variants</a">alternate forms</A> of the current glyph
for use in typesetting math. Presumably the variants are of different sizes.
<P>
Although ff will always return a string of glyph names, you may assign to
it with a tuple of glyphs and ff will convert that to corresponding names.</TD>
</TR>
<TR>
<TD><CODE>isExtendedShape</CODE></TD>
<TD colspan=2>A boolean containing the MATH "is extended shape" field.</TD>
</TR>
<TR>
<TD><CODE>italicCorrection</CODE></TD>
<TD colspan=2>The glyph's italic correction field. Used by both TeX and MATH.
The special value of -32768 (0x8000) means the value is unspecified (An
unspecified value will not go into the output tables, a value of 0 will)</TD>
</TR>
<TR>
<TD><CODE>layer_cnt</CODE></TD>
<TD colspan=2>The number of layers in this glyph. (Cannot be set)</TD>
</TR>
<TR>
<TD><CODE><A NAME="glyph-layers">layers</A></CODE></TD>
<TD colspan=2>A dictionary like object containing the layers of the glyph.
It may be indexed by either a layer name, or an integer between 0 and
<CODE>glyph.layer_cnt-1</CODE> to produce a <A href="#Layer">Layer</A> object.
Layer 0 is the background layer. Layer 1 is the foreground layer.</TD>
</TR>
<TR>
<TD><CODE><A NAME="layerrefs">layerrefs</A></CODE></TD>
<TD colspan=2>A dictionary like object containing the references in the layers
of the glyph. It may be indexed by either a layer name, or an integer between
0 and <CODE>glyph.layer_cnt-1</CODE> to produce a
<A href="#g-references">reference tuple</A> object. Layer 0 is the background
layer. Layer 1 is the foreground layer.</TD>
</TR>
<TR>
<TD><CODE>lcarets</CODE></TD>
<TD colspan=2>A tuple containing the glyph's ligature caret locations. Setting
this will also either enable or disable the "Default Ligature Caret Count"
flag depending from the number of elements in the tuple.</TD>
</TR>
<TR>
<TD><CODE>left_side_bearing</CODE></TD>
<TD colspan=2>The left side bearing of the glyph</TD>
</TR>
<TR>
<TD><CODE>manualHints</CODE></TD>
<TD colspan=2>The glyph's hints have been set by hand, and the glyph should
not be autohinted without a specific request from the user. The "Don't AutoHint"
flag.</TD>
</TR>
<TR>
<TD><CODE>mathKern.bottomLeft</CODE></TD>
<TD colspan=2>The glyph's math kerning data associated with the bottom left
vertex. This returns a tuple of two element tuples, each of which contains
a kerning offset and an associated height (in the last entry the height term
is meaningless, but present).</TD>
</TR>
<TR>
<TD><CODE>mathKern.bottomRight</CODE></TD>
<TD colspan=2>The glyph's math kerning data associated with the bottom right
vertex. This returns a tuple of two element tuples, each of which contains
a kerning offset and an associated height (in the last entry the height term
is meaningless, but present).</TD>
</TR>
<TR>
<TD><CODE>mathKern.topLeft</CODE></TD>
<TD colspan=2>The glyph's math kerning data associated with the top left
vertex. This returns a tuple of two element tuples, each of which contains
a kerning offset and an associated height (in the last entry the height term
is meaningless, but present).</TD>
</TR>
<TR>
<TD><CODE>mathKern.topRight</CODE></TD>
<TD colspan=2>The glyph's math kerning data associated with the top right
vertex. This returns a tuple of two element tuples, each of which contains
a kerning offset and an associated height (in the last entry the height term
is meaningless, but present).</TD>
</TR>
<TR>
<TD><CODE>originalgid</CODE></TD>
<TD colspan=2>The GID of this glyph in the font it was read from. (readonly)</TD>
</TR>
<TR>
<TD><CODE><A NAME="glyph-persistent">persistent</A></CODE></TD>
<TD colspan=2>Whatever you want (these data will be saved as a pickled object
in the sfd file. It is your job to insure that whatever you put here can
be pickled). See also <A HREF="#glyph-temporary">the temporary</A> field.</TD>
</TR>
<TR>
<TD><CODE><A name="g-references">references</A></CODE></TD>
<TD colspan=2>A tuple of tuples containing glyph-name and a transformation
matrix for each reference in the foreground. See also
<A href="#g-foreground">foreground</A> and
<A HREF="python.html#layerrefs">layerrefs</A>.</TD>
</TR>
<TR>
<TD><CODE>right_side_bearing</CODE></TD>
<TD colspan=2>The right side bearing of the glyph</TD>
</TR>
<TR>
<TD><CODE>script</CODE></TD>
<TD colspan=2>A string containing the OpenType 4 letter tag for the script
associated with this glyph (readonly)</TD>
</TR>
<TR>
<TD><CODE><A NAME="glyph-temporary">temporary</A></CODE></TD>
<TD colspan=2>Whatever you want (these data will be lost once the font is
closed) See also <A HREF="#glyph-persistent">the persistent</A> field.</TD>
</TR>
<TR>
<TD><CODE>texheight</CODE></TD>
<TD colspan=2>The Tex height. The special value of -32768 (0x8000) means
the field is unspecified (An unspecified value will not go into the output
tables, a value of 0 will)</TD>
</TR>
<TR>
<TD><CODE>texdepth</CODE></TD>
<TD colspan=2>The Tex depth. The special value of -32768 (0x8000) means the
field is unspecified (An unspecified value will not go into the output tables,
a value of 0 will)</TD>
</TR>
<TR>
<TD><CODE>topaccent</CODE></TD>
<TD colspan=2>The glyph's top accent position field. Used by MATH. The special
value of -32768 (0x8000) means the field is unspecified (An unspecified value
will not go into the output tables, a value of 0 will)</TD>
</TR>
<TR>
<TD><CODE>ttinstrs</CODE></TD>
<TD colspan=2>Any truetype instructions, returned as a binary string</TD>
</TR>
<TR>
<TD><CODE><A name="g-unicode">unicode</A></CODE></TD>
<TD colspan=2>The glyph's unicode code point, or -1.
In addition to this primary mapping, a glyph can have multiple
secondary mappings - see <A HREF="#g-altuni">altuni</A>.
</TD>
</TR>
<TR>
<TD><CODE>unlinkRmOvrlpSave</CODE></TD>
<TD colspan=2>A flag that indicates the glyph's references should be unlinked
and remove overlap run on it before the font is saved (and then the original
references replaced after the save finishes)</TD>
</TR>
<TR>
<TD><CODE>userdata</CODE></TD>
<TD colspan=2>Deprecated name for <A HREF="#glyph-temporary">temporary field
above</A></TD>
</TR>
<TR>
<TD><CODE>vhints</CODE></TD>
<TD colspan=2>A tuple of all vertical postscript hints. Each hint is itself
a tuple of starting locations and widths.</TD>
</TR>
<TR>
<TD><CODE><A NAME="validation-state">validation</A>_state</CODE></TD>
<TD colspan=2>A bit mask indicating some problems this glyph might have.
(readonly)
<TABLE BORDER CELLPADDING="2">
<TR>
<TD>0x1</TD>
<TD>If set then this glyph has been validated.<BR>
If unset then other bits are meaningless.</TD>
</TR>
<TR>
<TD>0x2</TD>
<TD>Glyph has an open contour.</TD>
</TR>
<TR>
<TD>0x4</TD>
<TD>Glyph intersects itself somewhere.</TD>
</TR>
<TR>
<TD>0x8</TD>
<TD>At least one contour is drawn in the wrong direction</TD>
</TR>
<TR>
<TD>0x10</TD>
<TD>At least one reference in the glyph has been flipped<BR>
(and so is drawn in the wrong direction)</TD>
</TR>
<TR>
<TD>0x20</TD>
<TD>Missing extrema</TD>
</TR>
<TR>
<TD>0x40</TD>
<TD>A glyph name referred to from this glyph, in an opentype table, is not
present in the font.</TD>
</TR>
<TR>
<TD>0x40000</TD>
<TD>Points (or control points) are too far apart. (Coordinates must be within
32767)</TD>
</TR>
<TR>
<TH COLSPAN=2>PostScript only</TH>
</TR>
<TR>
<TD>0x80</TD>
<TD>PostScript has a limit of 1500 points in a glyph.</TD>
</TR>
<TR>
<TD>0x100</TD>
<TD>PostScript has a limit of 96 hints in a glyph.</TD>
</TR>
<TR>
<TD>0x200</TD>
<TD>Invalid glyph name.</TD>
</TR>
<TR>
<TH COLSPAN=2>TrueType only, errors in original file</TH>
</TR>
<TR>
<TD>0x400</TD>
<TD>More points in a glyph than allowed in 'maxp'</TD>
</TR>
<TR>
<TD>0x800</TD>
<TD>More paths in a glyph than allowed in 'maxp'</TD>
</TR>
<TR>
<TD>0x1000</TD>
<TD>More points in a composite glyph than allowed in 'maxp'</TD>
</TR>
<TR>
<TD>0x2000</TD>
<TD>More paths in a composite glyph than allowed in 'maxp'</TD>
</TR>
<TR>
<TD>0x4000</TD>
<TD>Instructions longer than allowed in 'maxp'</TD>
</TR>
<TR>
<TD>0x8000</TD>
<TD>More references in a glyph than allowed in 'maxp'</TD>
</TR>
<TR>
<TD>0x10000</TD>
<TD>References nested more deeply than allowed in 'maxp'</TD>
</TR>
<TR>
<TD>0x40000</TD>
<TD>Points too far apart. TrueType and Type2 fonts are limited to 16 bit
numbers, and so adjacent points must be within 32767 em-units of each other.</TD>
</TR>
<TR>
<TD>0x80000</TD>
<TD>Points non-integral. TrueType points and control points must be integer
aligned. (FontForge will round them if they aren't)</TD>
</TR>
<TR>
<TD>0x100000</TD>
<TD>Missing anchor. According to the opentype spec, if a glyph contains an
anchor point for one anchor class in a subtable, it must contain anchor points
for all anchor classes in the subtable. Even it, logically, they do not apply
and are unnecessary.</TD>
</TR>
<TR>
<TD>0x200000</TD>
<TD>Duplicate glyph name. Two (or more) glyphs in this font have the same
name. When outputting a PostScript font only one of them will ever be seen.
<P>
It's a little hard to detect this in normal use, but if you change the encoding
to "Glyph Order", and then use Edit->Select->Wildcard and enter the
glyph name, both of them should be selected.</TD>
</TR>
<TR>
<TD>0x400000</TD>
<TD>Duplicate unicode code point. Two (or more) glyphs in this font have
the code point. When outputting an sfnt (TrueType/OpenType) font only one
of them will ever be seen.
<P>
It's a little hard to detect this in normal use, but if you change the encoding
to "Glyph Order", and then use Edit->Select->Wildcard and enter the
code point, both of them should be selected.</TD>
</TR>
<TR>
<TD>0x800000</TD>
<TD>Overlapped hints. Either the glyph has no hint masks and there are overlapped
hints, or a hint mask specifies two overlapping hints.</TD>
</TR>
</TABLE>
</TD>
</TR>
<TR>
<TD><CODE>verticalComponents</CODE></TD>
<TD colspan=2>A tuple of tuples.
<P>
This allows <A href="math.html#GlyphConstruction">constructing</A> very large
versions of the glyph by stacking the componants together. Some components
may be repeated so there is no bound on the size.
<P>
This is different from verticalVariants which expects prebuilt glyphs of
various fixed sizes.
<P>
The components are stacked in the order they appear in the (top-level) tuple.
Each sub-tuple represents information on one component. The subtuple should
contain: (String glyph-name, Boolean is-extender, Int startConnectorLength,
Int endConnectorLength, Int fullAdvance). Any of these may be omitted (except
the glyph name) and will be assumed to be 0 if so.</TD>
</TR>
<TR>
<TD><CODE>verticalComponentItalicCorrection</CODE></TD>
<TD colspan=2>The italic correction for any composite glyph made with the
verticalComponents.</TD>
</TR>
<TR>
<TD><CODE>verticalVariants</CODE></TD>
<TD colspan=2>A string containing a list of glyph names. These are
<A href="math.html#Variants</a">alternate forms</A> of the current glyph
for use in typesetting math. Presumably the variants are of different sizes.</TD>
</TR>
<TR>
<TD><CODE><A name="g-width">width</A></CODE></TD>
<TD colspan=2>The advance width of the glyph. See also
<A HREF="#g-vwidth">vwidth</A>.</TD>
</TR>
<TR>
<TD><CODE><A name="g-vwidth">vwidth</A></CODE></TD>
<TD colspan=2>The vertical advance width of the glyph. See also
<A HREF="#g-width">width</A>.</TD>
</TR>
<TR>
<TH colspan=3>Methods</TH>
</TR>
<TR>
<TH>method</TH>
<TH>args</TH>
<TH>comments</TH>
</TR>
<TR>
<TD><CODE>addAnchorPoint</CODE></TD>
<TD><CODE>(anchor-class-name,<BR>
anchor-type,<BR>
x,y<BR>
[,ligature-index])</CODE></TD>
<TD>Adds an anchor point. anchor-type may be one of the strings
<UL>
<LI>
"mark"
<LI>
"base"
<LI>
"ligature"
<LI>
"basemark"
<LI>
"entry"
<LI>
"exit"
</UL>
<P>
If there is an anchor point with the same anchor-class-name and:
<UL>
<LI>
lookup type is "gpos_mark2base" or
<LI>
lookup type is "gpos_mark2ligature" and ligature-index is the same or
<LI>
anchor-type is the same
</UL>
<P>
then the existing anchor will be overwritten.</TD>
</TR>
<TR>
<TD><CODE>addExtrema</CODE></TD>
<TD><CODE>([flags,emsize])</CODE></TD>
<TD>Extrema should be marked by on-curve points. If a curve lacks a point
at an extrema this command will add one. Flags may be one of the following
strings
<DL>
<DT>
all
<DD>
Add all missing extrema
<DT>
only_good
<DD>
Only add extrema on longer splines (with respect to the em-size)
<DT>
only_good_rm
<DD>
As above but also merge away on-curve points which are very close to, but
not on, an added extremum
</DL>
</TD>
</TR>
<TR>
<TD><CODE>addReference</CODE></TD>
<TD><CODE>(glyph-name[,transform])</CODE></TD>
<TD>Adds a reference to the specified glyph into the current glyph. Optionally
specifying a transformation matrix</TD>
</TR>
<TR>
<TD><CODE>addHint</CODE></TD>
<TD><CODE>(is-vertical,start,width)</CODE></TD>
<TD>Adds a postscript hint. Takes a boolean flag indicating whether the hint
is horizontal or vertical, a start location and the hint's width.</TD>
</TR>
<TR>
<TD><CODE>addPosSub</CODE></TD>
<TD><CODE>(subtable-name,variant)<BR>
(subtable-name,variants)<BR>
(subtable-name,ligature-components)<BR>
(subtable-name,xoff,yoff,xadv,yadv)<BR>
(subtable-name,other-glyph-name,kerning)<BR>
(subtable-name,other-glyph-name, xoff1,yoff1,xadv1,yadv1,<BR>
xoff2,yoff2,xadv2,yadv2)</CODE></TD>
<TD>Adds position/substitution data to the glyph. The number and type of
the arguments vary acording to the type of the lookup containing the subtable.
The first argument should always be a lookup subtable name. If the lookup
is for single substitutions then the second argument should be a string
containing a single glyph name. For multiple and alternated substitutions
a tuple of glyph names. For ligatures, a tuple of the ligature components
(glyph names). For single positionings the second through fifth arguments
should be small integers representing the adjustment along the appropriate
axis. For pairwise positionings (kerning) the second argument should be the
name of the other glyph being kerned with, and the third through tenth should
be small integers -- or, if there are exactly three arguments then the third
specifies traditional, one-axis, kerning
<P>
If there is a previously existing entry, this will replace it (except for
ligatures).</TD>
</TR>
<TR>
<TD><CODE>appendAccent</CODE></TD>
<TD><CODE>(name="glyph-name")<BR>
(unicode=<codepoint>)</CODE></TD>
<TD>Makes a reference to the specified glyph, adds that reference to the
current layer of this glyph, and positions it to make a reasonable accent.</TD>
</TR>
<TR>
<TD><CODE>autoHint</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Generates PostScript hints for this glyph.</TD>
</TR>
<TR>
<TD><CODE>autoInstr</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Generates TrueType instructions for this glyph.</TD>
</TR>
<TR>
<TD><CODE>autoTrace</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Auto traces any background images</TD>
</TR>
<TR>
<TD><CODE>boundingBox</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Returns a tuple representing a rectangle (xmin,ymin, xmax,ymax) which
is the minimum bounding box of the glyph.</TD>
</TR>
<TR>
<TD><CODE>build</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>If the character is a composite character, then clears it and inserts
references to its components</TD>
</TR>
<TR>
<TD><CODE>canonicalContours</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Orders the contours in the current glyph by the x coordinate of their
leftmost point. (This can reduce the size of the charstring needed to describe
the glyph(s).</TD>
</TR>
<TR>
<TD><CODE>canonicalStart</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Sets the start point of all the contours of the current glyph to be the
leftmost point on the contour. (If there are several points with that value
then use the one which is closest to the baseline). This can reduce the size
of the charstring needed to describe the glyph(s). By regularizing things
it can also make more things available to be put in subroutines.</TD>
</TR>
<TR>
<TD><CODE>changeWeight</CODE></TD>
<TD><CODE>(stroke_width[,type,<BR>
serif_height,serif_fuzz,<BR>
counter_type,custom_zones])</CODE></TD>
<TD>See the <A HREF="Styles.html#Embolden">Element->Style->Change
Width</A> command for a more complete description of these arguments.
<P>
Stroke_width is the amount by which all stems are expanded.
<P>
Type is one of "LCG", "CJK", "auto", "custom".
<P>
Serif_height tells ff not to expand serifs which are that much off the baseline,
while serif_fuzz specifies the amount of fuzziness allowed in the match.
If you don't want special serif behavior set this to 0.
<P>
Counter_type is one of "squish", "retain", "auto".
<P>
Custom_zones is only meaningful if the type argument were "custom". It may
be either a number, which specifies the "top hint" value (bottom hint is
assumed to be 0, others are between), or a tuple of 4 numbers (top hint,
top zone, bottom zone, bottom hint).</TD>
</TR>
<TR>
<TD><CODE>condenseExtend</CODE></TD>
<TD><CODE>(c_factor,c_add[,sb_factor,sb_add,correct])</CODE></TD>
<TD>Condenses or extends the size of the counters and side-bearings of the
glyph. The first two arguments provide information on shrinking/growing the
counters, the second two the sidebearings. If the last two are omitted they
default to the same values as the first two.
<P>
A counter's width will become:<BR>
<CODE> new_width = c_factor * old_width + c_add</CODE>
<P>
If present the <CODE>correct</CODE> argument allows you to specify whether
you want to correct for the italic angle before condensing the glyph. (it
defaults to True)</TD>
</TR>
<TR>
<TD><CODE>clear</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Clears the contents of the glyph (and marks it as not
<A href="#g-isWorthOutputting">worth outputting</A>).</TD>
</TR>
<TR>
<TD><CODE><A name="g-cluster">cluster</A></CODE></TD>
<TD><CODE>([within,max])</CODE></TD>
<TD>Moves clustered coordinates to a standard central value. See also
<A href="#g-round">round</A>.</TD>
</TR>
<TR>
<TD><CODE><A name="g-correctDirection">correctDirection</A></CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Orients all contours so that external ones are clockwise and internal
counter-clockwise.</TD>
</TR>
<TR>
<TD><CODE><A name="g-exclude">exclude</A></CODE></TD>
<TD><CODE>(excluded-layer)</CODE></TD>
<TD>Removes the excluded area from the current glyph. Takes an argument which
is a layer. See also <A href="#g-removeOverlap">removeOverlap</A> and
<A href="#g-intersect">intersect</A>.</TD>
</TR>
<TR>
<TD><CODE>export</CODE></TD>
<TD><TABLE>
<TR>
<TD><CODE>(filename[,pixelsize,bitdepth])</CODE></TD>
<TD>bitmap images</TD>
</TR>
<TR>
<TD><CODE> (filename[,layer])</CODE></TD>
<TD>vector outlines</TD>
</TR>
</TABLE>
</TD>
<TD>Uses the file's extension to determine output file type. Exports outline
formats to the file. For bitmap formats it will rasterize the glyph and output
that. There are different optional arguments for rasterizing images and for
direct outline output. bitdepth must be 1 or 8.</TD>
</TR>
<TR>
<TD><CODE>getPosSub</CODE></TD>
<TD><CODE>(lookup-subtable-name)</CODE></TD>
<TD>Returns any positioning/substitution data attached to the glyph controlled
by the lookup-subtable. If the name is "*" then returns data from all subtables.
<P>
The data are returned as a tuple of tuples. The first element of the subtuples
is the name of the lookup-subtable. The second element will be one of the
strings: "Position", "Pair", "Substitution", "AltSubs", "MultSubs","Ligature".
<P>
Positioning data will be followed by four small integers representing adjustments
to the: x position of the glyph, the y position, the horizontal advance,
and the vertical advance.
<P>
Pair data will be followed by the name of the other glyph in the pair and
then eight small integers representing adjustments to the: x position of
the first glyph, the y position, the horizontal advance, and the vertical
advance, and then a similar foursome for the second glyph.
<P>
Substitution data will be followed by a string containing the name of the
glyph to replace the current one.
<P>
Multiple and Alternate data will be followed by several strings each containing
the name of a replacement glyph.
<P>
Ligature data will be followed by several strings each containing the name
of a ligature component glyph.</TD>
</TR>
<TR>
<TD><CODE>importOutlines</CODE></TD>
<TD><CODE>(filename,[flags])</CODE></TD>
<TD>Uses the file's extension to determine behavior. Imports outline descriptions
(eps, svg, glif files) into the forground layer. Imports image descriptions
(bmp, png, xbm, etc.) into the background layer. Optionally, flags can be
used to control PostScript import, it'll be ignored for other file types.
Flags is a tuple of the following strings
<DL>
<DT>
toobigwarn
<DD>
Supress warning window about too big stroke width
<DT>
removeoverlap
<DD>
When FontForge detects that an expanded stroke will self-intersect, then
setting this flag will cause it to try to make things nice by removing the
intersections
<DT>
handle_eraser
<DD>
Certain programs use pens with white ink as erasers. When this flag is set,
FontForge will attempt to simulate that.
<DT>
correctdir
<DD>
</DL>
</TD>
</TR>
<TR>
<TD><CODE><A name="g-intersect">intersect</A></CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Leaves only areas in the intersection of contours. See also
<A href="#g-removeOverlap">removeOverlap</A> and
<A href="#g-exclude">exclude</A>.</TD>
</TR>
<TR>
<TD><CODE><A name="g-isWorthOutputting">isWorthOutputting</A></CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Returns whether the glyph is worth outputting into a font file. Basically
a glyph is worth outputting if it contains any contours, or references or
has had its width set.</TD>
</TR>
<TR>
<TD><CODE>preserveLayerAsUndo</CODE></TD>
<TD><CODE>([layer,dohints])</CODE></TD>
<TD>Normally undo handling is turned off during python scripting. If you
wish you may tell fontforge to preserve the current state of a layer so that
whatever you do later can be undone by the user. You may omit the layer parameter
(in which case the currently active layer will be used). You may also request
that hints be preserved (they are not, by default).</TD>
</TR>
<TR>
<TD><CODE><A name="g-removeOverlap">removeOverlap</A></CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Removes overlapping areas. See also <A href="#g-intersect">intersect</A>
and <A href="#g-exclude">exclude</A>.</TD>
</TR>
<TR>
<TD><CODE>removePosSub</CODE></TD>
<TD><CODE>(lookup-subtable-name)</CODE></TD>
<TD>Removes all data from the glyph corresponding to the given lookup-subtable.
If the name is "*" then all data will be removed.</TD>
</TR>
<TR>
<TD><CODE><A name="g-round">round</A></CODE></TD>
<TD><CODE>([factor])</CODE></TD>
<TD>Rounds the x and y coordinates of each point in the glyph. If factor
is specified then new-coord = round(factor*old-coord)/factor. See also
<A href="#g-cluster">cluster</A>.</TD>
</TR>
<TR>
<TD><CODE>selfIntersects</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Returns whether any of the contours in this glyph intersects any other
contour in the glyph (including itself).</TD>
</TR>
<TR>
<TD><CODE>simplify</CODE></TD>
<TD><CODE>([error-bound,flags,tan_bounds,<BR>
linefixup,linelenmax])</CODE></TD>
<TD>Tries to remove excess points in the glyph if doing so will not perturb
the curve by more than <CODE>error-bound</CODE>. Flags is a tuple of the
following strings
<DL>
<DT>
ignoreslopes
<DD>
Allow slopes to change
<DT>
ignoreextrema
<DD>
Allow removal of extrema
<DT>
smoothcurves
<DD>
Allow curve smoothing
<DT>
choosehv
<DD>
Snap to horizontal or vertical
<DT>
forcelines
<DD>
flatten bumps on lines
<DT>
nearlyhvlines
<DD>
Make nearly horizontal/vertical lines be so
<DT>
mergelines
<DD>
Merge adjacent lines into one
<DT>
setstarttoextremum
<DD>
Rotate the point list so that the start point is on an extremum
<DT>
removesingletonpoints
<DD>
If the contour contains just one point then remove it
</DL>
</TD>
</TR>
<TR>
<TD><CODE>stroke</CODE></TD>
<TD><CODE>("circular",width[,linecap,linejoin,flags])<BR>
("eliptical",width,minor-width,angle<BR>
[,linecap,linejoin,flags])<BR>
("caligraphic",width,height,angle[,flags])<BR>
("polygonal",contour[,flags])</CODE></TD>
<TD>Strokes the contours of the glyph using one of the indicated pens. Line
cap may be one of
<UL>
<LI>
butt
<LI>
round
<LI>
square
</UL>
<P>
line join may be
<UL>
<LI>
miter
<LI>
round
<LI>
bevel
</UL>
<P>
flags is a tuple containing some of the following strings
<UL>
<LI>
removeinternal
<LI>
removeexternal
<LI>
cleanup
</UL>
<P>
If a polygonal pen is specified, the contour must be a closed convex polygon
(no curved edges) with fewer than 100 vertices.</TD>
</TR>
<TR>
<TD><CODE>transform</CODE></TD>
<TD><CODE>(matrix[,flags])</CODE></TD>
<TD>Transforms the glyph by the matrix. The optional flags argument should
be a tuple containing any of the following strings:
<UL>
<LI>
partialRefs -- Don't transform any references in the glyph, but do transform
their offsets. This is useful if the refered glyph will be (or has been)
transformed.
<LI>
round -- Round to int after the transformation is done.
</UL>
</TD>
</TR>
<TR>
<TD><CODE>nltransform</CODE></TD>
<TD><CODE>(xexpr,yexpr)</CODE></TD>
<TD>xexpr and yexpr are strings specifying non-linear transformations that
will be applied to all points in the current layer (with xexpr being applied
to x values, and yexpr to y values, of course). The syntax for the expressions
is explained in the <A HREF="transform.html#Non-Linear">non-linear transform
dialog</A>.</TD>
</TR>
<TR>
<TD><CODE>unlinkRef</CODE></TD>
<TD><CODE>([ref-name])</CODE></TD>
<TD>Unlinks the reference to the glyph named <CODE>ref-name</CODE>. If
<CODE>ref-name</CODE> is omitted, unlinks all references.</TD>
</TR>
<TR>
<TD><CODE>unlinkThisGlyph</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Unlinks all the references to the current glyph within any other glyph
in the font.</TD>
</TR>
<TR>
<TD><CODE>useRefsMetrics</CODE></TD>
<TD><CODE>(ref-name[,flag])</CODE></TD>
<TD>Finds a reference with the given name and sets the "use_my_metrics" flag
on it (so this glyph will have the same advance width as the glyph the reference
points to).
<P>
If the optional flag argument is False, then the glyph will no longer have
its metrics bound to the reference.</TD>
</TR>
<TR>
<TD><CODE>validate</CODE></TD>
<TD><CODE>([force])</CODE></TD>
<TD>Validates the glyph and returns the
<CODE><A HREF="python.html#validation-state">validation_state</A></CODE>
of the glyph (except bit 0x1 will always be clear). If the glyph passed the
validation then the return value will be 0 (not 0x1). Otherwise the return
value will be the set of errors found. If force is specified true this will
always be validated, if force is unspecified (or specified as false) then
it will return the cached value if it is known, otherwise will validate it.</TD>
</TR>
<TR>
<TD><CODE>draw</CODE></TD>
<TD><CODE>(pen)</CODE></TD>
<TD>Draw the glyph's outline to the
<A href="http://www.robofab.org/objects/pen.html">pen argument.</A></TD>
</TR>
<TR>
<TD><CODE><A name="glyph-glyphPen">glyphPen</A></CODE></TD>
<TD><CODE>([replace=False])</CODE></TD>
<TD>Creates a new glyphPen which will draw into the current glyph. By default
the pen will replace any existing contours and references, but setting the
optional keyword argument, <CODE>replace</CODE> to false will retain the
old contents.</TD>
</TR>
<TR>
<TD colspan=3><STRONG>Note:</STRONG> Glyphs do not have an independent existence.
They live in fonts. You may not create them with stand-alone, only in the
context of a font. See <A href="#f-createChar">font.createChar</A></TD>
</TR>
</TABLE>
<P>
<TABLE id="type" border=1>
<CAPTION>
<A name="selection">selection</A>
</CAPTION>
<TR>
<TD colspan=3>This represents a font's selection. You may index it with an
encoding value (in the encoding ISO-646-US (ASCII) the character "A" has
encoding index 65), or with a glyph's name, or with a string like "uXXXXX"
where XXXXX represent the glyph's unicode codepoint in hex, or with a fontforge
glyph object. The value of indexing into a selection will be either True
or False.
<BLOCKQUOTE>
<PRE><FONT COLOR="Gray">>>></FONT> print fontforge.activeFont().selection[65]
<FONT COLOR="Gray">True</FONT>
</PRE>
</BLOCKQUOTE>
<P>
This type may not be pickled.</TD>
</TR>
<TR>
<TH colspan=3>Members</TH>
</TR>
<TR>
<TH>member</TH>
<TH colspan=2>comments</TH>
</TR>
<TR>
<TD><CODE>byGlyphs</CODE></TD>
<TD colspan=2>Returns another selection, just the same as this one except
that its iterator function will return glyphs (rather than encoding slots)
and will only return those entries for which glyphs exist. (This is read
only)</TD>
</TR>
<TR>
<TH colspan=3>Iterator Protocol</TH>
</TR>
<TR>
<TD><CODE>__iter__</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Returns an iterator for the selection which will return all selected
encoding slots in encoding order.</TD>
</TR>
<TR>
<TH colspan=3>Methods</TH>
</TR>
<TR>
<TH>method</TH>
<TH>args</TH>
<TH>comments</TH>
</TR>
<TR>
<TD><CODE>all</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Select everything.</TD>
</TR>
<TR>
<TD><CODE>none</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Deselect everything.</TD>
</TR>
<TR>
<TD><CODE>changed</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Select all glyphs which have changed.</TD>
</TR>
<TR>
<TD><CODE>invert</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Invert the selection.</TD>
</TR>
<TR>
<TD><CODE>select</CODE></TD>
<TD><CODE>(args)</CODE></TD>
<TD>There may be an arbetrary number of arguments. Each argument may be either:
<UL>
<LI>
A glyph name<BR>
Note: There need not be a glyph with this name in the font yet, but if you
use a standard name (like "A") fontforge will still know where that glyph
should be.
<LI>
An integer (this will be interpreted as either an encoding index or (default)
a unicode code point depending on the flags).
<LI>
A fontforge glyph.
<LI>
A tuple of flags.<BR>
(If you wish to specify a single flag it must still be in a tuple, and you
must append a trailing comma to the flag (so <CODE>("more",) </CODE>rather
than just <CODE><STRIKE>("more")</STRIKE></CODE>). FF needs the flags to
be in a tuple otherwise it can't distinguish them from glyph names)
<DL>
<DT>
unicode
<DD>
Interpret integer arguments as unicode code points
<DT>
encoding
<DD>
Interpret integer arguments as encoding indeces.
<DT>
more
<DD>
Specified items should be selected
<DT>
less
<DD>
Specified items should be deselected.
<DT>
singletons
<DD>
Specified items should be interpreted individually and mean the obvious.
<DT>
ranges
<DD>
Specified items should be interpreted in pairs and represent all encoding
slots between the start and end points specified by the pair. So
<CODE>.select(("ranges",None),"A","Z")</CODE> would select all the upper
case (latin) letters.
</DL>
</UL>
<P>
If the first argument is not a flag argument (or if it doesn't specify either
"more" or "less") then the selection will be cleared. So
<CODE>.select("A")</CODE> would produce a selection with only "A" selected,
<CODE>.select(("more",None),"A")</CODE> would add "A" to the current selection,
while <CODE>.select(("less",None),"A")</CODE> would remove "A" from the current
selection.</TD>
</TR>
</TABLE>
<P>
<TABLE id="type" border=1>
<CAPTION>
<A NAME="private">private</A>
</CAPTION>
<TR>
<TD colspan=3>This represents a font's postscript private dictionary. You
may index it with one of the standard names of things that live in the private
dictionary.
<P>
This type may not be pickled.</TD>
</TR>
<TR>
<TH colspan=3>Iterator Protocol</TH>
</TR>
<TR>
<TD><CODE>__iter__</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Returns an iterator for the dictionary which will return all entres.</TD>
</TR>
<TR>
<TH colspan=3>Methods</TH>
</TR>
<TR>
<TH>method</TH>
<TH>args</TH>
<TH>comments</TH>
</TR>
<TR>
<TD><CODE>guess</CODE></TD>
<TD><CODE>(name)</CODE></TD>
<TD>Guess a value for this this entry in the private dictionary. If fontforge
can't make a guess it will simply ignore the request.</TD>
</TR>
</TABLE>
<P>
<TABLE id="type" border=1>
<CAPTION>
<A NAME="math">math</A>
</CAPTION>
<TR>
<TD colspan=3>This represents a font's math constant table. Not all fonts
have math tables, and checking this field will not create the underlying
object, but examining or assigning to its members will create it..
<P>
This type may not be pickled.</TD>
</TR>
<TR>
<TH colspan=3>Members</TH>
</TR>
<TR>
<TD colspan=3>Any of the math constant names may be used as member names.<BR>
The list is long, and I shall not copy them all. Here is a subset<BR>
<CODE>ScriptPercentScaleDown<BR>
ScriptScriptPercentScaleDown<BR>
DelimitedSubFormulaMinHeight<BR>
...</CODE><BR>
(These names begin with capital letters, not python's conventions but
MicroSoft's)<BR>
These all take (16 bit) integer values.<BR>
I do not currently provide python access to any associated device tables.</TD>
</TR>
<TR>
<TH colspan=3>Methods</TH>
</TR>
<TR>
<TH>method</TH>
<TH>args</TH>
<TH>comments</TH>
</TR>
<TR>
<TD><CODE>exists</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Returns whether the font currently has an underlying math table associated
with it. Note that examining or assigning to one of the members will create
such a table.</TD>
</TR>
<TR>
<TD><CODE>clear</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Removes any underlying math table from the font.</TD>
</TR>
</TABLE>
<P>
<TABLE id="type" border=1>
<CAPTION>
<A name="Font">font</A>
</CAPTION>
<TR>
<TH colspan=3>Description</TH>
</TR>
<TR>
<TD colspan=3>The font type refers to a fontforge Font object. It generally
contains a list of glyphs, an encoding to order those glyphs, a fontname,
a list of GPOS/GSUB lookups and many other things.
<P>
This type may not be pickled.</TD>
</TR>
<TR>
<TH colspan=3>Creation</TH>
</TR>
<TR>
<TD><CODE>fontforge.font</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Creates a new font</TD>
</TR>
<TR>
<TH colspan=3>Members</TH>
</TR>
<TR>
<TH>member</TH>
<TH colspan=2>comments</TH>
</TR>
<TR>
<TD><CODE>activeLayer</CODE></TD>
<TD colspan=2>Returns currently active layer in the font (as an integer).
May be set to an integer or a layer name to change the active layer.</TD>
</TR>
<TR>
<TD><CODE>ascent</CODE></TD>
<TD colspan=2>The font's ascent</TD>
</TR>
<TR>
<TD><CODE>bitmapSizes</CODE></TD>
<TD colspan=2>A tuple with an entry for each bitmap strike attached to the
font. Each strike is identified by pixelsize (if the strike is a grey scale
font it will be indicated by
<CODE>(bitmap-depth<<16)|pixelsize</CODE>.
<P>
When setting this value pass in a tuple of the same format. Any existing
strike not specified in the tuple will be removed. Any new sizes will be
created (but not rasterized -- use <A href="#f-regenBitmaps">regenBitmaps</A>
for that).</TD>
</TR>
<TR>
<TD><CODE>capHeight</CODE></TD>
<TD colspan=2>(readonly) Computes the Cap Height (the height of capital letters
such as "E"). A negative number indicates the value could not be computed
(the font might have no capital letters because it was lower case only, or
didn't include glyphs for a script with capital letters).</TD>
</TR>
<TR>
<TD><CODE>changed</CODE></TD>
<TD colspan=2>Bit indicating whether the font has been modified. This is
(should be) maintained automatically, but you may set it if you wish.</TD>
</TR>
<TR>
<TD><CODE>cidcopyright</CODE></TD>
<TD COLSPAN=2>Copyright message of the cid-keyed font as a whole (ie. not
the current subfont).</TD>
</TR>
<TR>
<TD><CODE>cidfamilyname</CODE></TD>
<TD COLSPAN=2>Family name of the cid-keyed font as a whole (ie. not the current
subfont).</TD>
</TR>
<TR>
<TD><CODE>cidfontname</CODE></TD>
<TD COLSPAN=2>Font name of the cid-keyed font as a whole (ie. not the current
subfont).</TD>
</TR>
<TR>
<TD><CODE>cidfullname</CODE></TD>
<TD COLSPAN=2>Full name of the cid-keyed font as a whole (ie. not the current
subfont).</TD>
</TR>
<TR>
<TD><CODE>cidordering</CODE></TD>
<TD COLSPAN=2> </TD>
</TR>
<TR>
<TD><CODE>cidregistry</CODE></TD>
<TD COLSPAN=2> </TD>
</TR>
<TR>
<TD><CODE>cidsubfont</CODE></TD>
<TD COLSPAN=2>Returns the number index of the current subfont in the cid-keyed
font (or -1 if this is not a cid-keyed font).
<P>
May be set to an index (an integer) or a subfont fontname (a string) to change
the current subfont. (To find the name of the current subfont, simply use
.fontname).</TD>
</TR>
<TR>
<TD><CODE>cidsubfontcnt</CODE></TD>
<TD COLSPAN=2>Returns the number of subfonts in this cid-keyed font (or 0
if it is not a cid-keyed font)</TD>
</TR>
<TR>
<TD><CODE>cidsubfontnames</CODE></TD>
<TD COLSPAN=2>Returns a tuple of the subfont names in this cid-keyed font
(or None if it is not a cid-keyed font)</TD>
</TR>
<TR>
<TD><CODE>cidsupplement</CODE></TD>
<TD COLSPAN=2> </TD>
</TR>
<TR>
<TD><CODE>cidversion</CODE></TD>
<TD COLSPAN=2> </TD>
</TR>
<TR>
<TD><CODE>cidweight</CODE></TD>
<TD COLSPAN=2>Weight of the cid-keyed font as a whole</TD>
</TR>
<TR>
<TD><CODE>comment</CODE></TD>
<TD colspan=2>A comment associated with the font. Can be anything.</TD>
</TR>
<TR>
<TD><CODE>copyright</CODE></TD>
<TD colspan=2>PostScript copyright notice</TD>
</TR>
<TR>
<TD><CODE>cvt</CODE></TD>
<TD colspan=2>Returns a sequence object containing the font's cvt table.
Changes made to this object will be made to the font (this is a reference
not a copy).<BR>
The object has one additional method cvt.find(value[,low,high]) which finds
the index of value in the cvt table (or -1 if not found). If low and high
are specified then the index will be between [low,high).</TD>
</TR>
<TR>
<TD><CODE>default_base_filename</CODE></TD>
<TD colspan=2>The default base for the filename when generating a font</TD>
</TR>
<TR>
<TD><CODE>descent</CODE></TD>
<TD colspan=2>The font's descent</TD>
</TR>
<TR>
<TD><CODE>design_size</CODE></TD>
<TD colspan=2>Size (in pica points) for which this font was designed.</TD>
</TR>
<TR>
<TD><CODE>em</CODE></TD>
<TD colspan=2>The em size of the font. Setting this will scale the entire
font to the new size.</TD>
</TR>
<TR>
<TD><CODE>encoding</CODE></TD>
<TD colspan=2>The name of the current encoding. Setting it will change the
encoding used for indexing</TD>
</TR>
<TR>
<TD><CODE>familyname</CODE></TD>
<TD colspan=2>PostScript font family name</TD>
</TR>
<TR>
<TD><CODE>fondname</CODE></TD>
<TD colspan=2>Mac fond name</TD>
</TR>
<TR>
<TD><CODE>fontlog</CODE></TD>
<TD colspan=2>A comment associated with the font. Can be anything.</TD>
</TR>
<TR>
<TD><CODE>fontname</CODE></TD>
<TD colspan=2>PostScript font name<BR>
Note that in a CID keyed font this will be the name of the current subfont.
Use cidfontname for the name of the font as a whole.</TD>
</TR>
<TR>
<TD><CODE>fullname</CODE></TD>
<TD colspan=2>PostScript font name</TD>
</TR>
<TR>
<TD><CODE>gasp</CODE></TD>
<TD colspan=2>Returns a tuple of all gasp table entries. Each item in the
tuple is itself a tuple composed of a ppem (an integer) and a tuple of flags.
The flags are a chosen from:
<UL>
<LI>
gridfit
<LI>
antialias
<LI>
symmetric-smoothing
<LI>
gridfit+smoothing
</UL>
</TD>
</TR>
<TR>
<TD><CODE>gasp_version</CODE></TD>
<TD colspan=2>The version of the 'gasp' table. Currently this may be 0 or
1.</TD>
</TR>
<TR>
<TD><CODE>gpos_lookups</CODE></TD>
<TD colspan=2>Returns a tuple of all positioning lookup names in the font.
This member cannot be set.</TD>
</TR>
<TR>
<TD><CODE>gsub_lookups</CODE></TD>
<TD colspan=2>Returns a tuple of all substitution lookup names in the font.
This member cannot be set.</TD>
</TR>
<TR>
<TD><CODE>guide</CODE></TD>
<TD colspan=2>A copy of the font's guide layer</TD>
</TR>
<TR>
<TD><CODE>hasvmetrics</CODE></TD>
</TR>
<TR>
<TD><CODE>head_optimized_for_cleartype</CODE></TD>
</TR>
<TR>
<TD><CODE>hhea_ascent</CODE></TD>
</TR>
<TR>
<TD><CODE>hhea_ascent_add</CODE></TD>
</TR>
<TR>
<TD><CODE>hhea_descent</CODE></TD>
</TR>
<TR>
<TD><CODE>hhea_descent_add</CODE></TD>
</TR>
<TR>
<TD><CODE>hhea_linegap</CODE></TD>
</TR>
<TR>
<TD><CODE><A NAME="horizontal-baseline">horizontalBaseline</A></CODE></TD>
<TD COLSPAN=2>Returns a tuple of tuples containing the horizontal baseline
information in the font (the 'BASE' table). If there is no information NONE
will be returned, otherwise the format of the tuple is:<BR>
<CODE>((tuple of baseline tags used), (tuple of script information))</CODE>
<BR>
The <CODE>(tuple of baseline tags used)</CODE> is simply a tuple of 4 letter
strings as <CODE>("hang", "ideo", "romn")</CODE> these are standard baseline
tag names as defined in the opentype spec. The number of entries here, and
their order is important as there will be subsequent tuples (in the script
tuple) which use the same ordering.
<P>
The <CODE>(tuple of script information)</CODE> is again a tuple of <CODE>script
information</CODE> tuples.
<P>
A <CODE>script information</CODE> tuple looks like<BR>
<CODE>(script-tag,default-baseline-tag, (tuple of baseline positions), (tuple
of language extents))</CODE><BR>
If there are no baseline tags defined (an empty tuple), then the
<CODE>default-baseline-tag</CODE> and the <CODE>(tuple of baseline
positions)</CODE> will be NONE. Otherwise both tags will be 4 character strings,
and the <CODE>(tuple of baseline positions)</CODE> will be a tuple of numbers
(in the same order as the <CODE>(tuple of baseline tags used)</CODE> above)
specifying the relative positions of each baseline for this script.
<P>
A <CODE>(tuple of language extents)</CODE> is a tuple of <CODE>language
extent</CODE> tuples.
<P>
A <CODE>language extent</CODE> tuple is<BR>
<CODE>(language-tag,min-extent,max-extent, (tuple of feature
extents))</CODE><BR>
<CODE>language-tag</CODE> is a 4 letter string specifying an opentype
language,<CODE>min</CODE>/<CODE>max-extent</CODE> are numbers specifying
how far above and below the baseline characters go in this script/language.
<P>
A <CODE>(tuple of feature extents></CODE> is a tuple of <CODE>feature
extent</CODE> tuples.
<P>
A <CODE>feature extent</CODE> tuple is<BR>
<CODE>(feature-tag,min-extent,max-extent, (tuple of feature
extents))</CODE><BR>
<CODE>feature-tag</CODE> is a 4 letter string specifying an opentype (GPOS
or GSUB) feature tag,<CODE>min</CODE>/<CODE>max-extent</CODE> are numbers
specifying how far above and below the baseline characters go in this
script/language with the feature applied.
<P>
<B>Example:</B>
<BLOCKQUOTE>
<PRE>(("hang","ideo","romn"),
(("cyrl","romn",(1405,-288,0),()),
("grek","romn",(1405,-288,0),()),
("latn","romn",(1405,-288,0),
("dflt",-576,1913,
("NoAc",-576,1482))
("ENG ",-576,1482,())
)
)
)
</PRE>
</BLOCKQUOTE>
</TD>
</TR>
<TR>
<TD><CODE>is_cid</CODE></TD>
<TD colspan=2>Indicates whether the font is a cid-keyed font or not. (Read-only)</TD>
</TR>
<TR>
<TD><CODE>is_quadratic</CODE></TD>
<TD colspan=2>Deprecated. Whether the contours should be interpretted as
a set of quadratic or cubic splines. Setting this value has the side effect
of converting the entire font into the other format
<P>
Now each layer may have its own setting for this value, which should be set
on the font's <A HREF="python.html#f-layers">layers</A> object.</TD>
</TR>
<TR>
<TD><CODE>isnew</CODE></TD>
<TD colspan=2>A flag indicating that this is a new font</TD>
</TR>
<TR>
<TD><CODE>italicangle</CODE></TD>
</TR>
<TR>
<TD><CODE>macstyle</CODE></TD>
</TR>
<TR>
<TD><CODE>layer_cnt</CODE></TD>
<TD COLSPAN=2>The number of layers in the font. (Read only. Can change using
<CODE>add</CODE> and <CODE>del</CODE> operations on the
<A HREF="python.html#f-layers">layers</A> array)</TD>
</TR>
<TR>
<TD><CODE><A NAME="f-layers">layers</A></CODE></TD>
<TD COLSPAN=2>Returns a dictionary like object with information on the layers
of the font -- a name and a boolean indicating whether the layer is quadratic
or not.
<P>
You may remove a layer with <CODE>del font.layers["unneeded
layer"]</CODE>;<BR>
You may add a new layer with <CODE>font.layers.add("layer-name",is_quadratic[,
is_background])</CODE>;<BR>
You may change a layer's name with <CODE>font.layers["layer"].name =
"new-name"</CODE>;<BR>
You may change the type of splines in a layer with
<CODE>font.layers["layer"].is_quadratic = True</CODE>;<BR>
You may change whether it is a background layer by
<CODE>font.layers["layer"].is_background = True</CODE>;
<P>
Note: The layers that live in the font are different from layers that live
in a glyph. These objects do not have the Layer type documented earlier.</TD>
</TR>
<TR>
<TD><CODE>loadState</CODE></TD>
<TD colspan=2>A bitmask indicating non-fatal errors found when loading the
font. (readonly)
<TABLE>
<TR>
<TD>0x01</TD>
<TD>Bad PostScript entry in 'name' table</TD>
</TR>
<TR>
<TD>0x02</TD>
<TD>Bad 'glyf' or 'loca' table</TD>
</TR>
<TR>
<TD>0x04</TD>
<TD>Bad 'CFF ' table</TD>
</TR>
<TR>
<TD>0x08</TD>
<TD>Bad 'hhea', 'hmtx', 'vhea' or 'vmtx' table</TD>
</TR>
<TR>
<TD>0x10</TD>
<TD>Bad 'cmap' table</TD>
</TR>
<TR>
<TD>0x20</TD>
<TD>Bad 'EBLC', 'bloc', 'EBDT' or 'bdat' (embedded bitmap) table</TD>
</TR>
<TR>
<TD>0x40</TD>
<TD>Bad Apple GX advanced typography table</TD>
</TR>
<TR>
<TD>0x80</TD>
<TD>Bad OpenType advanced typography table (GPOS, GSUB, GDEF, BASE)</TD>
</TR>
<TR>
<TD>0x100</TD>
<TD>Bad OS/2 version number<BR>
Windows will reject all fonts with a OS/2 version number of 0 and will reject
OT-CFF fonts with a version number of 1</TD>
</TR>
</TABLE>
</TD>
</TR>
<TR>
<TD><CODE>maxp_FDEFs</CODE></TD>
<TD colspan=2>The number of function definitions used by the tt program</TD>
</TR>
<TR>
<TD><CODE>maxp_IDEFs</CODE></TD>
<TD colspan=2>The number of instruction definitions used by the tt program</TD>
</TR>
<TR>
<TD><CODE>maxp_maxStackDepth</CODE></TD>
<TD colspan=2>The maximum stack depth used by the tt program</TD>
</TR>
<TR>
<TD><CODE>maxp_storageCnt</CODE></TD>
<TD colspan=2>The number of storage locations used by the tt program</TD>
</TR>
<TR>
<TD><CODE>maxp_twilightPtCnt</CODE></TD>
<TD colspan=2>The number of points in the twilight zone of the tt program</TD>
</TR>
<TR>
<TD><CODE>maxp_zones</CODE></TD>
<TD colspan=2>The number of zones used in the tt program</TD>
</TR>
<TR>
<TD><CODE>multilayer</CODE></TD>
</TR>
<TR>
<TD><CODE>onlybitmaps</CODE></TD>
<TD colspan=2>A flag indicating that this font only contains bitmaps. No
outlines.</TD>
</TR>
<TR>
<TD><CODE>os2_codepages</CODE></TD>
<TD COLSPAN=2>A 2 element tuple containing the OS/2 Codepages field</TD>
</TR>
<TR>
<TD><CODE>os2_family_class</CODE></TD>
</TR>
<TR>
<TD><CODE>os2_fstype</CODE></TD>
</TR>
<TR>
<TD><CODE>os2_panose</CODE></TD>
</TR>
<TR>
<TD><CODE>os2_strikeypos</CODE></TD>
</TR>
<TR>
<TD><CODE>os2_strikeysize</CODE></TD>
</TR>
<TR>
<TD><CODE>os2_subxoff</CODE></TD>
</TR>
<TR>
<TD><CODE>os2_subxsize</CODE></TD>
</TR>
<TR>
<TD><CODE>os2_subyoff</CODE></TD>
</TR>
<TR>
<TD><CODE>os2_subysize</CODE></TD>
</TR>
<TR>
<TD><CODE>os2_supxoff</CODE></TD>
</TR>
<TR>
<TD><CODE>os2_supxsize</CODE></TD>
</TR>
<TR>
<TD><CODE>os2_supyoff</CODE></TD>
</TR>
<TR>
<TD><CODE>os2_supysize</CODE></TD>
</TR>
<TR>
<TD><CODE>os2_typoascent</CODE></TD>
</TR>
<TR>
<TD><CODE>os2_typoascent_add</CODE></TD>
</TR>
<TR>
<TD><CODE>os2_typodescent</CODE></TD>
</TR>
<TR>
<TD><CODE>os2_typodescent_add</CODE></TD>
</TR>
<TR>
<TD><CODE>os2_typolinegap</CODE></TD>
</TR>
<TR>
<TD><CODE>os2_use_typo_metrics</CODE></TD>
</TR>
<TR>
<TD><CODE>os2_unicoderanges</CODE></TD>
<TD COLSPAN=2>A 4 element tuple containing the OS/2 Unicode Ranges field</TD>
</TR>
<TR>
<TD><CODE>os2_vendor</CODE></TD>
</TR>
<TR>
<TD><CODE>os2_version</CODE></TD>
</TR>
<TR>
<TD><CODE>os2_weight</CODE></TD>
</TR>
<TR>
<TD><CODE>os2_weight_width_slope_only</CODE></TD>
</TR>
<TR>
<TD><CODE>os2_width</CODE></TD>
</TR>
<TR>
<TD><CODE>os2_winascent</CODE></TD>
</TR>
<TR>
<TD><CODE>os2_winascent_add</CODE></TD>
</TR>
<TR>
<TD><CODE>os2_windescent</CODE></TD>
</TR>
<TR>
<TD><CODE>os2_windescent_add</CODE></TD>
</TR>
<TR>
<TD><CODE><A NAME="path">path</A></CODE></TD>
<TD colspan=2>(readonly) Returns a string containing the name of the file
from which the font was originally read (in this session), or if this is
a new font, returns a made up filename in the current directory named something
like "Untitled1.sfd". See also <A HREF="#sfd-path">sfd_path</A>.</TD>
</TR>
<TR>
<TD><CODE><A NAME="font-persistent">persistent</A></CODE></TD>
<TD colspan=2>Whatever you want -- though I recommend you store a dict here
(these data will be saved as a pickled object in the sfd file. It is your
job to insure that whatever you put here can be pickled)
<P>
If you do store a dict then the following entries will be treated specially:
<TABLE border=1>
<TR>
<TD>initScriptString</TD>
<TD>If present, and if this is a string, then each time the font is loaded
from an sfd file, this string will be passed to the python interpretter.
Note: This is a string, not a function. Function code cannot be pickled.
Since it is a string it will receive no arguments, but the current font will
be available in the activeFont method of the fontforge module.
<P>
This string will be interpretted before the loadFontHook of the
<A HREF="python.html#module-hooks">module hooks</A> dictionary.
<P>
One possible behavior for this string is to define function hooks to be stored
in the temporary dict described below.</TD>
</TR>
</TABLE>
</TD>
</TR>
<TR>
<TD><CODE>math</CODE></TD>
<TD colspan=2>Returns an <A HREF="#math">object which provides information
on the font's underlying math constant table. There is only one of these
per font.</A></TD>
</TR>
<TR>
<TD><CODE>private</CODE></TD>
<TD colspan=2>Returns a <A HREF="#private">dictionary like object representing
the PostScript private dictionary</A> for the font. Changing entries in this
object will change them in the font. (It's a reference, not a copy).
<P>
There is an iterator associated with this entry.</TD>
</TR>
<TR>
<TD><CODE><A NAME="Font_privateState">privateState</A></CODE></TD>
<TD colspan=2>Checks the (PostScript) Private dictionary and returns a bitmask
of some common errors.
<TABLE>
<TR>
<TD>0x000001</TD>
<TD>Odd number of elements in either the BlueValues or OtherBlues array.</TD>
</TR>
<TR>
<TD>0x000002</TD>
<TD>Elements in either the BlueValues or OtherBlues are disordered.</TD>
</TR>
<TR>
<TD>0x000004</TD>
<TD>Too many elements in either the BlueValues or OtherBlues array.</TD>
</TR>
<TR>
<TD>0x000008</TD>
<TD>Elements in either the BlueValues or OtherBlues array are too close (must
be at least 2*BlueFuzz +1 appart.</TD>
</TR>
<TR>
<TD>0x000010</TD>
<TD>Elements in either the BlueValues or OtherBlues array are not integers.</TD>
</TR>
<TR>
<TD>0x000020</TD>
<TD>Alignment zone height in either the BlueValues or OtherBlues array is
too big for the value of BlueScale.</TD>
</TR>
<TR>
<TD>0x000100</TD>
<TD>Odd number of elements in either the FamilyBlues or FamilyOtherBlues
array.</TD>
</TR>
<TR>
<TD>0x000200</TD>
<TD>Elements in either the FamilyBlues or FamilyOtherBlues are disordered.</TD>
</TR>
<TR>
<TD>0x000400</TD>
<TD>Too many elements in either the FamilyBlues or FamilyOtherBlues array.</TD>
</TR>
<TR>
<TD>0x000800</TD>
<TD>Elements in either the FamilyBlues or FamilyOtherBlues array are too
close (must be at least 2*BlueFuzz +1 appart.</TD>
</TR>
<TR>
<TD>0x001000</TD>
<TD>Elements in either the FamilyBlues or FamilyOtherBlues array are not
integers.</TD>
</TR>
<TR>
<TD>0x002000</TD>
<TD>Alignment zone height in either the FamilyBlues or FamilyOtherBlues array
is too big for the value of BlueScale.</TD>
</TR>
<TR>
<TD>0x010000</TD>
<TD>Missing BlueValues entry.</TD>
</TR>
<TR>
<TD>0x020000</TD>
<TD>Bad BlueFuzz entry.</TD>
</TR>
<TR>
<TD>0x040000</TD>
<TD>Bad BlueScale entry.</TD>
</TR>
<TR>
<TD>0x080000</TD>
<TD>Bad StdHW entry.</TD>
</TR>
<TR>
<TD>0x100000</TD>
<TD>Bad StdVW entry.</TD>
</TR>
<TR>
<TD>0x200000</TD>
<TD>Bad StemSnapH entry.</TD>
</TR>
<TR>
<TD>0x400000</TD>
<TD>Bad StemSnapV entry.</TD>
</TR>
<TR>
<TD>0x800000</TD>
<TD>StemSnapH does not include StdHW.</TD>
</TR>
<TR>
<TD>0x1000000</TD>
<TD>StemSnapV does not include StdVW.</TD>
</TR>
<TR>
<TD>0x2000000</TD>
<TD>Bad BlueShift entry.</TD>
</TR>
</TABLE>
</TD>
</TR>
<TR>
<TD><CODE>selection</CODE></TD>
<TD colspan=2>Returns a reference to an <A href="#selection">array-like object
representing the font's selection</A>. There is one entry for each encoding
slot (there may not be a glyph attached to every encoding slot). You may
set this with a tuple of integers (or boolean values). There should not be
more entries in the tuple than there are encoding slots in the current encoding.
A <CODE>True</CODE> or non-0 value means the slot is selected.</TD>
</TR>
<TR>
<TD><CODE><A NAME="sfd-path">sfd_path</A></CODE></TD>
<TD colspan=2>(readonly) Returns a string (or None) containing the name of
the sfd file associated with this font. Sometimes this will be the same as
<A HREF="#path">path</A> (above).</TD>
</TR>
<TR>
<TD><CODE>sfnt_names</CODE></TD>
<TD colspan=2>The strings in the sfnt 'name' table. A tuple of all ms names.
Each name is itself a tuple of strings (language,strid,string). Language
may be either the (english) name of the language/locale, or the number
representing that language in MicroSoft's specification. Strid may be one
of the (english) string names (Copyright, Family, SubFamily, etc.) or the
numeric value of that item. The string itself is in UTF-8.
<P>
Mac names will be automagically created from ms names</TD>
</TR>
<TR>
<TD><CODE>sfntRevision</CODE></TD>
<TD colspan=2>The font revision field stored in the 'head' table of an sfnt.
This is documented to be a fixed 16.16 number (that is a 32 bit number with
the binary point between bits 15 and 16).
<P>
The field may be unset (in which case when the font is generated, FontForge
will guess a default value from one of the version strings).
<P>
The value returned with be <CODE>None</CODE> if the field is unset or a double.
<P>
You may set it to <CODE>None</CODE> which "unsets" it, or to a double value,
or to an integer. The integer will be treated as a 32 bit integer and right
shifted by 16 to get a 16.16 value).</TD>
</TR>
<TR>
<TD><CODE>size_feature</CODE></TD>
<TD colspan=2>The OpenType 'size' feature has two formats. It may either
represent the design size of the font (and nothing else) or the design size,
and range (top and bottom point sizes for which this design works), a style
id (used to represent this design size throughout the font family) and a
set of language/string pairs used to represent this design size in the menu.
<P>
If no size information is specified in the font FontForge will return None.
<P>
If only the design size is specified, FontForge will return a tuple containing
a single element: the point size for which the font was designed. (This is
returned as a real number -- the field can represent tenths of a point).
<P>
Otherwise FontForge returns a tuple containing five elements, the design
size, the bottom of the design range, the top, the style id and a tuple of
tuples. Each sub-tuple is a language/string pair. Language may be either
the (english) name of the language/locale, or The string itself is in UTF-8.</TD>
</TR>
<TR>
<TD><CODE>strokedfont</CODE></TD>
<TD colspan=2>is this a stroked font?</TD>
</TR>
<TR>
<TD><CODE>strokewidth</CODE></TD>
<TD colspan=2>the stroke width of a stroked font</TD>
</TR>
<TR>
<TD><CODE><A NAME="font-temporary">temporary</A></CODE></TD>
<TD colspan=2>Whatever you want -- though I recommend you store a dict here
(these data will be lost once the font is closed)
<P>
If you do store a dict then the following entries will be treated specially:
<TABLE border=1>
<TR>
<TD>generateFontPreHook</TD>
<TD>If present, and if this is a function it will be called just before a
font is generated. It will be called with the font and the filename to which
the font will be written.</TD>
</TR>
<TR>
<TD>generateFontPostHook</TD>
<TD>If present, and if this is a function it will be called just after a
font is generated. It will be called with the font and the filename to which
the font will be written.</TD>
</TR>
</TABLE>
</TD>
</TR>
<TR>
<TD><CODE>texparameters</CODE></TD>
<TD colspan=2>Returns a tuple of <A HREF="fontinfo.html#TeX">TeX font
parameters</A>. TeX font type followed by 22 parameters. Font type is one
of:
<UL>
<LI>
text
<LI>
mathsym
<LI>
mathext
<LI>
unset
</UL>
<P>
In case of "unset" default values for font parameters will be returned.</TD>
</TR>
<TR>
<TD><CODE>uniqueid</CODE></TD>
</TR>
<TR>
<TD><CODE>upos</CODE></TD>
<TD colspan=2>underline position</TD>
</TR>
<TR>
<TD><CODE>userdata</CODE></TD>
<TD colspan=2>Deprecated name for
<A HREF="python.html#font-temporary">temporary</A> above</TD>
</TR>
<TR>
<TD><CODE>uwidth</CODE></TD>
<TD colspan=2>underline width</TD>
</TR>
<TR>
<TD><CODE>version</CODE></TD>
<TD colspan=2>PostScript font version string</TD>
</TR>
<TR>
<TD><CODE>verticalBaseline</CODE></TD>
<TD COLSPAN=2>Same format as
<A HREF="#horizontal-baseline">horizontal_baseline</A>, which see.</TD>
</TR>
<TR>
<TD><CODE>vertical_origin</CODE></TD>
<TD COLSPAN=2>deprecated</TD>
</TR>
<TR>
<TD><CODE>vhea_linegap</CODE></TD>
</TR>
<TR>
<TD><CODE>weight</CODE></TD>
<TD colspan=2>PostScript font weight string</TD>
</TR>
<TR>
<TD><CODE>woffMajor</CODE></TD>
<TD colspan=2>The major version number of a woff file, an integer.
<P>
The field may be unset (in which case when the font is generated, FontForge
will guess a default value from one of the version strings).
<P>
The value returned with be <CODE>None</CODE> if the field is unset or an
integer.
<P>
You may set it to <CODE>None</CODE> which "unsets" it, or to an integer.</TD>
</TR>
<TR>
<TD><CODE>woffMinor</CODE></TD>
<TD colspan=2>The minor version number of a woff file, an integer.
<P>
The field may be unset (in which case when the font is generated, FontForge
will guess a default value from one of the version strings).
<P>
The value returned with be <CODE>None</CODE> if the field is unset or an
integer.
<P>
You may set it to <CODE>None</CODE> which "unsets" it, or to an integer.</TD>
</TR>
<TR>
<TD><CODE>woffMetadata</CODE></TD>
<TD colspan=2>Any metadata associated with a woff file. This is a utf8 string
containing unparsed xml.</TD>
</TR>
<TR>
<TD><CODE>xHeight</CODE></TD>
<TD colspan=2>(readonly) Computes the X Height (the height of lower case
letters such as "x"). A negative number indicates the value could not be
computed (the font might have no lower case letters because it was upper
case only, or didn't include glyphs for a script with lower case letters).</TD>
</TR>
<TR>
<TH colspan=3>Iterator Protocol</TH>
</TR>
<TR>
<TD><CODE>__iter__</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Returns an iterator for the font which will run through the font, in
gid order, returning glyph names</TD>
</TR>
<TR>
<TD colspan=2><CODE><name> in f</CODE></TD>
<TD>Returns whether the font contains a glyph with the given name.</TD>
</TR>
<TR>
<TD colspan="2">Other iterators over the font:</TD>
<TD><A HREF="python.html#selection">selection</A>,
font.<A HREF="python.html#font-find">find</A>(),
font.<A HREF="python.html#font-glyphs">glyphs</A>()</TD>
</TR>
<TR>
<TH colspan=3>Mapping Protocol</TH>
</TR>
<TR>
<TD colspan=2><CODE>len(f)</CODE></TD>
<TD>The number of glyph slots in the current encoding</TD>
</TR>
<TR>
<TD colspan=2><CODE>f[i]</CODE></TD>
<TD>If <EM>i</EM> is an integer, then returns the glyph at that encoding.
If a string then returns the glyph with that name. May not be assigned to.</TD>
</TR>
<TR>
<TH colspan=3>Methods</TH>
</TR>
<TR>
<TH>method</TH>
<TH>args</TH>
<TH>comments</TH>
</TR>
<TR>
<TD><CODE>addAnchorClass</CODE></TD>
<TD><CODE>(lookup-subtable-name,<BR>
new-anchor-class-name)</CODE></TD>
<TD>Adds an anchor class to the specified (anchor) subtable.</TD>
</TR>
<TR>
<TD><a name="addKerningClass"><CODE>addKerningClass</CODE></a></TD>
<TD><CODE>(lookup-name,new-subtable-name,<BR>
first-classes,<BR>
second-classes,<BR>
offsets<BR>
[,after])</CODE>
<P ALIGN=Center>
<STRONG>or</STRONG>
<P>
<CODE>(lookup-name,new-subtable-name,<BR>
separation,<BR>
first-classes,<BR>
second-classes<BR>
[,onlyCloser,autokern,after])</CODE>
<P ALIGN=Center>
<STRONG>or</STRONG>
<P>
<CODE>(lookup-name,new-subtable-name,<BR>
separation,class-distance,<BR>
,first-glyph-list,<BR>
second-glyph-list,<BR>
[,onlyCloser,autokern,after])</CODE>
<P ALIGN=Center>
<STRONG>or</STRONG>
<P>
<CODE>(lookup-name,new-subtable-name,<BR>
separation,class-distance,<BR>
[,onlyCloser,autokern,after])</CODE></TD>
<TD>Creates a new subtable and a new kerning class in the named lookup. The
classes arguments are tuples of tuples of glyph names (each sub-tuble of
glyph names is a kerning class). The offsets argument is a tuple of kerning
offsets. There must be as many entries as
<CODE>len(first-class)*len(second-class)</CODE>. The optional after argument
is used to specify the order of the subtable within the lookup.
<P>
The second format will cause FontForge to auto kern the subtable. The separation
argument specifies the desired optical distance between any two glyphs (if
this is specified as 0 then the kerning class will be designed so glyphs
just touch each other). Again the user specifies two sets of predefined classes.
If the (optional) <CODE>onlyCloser</CODE> flag is set true then only negative
kerning values will be inserted into the table.
<P>
In the third format the user merely specifies two lists of glyphs to be used,
fontforge will look for similarities among among the glyphs and guess at
classes. The class-distance argument to determine how precise the classes
should match (1 is very tight matching, 20 is rather loose).
<P>
In the last format the font's selection will be used to specify the list
of glyphs to be examined (and the same list will be used for both the left
and right glyphs -- but fontforge will probably find different classes).</TD>
</TR>
<TR>
<TD><CODE><A name="font-addLookup">addLookup</A></CODE></TD>
<TD><CODE>(new-lookup-name,type,flags,<BR>
feature-script-lang-tuple<BR>
[,after-lookup-name)</CODE></TD>
<TD>Creates a new lookup with the given name, type and flags. It will tag
it with any indicated features. The type of one of
<UL>
<LI>
gsub_single
<LI>
gsub_multiple
<LI>
gsub_alternate
<LI>
gsub_ligature
<LI>
gsub_context
<LI>
gsub_contextchain
<LI>
gsub_revesechain
<LI>
morx_indic
<LI>
morx_context
<LI>
morx_insert
<LI>
gpos_single
<LI>
gpos_pair
<LI>
gpos_cursive
<LI>
gpos_mark2base
<LI>
gpos_mark2ligature
<LI>
gpos_mark2mark
<LI>
gpos_context
<LI>
gpos_contextchain
<LI>
kern_statemachine
</UL>
<P>
The flags argument is a tuple of strings. At most one of these strings may
be the name of a mark class. The others are:
<UL>
<LI>
right_to_left
<LI>
ignore_bases
<LI>
ignore_ligatures
<LI>
ignore_marks
</UL>
<P>
A feature-script-lang tuple is a tuple with one entry for each feature (there
may be no entries if there are no features). Each entry is itself a two element
tuple, the first entry is a string containing a 4 letter feature tag, and
the second entry is another tuple (potentially empty) with an entry for each
script for which the feature is active. Each entry here is itself a two element
tuple. The first element is a 4 letter script tag and the second is a tuple
of languages. Each entry in the language tuple is a four letter language.
Example: (("liga",(("latn",("dflt")),)),)<BR>
The optional final argument allows you to specify the ordering of the lookup.
If not specified the lookup will be come the first lookup in its table.</TD>
</TR>
<TR>
<TD><CODE>addLookupSubtable</CODE></TD>
<TD><CODE>(lookup-name,<BR>
new-subtable-name<BR>
[,after-subtable-name])</CODE></TD>
<TD>Creates a new subtable within the specified lookup.
The lookup name should be a string specifying an existing lookup.
The subtable name should also be a string and should not match
any currently existing subtable in the lookup.
The optional final
argument allows you to specify the ordering within the lookup. If not specified
this subtable will be first in the lookup.
<P>
If you want to create a subtable in a contextual lookup, then use
<a href="#addContextualSubtable"><CODE>addContextualSubtable</CODE></a> below.
If you want to create a kerning class subtable, then use
<a href="#addKerningClass"><CODE>addKerningClass</CODE></a> above.
</TD>
</TR>
<TR>
<TD><a name="addContextualSubtable"><CODE>addContextualSubtable</CODE></a></TD>
<TD><CODE>(lookup-name,<BR>
new-subtable-name<BR>
type<BR>
rule<BR>
[,afterSubtable=]
[,bclasses=]
[,mclasses=]
[,fclasses=]
[,bclassnames=]
[,mclassnames=]
[,fclassnames=] )</CODE></TD>
<TD>Creates a new subtable within the specified contextual lookup
(contextual, contextual chaining, or reverse contextual chaining).
The lookup name should be a string specifying an existing lookup.
The subtable name should also be a string and should not match
any currently existing subtable in the lookup.
<P>The <CODE>type</CODE> should be one of the strings "glyph", "class",
"coverage" or "reversecoverage".
The <CODE>rule</CODE> should be a string specifying a string to match
and a set of lookups to apply once the match has been made. (See below
for more details).
<P>The remaining arguments are optional, keyword arguments.
<UL><LI><CODE>afterSubtable=</CODE>, if present this should be followed by
a string, the name of a subtable after which this one is to be placed
in the lookup. If not specified this subtable will be first in the
lookup.
<LI><CODE>bclasses=, fclasses=, mclasses=</CODE> these three arguments
specify sets of glyph classes for when <CODE>type="class"</CODE>. They
should be a tuple of thingies where each thingy is either a string
containing a list of space separated glyph names, or another tuple
containing a set of strings, each a glyph name. Note that the first
class is magic and should usually be left as a null string.
<LI><CODE>bclassnames=, fclassnames=, mclassnames=</CODE> These provide
names for the glyph classes described above. These names are optional,
but can be convenient. These are tuples of strings. There should be the
same number of entries in <CODE>bclassnames</CODE> as there are in
<CODE>bclasses</code>.
</UL>
<DL>
<DT>
When <CODE>type="glyph"</CODE>
<DD>The rule should look something like:<BR/>
<CODE> glyph-name1 glyph-name2 | glyph-name3 @<lookup-name> | glyph-name4</CODE><BR/>
The "|"s divide between backtrack, match and lookahead sections. So this
example would match it the current glyph were named <CODE>glyph-name3</CODE>
and it were preceded by <CODE>glyph-name2</CODE> and that by
<CODE>glyph-name1</CODE> and followed by <CODE>glyph-name4</CODE>. If
the match were successful then the lookup named <CODE>lookup-name</CODE>
would be applied. The @<> are litteral characters and should be
present in the rule.
<P>If the invoked lookup is a ligature lookup then it should be invoked
after the first glyph that forms the lookup (rather than the last) and
all glyphs that might make up the lookup should be in the match section.
So...<BR/>
<CODE> e | f @<ff-lig> f l | o</CODE><BR/>
would only apply the <CODE>ff-lig</CODE> lookup if the <CODE>ffl</CODE>
were preceeded by <CODE>e</CODE> and followed by <CODE>o</CODE>.
<DT>
When <CODE>type="class"</CODE>
<DD>The rule should look something like:<BR/>
<CODE> class-name1 class-name2 | class-name3 @<lookup-name> | class-name4</CODE><BR/>
Very similar to the case of glyphs, except that instead of glyph names
we have class names here. It is possible to have different sets of
class names in the three different sections (backtrack, match and
lookahead). If you don't specify any class names then you must use
numbers instead, each number refering to the class at that position in
the tuple (the first class will be class 0, the second class 1, and so
on).
<DT>
When <CODE>type="coverage"</CODE>
<DD>The rule should look something like:<BR/>
<CODE> [g1 g2] [g3 g4] | [g5 g6 g7] @<lookup-name> | [g8 g9]</CODE><BR/>
Each entry within brackets, <CODE>[]</CODE>, represents a coverage table
and should be a list of glyph names. The brackets are specified literally.
<DT>
When <CODE>type="reversecoverage"</CODE>
<DD>The rule should look something like:<BR/>
<CODE> [g1 g2] [g3 g4] | [g5 g6 g7] => [rg1 rg2 rg3] | [g8 g9]</CODE><BR/>
Very similar to normal coverage tables except that instead of specifying
a lookup there are replacement glyphs inline. There must be the same
number of replacement glyphs (<CODE>rg1, rg2, rg3</CODE>) as match
glyphs (<CODE>g5, g6, g7</CODE>) and there may be only one coverage
table in the match section.
</DL>
<STRONG>WARNING</STRONG> This format has some limitations, if there are
multiple lookups they will be applied in textual order (First lookup
in the string is the first one applied). This limitation is also
present in Adobe's feature files so I hope it shan't be a severe
limitation.
</TD>
</TR>
<TR>
<TD><CODE>addSmallCaps</CODE></TD>
<TD><CODE>(scheight=,<BR>
capheight=,<BR>
lcstem=,<BR>
ucstem=,<BR>
symbols=,<BR>
letter_extension=,<BR>
symbol_extension=,<BR>
stem_height_factor=)</CODE></TD>
<TD>This function uses keyword parameters. None is required, if omitted a
default value will be used (generally found by analyzing the font).
<P>
For each selected letter, this function will create a corresponding small
caps glyph. If you set the <CODE>symbol</CODE> keyword to <CODE>true</CODE>
it will also create small caps variants of digits and symbols.
<P>
The outlines of the new glyph will be based on the outlines of the upper-case
variant of the letter. These will then <B></B>be scaled so that a glyph which
was <CODE>capheight</CODE> high will now be <CODE>scheight</CODE> high, and
so that stems which were <CODE>ucstem</CODE> wide will be <CODE>lcstem</CODE>
wide. Normally the ratio of stem heights is the same as the ratio of stem
widths, but you may change that with <CODE>stem_height_factor</CODE>.
<P>
When it creates a new glyph it will name that glyph by appending ".sc" to
the original lower case letter name (so "a" would become "a.sc") you may
change the extension used with <CODE>letter_extension</CODE>. Similary symbols
and digits will use the extension "taboldstyle", but you may change that
with <CODE>symbol_extension</CODE>.
<P>
When it creates a glyph it also creates two lookups one bound to the feature
"c2sc" and the other to "smcp". A mapping from the lower case letter to the
small caps letter will be provided under "smcp", while a mapping from the
upper case to the small caps under "c2sc". Symbols will have both lookup
maps attached to the original glyph.</TD>
</TR>
<TR>
<TD><CODE>alterKerningClass</CODE></TD>
<TD><CODE>(subtable-name,<BR>
first-classes,<BR>
second-classes,<BR>
offsets)</CODE></TD>
<TD>Changes the kerning class in the named subtable. The classes arguments
are tuples of tuples of glyph names (each sub-tuble of glyph names is a kerning
class). The offsets argument is a tuple of kerning offsets. There must be
as many entries as <CODE>len(first-class)*len(second-class)</CODE>. The optional
after argument is used to specify the order of the subtable within the lookup.</TD>
</TR>
<TR>
<TD><CODE>autoKern</CODE></TD>
<TD><CODE>(subtable-name,<BR>
separation<BR>
[,minKern=,<BR>
onlyCloser=,<BR>
touch=])</CODE>
<P align="center">
<STRONG>or</STRONG>
<P>
<CODE>(subtable-name,<BR>
separation,<BR>
glyph-list1,<BR>
glyph-list2<BR>
[,minKern=,<BR>
onlyCloser=,<BR>
touch=])</CODE></TD>
<TD>The named subtable must be a kerning pair subtable that already exists.
<P>
This command will automatically generate kerning pairs for the named subtable.
If no glyph lists are specified it will look at all pairs of the glyphs in
the selection; if glyph lists are specified then it will look at all pairs
that can be made with one glyph from the first list and the second from the
second list.
<P>
It will attempt to guess a good kerning value between the two glyphs -- a
value which will make the optical separation between the two appear to be
<CODE>separation</CODE> em-units. If <CODE>minkern</CODE> is specified then
and the (absolute value of the) kerning correction is less than this number
then no kerning pair will be generated. If <CODE>onlyCloser</CODE> is set
true then only negative kerning offsets will be generated (only thing which
move two glyphs closer together). If touch is set to 1 then the kerning offset
will not be based on optical distance but on the closest approach between
two the two glyphs.</TD>
</TR>
<TR>
<TD><CODE>appendSFNTName</CODE></TD>
<TD><CODE>(language,strid,string)</CODE></TD>
<TD>Adds a new (or replaces an old) string in the sfnt 'name' table. Language
may be either the english name of the language/locale as a string, or the
number representing that language in MicroSoft's specification. Strid may
be one of the (english) string names (Copyright, Family, SubFamily, etc.)
or the numeric value of that item. The string itself is in UTF-8.</TD>
</TR>
<TR>
<TD><CODE>buildOrReplaceAALTFeatures</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Removes any existing AALT features (and any lookups solely controled
by such features) and creates new ones containing all possible single and
alternate substutions available for each glyph.</TD>
</TR>
<TR>
<TD><CODE>cidConvertByCMap</CODE></TD>
<TD><CODE>(cmap-filename)</CODE></TD>
<TD>Converts a normal font into a CID-keyed font with one subfont using
<P>
the CMAP to determine the mapping.</TD>
</TR>
<TR>
<TD><CODE>cidConvertTo</CODE></TD>
<TD><CODE>(registry,ordering,supplement)</CODE></TD>
<TD>Converts a normal font into a CID-keyed font with one subfont.</TD>
</TR>
<TR>
<TD><CODE>cidFlatten</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Converts a CID font into a normal font (glyphs will be in CID order).</TD>
</TR>
<TR>
<TD><CODE>cidFlattenByCMap</CODE></TD>
<TD><CODE>(cmap-filename)</CODE></TD>
<TD>Converts a CID font into a normal font using the encoding specified in
the CMAP file.</TD>
</TR>
<TR>
<TD><CODE>cidInsertBlankSubFont</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Adds a new (blank) sub-font into a cid-keyed font and changes the current
sub-font to be it.</TD>
</TR>
<TR>
<TD><CODE>cidRemoveSubFont</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Removes the current subfont from a cid-keyed font.</TD>
</TR>
<TR>
<TD><CODE>close</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Frees memory for the current font.
<P>
<STRONG>Warning:</STRONG> Any python pointers to it will become invalid.</TD>
</TR>
<TR>
<TD><CODE>compareFonts</CODE></TD>
<TD><CODE>(other-font,filename,<BR>
flags-tuple)</CODE></TD>
<TD>This will compare the current font with the font in
<CODE>other-font</CODE> (which must already have been opened). It will write
the results to the <CODE>filename</CODE>, you may use "-" to send the output
to stdout. The <CODE>flags</CODE> argument is a tuple of strings and controls
what will be compared.
<TABLE BORDER CELLPADDING="2">
<CAPTION>
<SMALL>flags</SMALL>
</CAPTION>
<TR>
<TD>outlines</TD>
<TD>compare outlines</TD>
</TR>
<TR>
<TD>outlines-exactly</TD>
<TD>compare outlines exactly (otherwise allow slight errors and the unlinking
of references)</TD>
</TR>
<TR>
<TD>warn-outlines-mismatch</TD>
<TD>warn if the outlines don't exactly match (but are pretty close)</TD>
</TR>
<TR>
<TD>hints</TD>
<TD>compare hints</TD>
</TR>
<TR>
<TD>warn-refs-unlink</TD>
<TD>warn if references need to be unlinked before a match is found</TD>
</TR>
<TR>
<TD>strikes</TD>
<TD>compare bitmap strikes</TD>
</TR>
<TR>
<TD>fontnames</TD>
<TD>compare font names</TD>
</TR>
<TR>
<TD>gpos</TD>
<TD>compare glyph positioning</TD>
</TR>
<TR>
<TD>gsub</TD>
<TD>compare glyph substitutions</TD>
</TR>
<TR>
<TD>add-outlines</TD>
<TD>for any glyphs whose outlines differ, add the outlines of the glyph in
the second font to the background of the glyph in the first</TD>
</TR>
<TR>
<TD>create-glyphs</TD>
<TD>if a glyph exists in the second font but not the first, create that glyph
in the first and add the outlines from the second into the backgroun layer</TD>
</TR>
</TABLE>
</TD>
</TR>
<TR>
<TD><CODE><A name="f-createChar">createChar</A></CODE></TD>
<TD><CODE>(uni[,name])</CODE></TD>
<TD>Create (and return) a character at the specified unicode codepoint in
this font and optionally name it. If you wish to create an glyph with no
unicode codepoint set the first argument to -1 and specify a name. If there
is already a character there, return it (it will not be renamed).</TD>
</TR>
<TR>
<TD><CODE>createInterpolatedGlyph</CODE></TD>
<TD><CODE>(glyph1,glyph2,amount)</CODE></TD>
<TD>Create (and return) a glyph with the same unicode code point as glyph1.
The glyph may not already exist. The contents of the glyph will be formed
by interpolating between glyph1 and glyph2. If amount==0 the result will
look like glyph1, or 1 then like glyph2.</TD>
</TR>
<TR>
<TD><CODE>createMappedChar</CODE></TD>
<TD><CODE>(enc)<BR>
(name)</CODE></TD>
<TD>Create (and return) a character at the specified encoding in this font.
If there is already a character there, return it</TD>
</TR>
<TR>
<TD><CODE><A NAME="font-find">find</A></CODE></TD>
<TD><CODE>(contour[,error-bound,search_flags])</CODE></TD>
<TD>Searches the font for all glyphs containing the contour (or layer) and
returns an iterator which returns those glyphs.
<P>
error-bound: defaults to 0.01.<BR>
search_flags: tuple of the strings: reverse, flips, rotate, scale.
<P>
When found, the glyph.temporary is set to a dict of:
<PRE>
{
"findMatchedRefs": matched_refs_bit_map,
"findMatchedContours": matched_contours_bit_map,
"findMatchedContoursStart": matched_contours_start_bit_map,
}
</PRE>
</TD>
</TR>
<TR>
<TD><CODE>findEncodingSlot</CODE></TD>
<TD><CODE>(uni)<BR>
(name)</CODE></TD>
<TD>Tests whether a glyph with this codepoint or name is in the font's encoding
and returns the encoding slot. If the glyph is not present it returns -1.
<P>
(If a glyph with that name/unicode is in the font, but is not in the encoding,
then an value beyond the end of the encoding will be returned).</TD>
</TR>
<TR>
<TD><CODE><A NAME="font-glyphs">glyphs</A></CODE></TD>
<TD><CODE>([type])</CODE></TD>
<TD>Returns an iterator which will return the glyphs in the font. By default
they will be returned in "GID" order, but if type is specified as "encoding"
they will be returned in encoding order. If returned in encoding order it
is possible that a glyph will be returned more than once if there are multiple
encoding slots which reference it.</TD>
</TR>
<TR>
<TD><CODE><A name="f-generate">generate</A></CODE></TD>
<TD><CODE>(filename<BR>
[,bitmap_type=,<BR>
flags=,<BR>
bitmap_resolution=,<BR>
subfont_directory=,<BR>
namelist=,<BR>
layer=])</CODE></TD>
<TD>Generates a font. The type is determined by the font's extension. The
bitmap type (if specified) is also an extension. If layer is specified, then
the splines and references in that layer will be used instead of the foreground
layer.
<P>
Flags is a tuple containing some of
<DL>
<DT>
afm
<DD>
output an afm file
<DT>
pfm
<DD>
output a pfm file
<DT>
tfm
<DD>
output a tfm file
<DT>
ofm
<DD>
output a ofm file
<DT>
composites-in-afm
<DD>
Store composite info in the afm file
<DT>
glyph-map-file
<DD>
Output a glyph map file giving the mapping between output gid and glyphnames
<DT>
short-post
<DD>
Do not include glyphnames in a ttf/otf file
<DT>
apple
<DD>
output apple advanced typography tables
<DT>
opentype
<DD>
output opentype tables
<DT>
old-kern
<DD>
output an old style 'kern' with opentype tables
<DT>
dummy-dsig
<DD>
output an empty DSIG table so MS will mark a font with .ttf extension as
an OpenType font.
<DT>
TeX-table
<DD>
Include a 'TeX ' table in an ttf/otf file
<DT>
round
<DD>
Round PS coordinates to integers
<DT>
no-hints
<DD>
Do not include PS hints
<DT>
no-flex
<DD>
Do not include PS flex hints
<DT>
omit-instructions
<DD>
Do not include TrueType instructions
<DT>
PfEd-comments
<DD>
Include font and glyph comments in the 'PfEd' table
<DT>
PfEd-colors
<DD>
Include glyph colors in the 'PfEd' table
<DT>
PfEd-lookups
<DD>
Include lookup names in the 'PfEd' table
<DT>
PfEd-guidelines
<DD>
Include guideline locations in the 'PfEd' table
<DT>
PfEd-background
<DD>
Include background (and spiro) layers in the 'PfEd' table
<DT>
symbol
<DD>
Generate an sfnt with a Symbol cmap entry rather than a Unicode entry.
</DL>
<P>
See also <A href="#font-save">save()</A>.</TD>
</TR>
<TR>
<TD><CODE>generateTtc</CODE></TD>
<TD><CODE>(filename,others,<BR>
[flags=,<BR>
ttcflags=, namelist=,<BR>
layer=])</CODE></TD>
<TD>Generates a truetype collection file containing the current font and
all others listed -- the <CODE>others</CODE> argument may be
<CODE>None</CODE>, a font, or a tuple (or list) of fonts.
<P>
Flags are as above,
<P>
Ttcflags is a tuple consisting of the following
<DL>
<DT>
merge
<DD>
Try and share tables and glyphs among the various fonts.
<DT>
cff
<DD>
Use the CFF glyph format rather than the TrueType format (the OpenType
documentation says that this does not work, but both the Mac and unix/linux
accept it).
</DL>
</TD>
</TR>
<TR>
<TD><CODE>generateFeatureFile</CODE></TD>
<TD><CODE>(filename[,lookup-name])</CODE></TD>
<TD>Generates an adobe feature file for the current font. If a lookup-name
is specified then only data for that lookup will be generated.</TD>
</TR>
<TR>
<TD><CODE>genericGlyphChange</CODE></TD>
<TD><CODE>(stemType=<str>,<BR>
thickThreshold=<double>,<BR>
stemScale=<double>,<BR>
stemAdd=<double>,<BR>
stemHeightScale=<double>,<BR>
stemHeightAdd=<double>,<BR>
stemWidthScale=<double>,<BR>
stemWidthAdd=<double>,<BR>
thinStemScale=<double>,<BR>
thinStemAdd=<double>,<BR>
thickStemScale=<double>,<BR>
thickStemAdd=<double>,<BR>
processDiagonalStems=<boolean>,<BR>
<BR>
hCounterType=<str>,<BR>
hCounterScale=<double>,<BR>
hCounterAdd=<double>,<BR>
lsbScale=<double>,<BR>
lsbAdd=<double>,<BR>
rsbScale=<double>,<BR>
rsbAdd=<double>,<BR>
<BR>
vCounterType=<str>,<BR>
vCounterScale=<double>,<BR>
vCounterAdd=<double>,<BR>
vScale=<double>,<BR>
vMap=<tuple of tuples>)</CODE></TD>
<TD>This function uses keyword parameters. Which ones are required depends
on the three type arguments (<CODE>stemType, hCounterType,
vCounterType</CODE>).
<P>
If <CODE>stemType</CODE> is omitted, or is the string "uniform", then
the <CODE>stemScale</CODE> parameter must be specified (and
<CODE>stemAdd</CODE> may be). <CODE>stemScale</CODE> specifies a
scaling factor by which all stems (horizontal and vertical, thick and
thin) will be scaled. A value of 1.0 means no change. While
<CODE>stemAdd</CODE> specifies the number of em-units to add to the
width of each stem.
<P>
If <CODE>stemType</CODE> is the string "horizontalVertical",
then values must be specified for <CODE>stemHeightScale</CODE> and
<CODE>stemWidthScale</CODE> (and may be for <CODE>stemHeightAdd,
stemWidthAdd</CODE>). The first of these specifies scaling for the
height of horizontal stems, and the second scaling for the width
of vertical stems.
<P>
If <CODE>stemType</CODE> is the string "thickThin",
then values must be specified for <CODE>thinStemScale</CODE>,
<CODE>thickStemScale</CODE> and <CODE>thickThreshold</CODE>
(and may be for <CODE>thinStemAdd, thickStemAdd</CODE>). The
first of these specifies scaling for the width/height of thin
stems, and the second scaling for the width/height of thick
stems. While the <CODE>thickThreshold</CODE> argument specifies
the size (in em-units) at which a stem is classified as "thick".
<P>
<P>
If <CODE>hCounterType</CODE> is omitted, or is the string "uniform",
then horizontal counters, and the left and right side bearings will
all be scaled using the same rules, and <CODE>hCounterScale</CODE>
must be specified to provide the scaling factor (while
<CODE>hCounterAdd</CODE> may be specified).
<P>
If <CODE>hCounterType</CODE> is the string "nonUniform",
then horizontal counters, and the left and right side bearings may
all be scaled using different rules, and <CODE>hCounterScale,
lsbScale</CODE> and <CODE>rsbScale</CODE> must be specified to
provide the scaling factors (while <CODE>hCounterAdd, lsbAdd,</CODE>
and <CODE>rsbAdd</CODE> may be specified).
<P>
If <CODE>hCounterType</CODE> is the string "center", then the left
and right side-bearings will be set so the new glyph is centered
within the original glyph's width. (Probably more useful for CJK
fonts than LGC fonts).
<P>
If <CODE>hCounterType</CODE> is the string "retainScale", then the
left and right side-bearings will be set so the new glyph is within
within the original glyph's width, and the side-bearings remain in
the same proportion to each other as before.
<P>
<P>
If <CODE>vCounterType</CODE> is omitted, or is the string "mapped",
then certain zones on the glyph may be placed at new (or the same)
locations -- similar to BlueValues. So you can specify a zone for
the baseline, one for the
x-height and another for the top of capitals and ascenders (and perhaps
a fourth for descenders). Each such zone is specified by the
<CODE>vMap</CODE> argument which is a tuple of 3-tuples, each
3-tuple specifying a zone with: Original location, original width, and
final location. <strong>No default value is provided for this argument
you must figure out all the values yourself</strong>.
<P>
If <CODE>vCounterType</CODE> is the string "scaled",
then vertical counters, and the top and bottom side bearings will
all be scaled using the same rules, and <CODE>vCounterScale</CODE>
must be specified to provide the scaling factor (while
<CODE>vCounterAdd</CODE> may be specified). This is probably most
useful for CJK fonts.</TD>
</TR>
<TR>
<TD><CODE>getKerningClass</CODE></TD>
<TD><CODE>(subtable-name)</CODE></TD>
<TD>Returns a tuple whose entries are: (first-classes, second-classes, offsets).
The classes are themselves tuples of tuples of glyph names. The offsets will
be a tuple of numeric kerning offsets.</TD>
</TR>
<TR>
<TD><CODE>getLookupInfo</CODE></TD>
<TD><CODE>(lookup-name)</CODE></TD>
<TD>Returns a tuple whose entries are: (lookup-type, lookup-flags,
feature-script-lang-tuple) The lookup type is a string as described in
<A HREF="#font-addLookup">addLookup</A>, and the feature-script-lang tuple
is also described <A HREF="#font-addLookup">there</A>.</TD>
</TR>
<TR>
<TD><CODE>getLookupSubtables</CODE></TD>
<TD><CODE>(lookup-name)</CODE></TD>
<TD>Returns a tuple of all subtable names in that lookup.</TD>
</TR>
<TR>
<TD><CODE>getLookupSubtableAnchorClasses</CODE></TD>
<TD><CODE>(subtable-name)</CODE></TD>
<TD>Returns a tuple of all anchor class names in that subtable.</TD>
</TR>
<TR>
<TD><CODE>getLookupOfSubtable</CODE></TD>
<TD><CODE>(subtable-name)</CODE></TD>
<TD>Returns the name of the lookup containing this subtable.</TD>
</TR>
<TR>
<TD><CODE>getSubtableOfAnchor</CODE></TD>
<TD><CODE>(anchor-class-name)</CODE></TD>
<TD>Returns the name of the subtable containing this anchor class.</TD>
</TR>
<TR>
<TD><CODE>importBitmaps</CODE></TD>
<TD><CODE>(bitmap-font-file<BR>
[,to-background])</CODE></TD>
<TD>Load any bitmap strikes out of the bitmap-font-file into the current
font</TD>
</TR>
<TR>
<TD><CODE>importLookups</CODE></TD>
<TD><CODE>(another-font,lookup-names<BR>
[,before-name])</CODE></TD>
<TD>The first argument must be a FontForge Font object, the second a string
or a tuple of strings, and the third, another string. It will search the
other font for the named lookup(s) and import it into the current font.
(Contextual lookups which invoke other lookups will have any nested lookups
imported as well). Lookups will be imported in the order listed. If a before-name
is specified, then it is looked up in the current font and all lookups will
be added before it, if not specified lookups will appear at the end of the
list.</TD>
</TR>
<TR>
<TD><CODE>interpolateFonts</CODE></TD>
<TD><CODE>(fraction,filename)</CODE></TD>
<TD>Interpolates a font between the current font and the font contained in
filename.</TD>
</TR>
<TR>
<TD><CODE>isKerningClass</CODE></TD>
<TD><CODE>(subtable-name)</CODE></TD>
<TD>Returns whether the named subtable contains a kerning class.</TD>
</TR>
<TR>
<TD><CODE>isVerticalKerning</CODE></TD>
<TD><CODE>(subtable-name)</CODE></TD>
<TD>Returns whether the named subtable contains a vertical kerning data</TD>
</TR>
<TR>
<TD><CODE>italicize</CODE></TD>
<TD><CODE>(italic_angle=, ia=<BR>
lc_condense=, lc=<BR>
uc_condense=, uc=<BR>
symbol_condense=, symbol=<BR>
deserif_flat=,<BR>
deserif_slant=,<BR>
deserif_pen=,<BR>
baseline_serifs=,<BR>
xheight_serifs=,<BR>
ascent_serifs=,<BR>
descent_serifs=,<BR>
diagonal_serifs=,<BR>
a=,<BR>
f=,<BR>
u0438=,<BR>
u043f=,<BR>
u0442=,<BR>
u0444=,<BR>
u0448=,<BR>
u0452=,<BR>
u045f=)</CODE></TD>
<TD>This function uses keyword parameters. None is required, if omitted a
default value will be used. Some keywords have abbreviations ("ia" for
"italic_angle") you may use either.
<P>
This function will attempt to italicize each selected glyph. For a detailed
explanation of what this entails please see the information on the
<A href="Styles.html#Italic"> Italic dialog</A>.
<P>
The <CODE>*_condense</CODE> keywords should be 4 element tuples of floating
point numbers; these numbers correspond to: Left side bearing condensation,
stem condensation, counter condensation and right side bearing condensation.
These numbers should be small numbers around 1 (scale factors, not percentages).
<P>
Set at most one of the <CODE>deserif_*</CODE> keywords.
<P>
Setting <CODE>a</CODE> to <CODE>true</CODE> will turn on the transformation
that applies to the "a" glyph. Setting <CODE>u0438</CODE> will control the
transformation that applies to the glyph at unicode codepoint U+0438.
<P>
The <CODE>f</CODE> keyword is slightly more complex. Setting it to 0 turns
off all transformations of glyphs like "f", setting it to 1 will give "f"
a tail which looks like a rotated version of its head, and setting it to
2 will simply extend the main stem of "f" below the baseline.</TD>
</TR>
<TR>
<TD><CODE>lookupSetFeatureList</CODE></TD>
<TD><CODE>(lookup-name,<BR>
feature-script-lang-tuple)</CODE></TD>
<TD>Sets the feature list of indicated lookup. The feature-script-lang tuple
is described at <A HREF="#font-addLookup">addLookup</A>.</TD>
</TR>
<TR>
<TD><CODE>lookupSetFlags</CODE></TD>
<TD><CODE>(lookup-name,flags)</CODE></TD>
<TD>Sets the lookup flags for the named lookup.</TD>
</TR>
<TR>
<TD><CODE>lookupSetStoreLigatureInAfm</CODE></TD>
<TD><CODE>(lookup-name,boolean)</CODE></TD>
<TD>Sets whether this ligature lookup contains data to store in the afm.</TD>
</TR>
<TR>
<TD><CODE>mergeFonts</CODE></TD>
<TD><CODE>(filename[,<BR>
preserveCrossFontKerning])</CODE></TD>
<TD>Merges the font in the file into the current font.</TD>
</TR>
<TR>
<TD><CODE>mergeFeature</CODE></TD>
<TD><CODE>(filename)</CODE></TD>
<TD>Merge feature and lookup information from an adobe feature file, or metrics
information from the (afm,tfm,etc) file into the current font.</TD>
</TR>
<TR>
<TD><CODE>mergeKern</CODE></TD>
<TD><CODE>(filename)</CODE></TD>
<TD>Deprecated name for mergeFeature above</TD>
</TR>
<TR>
<TD><CODE>mergeLookups</CODE></TD>
<TD><CODE>(lookup-name1,lookup-name2)</CODE></TD>
<TD>The lookups must be of the same type. All subtables from lookup-name2
will be moved to lookup-name1, the features list of lookup-name2 will be
merged with that of lookup-name1, and lookup-name2 will be removed.</TD>
</TR>
<TR>
<TD><CODE>mergeLookupSubtables</CODE></TD>
<TD><CODE>(subtable-name1,<BR>
subtable-name2)</CODE></TD>
<TD>The subtables must be in the same lookup. Not all lookup types allow
their subtables to be merged (contextual subtables may not be merged, kerning
classes may not be (kerning pairs may be)). Any information bound to subtable2
will be bound to subtable1 and subtable2 will be removed.</TD>
</TR>
<TR>
<TD><CODE>printSample</CODE></TD>
<TD><CODE>(type,pointsize,<BR>
sample,output-file)</CODE></TD>
<TD>Type is a string which must be one of
<DL>
<DT>
fontdisplay
<DD>
Display all glyphs in the font in encoding order
<DT>
chars
<DD>
Display the selected glyphs scaled to fill a page<BR>
Ignores the pointsize argument.
<DT>
waterfall
<DD>
Displays the selected glyphs at many pointsizes.<BR>
The pointsize argument should be a tuple of pointsizes here.
<DT>
fontsample
<DD>
The third argument should contain a string which will be layed out and displayed
as well as FontForge can.
<DT>
fontsampleinfile
<DD>
The third argument should contain the name of a file which contains text
to be layed out and displayed.
</DL>
<P>
If output is to a file (see <A href="#printSetup">printSetup</A>) then the
last argument specifies a file name in which to store output.</TD>
</TR>
<TR>
<TD><CODE>randomText</CODE></TD>
<TD><CODE>(script[,lang])</CODE></TD>
<TD>Returns a random text sample using the letter frequencies of the specified
script (and optionally language). Both script and language should be expressed
as strings containing OpenType Script and Language tags. "dflt" is a reasonable
language tag. If the language is not specified, one will be chosen at random.
If ff has no frequency information for the script/language specified it will
use the letters in the script with equal frequencies.</TD>
</TR>
<TR>
<TD><CODE><A name="f-regenBitmaps">regenBitmaps</A></CODE></TD>
<TD><CODE>(tuple-of-sizes)</CODE></TD>
<TD>A tuple with an entry for each bitmap strike to be regenerated
(rerasterized). Each strike is identified by pixelsize (if the strike is
a grey scale font it will be indicated by
<CODE>(bitmap-depth<<16)|pixelsize</CODE>.</TD>
</TR>
<TR>
<TD><CODE>removeAnchorClass</CODE></TD>
<TD><CODE>(anchor-class-name)</CODE></TD>
<TD>Removes the named AnchorClass (and all associated points) from the font.</TD>
</TR>
<TR>
<TD><CODE>removeLookup</CODE></TD>
<TD><CODE>(lookup-name)</CODE></TD>
<TD>Remove the lookup (and any subtables within it).</TD>
</TR>
<TR>
<TD><CODE>removeLookupSubtable</CODE></TD>
<TD><CODE>(subtable-name)</CODE></TD>
<TD>Remove the subtable (and all data associated with it).</TD>
</TR>
<TR>
<TD><CODE>removeGlyph</CODE></TD>
<TD><CODE>(uni[,name])<BR>
(name)<BR>
(glyph)</CODE></TD>
<TD>You may either pass in a FontForge glyph object (from this font) or identify
a glyph in the font by unicode code point or name. In any case the glyph
will be removed from the font.
<P>
If you use (uni,name) to specify a name, set uni to -1.
<P>
<STRONG>WARNING:</STRONG> This frees fontforge's storage to this glyph. If
you have any python pointers to that storage they will be looking at garbage.
This does not go through the usual python reference mechanism.</TD>
</TR>
<TR>
<TD><CODE>replaceAll</CODE></TD>
<TD><CODE>(srch,rpl[,error-bound])</CODE></TD>
<TD>Searches the font for all occurences of the srch contour (or layer) and
replaces them with the replace contour (or layer).</TD>
</TR>
<TR>
<TD><CODE><A name="font-revert">revert</A></CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Reloads the font from the disk.
<P>
<B>Caveat:</B> if you have any pointers to glyphs which live in the font
those pointers will no longer be valid, and using them will cause crashes.
This is very un-python-like.</TD>
</TR>
<TR>
<TD><CODE>revertFromBackup</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Reloads the font from the backup file on the disk.
<P>
<B>Caveat:</B> if you have any pointers to glyphs which live in the font
those pointers will no longer be valid, and using them will cause crashes.
This is very un-python-like.</TD>
</TR>
<TR>
<TD><CODE><A name="font-save">save</A></CODE></TD>
<TD><CODE>([filename])</CODE></TD>
<TD>Saves the font to an sfd file. See also
<A href="#f-generate">generate()</A></TD>
</TR>
<TR>
<TD><CODE>saveNamelist</CODE></TD>
<TD><CODE>(filename)</CODE></TD>
<TD>Saves the font's namelist to a file.</TD>
</TR>
<TR>
<TD><CODE>getTableData</CODE></TD>
<TD><CODE>(table-name)</CODE></TD>
<TD>Gets binary data from any saved table. FF will save 'fpgm', 'prep', 'cvt
' and 'maxp'. FF may also save tables which you explicitly request. Do not
expect to get binary data for tables like 'GPOS' or 'glyf' which FF will
generate when it creates a font... that information is not currently available.
<P>
Returns a binary string.</TD>
</TR>
<TR>
<TD><CODE>setTableData</CODE></TD>
<TD><CODE>(table-name,sequence)</CODE></TD>
<TD>Sets binary data of any saved table. FF will save 'fpgm', 'prep', 'cvt
' and 'maxp'. FF may also save tables which you explicitly request. Do not
expect to set binary data for tables like 'GPOS' or 'glyf' which FF will
generate when it creates a font... that information is not currently available.
<P>
If sequence is None, then the named table will be removed from the font.</TD>
</TR>
<TR>
<TD><CODE>validate</CODE></TD>
<TD><CODE>([force])</CODE></TD>
<TD>Validates the font and returns a bit mask of all errors from all glyphs
(as defined in the
<CODE><A HREF="python.html#validation-state">validation_state</A></CODE>
of a glyph -- except bit 0x1 is clear). If the font passed the validation
then the return value will be 0 (not 0x1). Otherwise the return value will
be the set of errors found.
<P>
Note: The set of errors is slightly different for TrueType and PostScript
output. The returned mask contains the list of potential errors. You must
figure out which apply to you.
<P>
Normally each glyph will cache its validation_state and it will not be
recalculated. If you pass a non-zero argument to the routine then it will
force recalculation of each glyph -- this can be slow.s</TD>
</TR>
<TR>
<TH colspan=3>Selection based interface<BR>
See the <A href="#selection">selection type</A> for how to alter the selection</TH>
</TR>
<TR>
<TD><CODE>addExtrema</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Extrema should be marked by on-curve points. If a curve in any selected
glyph lacks a point at a significant extremum this command will add one.</TD>
</TR>
<TR>
<TD><CODE>addSmallCaps</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>For all selected upper or lower case letters in the latin, greek and
cyrillic scripts this will try to create a small caps version of that glyph
in a new glyph slot. So if you select "A" (or "a") then a glyph "a.sc" will
be created (if "a.sc" already exists, it will be reused, and its current
contents cleared). The contents of "a.sc" will be based on the upper case
variant of this glyph (and that variant must be present for the command to
work). FontForge will also create two lookups (unless appropriate ones already
exist) one, bound to the feature 'c2sc' will map upper case letters to small
caps, the other, bound to feature 'smcp' will map lower case letters to small
caps.</TD>
</TR>
<TR>
<TD><CODE>autoHint</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Generates PostScript hints for all selected glyphs.</TD>
</TR>
<TR>
<TD><CODE>autoInstr</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Generates TrueType instructions for all selected glyphs.</TD>
</TR>
<TR>
<TD><CODE>autoWidth</CODE></TD>
<TD><CODE>(separation [,minBearing=,maxBearing=])</CODE></TD>
<TD>Guesses at reasonable horizontal advance widths for the selected glyphs</TD>
</TR>
<TR>
<TD><CODE>autoTrace</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Auto traces any background images in all selected glyphs</TD>
</TR>
<TR>
<TD><CODE>build</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>If any of the selected characters is a composite character, then this
command will clear it and insert references to its components (this command
can create new glyphs).</TD>
</TR>
<TR>
<TD><CODE>canonicalContours</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Orders the contours in the selected glyphs by the x coordinate of their
leftmost point. (This can reduce the size of the charstring needed to describe
the glyph(s).</TD>
</TR>
<TR>
<TD><CODE>canonicalStart</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Sets the start point of all the contours of the selected glyphs to be
the leftmost point on the contour. (If there are several points with that
value then use the one which is closest to the baseline). This can reduce
the size of the charstring needed to describe the glyph(s). By regularizing
things it can also make more things available to be put in subroutines.</TD>
</TR>
<TR>
<TD><CODE>changeWeight</CODE></TD>
<TD><CODE>(stroke_width[,type,<BR>
serif_height,serif_fuzz,<BR>
counter_type,custom_zones])</CODE></TD>
<TD>See the <A HREF="Styles.html#Embolden">Element->Style->Change
Width</A> command for a more complete description of these arguments.
<P>
Stroke_width is the amount by which all stems are expanded.
<P>
Type is one of "LCG", "CJK", "auto", "custom".
<P>
Serif_height tells ff not to expand serifs which are that much off the baseline,
while serif_fuzz specifies the amount of fuzziness allowed in the match.
If you don't want special serif behavior set this to 0.
<P>
Counter_type is one of "squish", "retain", "auto".
<P>
Custom_zones is only meaningful if the type argument were "custom". It may
be either a number, which specifies the "top hint" value (bottom hint is
assumed to be 0, others are between), or a tuple of 4 numbers (top hint,
top zone, bottom zone, bottom hint).</TD>
</TR>
<TR>
<TD><CODE>condenseExtend</CODE></TD>
<TD><CODE>(c_factor,c_add<BR>
[,sb_factor,sb_add,<BR>
correct])</CODE></TD>
<TD>Condenses or extends the size of the counters and side-bearings of the
selected glyphs. The first two arguments provide information on shrinking/growing
the counters, the second two the sidebearings. If the last two are omitted
they default to the same values as the first two.
<P>
A counter's width will become:<BR>
<CODE> new_width = c_factor * old_width + c_add</CODE>
<P>
If present the <CODE>correct</CODE> argument allows you to specify whether
you want to correct for the italic angle before condensing the glyph. (it
defaults to True)</TD>
</TR>
<TR>
<TD><CODE>clear</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Clears the contents of all selected glyphs</TD>
</TR>
<TR>
<TD><CODE><A name="f-cluster">cluster</A></CODE></TD>
<TD><CODE>([within,max])</CODE></TD>
<TD>Moves clustered coordinates to a standard central value in all selected
glyphs. See also <A href="#f-round">round</A>.</TD>
</TR>
<TR>
<TD><CODE>copy</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Copies all selected glyphs into (fontforge's internal) clipboard.</TD>
</TR>
<TR>
<TD><CODE>copyReference</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Copies all selected glyphs (as references) into (fontforge's internal)
clipboard.</TD>
</TR>
<TR>
<TD><CODE><A name="f-correctDirection">correctDirection</A></CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Orients all contours so that external ones are clockwise and internal
counter-clockwise in all selected glyphs.</TD>
</TR>
<TR>
<TD><CODE>correctReferences</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Checks a font for glyphs with mixed contours and references (or references
with transformation matrices which cannot be represented truetype (ie. scaling
by 2 or more)). If a mixed case is discovered fontforge will take the contours
out of the glyph, put them in a new glyph, and make a reference to the new
glyph.</TD>
</TR>
<TR>
<TD><CODE>cut</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Copies all selected glyphs into (fontforge's internal) clipboard. And
then clears them.</TD>
</TR>
<TR>
<TD><CODE>paste</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Pastes the contents of (fontforge's internal) clipboard into the selected
glyphs -- and removes what was there before.</TD>
</TR>
<TR>
<TD><CODE><A name="f-intersect">intersect</A></CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Leaves only areas in the intersection of contours in all selected glyphs.
See also <A href="#f-removeOverlap">removeOverlap</A>.</TD>
</TR>
<TR>
<TD><CODE>pasteInto</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Pastes the contents of (fontforge's internal) clipboard into the selected
glyphs -- and retains what was there before.</TD>
</TR>
<TR>
<TD><CODE><A name="f-removeOverlap">removeOverlap</A></CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Removes overlapping areas in all selected glyphs. See also
<A href="#f-intersect">intersect</A>.</TD>
</TR>
<TR>
<TD><CODE>replaceWithReference</CODE></TD>
<TD><CODE>([fudge])</CODE></TD>
<TD>Finds any glyph which contains an inline copy of one of the selected
glyphs, and converts that copy into a reference to the appropriate glyph.
Selection is changed to the set of glyphs which the command alters.
<P>
If specified the fudge argument specifies the error allowed for coordinate
differences.</TD>
</TR>
<TR>
<TD><CODE><A name="f-round">round</A></CODE></TD>
<TD><CODE>([factor])</CODE></TD>
<TD>Rounds the x and y coordinates of each point in all selected glyphs.
If factor is specified then new-coord = round(factor*old-coord)/factor. See
also <A href="#f-cluster">cluster</A>.</TD>
</TR>
<TR>
<TD><CODE>simplify</CODE></TD>
<TD><CODE>([error-bound,flags,tan_bounds,<BR>
linefixup,linelenmax])</CODE></TD>
<TD>Tries to remove excess points in all selected glyphs if doing so will
not perturb the curve by more than <CODE>error-bound</CODE>. Flags is a tuple
of the following strings
<DL>
<DT>
ignoreslopes
<DD>
Allow slopes to change
<DT>
ignoreextrema
<DD>
Allow removal of extrema
<DT>
smoothcurves
<DD>
Allow curve smoothing
<DT>
choosehv
<DD>
Snap to horizontal or vertical
<DT>
forcelines
<DD>
flatten bumps on lines
<DT>
nearlyhvlines
<DD>
Make nearly horizontal/vertical lines be so
<DT>
mergelines
<DD>
Merge adjacent lines into one
<DT>
setstarttoextremum
<DD>
Rotate the point list so that the start point is on an extremum
<DT>
removesingletonpoints
<DD>
If the contour contains just one point then remove it
</DL>
</TD>
</TR>
<TR>
<TD><CODE>stroke</CODE></TD>
<TD><CODE>("circular",width[,<BR>
linecap,linejoin,flags])<BR>
("eliptical",width,<BR>
minor-width,angle<BR>
[,linecap,linejoin,flags])<BR>
("caligraphic",width,<BR>
height,angle[,flags])<BR>
("polygonal",contour[,flags])</CODE></TD>
<TD>Strokes the contours of all selected glyphs using one of the indicated
pens. Line cap may be one of
<UL>
<LI>
butt
<LI>
round
<LI>
square
</UL>
<P>
line join may be
<UL>
<LI>
miter
<LI>
round
<LI>
bevel
</UL>
<P>
flags is a tuple containing some of the following strings
<UL>
<LI>
removeinternal
<LI>
removeexternal
<LI>
cleanup
</UL>
<P>
If a polygonal pen is specified the contour must be a closed convex polygon
(no curved edges) with fewer than 100 vertices.</TD>
</TR>
<TR>
<TD><CODE>transform</CODE></TD>
<TD><CODE>(matrix)</CODE></TD>
<TD>Transforms all selected glyphs by the matrix.</TD>
</TR>
<TR>
<TD><CODE>nltransform</CODE></TD>
<TD><CODE>(xexpr,yexpr)</CODE></TD>
<TD>xexpr and yexpr are strings specifying non-linear transformations that
will be applied to all points in the selected glyphs of the font (with xexpr
being applied to x values, and yexpr to y values, of course). The syntax
for the expressions is explained in the
<A HREF="transform.html#Non-Linear">non-linear transform dialog</A>.</TD>
</TR>
<TR>
<TD><CODE>unlinkReferences</CODE></TD>
<TD><CODE>()</CODE></TD>
<TD>Unlinks all references in all selected glyphs and replaces them with
splines.</TD>
</TR>
</TABLE>
<H3>
Stupid example
</H3>
<TABLE BORDER=1>
<TR>
<TD><PRE>import fontforge #Load the module
amb=fontforge.open("Ambrosia.sfd") #Open a font
amb.selection.select(("ranges",None),"A","Z") #select A-Z
amb.copy() #Copy those glyphs into the clipboard
n=fontforge.font() #Create a new font
n.selection.select(("ranges",None),"A","Z") #select A-Z of it
n.paste() #paste the glyphs above in
print n["A"].foreground #test to see that something
# actually got pasted
n.fontname="NewFont" #Give the new font a name
n.save("NewFont.sfd") #and save it.
</PRE>
</TD>
</TR>
</TABLE>
<H2>
FontForge as a python <A NAME="extension">extension</A>
</H2>
<P>
If you have configured fontforge with the <CODE>--enable-pyextension</CODE>
argument, then when fontforge installs itself it will also set itself up
as something that can be used inside of python (up until now we have been
talking about using python inside of fontforge).
<BLOCKQUOTE id="shell">
<PRE><FONT COLOR="Gray">$ </FONT>./configure --enable-pyextension
<FONT COLOR="Gray">$ </FONT>make
<FONT COLOR="Gray">$ </FONT>sudo make install
</PRE>
</BLOCKQUOTE>
<P>
once you do that you can invoke all of the above fontforge commands from
inside of python by saying:
<BLOCKQUOTE id="shell">
<PRE><FONT COLOR="Gray">>>> </FONT>import fontforge
</PRE>
</BLOCKQUOTE>
</DIV>
</BODY></HTML>
distrib
>
Mageia
>
5
>
i586
>
media
>
core-release
>
by-pkgid
>
6b465285c9860724a695461ac61807f4
>
files
>
632
