construct::opal::DefinitionEditorStateTask

OPAL task construct.definition_editor.state: read what the definition editor shows.

Declared in src/libs/libconstruct/construct/opal/DefinitionEditorTasks.hpp
Inherits OpalTask
Group construct

Detailed description

The outputs are the definition, where it lives (home), whether it has unsaved changes (dirty), the active tab, the validation state and badge, the open sections, and the statistics of the live preview. A map or a list goes out as compact JSON. The task changes nothing, so it is idempotent and a plan can skip it.

The task runs on the interface thread. It resolves its document through the plan scope and finds the editor through the DefinitionEditorBridge of the document. If no editor shows that document, it fails with a message that names the active document and construct.definition_editor.open. It is one of the tasks of construct-definition-editor §DUO-4.

See also DefinitionEditorOpenTask.