/**
 * Copyright 2023-present DreamNum Co., Ltd.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
import type { RichTextValue } from '@univerjs/core';
import type { IEventBase } from '@univerjs/core/facade';
import type { FWorkbook, FWorksheet } from '@univerjs/sheets/facade';
import type { FTheadCommentItem, FThreadComment } from './f-thread-comment';
import { FEventName } from '@univerjs/core/facade';
/**
 * @ignore
 */
interface IFSheetsThreadCommentEventNameMixin {
    /**
     * Event fired after comment added
     * @see {@link ISheetCommentAddEventParams}
     * @example
     * ```ts
     * const disposable = univerAPI.addEvent(univerAPI.Event.CommentAdded, (params) => {
     *   const { comment, workbook, worksheet, row, col } = params;
     *   console.log(params);
     * });
     *
     * // Remove the event listener, use `disposable.dispose()`
     * ```
     */
    readonly CommentAdded: 'CommentAdded';
    /**
     * Event fired before comment added
     * @see {@link IBeforeSheetCommentAddEventParams}
     * @example
     * ```ts
     * const disposable = univerAPI.addEvent(univerAPI.Event.BeforeCommentAdd, (params) => {
     *   const { comment, workbook, worksheet, row, col } = params;
     *   console.log(params);
     *
     *   // Cancel the comment add operation
     *   params.cancel = true;
     * });
     *
     * // Remove the event listener, use `disposable.dispose()`
     * ```
     */
    readonly BeforeCommentAdd: 'BeforeCommentAdd';
    /**
     * Event fired after comment updated
     * @see {@link ISheetCommentUpdateEventParams}
     * @example
     * ```ts
     * const disposable = univerAPI.addEvent(univerAPI.Event.CommentUpdated, (params) => {
     *   const { comment, workbook, worksheet, row, col } = params;
     *   console.log(params);
     * });
     *
     * // Remove the event listener, use `disposable.dispose()`
     * ```
     */
    readonly CommentUpdated: 'CommentUpdated';
    /**
     * Event fired before comment update
     * @see {@link IBeforeSheetCommentUpdateEventParams}
     * @example
     * ```ts
     * const disposable = univerAPI.addEvent(univerAPI.Event.BeforeCommentUpdate, (params) => {
     *   const { comment, workbook, worksheet, row, col, newContent } = params;
     *   console.log(params);
     *
     *   // Cancel the comment update operation
     *   params.cancel = true;
     * });
     *
     * // Remove the event listener, use `disposable.dispose()`
     * ```
     */
    readonly BeforeCommentUpdate: 'BeforeCommentUpdate';
    /**
     * Event fired after comment deleted
     * @see {@link ISheetCommentDeleteEventParams}
     * @example
     * ```ts
     * const disposable = univerAPI.addEvent(univerAPI.Event.CommentDeleted, (params) => {
     *   const { commentId, workbook, worksheet } = params;
     *   console.log(params);
     * });
     *
     * // Remove the event listener, use `disposable.dispose()`
     * ```
     */
    readonly CommentDeleted: 'CommentDeleted';
    /**
     * Event fired before comment delete
     * @see {@link IBeforeSheetCommentDeleteEventParams}
     * @example
     * ```ts
     * const disposable = univerAPI.addEvent(univerAPI.Event.BeforeCommentDelete, (params) => {
     *   const { comment, workbook, worksheet, row, col } = params;
     *   console.log(params);
     *
     *   // Cancel the comment delete operation
     *   params.cancel = true;
     * });
     *
     * // Remove the event listener, use `disposable.dispose()`
     * ```
     */
    readonly BeforeCommentDelete: 'BeforeCommentDelete';
    /**
     * Event fired after comment resolve
     * @see {@link ISheetCommentResolveEventParams}
     * @example
     * ```ts
     * const disposable = univerAPI.addEvent(univerAPI.Event.CommentResolved, (params) => {
     *   const { comment, row, col, resolved, workbook, worksheet } = params;
     *   console.log(params);
     * });
     *
     * // Remove the event listener, use `disposable.dispose()`
     * ```
     */
    readonly CommentResolved: 'CommentResolved';
    /**
     * Event fired before comment resolve
     * @see {@link ISheetCommentResolveEventParams}
     * @example
     * ```ts
     * const disposable = univerAPI.addEvent(univerAPI.Event.BeforeCommentResolve, (params) => {
     *   const { comment, row, col, resolved, workbook, worksheet } = params;
     *   console.log(params);
     *
     *   // Cancel the comment resolve operation
     *   params.cancel = true;
     * });
     *
     * // Remove the event listener, use `disposable.dispose()`
     * ```
     */
    readonly BeforeCommentResolve: 'BeforeCommentResolve';
}
/**
 * @ignore
 */
