mirror of
https://github.com/google/blockly.git
synced 2026-05-10 14:10:11 +02:00
Beka Westberg
f85304f0ae
* chore: automatically change imports to import types * chore: revert changes that actually need to be imports * chore: format * chore: add more import type statements based on importsNotUsedAsValues * chore: fix tsconfig * chore: add link to compiler issue
86 lines
2.5 KiB
TypeScript
86 lines
2.5 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright 2020 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
/**
|
|
* @fileoverview The interface for a bubble.
|
|
*/
|
|
|
|
/**
|
|
* The interface for a bubble.
|
|
* @namespace Blockly.IBubble
|
|
*/
|
|
import * as goog from '../../closure/goog/goog.js';
|
|
goog.declareModuleId('Blockly.IBubble');
|
|
|
|
/* eslint-disable-next-line no-unused-vars */
|
|
// Unused import preserved for side-effects. Remove if unneeded.
|
|
import '../block_drag_surface.js';
|
|
/* eslint-disable-next-line no-unused-vars */
|
|
// Unused import preserved for side-effects. Remove if unneeded.
|
|
import '../utils/coordinate.js';
|
|
|
|
import type {IContextMenu} from './i_contextmenu.js';
|
|
import type {IDraggable} from './i_draggable.js';
|
|
|
|
|
|
/**
|
|
* A bubble interface.
|
|
* @alias Blockly.IBubble
|
|
*/
|
|
export interface IBubble extends IDraggable, IContextMenu {
|
|
/**
|
|
* Return the coordinates of the top-left corner of this bubble's body
|
|
* relative to the drawing surface's origin (0,0), in workspace units.
|
|
* @return Object with .x and .y properties.
|
|
*/
|
|
getRelativeToSurfaceXY: AnyDuringMigration;
|
|
|
|
/**
|
|
* Return the root node of the bubble's SVG group.
|
|
* @return The root SVG node of the bubble's group.
|
|
*/
|
|
getSvgRoot: AnyDuringMigration;
|
|
|
|
/**
|
|
* Set whether auto-layout of this bubble is enabled. The first time a bubble
|
|
* is shown it positions itself to not cover any blocks. Once a user has
|
|
* dragged it to reposition, it renders where the user put it.
|
|
* @param enable True if auto-layout should be enabled, false otherwise.
|
|
*/
|
|
setAutoLayout: AnyDuringMigration;
|
|
|
|
/**
|
|
* Triggers a move callback if one exists at the end of a drag.
|
|
* @param adding True if adding, false if removing.
|
|
*/
|
|
setDragging: AnyDuringMigration;
|
|
|
|
/**
|
|
* Move this bubble during a drag, taking into account whether or not there is
|
|
* a drag surface.
|
|
* @param dragSurface The surface that carries rendered items during a drag,
|
|
* or null if no drag surface is in use.
|
|
* @param newLoc The location to translate to, in workspace coordinates.
|
|
*/
|
|
moveDuringDrag: AnyDuringMigration;
|
|
|
|
/**
|
|
* Move the bubble to the specified location in workspace coordinates.
|
|
* @param x The x position to move to.
|
|
* @param y The y position to move to.
|
|
*/
|
|
moveTo: AnyDuringMigration;
|
|
|
|
/**
|
|
* Update the style of this bubble when it is dragged over a delete area.
|
|
* @param enable True if the bubble is about to be deleted, false otherwise.
|
|
*/
|
|
setDeleteStyle: AnyDuringMigration;
|
|
|
|
/** Dispose of this bubble. */
|
|
dispose: () => void;
|
|
}
|