Skip to content

fontlab.flPackage · declarations 004

Back to fontlab.flPackage

prepareFontGateData

prepareFontGateData(prepare_tth: bool) -> Any

prepareFontGateData(bool prepare_tth)

Prepare the low-level fontgate data structures for export. Pass prepare_tth=True to include TrueType hinting data.

Source: FontLab Proteus API documentation

preparePropertiesData

preparePropertiesData() -> Any

preparePropertiesData()

Prepare the variable-properties data structures for the inspector UI.

Source: FontLab Proteus API documentation

projectPackageName

projectPackageName() -> Any

string projectPackageName()

Return the name of this package within a multi-font project.

Source: FontLab Proteus API documentation

ps_stemsH instance-attribute

ps_stemsH: Any

list(flStem)

PostScript horizontal stems (describing horizontal stroke weights).

Source: FontLab Proteus API documentation

ps_stemsV instance-attribute

ps_stemsV: Any

list(flStem)

PostScript vertical stems (describing vertical stroke weights).

Source: FontLab Proteus API documentation

ps_zonesB instance-attribute

ps_zonesB: Any

list(flZone)

PostScript bottom alignment zones (baseline, descender).

Source: FontLab Proteus API documentation

ps_zonesT instance-attribute

ps_zonesT: Any

list(flZone)

PostScript top alignment zones (x-height, cap height, ascender).

Source: FontLab Proteus API documentation

psn instance-attribute

psn: Any

string

PostScript name — the single-word identifier used in PostScript and PDF, e.g. "GillSans-BoldItalic".

Source: FontLab Proteus API documentation

readFromFile

readFromFile(*args: Any, **kwargs: Any) -> Any

flPackage/Nothing readFromFile(string[, StorageInfo*=0])

Load a font from a file path and return its flPackage, or None if the file cannot be opened. The optional StorageInfo controls import options.

Source: FontLab Proteus API documentation

referencesCount

referencesCount(shapeDataId: int) -> int

int referencesCount(uint shapeDataId)

Count how many glyphs reference a particular shared shape data. If this is greater than 1, the shape is used as a component.

Source: FontLab Proteus API documentation

removeMaster

removeMaster(name: Any, remove_glyph_masters: bool) -> Any

removeMaster(string name, bool remove_glyph_masters)

Remove a master. If remove_glyph_masters=True, the corresponding layer is deleted from every glyph as well.

Source: FontLab Proteus API documentation

renameGlyph

renameGlyph(glyph: fgGlyph, name: Any, rename: bool) -> bool

bool renameGlyph(fgGlyph glyph, string name, bool rename)

Rename a glyph. If rename=True, FontLab also updates references to the old name in feature code and components.

Source: FontLab Proteus API documentation

renameMaster

renameMaster(old_name: Any, new_name: Any) -> Any

string renameMaster(string old_name, string new_name)

Rename a master. Returns the name that was actually used (FontLab may adjust it to ensure uniqueness).

Source: FontLab Proteus API documentation

replaceGlyph

replaceGlyph(target: fgGlyph, newGlyph: fgGlyph, rename: bool) -> bool

bool replaceGlyph(fgGlyph target, fgGlyph newGlyph, bool rename)

Swap one glyph for another. If rename=True, the new glyph takes the old glyph's name.

Source: FontLab Proteus API documentation

replaceShapeWithReference

replaceShapeWithReference(*args: Any, **kwargs: Any) -> Any

flShape/Nothing replaceShapeWithReference(flShape shape, bool process[, string layer_name])

Replace an inline shape with a reference to shared shape data, effectively making it a component.

Source: FontLab Proteus API documentation

resetPackage

resetPackage() -> Any

resetPackage()

Reset the internal package state to defaults. Rarely needed in scripts.

Source: FontLab Proteus API documentation

resetStemData

resetStemData(*args: Any, **kwargs: Any) -> Any

(flStems stemsH, flStems stemsV) resetStemData(flStems stemsH, flStems stemsV)

Reset stem data to default values derived from the font's outline weights.

Source: FontLab Proteus API documentation

runActions

runActions(*args: Any, **kwargs: Any) -> Any

void runActions(QList &glyphs, QStringList actions, int layer_mode, bool do_undo)

Apply one or more named actions to a list of glyphs. Pass do_undo=True to make the operation undoable.

Source: FontLab Proteus API documentation

safeBottom_value instance-attribute

safeBottom_value: Any

double

The bottom of the "safe" rendering zone.

Source: FontLab Proteus API documentation

safeTop_value instance-attribute

safeTop_value: Any

double

The top of the "safe" rendering zone.

Source: FontLab Proteus API documentation

sampleString instance-attribute

sampleString: Any

string

An auto-generated sample text string based on the font's character set.

Source: FontLab Proteus API documentation

setAxis

setAxis(*args: Any, **kwargs: Any) -> Any

setAxis(const flAxis &p)

Update an existing axis with new values (min, max, default, mapping).

Source: FontLab Proteus API documentation

setLocation

setLocation(*args: Any, **kwargs: Any) -> Any

setLocation(flLocation location[, string master_name])

Set the design-space location for a master.

Source: FontLab Proteus API documentation

setMaster

setMaster(notify: Any = ...) -> Any

setMaster(string name[, bool notify = false])

Switch the active master to the one with the given name. Pass notify=True to refresh the UI.

Source: FontLab Proteus API documentation

setUpm

setUpm(upm: int, scale: bool) -> Any

setUpm(int upm, bool scale)

Change the units-per-em value. If scale=True, all outlines and metrics are scaled proportionally so nothing visually changes.

Source: FontLab Proteus API documentation

set_ascender_locked

set_ascender_locked(b: bool) -> Any

set_ascender_locked(bool b)

Lock the ascender metric so it cannot be changed by automatic recalculation.

Source: FontLab Proteus API documentation

set_capsHeight_locked

set_capsHeight_locked(b: bool) -> Any

set_capsHeight_locked(bool b)

Lock the cap-height metric.

Source: FontLab Proteus API documentation

set_descender_locked

set_descender_locked(b: bool) -> Any

set_descender_locked(bool b)

Lock the descender metric.

Source: FontLab Proteus API documentation

set_interpolate

set_interpolate(*args: Any, **kwargs: Any) -> Any

set_interpolate(bool b[, string master_name])

Enable or disable interpolation for the font or a specific master.

Source: FontLab Proteus API documentation

set_measurement_locked

set_measurement_locked(b: bool) -> Any

set_measurement_locked(bool b)

Lock the measurement line position.

Source: FontLab Proteus API documentation

set_xHeight_locked

set_xHeight_locked(b: bool) -> Any

set_xHeight_locked(bool b)

Lock the x-height metric.

Source: FontLab Proteus API documentation

sgn instance-attribute

sgn: Any

string

Style group name (subfamily within the family), e.g. "Bold Italic".

Source: FontLab Proteus API documentation

slantTransform instance-attribute

slantTransform: Any

QTransform

The geometric transform that applies the font's italic slant angle. Used when measuring italic metrics.

Source: FontLab Proteus API documentation

slope instance-attribute

slope: Any

string

Slope string, e.g. "Italic", "Oblique".

Source: FontLab Proteus API documentation

smartCornerParameters instance-attribute

smartCornerParameters: Any

SmartCornerParameters

Parameters controlling smart-corner behaviour. Construct with fontlab.SmartCornerParameters(); edit curvature (default 0.67) and inktrap_len (default 2.0), then assign the value back to this property.

Source: FontLab Proteus API documentation

stems

stems(HintingDataType: Any, top: bool) -> Any

list(flStem)& stems(HintingDataType, bool top)

Return the list of PostScript or TrueType stems (horizontal or vertical). The first argument selects PS vs. TT; top selects H vs. V.

Source: FontLab Proteus API documentation

store_font_info

store_font_info(*args: Any, **kwargs: Any) -> Any

store_font_info(fg::Package *package)

Write font info (names, metrics, flags) into a low-level fontgate package. Called internally before export.

Source: FontLab Proteus API documentation

store_hinting_data

store_hinting_data(package: fgPackage) -> Any

store_hinting_data(fgPackage package)

Write the font's hinting data (stems, zones, glyph hints) into a low-level fontgate package. Called internally before export.

Source: FontLab Proteus API documentation

styleCode

styleCode() -> Any

unsigned char styleCode()

Return the OS/2 fsSelection style code byte.

Source: FontLab Proteus API documentation

tfn instance-attribute

tfn: Any

string

Typographic family name — the top-level family name shared by all styles, e.g. "Gill Sans".

Source: FontLab Proteus API documentation