Donner SVG main
0.8.0 ยท 382bd0190.8.0 main
SVG editor and embeddable C⁠+⁠+⁠20 engine.
Loading...
Searching...
No Matches
donner::editor::EditorShellOptions Struct Reference

Initial document and host-capability settings for the editor shell. More...

#include "donner/editor/EditorShell.h"

Public Attributes

std::string svgPath
 SVG file path requested at startup.
std::optional< std::string > initialSource
 Optional initial XML source supplied directly by the host.
std::optional< std::string > initialPath
 Optional path associated with the initial source.
bool allowFileSystemActions = true
 Permit open, save, save-as, and export actions to access the host filesystem.
std::optional< std::string > diagnosticTelemetryOutputPath
 Optional host-selected diagnostic destination; UI input cannot replace it.
bool allowHostClipboardAccess = true
 Permit source and shape clipboard actions to access the host clipboard.
bool showWelcome = false
 Show the in-workspace welcome and sample picker on the first frame.
std::string editorNoticeText
 Host-provided notice displayed in the editor.
bool fitLargeDocumentsOnOpen = true
 Open a document larger than the canvas fitted to it, rather than at 100%. Replays of recordings made before the editor did this turn it off, so their screen coordinates still land where they were recorded.
bool useLegacyCanvasZoomControls = false
 Preserve canvas shortcuts and percentage-control clicks from recordings made before Zoom to Fit.
std::string editorBuildInfo
 Embedded "<version>\n<commit>\n" build metadata displayed in the About dialog. May be empty when the build did not embed it.
std::string fontPreviewCachePath
 Per-user preview cache directory; empty disables disk persistence.
std::optional< std::string > reproOutputPath
 Optional destination path for a .donner-repro recording of the user's UI interactions. When set, the shell constructs a ReproRecorder and snapshots ImGui input state at the start of every frame. Written to disk in the destructor.

Detailed Description

Initial document and host-capability settings for the editor shell.

Member Data Documentation

◆ allowFileSystemActions

bool donner::editor::EditorShellOptions::allowFileSystemActions = true

Permit open, save, save-as, and export actions to access the host filesystem.

◆ allowHostClipboardAccess

bool donner::editor::EditorShellOptions::allowHostClipboardAccess = true

Permit source and shape clipboard actions to access the host clipboard.

◆ diagnosticTelemetryOutputPath

std::optional<std::string> donner::editor::EditorShellOptions::diagnosticTelemetryOutputPath

Optional host-selected diagnostic destination; UI input cannot replace it.

◆ editorBuildInfo

std::string donner::editor::EditorShellOptions::editorBuildInfo

Embedded "<version>\n<commit>\n" build metadata displayed in the About dialog. May be empty when the build did not embed it.

◆ editorNoticeText

std::string donner::editor::EditorShellOptions::editorNoticeText

Host-provided notice displayed in the editor.

◆ fitLargeDocumentsOnOpen

bool donner::editor::EditorShellOptions::fitLargeDocumentsOnOpen = true

Open a document larger than the canvas fitted to it, rather than at 100%. Replays of recordings made before the editor did this turn it off, so their screen coordinates still land where they were recorded.

◆ fontPreviewCachePath

std::string donner::editor::EditorShellOptions::fontPreviewCachePath

Per-user preview cache directory; empty disables disk persistence.

◆ initialPath

std::optional<std::string> donner::editor::EditorShellOptions::initialPath

Optional path associated with the initial source.

◆ initialSource

std::optional<std::string> donner::editor::EditorShellOptions::initialSource

Optional initial XML source supplied directly by the host.

◆ reproOutputPath

std::optional<std::string> donner::editor::EditorShellOptions::reproOutputPath

Optional destination path for a .donner-repro recording of the user's UI interactions. When set, the shell constructs a ReproRecorder and snapshots ImGui input state at the start of every frame. Written to disk in the destructor.

◆ showWelcome

bool donner::editor::EditorShellOptions::showWelcome = false

Show the in-workspace welcome and sample picker on the first frame.

◆ svgPath

std::string donner::editor::EditorShellOptions::svgPath

SVG file path requested at startup.

◆ useLegacyCanvasZoomControls

bool donner::editor::EditorShellOptions::useLegacyCanvasZoomControls = false

Preserve canvas shortcuts and percentage-control clicks from recordings made before Zoom to Fit.


The documentation for this struct was generated from the following file: