Skip to content

fontlab.flWorkspace · declarations 001

Back to fontlab.flWorkspace

RenderMode instance-attribute

RenderMode: dict

activateEditor

activateEditor(arg0: flVisualItem, canvas_pos: QPointF) -> Any

activateEditor(flVisualItem, QPointF canvas_pos)

Opens the full editor for a specific visual item at the given canvas position.

Source: FontLab Proteus API documentation

activateNext

activateNext() -> Any

activateNext()

Switches focus to the next canvas in order — like pressing Ctrl+Tab to cycle through windows.

Source: FontLab Proteus API documentation

activatePrev

activatePrev() -> Any

activatePrev()

Switches focus to the previous canvas.

Source: FontLab Proteus API documentation

activeFontPanel instance-attribute

activeFontPanel: Any

QWidget*

The active (focused) font panel widget.

Source: FontLab Proteus API documentation

activeTextMode instance-attribute

activeTextMode: Any

EditMode

The current text-editing mode (relevant in the Text/Metrics window).

Source: FontLab Proteus API documentation

addFamilyMembers

addFamilyMembers(match_subfamily: Any = ...) -> bool

bool addFamilyMembers(QList &packages[, bool match_subfamily = false])

Links multiple open fonts together as a family. Set match_subfamily=True to match by subfamily name as well.

Source: FontLab Proteus API documentation

addPackage

addPackage(arg0: flPackage) -> Any

addPackage(flPackage)

Opens and registers a font package in the workspace, making it appear in the application.

Source: FontLab Proteus API documentation

attachCanvas

attachCanvas(arg0: flCanvas) -> Any

attachCanvas(flCanvas)

Registers a new canvas with the workspace, making it part of the application's window management.

Source: FontLab Proteus API documentation

blockUpdate

blockUpdate(time: Any = ...) -> Any

blockUpdate([int time = 2000])

Suppresses screen updates for time milliseconds. Useful during batch edits to avoid flickering. The screen refreshes automatically when the block expires.

Source: FontLab Proteus API documentation

canvases

canvases() -> list[flObject]

QList canvases()

Returns all open canvas windows.

Source: FontLab Proteus API documentation

closePackage

closePackage(arg0: flPackage) -> Any

closePackage(flPackage)

Closes a font package and removes it from the workspace.

Source: FontLab Proteus API documentation

closeProject

closeProject() -> Any

closeProject()

Closes the current project.

Source: FontLab Proteus API documentation

convertMouseEvent

convertMouseEvent(QMouseEvent: Any, arg1: QPoint) -> flMouseEvent

flMouseEvent convertMouseEvent(QEvent | QMouseEvent, QPoint)

Converts a Qt mouse event into a FontLab mouse event. Used when writing custom tools or event handlers.

Source: FontLab Proteus API documentation

createNewProject

createNewProject() -> Any

createNewProject()

Creates a new empty project.

Source: FontLab Proteus API documentation

currentFontPanel instance-attribute

currentFontPanel: Any

QWidget*

The current font panel widget.

Source: FontLab Proteus API documentation

currentGlyph instance-attribute

currentGlyph: Any

flGlyphInfo

Information about the glyph currently open in the glyph editor. Read this to find out which glyph the user is looking at right now.

Source: FontLab Proteus API documentation

currentPackage instance-attribute

currentPackage: Any

flPackage

The currently active (foreground) font — the one whose window is in front. Setting this switches which font FontLab considers "current".

Source: FontLab Proteus API documentation

cursorId instance-attribute

cursorId: Any

CursorId

The current cursor shape displayed over the application.

Source: FontLab Proteus API documentation

deactivateEditor

deactivateEditor() -> Any

deactivateEditor()

Closes the current editor mode, returning to the font window.

Source: FontLab Proteus API documentation

defaultFontSize instance-attribute

defaultFontSize: Any

int

The default point size used when creating new text blocks in the Metrics or Text window.

Source: FontLab Proteus API documentation

destroyCanvas

destroyCanvas(arg0: flCanvas) -> Any

destroyCanvas(flCanvas)

Closes and destroys a canvas window.

