blockly/core/events/events_var_create.d.ts

Blockly is a library for building visual programming editors.

/**
 * @license
 * Copyright 2018 Google LLC
 * SPDX-License-Identifier: Apache-2.0
 */
/**
 * Class for a variable creation event.
 *
 * @class
 */
import type { IVariableModel, IVariableState } from '../interfaces/i_variable_model.js';
import type { Workspace } from '../workspace.js';
import { VarBase, VarBaseJson } from './events_var_base.js';
import { EventType } from './type.js';
/**
 * Notifies listeners that a variable model has been created.
 */
export declare class VarCreate extends VarBase {
    type: EventType;
    /** The type of the variable that was created. */
    varType?: string;
    /** The name of the variable that was created. */
    varName?: string;
    /**
     * @param opt_variable The created variable. Undefined for a blank event.
     */
    constructor(opt_variable?: IVariableModel<IVariableState>);
    /**
     * Encode the event as JSON.
     *
     * @returns JSON representation.
     */
    toJson(): VarCreateJson;
    /**
     * Deserializes the JSON event.
     *
     * @param event The event to append new properties to. Should be a subclass
     *     of VarCreate, but we can't specify that due to the fact that parameters
     *     to static methods in subclasses must be supertypes of parameters to
     *     static methods in superclasses.
     * @internal
     */
    static fromJson(json: VarCreateJson, workspace: Workspace, event?: any): VarCreate;
    /**
     * Run a variable creation event.
     *
     * @param forward True if run forward, false if run backward (undo).
     */
    run(forward: boolean): void;
}
export interface VarCreateJson extends VarBaseJson {
    varType: string;
    varName: string;
}
//# sourceMappingURL=events_var_create.d.ts.map