using System;
using System.Collections.Generic;
using Chernobyl.Update;

namespace Chernobyl.Input.Controls
{
    /// <summary>
    /// An interface for working with controls. Controls are forms of input that 
    /// interact with the application such as buttons, analog sticks, gamepads, 
    /// etc.
    /// </summary>
    public interface IControl : IUpdateable, INamed
    {
        /// <summary>
        /// The parent of this control.
        /// </summary>
        IControl ControlParent { get; set; }

        /// <summary>
        /// Controls that are part of this control. For
        /// example, the "Left Button" or "Scroll Wheel"
        /// might be a part of a mouse control. Some controls
        /// will not have children controls.
        /// </summary>
        ICollection<IControl> ControlChildren { get; }

        /// <summary>
        /// An event that is raised when this <see cref="IControl"/> is
        /// disconnected from the device it was previously connected to and is
        /// no longer available for use. Actions performed on the 
        /// <see cref="IControl"/> after it has been disconnected may result
        /// is an <see cref="DisconnectedException"/> being thrown.
        /// </summary>
        event EventHandler Disconnected;
    }

    /// <summary>
    /// A helper class which is used to pass data on the 
    /// invocation of an event of the IControl interface. 
    /// Note that this class does not have to be used by 
    /// classes deriving from IControl.
    /// </summary>
    public class ControlEventArgs<TControl> : EventArgs where TControl : IControl
    {
        /// <summary>
        /// Initializes a new instance of the 
        /// <see cref="ControlEventArgs{ControlType}"/> class.
        /// </summary>
        /// <param name="control">The control that was affected by the event.</param>
        public ControlEventArgs(TControl control)
        {
            Control = control;
        }

        /// <summary>
        /// The control where the event was fired from.
        /// </summary>
        public TControl Control { get; private set; }
    }
}