blockly/core/events/events_comment_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 comment creation event.
 *
 * @class
 */
import type { WorkspaceComment } from '../comments/workspace_comment.js';
import * as comments from '../serialization/workspace_comments.js';
import type { Workspace } from '../workspace.js';
import { CommentBase, CommentBaseJson } from './events_comment_base.js';
import { EventType } from './type.js';
/**
 * Notifies listeners that a workspace comment was created.
 */
export declare class CommentCreate extends CommentBase {
    type: EventType;
    /** The XML representation of the created workspace comment. */
    xml?: Element | DocumentFragment;
    /** The JSON representation of the created workspace comment. */
    json?: comments.State;
    /**
     * @param opt_comment The created comment.
     *     Undefined for a blank event.
     */
    constructor(opt_comment?: WorkspaceComment);
    /**
     * Encode the event as JSON.
     *
     * @returns JSON representation.
     */
    toJson(): CommentCreateJson;
    /**
     * Deserializes the JSON event.
     *
     * @param event The event to append new properties to. Should be a subclass
     *     of CommentCreate, 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: CommentCreateJson, workspace: Workspace, event?: any): CommentCreate;
    /**
     * Run a creation event.
     *
     * @param forward True if run forward, false if run backward (undo).
     */
    run(forward: boolean): void;
}
export interface CommentCreateJson extends CommentBaseJson {
    xml: string;
    json: object;
}
//# sourceMappingURL=events_comment_create.d.ts.map