export declare class FSheetsThreadCommentEventNameMixin extends FEventName implements IFSheetsThreadCommentEventNameMixin {
    get CommentAdded(): 'CommentAdded';
    get BeforeCommentAdd(): 'BeforeCommentAdd';
    get CommentUpdated(): 'CommentUpdated';
    get BeforeCommentUpdate(): 'BeforeCommentUpdate';
    get CommentDeleted(): 'CommentDeleted';
    get BeforeCommentDelete(): 'BeforeCommentDelete';
    get CommentResolved(): 'CommentResolved';
    get BeforeCommentResolve(): 'BeforeCommentResolve';
}
/**
 * Event interface triggered after a comment is added to a sheet
 * @interface ISheetCommentAddEventParams
 * @augments {IEventBase}
 */
export interface ISheetCommentAddEventParams extends IEventBase {
    /** The workbook instance */
    workbook: FWorkbook;
    /** The worksheet where the comment is added */
    worksheet: FWorksheet;
    /** Row index of the comment */
    row: number;
    /** Column index of the comment */
    col: number;
    /** The added comment object */
    comment: FThreadComment;
}
/**
 * Event interface triggered before a comment is added to a sheet
 * @interface IBeforeSheetCommentAddEventParams
 * @augments {IEventBase}
 */
export interface IBeforeSheetCommentAddEventParams extends IEventBase {
    /** The workbook instance */
    workbook: FWorkbook;
    /** The worksheet where the comment will be added */
    worksheet: FWorksheet;
    /** Row index for the new comment */
    row: number;
    /** Column index for the new comment */
    col: number;
    /** The comment item to be added */
    comment: FTheadCommentItem;
}
/**
 * Event interface triggered after a comment is updated in a sheet
 * @interface ISheetCommentUpdateEventParams
 * @augments {IEventBase}
 */
export interface ISheetCommentUpdateEventParams extends IEventBase {
    /** The workbook instance */
    workbook: FWorkbook;
    /** The worksheet containing the updated comment */
    worksheet: FWorksheet;
    /** Row index of the comment */
    row: number;
    /** Column index of the comment */
    col: number;
    /** The updated comment object */
    comment: FThreadComment;
}
/**
 * Event interface triggered before a comment is updated in a sheet
 * @interface IBeforeSheetCommentUpdateEventParams
 * @augments {IEventBase}
 */
export interface IBeforeSheetCommentUpdateEventParams extends IEventBase {
    /** The workbook instance */
    workbook: FWorkbook;
    /** The worksheet containing the comment */
    worksheet: FWorksheet;
    /** Row index of the comment */
    row: number;
    /** Column index of the comment */
    col: number;
    /** The current comment object */
    comment: FThreadComment;
    /** The new content to replace the existing comment */
    newContent: RichTextValue;
}
/**
 * Event interface triggered before a comment is deleted from a sheet
 * @interface IBeforeSheetCommentDeleteEventParams
 * @augments {IEventBase}
 */
export interface IBeforeSheetCommentDeleteEventParams extends IEventBase {
    /** The workbook instance */
    workbook: FWorkbook;
    /** The worksheet containing the comment */
    worksheet: FWorksheet;
    /** Row index of the comment */
    row: number;
    /** Column index of the comment */
    col: number;
    /** The comment to be deleted */
    comment: FThreadComment;
}
/**
 * Event interface triggered after a comment is deleted from a sheet
 * @interface ISheetCommentDeleteEventParams
 * @augments {IEventBase}
 */
export interface ISheetCommentDeleteEventParams extends IEventBase {
    /** The workbook instance */
    workbook: FWorkbook;
    /** The worksheet that contained the comment */
    worksheet: FWorksheet;
    /** The ID of the deleted comment */
    commentId: string;
}
/**
 * Event interface triggered when a comment's resolve status changes
 * @interface ISheetCommentResolveEventParams
 * @augments {IEventBase}
 */
export interface ISheetCommentResolveEventParams extends IEventBase {
    /** The workbook instance */
    workbook: FWorkbook;
    /** The worksheet containing the comment */
    worksheet: FWorksheet;
    /** Row index of the comment */
    row: number;
    /** Column index of the comment */
    col: number;
    /** The comment object */
    comment: FThreadComment;
    /** The new resolve status */
    resolved: boolean;
}
/**
 * @ignore
 */
export interface ISheetsThreadCommentEventParamConfig {
    BeforeCommentAdd: IBeforeSheetCommentAddEventParams;
    CommentAdded: ISheetCommentAddEventParams;
    BeforeCommentUpdate: IBeforeSheetCommentUpdateEventParams;
    CommentUpdated: ISheetCommentUpdateEventParams;
    BeforeCommentDelete: IBeforeSheetCommentDeleteEventParams;
    CommentDeleted: ISheetCommentDeleteEventParams;
    BeforeCommentResolve: ISheetCommentResolveEventParams;
    CommentResolved: ISheetCommentResolveEventParams;
}
declare module '@univerjs/core/facade' {
    interface FEventName extends IFSheetsThreadCommentEventNameMixin {
    }
    interface IEventParamConfig extends ISheetsThreadCommentEventParamConfig {
    }
}
export {};