mirror of
https://github.com/google/blockly.git
synced 2026-05-13 07:30:10 +02:00
Beka Westberg
9d5dcc6e46
* chore: fix circular dependencies w/ static workspace funcs * remove preserved imports that aren't currently necessary (probably) * fix circular dependency with workspaces and block using stub * fix dependency between variables and xml by moving function to utils * add stub for trashcan as well * fix line endings from rebase * fix goog/base order * add trashcan patch * fix: types of compose and decompose in block * fix: workspace naming in toolbox * chore: add jsdoc * chore: restore registry comments to better positions * chore: remove implementations in goog.js * chore: fix types of stubs * chore: remove added AnyDuringMigration casts * chore: remove modifications to xml and variables * chore: format * chore: remove event requirements in workspace comments * chore: fix circular dependency with xml and workspace comments * fixup remove ContextMenu import * chore: fix dependency between mutator and workspace * chore: break circular dependency between names and procedures * chore: get tests to run? * chore: pr comments' * chore: fix stubbing field registry fromJson * chore: fix spying on fire * chore: fix stubbing parts of connection checker * chore: fix stubbing dialog * chore: fix stubbing style * chore: fix spying on duplicate * chore: fix stubbing variables * chore: fix stubbing copy * chore: fix stubbing in workspace * chore: remove unnecessary stubs * chore: fix formatting * chore: fix other formatting * chore: add backwards compatible static properties to workspace * chore: move static type properties * chore: move and comment stubs * chore: add newlines at EOF * chore: improve errors for monkey patched functions * chore: update comment with a pointer to the doc * chore: update comment with a pointer to the doc * chore: format
81 lines
2.4 KiB
TypeScript
81 lines
2.4 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright 2021 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
/**
|
|
* @fileoverview The interface for a component that has a handler for when a
|
|
* block is dropped on top of it.
|
|
*/
|
|
|
|
/**
|
|
* The interface for a component that has a handler for when a
|
|
* block is dropped on top of it.
|
|
* @namespace Blockly.IDragTarget
|
|
*/
|
|
import * as goog from '../../closure/goog/goog.js';
|
|
goog.declareModuleId('Blockly.IDragTarget');
|
|
|
|
/* eslint-disable-next-line no-unused-vars */
|
|
/* eslint-disable-next-line no-unused-vars */
|
|
// Unused import preserved for side-effects. Remove if unneeded.
|
|
// import './i_draggable.js';
|
|
/* eslint-disable-next-line no-unused-vars */
|
|
// Unused import preserved for side-effects. Remove if unneeded.
|
|
// import '../utils/rect.js';
|
|
|
|
import type {IComponent} from './i_component.js';
|
|
|
|
|
|
/**
|
|
* Interface for a component with custom behaviour when a block or bubble is
|
|
* dragged over or dropped on top of it.
|
|
* @alias Blockly.IDragTarget
|
|
*/
|
|
export interface IDragTarget extends IComponent {
|
|
/**
|
|
* Returns the bounding rectangle of the drag target area in pixel units
|
|
* relative to viewport.
|
|
* @return The component's bounding box. Null if drag target area should be
|
|
* ignored.
|
|
*/
|
|
getClientRect: AnyDuringMigration;
|
|
|
|
/**
|
|
* Handles when a cursor with a block or bubble enters this drag target.
|
|
* @param dragElement The block or bubble currently being dragged.
|
|
*/
|
|
onDragEnter: AnyDuringMigration;
|
|
|
|
/**
|
|
* Handles when a cursor with a block or bubble is dragged over this drag
|
|
* target.
|
|
* @param dragElement The block or bubble currently being dragged.
|
|
*/
|
|
onDragOver: AnyDuringMigration;
|
|
|
|
/**
|
|
* Handles when a cursor with a block or bubble exits this drag target.
|
|
* @param dragElement The block or bubble currently being dragged.
|
|
*/
|
|
onDragExit: AnyDuringMigration;
|
|
|
|
/**
|
|
* Handles when a block or bubble is dropped on this component.
|
|
* Should not handle delete here.
|
|
* @param dragElement The block or bubble currently being dragged.
|
|
*/
|
|
onDrop: AnyDuringMigration;
|
|
|
|
/**
|
|
* Returns whether the provided block or bubble should not be moved after
|
|
* being dropped on this component. If true, the element will return to where
|
|
* it was when the drag started.
|
|
* @param dragElement The block or bubble currently being dragged.
|
|
* @return Whether the block or bubble provided should be returned to drag
|
|
* start.
|
|
*/
|
|
shouldPreventMove: AnyDuringMigration;
|
|
}
|