construct::opal::DefinitionEditorEditTask

OPAL task construct.definition_editor.edit: change the record that the definition editor shows, as a control or a tab does.

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

Detailed description

A call gives one of two forms, and the task fails with the state unchanged when it gets both or neither:

  • path and value set one value and keep every other character of the text. path is a list of keys and indexes, or one top-level key.
  • tab (Shader, Blend, Preview or Source) and text replace what that tab shows.

The change is not saved. DefinitionEditorSaveTask saves it, and DefinitionEditorRevertTask gives it up.

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, DefinitionEditorStateTask.