Source: FontLab Proteus API documentation

doZoomIn

doZoomIn(s: Any = ...) -> Any

doZoomIn([double s = 2.0])

Zooms into the active canvas by factor s. Default doubles the zoom.

Source: FontLab Proteus API documentation

doZoomOut

doZoomOut(s: Any = ...) -> Any

doZoomOut([double s = 0.5])

Zooms out of the active canvas by factor s. Default halves the zoom.

Source: FontLab Proteus API documentation

exportCurrentFont

exportCurrentFont() -> Any

exportCurrentFont()

Exports the currently active font using whatever export settings are configured in the Font Info → Export dialog.

Source: FontLab Proteus API documentation

exportFont

exportFont(arg0: flPackage, ExportControl: Any) -> Any

exportFont(flPackage, ExportControl)

Exports a specific font with explicit export options. Useful for batch export scripts where you want to control format and destination precisely.

Source: FontLab Proteus API documentation

exportTo

exportTo(filename: str, format: str = ...) -> bool

bool exportTo(QString filename, QString format=['EPS' | 'JPG' | 'PDF' | 'PNG' | 'SVG'])

Exports visible canvas content to a file. format is one of 'EPS', 'JPG', 'PDF', 'PNG', or 'SVG'.

Source: FontLab Proteus API documentation

findPackageId

findPackageId(id: int) -> flPackage

flPackage findPackageId(uint id)

Finds an open font by its internal numeric ID. Handy when you've stored an ID and need to get back to the font object.

Source: FontLab Proteus API documentation

getActiveCanvas

getActiveCanvas() -> Any

flCanvas/Nothing getActiveCanvas()

Returns the canvas that currently has focus — the one in front. Returns None if no glyph window is open. This is the most common way to get a reference to the current editor.

Source: FontLab Proteus API documentation

getActiveTextBlock

getActiveTextBlock() -> Any

flTextBlockItem/Nothing getActiveTextBlock()

Returns the text block item that is currently active in the metrics or text window.

Source: FontLab Proteus API documentation

getActiveTextBlockModel

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

flTextBlock/Nothing getActiveTextBlockModel(): model of the exact active text block

Returns the exact active item's typed text-block model, or None when no item is active. Use this reader from Python: the legacy graphics-item getter depends on PythonQt wrapper availability. Does not select or activate a block.

Source: FontLab Proteus API documentation

getBoundingRect

getBoundingRect() -> QRectF

QRectF getBoundingRect()

Returns the bounding rectangle enclosing all content across open canvases.

Source: FontLab Proteus API documentation

getCanvasForViewport

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

flCanvas/Nothing getCanvasForViewport(QWidget*)

Finds the canvas associated with a specific Qt viewport widget. Mostly useful when building custom UI panels.

Source: FontLab Proteus API documentation

getCanvasUnderCursor

getCanvasUnderCursor() -> flCanvas

flCanvas getCanvasUnderCursor()

Returns whichever canvas window the mouse cursor is currently hovering over.

Source: FontLab Proteus API documentation

guidelinesUpdater

guidelinesUpdater() -> flNotifier

flNotifier guidelinesUpdater()

Returns the notifier that signals guideline changes.

Source: FontLab Proteus API documentation

hasPackage

hasPackage(flPackage: Any) -> bool

bool hasPackage(const flPackage)

Returns True if the given font is currently open. Useful for checking before operating on a package.

Source: FontLab Proteus API documentation

haveActiveEditor

haveActiveEditor() -> bool

bool haveActiveEditor()

Returns True if a glyph editor window is currently open and ready.

Source: FontLab Proteus API documentation

init

init() -> Any

init()

Initialises the workspace subsystem. Usually called by FontLab on startup.

Source: FontLab Proteus API documentation

instance

instance() -> flWorkspace

flWorkspace instance()

Returns the global workspace singleton — the FontLab application object.

Source: FontLab Proteus API documentation

isActiveCanvas

isActiveCanvas(flCanvas: Any) -> bool

bool isActiveCanvas(const flCanvas)

Checks whether the given canvas is the currently active one.

Source: FontLab Proteus API documentation