Skip to content

fontlab.flWorkspace · declarations 002

Back to fontlab.flWorkspace

isRulersEnabled

isRulersEnabled() -> bool

bool isRulersEnabled()

Returns True if rulers are currently visible.

Source: FontLab Proteus API documentation

mainWindow instance-attribute

mainWindow: Any

QWidget*

The application's main window widget.

Source: FontLab Proteus API documentation

packages

packages() -> list[flObject]

QList& packages()

Returns a list of all open font packages. This is your starting point for any script that processes multiple fonts at once.

Source: FontLab Proteus API documentation

paintBrush instance-attribute

paintBrush: Any

PaintBrush

The active paint brush settings (used by ShapeBuilder brush tools).

Source: FontLab Proteus API documentation

previewRender

previewRender() -> bool

bool previewRender()

Returns whether preview rendering is currently on.

Source: FontLab Proteus API documentation

readProject

readProject(QString: Any) -> bool

bool readProject(const QString)

Opens a project file from path. Returns True on success.

Source: FontLab Proteus API documentation

registerPythonTool

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

registerPythonTool(name, icon or None, object) -> token. Optional activate/deactivate, mousePressed/Moved/Released, keyPressed/Released and paint callbacks.

resetToolCursor

resetToolCursor() -> Any

resetToolCursor()

Resets the cursor to the default arrow.

Source: FontLab Proteus API documentation

saveProject

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

saveProject([QString]) | bool saveProject(QString, QList, QString ui_state

Saves the current project to path. Pass the list of fonts to include and optionally a serialized UI state string.

Source: FontLab Proteus API documentation

setActiveCanvas

setActiveCanvas(arg0: flCanvas) -> Any

setActiveCanvas(flCanvas)

Brings a specific canvas window to the front and makes it active.

Source: FontLab Proteus API documentation

setActiveSketchboard

setActiveSketchboard() -> Any

setActiveSketchboard()

Switches to the Sketchboard canvas.

Source: FontLab Proteus API documentation

setAutoMode

setAutoMode() -> Any

setAutoMode()

Lets FontLab automatically choose the most appropriate tool for the current context.

Source: FontLab Proteus API documentation

setFocusToCanvas

setFocusToCanvas(arg0: flCanvas) -> Any

setFocusToCanvas(flCanvas)

Sends keyboard focus to a canvas without necessarily bringing it to the front.

Source: FontLab Proteus API documentation

setPreviewRender

setPreviewRender(bool: Any) -> Any

setPreviewRender(bool)

Enables or disables preview rendering mode.

Source: FontLab Proteus API documentation

setRenderMode

setRenderMode(RenderMode: Any) -> Any

setRenderMode(RenderMode)

Sets the rendering mode for all canvases (e.g. outline, filled, preview).

Source: FontLab Proteus API documentation

setRulers

setRulers(enabled: bool) -> Any

setRulers(bool enabled)

Shows or hides rulers.

Source: FontLab Proteus API documentation

setToolBrush

setToolBrush() -> Any

setToolBrush()

Activates the Brush tool.

Source: FontLab Proteus API documentation

setToolBucket

setToolBucket() -> Any

setToolBucket()

Activates the Paint Bucket tool.

Source: FontLab Proteus API documentation

setToolCursor

setToolCursor(CursorId: Any) -> Any

setToolCursor(CursorId)

Sets the cursor to a specific shape by CursorId constant.

Source: FontLab Proteus API documentation

setToolEditor

setToolEditor() -> Any

setToolEditor()

Activates the Node/Contour editing tool — the standard editing mode for working with nodes.

Source: FontLab Proteus API documentation

setToolEllipse

setToolEllipse() -> Any

setToolEllipse()

Activates the Ellipse drawing tool.

Source: FontLab Proteus API documentation

setToolGuidelines

setToolGuidelines() -> Any

setToolGuidelines()

Activates the Guidelines tool.

Source: FontLab Proteus API documentation

setToolKnife

setToolKnife() -> Any

setToolKnife()

Activates the Knife tool for cutting contours.

Source: FontLab Proteus API documentation

setToolMagnet

setToolMagnet() -> Any

setToolMagnet()

Activates the Magnet (snap) tool.

Source: FontLab Proteus API documentation

setToolMetrics

setToolMetrics() -> Any

setToolMetrics()

Activates the Metrics tool for adjusting spacing and kerning.

Source: FontLab Proteus API documentation

setToolOptimizer

setToolOptimizer() -> Any

setToolOptimizer()

Activates the Optimizer tool.

Source: FontLab Proteus API documentation

setToolPen

setToolPen() -> Any

setToolPen()

Activates the Pen tool for drawing new Bézier paths.

Source: FontLab Proteus API documentation

setToolPencil

setToolPencil() -> Any

setToolPencil()

Activates the freehand Pencil tool.

Source: FontLab Proteus API documentation

setToolRectangle

setToolRectangle() -> Any

setToolRectangle()

Activates the Rectangle drawing tool.

Source: FontLab Proteus API documentation

setToolRotate

setToolRotate() -> Any

setToolRotate()

Activates the Rotate tool.

Source: FontLab Proteus API documentation

setToolScale

setToolScale() -> Any

setToolScale()

Activates the Scale tool.

Source: FontLab Proteus API documentation

setToolScissors

setToolScissors() -> Any

setToolScissors()

Activates the Scissors tool.

Source: FontLab Proteus API documentation

setToolShape

setToolShape() -> Any

setToolShape()

Activates the Shape selection tool (selects whole shapes, not individual nodes).

Source: FontLab Proteus API documentation

setToolSlant

setToolSlant() -> Any

setToolSlant()

Activates the Slant tool.

Source: FontLab Proteus API documentation

setToolSmartPen

setToolSmartPen() -> Any

setToolSmartPen()

Activates the Smart Pen tool.

Source: FontLab Proteus API documentation

setToolText

setToolText() -> Any

setToolText()

Activates the Text tool for inserting text strings.

Source: FontLab Proteus API documentation

setToolTransform

setToolTransform() -> Any

setToolTransform()

Activates the Transform tool.

Source: FontLab Proteus API documentation

showFocus

showFocus() -> bool

bool showFocus()

Returns whether the focus indicator is visible.

Source: FontLab Proteus API documentation

showSmallItems

showSmallItems() -> bool

bool showSmallItems()

Returns whether small items (like tiny nodes) are shown.

Source: FontLab Proteus API documentation

signedObjects instance-attribute

signedObjects: Any

QMap

A map of all "signed" (tracked/registered) objects in the workspace. Used internally for object identity management.

Source: FontLab Proteus API documentation