$treeview $search $mathjax
Stratagus  2.2.7
$projectbrief
$projectbrief
$searchbox
-->
         _________ __                 __
        /   _____//  |_____________ _/  |______     ____  __ __  ______
        \_____  \\   __\_  __ \__  \\   __\__  \   / ___\|  |  \/  ___/
        /        \|  |  |  | \// __ \|  |  / __ \_/ /_/  >  |  /\___ \
       /_______  /|__|  |__|  (____  /__| (____  /\___  /|____//____  >
               \/                  \/          \//_____/            \/
    ______________________                           ______________________
                          T H E   W A R   B E G I N S
                   Stratagus - A free fantasy real time strategy game engine

gcn::KeyInput Class Reference

#include <keyinput.h>

List of all members.


Public Types

enum  { EMPTY = 0, PRESS, RELEASE }

Public Member Functions

 KeyInput ()
 KeyInput (const Key &key, int type)
void setType (int type)
int getType () const
void setKey (const Key &key)
const KeygetKey () const

Protected Attributes

Key mKey
int mType
int mButton

Detailed Description

Internal class representing keyboard input. Generally you won't have to bother using this class.

Member Enumeration Documentation

anonymous enum

Enum with key input values.

Enumerator:
EMPTY 
PRESS 
RELEASE 


Constructor & Destructor Documentation

gcn::KeyInput::KeyInput (  )  [inline]

Constructor.

gcn::KeyInput::KeyInput ( const Key key,
int  type 
)

Constructor.

Parameters:
key the Key the input concerns.
type the type of input.


Member Function Documentation

void gcn::KeyInput::setType ( int  type  ) 

Sets the input type.

Parameters:
type the type of input.

int gcn::KeyInput::getType (  )  const

Gets the input type.

Returns:
the input type.

void gcn::KeyInput::setKey ( const Key key  ) 

Sets the key the input concerns.

Parameters:
key the Key the input concerns.

const Key & gcn::KeyInput::getKey (  )  const

Gets the key the input concerns.

Returns:
the Key the input concerns.


Member Data Documentation

Key gcn::KeyInput::mKey [protected]

int gcn::KeyInput::mType [protected]

int gcn::KeyInput::mButton [protected]


The documentation for this class was generated from the following files:
(C) Copyright 1998-2012 by The Stratagus Project under the GNU General Public License.
All trademarks and copyrights on this page are owned by their respective owners.