IFormControl.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;
using osu.Framework.Graphics.Containers;

namespace osu.Game.Graphics.UserInterfaceV2
{
    /// <summary>
    /// Represents an interface for all form controls.
    /// </summary>
    public interface IFormControl : IDrawable, IHasFilterTerms
    {
        /// <summary>
        /// Invoked when the value of the control has changed.
        /// </summary>
        event Action ValueChanged;

        /// <summary>
        /// Whether the value of this control is in a default state.
        /// </summary>
        bool IsDefault { get; }

        /// <summary>
        /// If enabled, resets the control to its default state.
        /// </summary>
        void SetDefault();

        /// <summary>
        /// Whether the control is currently disabled.
        /// </summary>
        bool IsDisabled { get; }

        /// <summary>
        /// The height of the main part of the control (when not expanded).
        /// This is used to attach external elements.
        /// </summary>
        float MainDrawHeight { get; }
    }
}