ceKeyboard.h

Go to the documentation of this file.

/* --- Source License
 * Author  : FX Programmer.
 * Contact : CorEngine@gmail.com
 *
 * Copyright (c) 2010 by FX Programmer.
 *
 * This source code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
 * (at your option) any later version.
 *
 * This source code 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 GNU Lesser General Public
 * License for more details.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *    1. The origin of this software must not be misrepresented; you must not
 *       claim that you wrote the original software. If you use this software
 *       in a product, an acknowledgement in the product documentation would be
 *       appreciated but is not required.
 *    2. Altered source versions must be clearly marked as such, and must not
 *       be misrepresented as being the original software.
 *    3. Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this source code; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301, USA.
 */

 #ifndef _CE_KEYBOARD_H_
 #define _CE_KEYBOARD_H_ 0x1 
 #ifndef CE_WITHOUT_KEYBOARD

 #ifndef __cplusplus
 #error ceKeyboard.h requires C++ compilation (use a .cpp suffix)
 #endif

 #if __GNUC__ >= 0x3
 #pragma GCC system_header
 #endif

 #if _MSC_VER > 1000
 #pragma once
 #pragma warning(disable: 4100)
 #endif

 #include "ceInputDevice.h"

 #include "ceKeyCodes.h"
 #include "begin_code.h"

 #define KEYMAP_SCANCODE   0x0 //!< Mapping virtual key to scancode.
 #define KEYMAP_VIRTUALKEY 0x3 //!< Mapping scancode to virtual key.

 namespace ce {

// ---                                             class IKeyboardEvent --- */

 class IKeyboardDevice;

 class DECLSPEC IKeyboardEvent
 {
  public:

    #ifndef DOXYGEN_SHOULD_SKIP_THIS
    virtual ~IKeyboardEvent(void) { };
    #endif

    virtual void APICALL 
      OnKeyPressed(const IKeyboardDevice *Owner, 
        const int key, const int buffer[256]) = 0x0;

    virtual void APICALL 
      OnKeyReleased(const IKeyboardDevice *Owner, 
        const int key, const int buffer[256]) = 0x0;

    virtual void APICALL 
      OnKeyEvent(const IKeyboardDevice *Owner, const int buffer[256]) = 0x0;

 };

// ---                                                                  --- */

// ---                                            class IKeyboardDevice --- */

 class DECLSPEC IKeyboardDevice : public IInputDevice
 {
  public:

    #ifndef DOXYGEN_SHOULD_SKIP_THIS
    virtual ~IKeyboardDevice(void) { };
    #endif

    virtual int APICALL 
      IsKeyPressed(const unsigned char key = 0x0) const = 0;

    virtual int APICALL 
      IsKeyReleased(const unsigned char key = 0x0) const = 0;

    /* ! \brief Undocumented.
        \param key Undocumented.
        \return Undocumented.
     * /
    virtual int APICALL 
      IsKeyModifier(const unsigned char key = 0x0) const = 0; */

    virtual int APICALL 
      MapVirtualKey(const unsigned char key, 
                    int map_type = KEYMAP_SCANCODE) const = 0;

    virtual int APICALL 
      GetKeyboardState(int buffer[256]) const = 0;

    virtual void APICALL 
      SetKeyboardEvent(IKeyboardEvent *Event) = 0;

    virtual IKeyboardEvent* APICALL 
      GetKeyboardEvent(void) = 0;

 };

// ---                                                                  --- */

 } // end namespace ce

 #include "close_code.h"

 #if _MSC_VER > 1000
 #pragma warning(default:4100)
 #endif

 #endif // CE_WITHOUT_KEYBOARD
 #endif // _CE_KEYBOARD_H_