Files
blockly/core/interfaces/i_toolbox.ts
Beka Westberg 29e1f0cb03 fix: tsc errors picked up from develop (#6224)
* fix: relative path for deprecation utils

* fix: checking if properties exist in svg_math

* fix: set all timeout PIDs to AnyDuringMigration

* fix: make nullability errors explicity in block drag surface

* fix: make null check in events_block_change explicit

* fix: make getEventWorkspace_ internal so we can access it from CommentCreateDeleteHelper

* fix: rename DIV -> containerDiv in tooltip

* fix: ignore backwards compat check in category

* fix: set block styles to AnyDuringMigration

* fix: type typo in KeyboardShortcut

* fix: constants name in row measurables

* fix: typecast in mutator

* fix: populateProcedures type of flattened array

* fix: ignore errors related to workspace comment deserialization

* chore: format files

* fix: renaming imports missing file extensions

* fix: remove check for sound.play

* fix: temporarily remove bad requireType.

All `export type` statements are stripped when tsc is run. This means
that when we attempt to require BlockDefinition from the block files, we
get an error because it does not exist.

We decided to temporarily remove the require, because this will no
longer be a problem when we conver the blocks to typescript, and
everything gets compiled together.

* fix: bad jsdoc in array

* fix: silence missing property errors

Closure was complaining about inexistant properties, but they actually
do exist, they're just not being transpiled by tsc in a way that closure
understands.

I.E. if things are initialized in a function called by the constructor,
rather than in a class field or in the custructor itself, closure would
error.

It would also error on enums, because they are transpiled to a weird
IIFE.

* fix: context menu action handler not knowing the type of this.

this: TypeX information gets stripped when tsc is run, so closure could
not know that this was not global. Fixed this by reorganizing to use the
option object directly instead of passing it to onAction to be bound to
this.

* fix: readd getDeveloperVars checks (should not be part of migration)

This was found because ALL_DEVELOPER_VARS_WARNINGS_BY_BLOCK_TYPE was no
longer being accessed.

* fix: silence closure errors about overriding supertype props

We propertly define the overrides in typescript, but these get removed
from the compiled output, so closure doesn't know they exist.

* fix: silence globalThis errors

this: TypeX annotations get stripped from the compiled output, so
closure can't know that we're accessing the correct things. However,
typescript makes sure that this always has the correct properties, so
silencing this should be fine.

* fix: bad jsdoc name

* chore: attempt compiling with blockly.js

* fix: attempt moving the import statement above the namespace line

* chore: add todo comments to block def files

* chore: remove todo from context menu

* chore: add comments abotu disabled errors
2022-06-27 09:25:56 -07:00

125 lines
3.2 KiB
TypeScript

/**
* @license
* Copyright 2020 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
/**
* @fileoverview The interface for a toolbox.
*/
/**
* The interface for a toolbox.
* @namespace Blockly.IToolbox
*/
import * as goog from '../../closure/goog/goog.js';
goog.declareModuleId('Blockly.IToolbox');
/* eslint-disable-next-line no-unused-vars */
// Unused import preserved for side-effects. Remove if unneeded.
import '../utils/toolbox.js';
/* eslint-disable-next-line no-unused-vars */
// Unused import preserved for side-effects. Remove if unneeded.
import './i_flyout.js';
/* eslint-disable-next-line no-unused-vars */
// Unused import preserved for side-effects. Remove if unneeded.
import './i_toolbox_item.js';
/* eslint-disable-next-line no-unused-vars */
// Unused import preserved for side-effects. Remove if unneeded.
import '../workspace_svg.js';
/* eslint-disable-next-line no-unused-vars */
import {IRegistrable} from './i_registrable.js';
/**
* Interface for a toolbox.
* @alias Blockly.IToolbox
*/
export interface IToolbox extends IRegistrable {
/** Initializes the toolbox. */
init: AnyDuringMigration;
/**
* Fills the toolbox with new toolbox items and removes any old contents.
* @param toolboxDef Object holding information for creating a toolbox.
*/
render: AnyDuringMigration;
/**
* Gets the width of the toolbox.
* @return The width of the toolbox.
*/
getWidth: AnyDuringMigration;
/**
* Gets the height of the toolbox.
* @return The width of the toolbox.
*/
getHeight: AnyDuringMigration;
/**
* Gets the toolbox flyout.
* @return The toolbox flyout.
*/
getFlyout: AnyDuringMigration;
/**
* Gets the workspace for the toolbox.
* @return The parent workspace for the toolbox.
*/
getWorkspace: AnyDuringMigration;
/**
* Gets whether or not the toolbox is horizontal.
* @return True if the toolbox is horizontal, false if the toolbox is
* vertical.
*/
isHorizontal: AnyDuringMigration;
/**
* Positions the toolbox based on whether it is a horizontal toolbox and
* whether the workspace is in rtl.
*/
position: AnyDuringMigration;
/** Handles resizing the toolbox when a toolbox item resizes. */
handleToolboxItemResize: AnyDuringMigration;
/** Unhighlights any previously selected item. */
clearSelection: AnyDuringMigration;
/**
* Updates the category colours and background colour of selected categories.
*/
refreshTheme: AnyDuringMigration;
/**
* Updates the flyout's content without closing it. Should be used in
* response to a change in one of the dynamic categories, such as variables or
* procedures.
*/
refreshSelection: AnyDuringMigration;
/**
* Sets the visibility of the toolbox.
* @param isVisible True if toolbox should be visible.
*/
setVisible: AnyDuringMigration;
/**
* Selects the toolbox item by it's position in the list of toolbox items.
* @param position The position of the item to select.
*/
selectItemByPosition: AnyDuringMigration;
/**
* Gets the selected item.
* @return The selected item, or null if no item is currently selected.
*/
getSelectedItem: AnyDuringMigration;
/** Disposes of this toolbox. */
dispose: AnyDuringMigration;
}