osu-framework / osu.Framework / Graphics / UserInterface / Checkbox.cs

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

using osu.Framework.Bindables;
using osu.Framework.Graphics.Containers;
using osu.Framework.Input.Events;

namespace osu.Framework.Graphics.UserInterface
{
    /// <summary>
    /// An abstract class that implements the functionality of a checkbox.
    /// </summary>
    public abstract class Checkbox : Container, IHasCurrentValue<bool>
    {
        private readonly BindableWithCurrent<bool> current = new BindableWithCurrent<bool>();

        public Bindable<bool> Current
        {
            get => current.Current;
            set => current.Current = value;
        }

        protected override bool OnClick(ClickEvent e)
        {
            if (!Current.Disabled)
            {
                Current.Value = !Current.Value;
                OnUserChange(Current.Value);
            }

            base.OnClick(e);
            return true;
        }

        /// <summary>
        /// Triggered when the value is changed based on end-user input to this control.
        /// </summary>
        protected virtual void OnUserChange(bool value)
        {
        }
    }
}