DangerousActionDialog.cs

// Copyright (c) ppy Pty Ltd <[email protected]>. Licensed under the MIT Licence.
// See the LICENCE file in the repository root for full licence text.

using System;
using osu.Framework.Graphics.Sprites;
using osu.Game.Localisation;

namespace osu.Game.Overlays.Dialog
{
    /// <summary>
    /// A dialog which provides confirmation for actions which result in permanent consequences.
    /// Differs from <see cref="ConfirmDialog"/> in that the confirmation button is a "dangerous" one
    /// (requires the confirm button to be held).
    /// </summary>
    /// <remarks>
    /// The default implementation comes with text for a generic deletion operation.
    /// This can be further customised by specifying custom <see cref="PopupDialog.HeaderText"/>.
    /// </remarks>
    public abstract partial class DangerousActionDialog : PopupDialog
    {
        /// <summary>
        /// The action which performs the deletion.
        /// </summary>
        protected Action? DangerousAction { get; set; }

        /// <summary>
        /// The action to perform if cancelled.
        /// </summary>
        protected Action? CancelAction { get; set; }

        protected DangerousActionDialog()
        {
            HeaderText = DialogStrings.CautionHeaderText;

            Icon = FontAwesome.Solid.ExclamationTriangle;

            Buttons = new PopupDialogButton[]
            {
                new PopupDialogDangerousButton
                {
                    Text = DialogStrings.Confirm,
                    Action = () => DangerousAction?.Invoke()
                },
                new PopupDialogCancelButton
                {
                    Text = DialogStrings.Cancel,
                    Action = () => CancelAction?.Invoke()
                }
            };
        }
    }
}