gum-tool-delete-logic

What problem does it solve?

Provides a concise reference to prevent incorrect or unsafe deletions in the Gum editor by clarifying which APIs to call, when confirmation and undo locks are required, and how plugin options are surfaced in the delete dialog. It helps developers and integrators avoid direct data-mutation calls from UI code and ensures deletions follow the correct confirmation and mutation paths.

Core Features & Use Cases

• Two clear delete patterns: AskTo* flows for states and categories with blocking validation, and a shared DeleteSelection flow for screens, components, behaviors, and instances that shows a DeleteOptionsWindow and supports plugin contributions.
• Responsibility split: IEditCommands handles user-facing dialogs and undo locks while IDeleteLogic performs pure data mutation, enabling safer code organization and testability.
• Testability & extensibility: Contains a testable seam for dialog message construction and documents plugin extension points such as DeleteObjectPlugin for "Delete XML?" and "Delete children?" options.
• Use Case: When a user presses Delete on an element tree or chooses Remove > Element, follow EditCommands.DeleteSelection to show the dialog and then let DeleteLogic.Remove* perform the actual removal.

Quick Start

Use this guide to determine whether to call IEditCommands.AskToDeleteState, IEditCommands.DeleteSelection, or the IDeleteLogic.Remove* method for a selected deletion scenario.