Skip to content

fontlab.flPackage · declarations 001

Back to fontlab.flPackage

activateGlyph

activateGlyph(arg0: flGlyph) -> Any

activateGlyph(flGlyph)

Open the given glyph in the glyph editor and make it active.

Source: FontLab Proteus API documentation

addAxis

addAxis(variable: flAxis) -> Any

string addAxis(flAxis variable)

Add a design-space axis (e.g. Weight, Width). Returns the accepted axis name.

Source: FontLab Proteus API documentation

addGlyph

addGlyph(flGlyph: Any) -> Any

addGlyph(fgGlyph / flGlyph )

Add a glyph to the font. The glyph must have a unique name; use findNewName if you're not sure.

Source: FontLab Proteus API documentation

addInstance

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

addInstance(const flInstance &instance)

Add a named instance to the font.

Source: FontLab Proteus API documentation

addMaster

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

string addMaster(string master_name, bool create_glyphs, flPackage source, string source_layer_name, bool copy_metrics, bool create_missing_glyphs[, flLocation location])

Add a new master to the font. If create_glyphs=True, empty glyph layers are created for every existing glyph. Pass a source package to copy layer data from it. Returns the accepted master name.

Source: FontLab Proteus API documentation

allGuidelines instance-attribute

allGuidelines: Any

QList

All guidelines including any special types.

Source: FontLab Proteus API documentation

ascender_value instance-attribute

ascender_value: Any

double

The ascender height — how far the tallest ascenders reach above the baseline, in font units.

Source: FontLab Proteus API documentation

assignData

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

assignData(const flPackage &package)

Copy all data from another package into this one. Overwrites everything.

Source: FontLab Proteus API documentation

autoKern

autoKern(left: flGlyph, right: flGlyph, master_name: Any) -> Any

autoKern(flGlyph left, flGlyph right, string master_name)

Automatically calculate and set a kern value for a specific pair of glyphs in the given master.

Source: FontLab Proteus API documentation

autohintGlyphs

autohintGlyphs(glyphs: list[flGlyph], make_hints: bool) -> Any

autohintGlyphs(QList glyphs, bool make_hints)

Run FontLab's auto-hinting algorithm on a list of glyphs. Pass make_hints=True to actually write the hints; False just analyses without committing.

Source: FontLab Proteus API documentation

axes instance-attribute

axes: Any

QList

All design-space axes defined in this font.

Source: FontLab Proteus API documentation

bold instance-attribute

bold: Any

bool

True if this font is styled as bold. Sets the relevant OS/2 bits.

Source: FontLab Proteus API documentation

buildShapeDataNames

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

QSet buildShapeDataNames(objId exclude[, string layer_name])

Return a set of all unique shared shape data names in the font, excluding a given object. Useful for generating new unique names.

Source: FontLab Proteus API documentation

can_interpolate

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

bool can_interpolate([string master_name])

Return True if the font (or a specific master) is compatible for interpolation — meaning all glyphs have matching structure across masters.

Source: FontLab Proteus API documentation

capsHeight_value instance-attribute

capsHeight_value: Any

double

The cap height — the distance from baseline to the top of flat capital letters like "H".

Source: FontLab Proteus API documentation

caretOffset_value instance-attribute

caretOffset_value: Any

double

Horizontal offset for the text insertion caret in italic fonts.

Source: FontLab Proteus API documentation

checkAxisName

checkAxisName(name: Any) -> Any

string checkAxisName(string name)

Validate and potentially correct an axis name, ensuring it meets OpenType requirements.

Source: FontLab Proteus API documentation

checkVariableName

checkVariableName(name: Any) -> Any

string checkVariableName(string name)

clearActiveGlyphs

clearActiveGlyphs() -> Any

clearActiveGlyphs()

clearInstances

clearInstances() -> Any

clearInstances()

Remove all named instances.

Source: FontLab Proteus API documentation

clearMasters

clearMasters(release: bool) -> Any

clearMasters(bool release)

Remove all masters from the font. Pass release=True to also free the underlying memory. Destructive — use with care.

Source: FontLab Proteus API documentation

close

close(prompt: Any = True) -> Any

close(prompt=True) - Close the font, prompting for unsaved changes. Pass False to discard changes without prompting.

Close the font. With no argument or True, prompt to save unsaved changes. Pass False to discard changes and close without prompting. Canceling the prompt leaves the font open.

Source: FontLab Proteus API documentation

collectNames

collectNames(storage: Any) -> Any

collectNames(StorageInfo * storage)

Collect all glyph names into the storage descriptor before saving.

Source: FontLab Proteus API documentation

completeData

completeData(fg_data: Any = ...) -> Any

completeData([bool fg_data = false])

Fill in any missing font information — default names, metrics, and flags — based on what is already set. Useful after programmatically building a font from scratch.

Source: FontLab Proteus API documentation

convertZonesToGuidelines

convertZonesToGuidelines(zonesT: flZones, zonesB: flZones) -> Any

convertZonesToGuidelines(flZones zonesT, flZones zonesB)

Convert a set of alignment zones into font-level guidelines. Useful for visual reference while drawing.

Source: FontLab Proteus API documentation

cornerTension_value instance-attribute

cornerTension_value: Any

double

The global corner tension for smart corners.

Source: FontLab Proteus API documentation

counterAnchors instance-attribute

counterAnchors: Any

int

The number of font-level anchor points defined.

Source: FontLab Proteus API documentation

counterGuides instance-attribute

counterGuides: Any

int

The number of font-level guidelines.

Source: FontLab Proteus API documentation

currentSearch instance-attribute

currentSearch: Any

QByteArray

The serialised state of the current font-window search filter.

Source: FontLab Proteus API documentation

curveTension instance-attribute

curveTension: Any

double

Global curve tension value — affects how FontLab draws Bézier curves.

Source: FontLab Proteus API documentation

curveTension_value instance-attribute

curveTension_value: Any

double

The global curve tension (0–1 scale).

Source: FontLab Proteus API documentation

defaultMaster instance-attribute

defaultMaster: Any

string

The name of the master used as the interpolation origin (usually the "Regular" or middle weight).

Source: FontLab Proteus API documentation

deleteGlyph

deleteGlyph(flGlyph: Any) -> bool

bool deleteGlyph(fgGlyph / flGlyph )

Remove a glyph from the font permanently. Returns True on success.

Source: FontLab Proteus API documentation

deleteGroups

deleteGroups(ids: set[int], deleteDependentContent: bool) -> Any

deleteGroups(QSet ids, bool deleteDependentContent)

Delete one or more groups. If deleteDependentContent=True, also removes kerning pairs that depended on those groups.

Source: FontLab Proteus API documentation

descender_value instance-attribute

descender_value: Any

double

The descender depth — a negative number for how far descenders drop below the baseline.

Source: FontLab Proteus API documentation

elidedName instance-attribute

elidedName: Any

string

A shortened family name used when the full name is too long for some environments.

Source: FontLab Proteus API documentation

ensureProteusData

ensureProteusData() -> Any

ensureProteusData()

Ensure that FontLab's Proteus-specific metadata block is initialised on this package.

Source: FontLab Proteus API documentation

family_zones

family_zones(top: bool) -> Any

list(flZone)& family_zones(bool top)

Return the family-level alignment zones, which apply across all masters.

Source: FontLab Proteus API documentation

family_zonesB instance-attribute

family_zonesB: Any

list(flZone)

Family-level bottom zones, shared across all masters.

Source: FontLab Proteus API documentation

family_zonesT instance-attribute

family_zonesT: Any

list(flZone)

Family-level top zones, shared across all masters.

Source: FontLab Proteus API documentation