blockly/core/events/events_comment_change.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 change event.
 *
 * @class
 */
import type { WorkspaceComment } from '../comments/workspace_comment.js';
import type { Workspace } from '../workspace.js';
import { CommentBase, CommentBaseJson } from './events_comment_base.js';
import { EventType } from './type.js';
/**
 * Notifies listeners that the contents of a workspace comment has changed.
 */
export declare class CommentChange extends CommentBase {
    type: EventType;
    /** The previous contents of the comment. */
    oldContents_?: string;
    /** The new contents of the comment. */
    newContents_?: string;
    /**
     * @param opt_comment The comment that is being changed.  Undefined for a
     *     blank event.
     * @param opt_oldContents Previous contents of the comment.
     * @param opt_newContents New contents of the comment.
     */
    constructor(opt_comment?: WorkspaceComment, opt_oldContents?: string, opt_newContents?: string);
    /**
     * Encode the event as JSON.
     *
     * @returns JSON representation.
     */
    toJson(): CommentChangeJson;
    /**
     * Deserializes the JSON event.
     *
     * @param event The event to append new properties to. Should be a subclass
     *     of CommentChange, 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: CommentChangeJson, workspace: Workspace, event?: any): CommentChange;
    /**
     * Does this event record any change of state?
     *
     * @returns False if something changed.
     */
    isNull(): boolean;
    /**
     * Run a change event.
     *
     * @param forward True if run forward, false if run backward (undo).
     */
    run(forward: boolean): void;
}
export interface CommentChangeJson extends CommentBaseJson {
    oldContents: string;
    newContents: string;
}
//# sourceMappingURL=events_comment_change.d.ts.map