#pragma region CPL License
/*
Nuclex Native Framework
Copyright (C) 2002-2013 Nuclex Development Labs

This library is free software; you can redistribute it and/or
modify it under the terms of the IBM Common Public License as
published by the IBM Corporation; either version 1.0 of the
License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
IBM Common Public License for more details.

You should have received a copy of the IBM Common Public
License along with this library
*/
#pragma endregion // CPL License

#ifndef NUCLEX_INPUT_DEVICES_WINRTKEYBOARD_H
#define NUCLEX_INPUT_DEVICES_WINRTKEYBOARD_H

#include "../Buffered/BufferedKeyboard.h"

namespace Nuclex { namespace Input { namespace Devices {

  // ------------------------------------------------------------------------------------------- //

  /// <summary>Keyboard that captures input from a WinRT CoreWindow</summary>
  class WinRTKeyboard : public BufferedKeyboard {

    /// <summary>Initializes a new WinRT-based keyboard</summary>
    public: WinRTKeyboard() {}
    
    /// <summary>Destroys the keyboard</summary>
    public: virtual ~WinRTKeyboard() {}

    /// <summary>Whether the input device is currently attached</summary>
    /// <returns>True if the input device is attached, otherwise false</returns>
    public: bool IsAttached() const { return true; }

    /// <summary>Retrieves the human-readable name of the input device</summary>
    /// <returns>The human-readable name of the input device</returns>
    public: const std::string &GetName() const {
      static std::string name("WinRT/Metro keyboard translator");
      return name;
    }

    /// <summary>Called when a key is pressed down</summary>
    /// <param name="sender">Window that registered the key press</param>
    /// <param name="arguments">Contains the pressed key</param>
    public: void InjectKeyDown(
      Windows::UI::Core::CoreWindow ^sender, Windows::UI::Core::KeyEventArgs ^arguments
    );

    /// <summary>Called when a key is released</summary>
    /// <param name="sender">Window that registered the key release</param>
    /// <param name="arguments">Contains the released key</param>
    public: void InjectKeyUp(
      Windows::UI::Core::CoreWindow ^sender, Windows::UI::Core::KeyEventArgs ^arguments
    );

    /// <summary>Called when a character has been entered</summary>
    /// <param name="sender">Window that received the character</param>
    /// <param name="arguments">Contains the entered character. Not.</param>
    public: void InjectCharacter(
      Windows::UI::Core::CoreWindow ^sender,
      Windows::UI::Core::CharacterReceivedEventArgs ^arguments
    );

  };

  // ------------------------------------------------------------------------------------------- //

}}} // namespace Nuclex::Input::Devices

#endif // NUCLEX_INPUT_DEVICES_WINRTKEYBOARD_H