RobustToolbox/Robust.Shared/Input/BoundKeyEventArgs.cs

using System;
using System.Diagnostics;
using Robust.Shared.Map;

namespace Robust.Shared.Input
{
    /// <summary>
    ///     Event data values for a bound key state change.
    /// </summary>
    [Virtual]
    [DebuggerDisplay("{Function}, {State}, CF: {CanFocus}, H: {Handled}")]
    public class BoundKeyEventArgs : EventArgs
    {
        /// <summary>
        ///     Bound key that that is changing.
        /// </summary>
        public BoundKeyFunction Function { get; }

        /// <summary>
        ///     New state of the <see cref="BoundKeyFunction"/>.
        /// </summary>
        public BoundKeyState State { get; }

        /// <summary>
        ///     Current Pointer location in screen coordinates.
        /// </summary>
        public ScreenCoordinates PointerLocation { get; }

        /// <summary>
        ///     Whether the Bound key can change the focused control.
        /// </summary>
        public bool CanFocus { get; internal set; }

        public bool Handled { get; private set; }

        /// <summary>
        /// Is this a repeated keypress (i.e., are they holding down the key)?
        /// </summary>
        public readonly bool IsRepeat;

        /// <summary>
        ///     Constructs a new instance of <see cref="BoundKeyEventArgs"/>.
        /// </summary>
        /// <param name="function">Bound key that that is changing.</param>
        /// <param name="state">New state of the function.</param>
        /// <param name="pointerLocation">Current Pointer location in screen coordinates.</param>
        public BoundKeyEventArgs(BoundKeyFunction function, BoundKeyState state, ScreenCoordinates pointerLocation, bool canFocus)
        {
            Function = function;
            State = state;
            PointerLocation = pointerLocation;
            CanFocus = canFocus;
        }

        /// <summary>
        ///     Constructs a new instance of <see cref="BoundKeyEventArgs"/>.
        /// </summary>
        /// <param name="function">Bound key that that is changing.</param>
        /// <param name="state">New state of the function.</param>
        /// <param name="pointerLocation">Current Pointer location in screen coordinates.</param>
        /// <param name="isRepeat"></param>
        public BoundKeyEventArgs(
            BoundKeyFunction function,
            BoundKeyState state,
            ScreenCoordinates pointerLocation,
            bool canFocus,
            bool isRepeat = false) : this(function, state, pointerLocation, canFocus)
        {
            IsRepeat = isRepeat;
        }

        /// <summary>
        ///     Mark this event as handled.
        /// </summary>
        public void Handle()
        {
            Handled = true;
        }
    }
}