CatStation/Content.Client/Instruments/UI/InstrumentMidiSourceBase.xaml.cs

using Robust.Client.AutoGenerated;
using Robust.Client.UserInterface.Controls;
using Robust.Client.UserInterface.XAML;

namespace Content.Client.Instruments.UI;

/// <summary>
/// A type of <see cref="BoxContainer" /> to be added to the <see cref="InstrumentMenu" /> for displaying and handling
/// all necessary controls regarding a certain type of MIDI input (i.e.: Files, Bands, Hardware input).
/// Must be initialized and registered to the menu inside <see cref="InstrumentBoundUserInterface" />.
/// </summary>
[GenerateTypedNameReferences]
public abstract partial class InstrumentMidiSourceBase : BoxContainer
{
    /// <summary>
    /// The string to display for the button on the left side of the instrument UI.
    /// </summary>
    public virtual string ButtonName { get; } = Loc.GetString("instruments-component-menu-unknown-midi-source-button");

    /// <summary>
    /// Returns true if this source is currently the active one.
    /// </summary>
    protected bool Enabled { get; private set; }

    protected InstrumentMidiSourceBase()
    {
        RobustXamlLoader.Load(this);
    }

    /// <summary>
    /// Override if the source requires additional handling to become enabled.
    /// i.e.: Opening MIDI-Input.
    /// </summary>
    [MustCallBase]
    public virtual void Enable()
    {
        Visible = true;
        Enabled = true;
    }

    /// <summary>
    /// Override if the source requires additional handling on being disabled.
    /// i.e.: Closing MIDI-Input.
    /// </summary>
    [MustCallBase]
    public virtual void Disable()
    {
        Enabled = false;
        Visible = false;
    }
}