Augene2Integration

uapmd_augene2::Integration: the Augene2 project service and everything its panel presents.

Every member runs on the model thread. Requests complete asynchronously: picking, compilation and applying the result to the timeline advance in PanelRegistry.update. Imports pick files through AppModel.documentProvider, which the host must keep ticking.

This object does not keep the service alive; once the application releases it (PanelRegistry.clearRetainedPanels) every member reads empty and every request is ignored. close releases only this reference.

Inheritors

AndroidAugene2Integration
JsAugene2Integration
JvmAugene2Integration
NativeAugene2Integration
WasmJsAugene2Integration

Properties

Link copied to clipboard
abstract val busy: Boolean

A document pick, an apply, or another history operation is in progress; edits are ignored.

Link copied to clipboard
abstract val compiling: Boolean

Sources are being checked or compiled.

Link copied to clipboard
abstract val diagnostics: List<String>
Link copied to clipboard
abstract var isOpen: Boolean

Panel visibility. The addin command opens it; disabling the addin closes it.

Link copied to clipboard
abstract var resourceFolder: String

Optional project-relative folder imported resources are placed under.

Link copied to clipboard
Link copied to clipboard
abstract val status: String
Link copied to clipboard

Functions

Link copied to clipboard
expect abstract fun close()
Link copied to clipboard
abstract fun compile()

Refreshes linked files, compiles, and applies the result as one undo step.

Link copied to clipboard
abstract fun importSources(compile: Boolean)

Picks MML files. Inputs (compile = true) are compiled; the others are only available to #include.

Link copied to clipboard
abstract fun relinkSource(path: String)

Picks a replacement file for the resource at path.

Link copied to clipboard
abstract fun removeSource(path: String)