fontlab_aidus_agentus.plugin.executor · declarations 001
Back to fontlab_aidus_agentus.plugin.executor
FL_AVAILABLE
module-attribute
FL_AVAILABLE
METRIC_ABS_TOLERANCE
module-attribute
METRIC_ABS_TOLERANCE
fl
Python interface for FontLab data objects
Architecture
The FontLab Python API is a C++/Python binding layer:
Python Script
↓ fontlab module
↓ C++ model objects
fl* classes (flNode, flContour, flShape, flLayer, flGlyph, flPackage…)
↓ fontgate (fg*)
fgGlyph, fgFont, fgContour…
The class articles document registered names, member kinds, calling conventions and property access. Some APIs depend on build flags. The separate fontgate module and inherited PythonQt/Qt APIs are outside this inventory.
CurrentFont() returns fgFont, and CurrentGlyph() returns fgGlyph. Use fl.flPackage(fg_font) or fl.flGlyph(fg_glyph) when calling the model APIs described by the fl* guides. Constructing a wrapper from an existing model object does not imply an independent geometry copy; use the appropriate clone() operation when a separate object is needed.
Type Conventions
Throughout the documentation, types use these conventions:
| Type | Meaning |
|---|---|
str |
Python string (C++ QString) |
float |
Python float (C++ double) |
int |
Python integer |
bool |
Python bool |
QPointF |
Qt 2D point; use PythonQt.QtCore.QPointF unless the specific overload documents tuple conversion |
QRectF |
Qt rectangle; use PythonQt.QtCore.QRectF unless the specific overload documents tuple conversion |
QTransform |
3×3 matrix — passed as a QTransform-like object |
QColor |
Qt color; use PythonQt.QtGui.QColor unless the specific overload documents tuple conversion |
list(T) |
Python list of type T |
T/None |
Returns T or Python None |
Calling conventions and inherited members
Registered methods take positional arguments unless their class article explicitly lists keyword support. Optional values shown as name=default in signatures do not by themselves imply keyword support. flNode documents its keyword-capable methods. Value-wrapper constructors document their own field-keyword initialization.
Inherited registrations are documented in the base class article; each class article names its binding base where applicable. C++ inheritance alone does not guarantee that a base member is exposed in Python. Binding annotations record declared signatures and can be incomplete; implementation notes in the class articles qualify known differences.
CurveEx: CurveEx representation
ExportControl: ExportControl representation
FaBasicPtr: FaBasicPtr representation
Interval: Interval representation
PaintBrush: PaintBrush representation
TransformFrame: TransformFrame representation
fgSymbol: fgSymbol representation
fgSymbolList: fgSymbolList representation
flAbstractEditor: flAbstractEditor representation
flAbstractVectorNode: flAbstractVectorNode representation
flAnchor: flAnchor representation
flAuditInfo: flAuditInfo representation
flAxis: flAxis representation
flBasicTool: flBasicTool representation
flCanvas: flCanvas representation
flContour: flContour representation
flContourInfo: flContourInfo representation
flEvent: flEvent representation
flExpression: flExpression representation
flGlyph: flGlyph representation
flGlyphInfo: flGlyphInfo representation
flGraphicsInfo: flGraphicsInfo representation
flGuideLine: flGuideLine representation
flHintingParameters: flHintingParameters representation
flInstance: flInstance representation
flItems: flItems representation
flLayer: flLayer representation
flLayerInfo: flLayerInfo representation
flLocation: flLocation representation
LocationValue: LocationValue representation
flMarkerPoint: flMarkerPoint representation
flMouseEvent: flMouseEvent representation
flModelProducer: flModelProducer representation
flNode: flNode representation
flNodeInfo: flNodeInfo representation
flObject: flObject representation
flPackage: flPackage representation
flPaper: flPaper representation
flPinPoint: flPinPoint representation
flPreferences: flPreferences representation
flProperty: flProperty representation
flPropertyDouble: flPropertyDouble representation
flPropertyPoint: flPropertyPoint representation
flSearchInfo: flSearchInfo representation
flShape: flShape representation
flShapeBuilder: flShapeBuilder representation
flShapeData: flShapeData representation
flShapeInfo: flShapeInfo representation
flSnapLine: flSnapLine representation
flSnapObject: flSnapObject representation
flStem: flStem representation
flZone: flZone representation
flSticker: flSticker representation
flTextBlock: flTextBlock representation
flTransform: flTransform representation
flVectorNode: flVectorNode representation
flVisualItem: flVisualItem representation
flWorkspace: flWorkspace representation
FontMetrics: FontMetrics representation
GlyphComponent: GlyphComponent representation
flTTHCommand: flTTHCommand representation
YPanelManager: YPanelManager representation
YPanelWidget: YPanelWidget representation
Info: Font Info data
FontLayer: FontLayer object
flObjectsList
Supplemental documentation: High-level FontLab editing API. flGlyph contains drawing layers, flLayer contains shapes, and flContour contains nodes. CurrentFont() and CurrentGlyph() access the active editing context.
Source: FontLab Proteus API documentation
Documentation is derived from captured and enriched Echopy source. Native objects are supplied by FontLab.