#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_WINDOWMESSAGEKEYBOARD_H
#define NUCLEX_INPUT_DEVICES_WINDOWMESSAGEKEYBOARD_H

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

#define WIN32_LEAN_AND_MEAN
#define VC_EXTRALEAN
#include <windows.h>

namespace Nuclex { namespace Input { namespace Devices {

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

  /// <summary>Keyboard that listens in on window messages</summary>
  class WindowMessageKeyboard : public BufferedKeyboard {

    /// <summary>Initializes a new window message based keyboard</summary>
    public: WindowMessageKeyboard();
    /// <summary>Frees all resources owned by the keyboard</summary>
    public: virtual ~WindowMessageKeyboard();

    /// <summary>Updates the keyboard's state in accordance to a window message</summary>
    /// <param name="message">Type of message being sent to the window</param>
    /// <param name="parameter1">First message-dependent parameter</param>
    /// <param name="parameter2">Second message-dependent parameter</param>
    /// <returns>True if the message was consumed, false if not</returns>
    public: bool ProcessWindowMessage(UINT message, WPARAM parameter1, LPARAM parameter2);

    /// <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;

    private: WindowMessageKeyboard(const WindowMessageKeyboard &);
    private: WindowMessageKeyboard &operator =(const WindowMessageKeyboard &);

  };

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

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

#endif // NUCLEX_INPUT_DEVICES_WINDOWMESSAGEKEYBOARD_H