using System;
using Chernobyl.Event;

namespace Chernobyl.Input.Controls
{
    /// <summary>
    /// An interface for handling keyboard devices.
    /// </summary>
    public interface IKeyboard : IControl
    {
        /// <summary>
        /// The backspace key or null if it does not exist on the keyboard.
        /// </summary>
        IButtonControl Backspace { get; }

        /// <summary>
        /// The delete key or null if it does not exist on the keyboard.
        /// </summary>
        IButtonControl Delete { get; }

        /// <summary>
        /// The down arrow or null if it does not exist on the keyboard.
        /// </summary>
        IButtonControl Down { get; }

        /// <summary>
        /// The End key or null if it does not exist on the keyboard.
        /// </summary>
        IButtonControl End { get; }

        /// <summary>
        /// The Home key or null if it does not exist on the keyboard.
        /// </summary>
        IButtonControl Home { get; }

        /// <summary>
        /// The up arrow or null if it does not exist on the keyboard.
        /// </summary>
        IButtonControl Up { get; }

        /// <summary>
        /// The up arrow or null if it does not exist on the keyboard.
        /// </summary>
        IButtonControl Left { get; }

        /// <summary>
        /// The right arrow or null if it does not exist on the keyboard.
        /// </summary>
        IButtonControl Right { get; }

        /// <summary>
        /// Gets the <see cref="IButtonControl"/> with the specified key name.
        /// </summary>
        IButtonControl this[string keyName] { get; }

        /// <summary>
        /// An event that is raised when text has been "entered" or typed on 
        /// the keyboard.
        /// </summary>
        event EventHandler<ItemsEventArgs<char>> TextEntered;
    }
}