Main Page | Class Hierarchy | Class List | Directories | File List | Class Members | Related Pages

key.hpp

00001 /*      _______   __   __   __   ______   __   __   _______   __   __                 
00002  *     / _____/\ / /\ / /\ / /\ / ____/\ / /\ / /\ / ___  /\ /  |\/ /\                
00003  *    / /\____\// / // / // / // /\___\// /_// / // /\_/ / // , |/ / /                 
00004  *   / / /__   / / // / // / // / /    / ___  / // ___  / // /| ' / /                  
00005  *  / /_// /\ / /_// / // / // /_/_   / / // / // /\_/ / // / |  / /                   
00006  * /______/ //______/ //_/ //_____/\ /_/ //_/ //_/ //_/ //_/ /|_/ /                    
00007  * \______\/ \______\/ \_\/ \_____\/ \_\/ \_\/ \_\/ \_\/ \_\/ \_\/                      
00008  *
00009  * Copyright (c) 2004, 2005 darkbits                        Js_./
00010  * Per Larsson a.k.a finalman                          _RqZ{a<^_aa
00011  * Olof Naessén a.k.a jansem/yakslem                _asww7!uY`>  )\a//
00012  *                                                 _Qhm`] _f "'c  1!5m
00013  * Visit: http://guichan.darkbits.org             )Qk<P ` _: :+' .'  "{[
00014  *                                               .)j(] .d_/ '-(  P .   S
00015  * License: (BSD)                                <Td/Z <fP"5(\"??"\a.  .L
00016  * Redistribution and use in source and          _dV>ws?a-?'      ._/L  #'
00017  * binary forms, with or without                 )4d[#7r, .   '     )d`)[
00018  * modification, are permitted provided         _Q-5'5W..j/?'   -?!\)cam'
00019  * that the following conditions are met:       j<<WP+k/);.        _W=j f
00020  * 1. Redistributions of source code must       .$%w\/]Q  . ."'  .  mj$
00021  *    retain the above copyright notice,        ]E.pYY(Q]>.   a     J@\
00022  *    this list of conditions and the           j(]1u<sE"L,. .   ./^ ]{a
00023  *    following disclaimer.                     4'_uomm\.  )L);-4     (3=
00024  * 2. Redistributions in binary form must        )_]X{Z('a_"a7'<a"a,  ]"[
00025  *    reproduce the above copyright notice,       #}<]m7`Za??4,P-"'7. ).m
00026  *    this list of conditions and the            ]d2e)Q(<Q(  ?94   b-  LQ/
00027  *    following disclaimer in the                <B!</]C)d_, '(<' .f. =C+m
00028  *    documentation and/or other materials      .Z!=J ]e []('-4f _ ) -.)m]'
00029  *    provided with the distribution.          .w[5]' _[ /.)_-"+?   _/ <W"
00030  * 3. Neither the name of Guichan nor the      :$we` _! + _/ .        j?
00031  *    names of its contributors may be used     =3)= _f  (_yQmWW$#(    "
00032  *    to endorse or promote products derived     -   W,  sQQQQmZQ#Wwa]..
00033  *    from this software without specific        (js, \[QQW$QWW#?!V"".
00034  *    prior written permission.                    ]y:.<\..          .
00035  *                                                 -]n w/ '         [.
00036  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT       )/ )/           !
00037  * HOLDERS AND CONTRIBUTORS "AS IS" AND ANY         <  (; sac    ,    '
00038  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING,               ]^ .-  %
00039  * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF            c <   r
00040  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR            aga<  <La
00041  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE          5%  )P'-3L
00042  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR        _bQf` y`..)a
00043  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,          ,J?4P'.P"_(\?d'.,
00044  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES               _Pa,)!f/<[]/  ?"
00045  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT      _2-..:. .r+_,.. .
00046  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,     ?a.<%"'  " -'.a_ _,
00047  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION)                     ^
00048  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
00049  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
00050  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
00051  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
00052  * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00053  */
00054 
00055 #ifndef GCN_KEY_HPP
00056 #define GCN_KEY_HPP
00057 
00058 #include <string>
00059 
00060 #include "guichan/platform.hpp"
00061 
00062 namespace gcn
00063 {
00067     class GCN_CORE_DECLSPEC Key
00068     {
00069     public:
00073         Key();
00074     
00080         Key(int value);
00081     
00087         bool isCharacter() const;
00088 
00094         bool isNumber() const;
00095     
00101         bool isLetter() const;
00102 
00108         bool isShiftPressed() const;
00109     
00115         void setShiftPressed(bool pressed);
00116 
00121         bool isControlPressed() const;
00122     
00128         void setControlPressed(bool pressed);
00129 
00135         bool isAltPressed() const;
00136 
00142         void setAltPressed(bool pressed);
00143 
00149         bool isMetaPressed() const;
00150 
00156         void setMetaPressed(bool pressed);
00157     
00163         bool isNumericPad() const;
00164 
00170         void setNumericPad(bool numpad);
00171     
00178         int getValue() const;
00179 
00185         void setValue(int value);
00186 
00190         enum
00191         {
00192             SPACE              = ' ',
00193             TAB                = '\t', 
00194             ENTER              = '\n',   
00195             LEFT_ALT           = 1000,
00196             RIGHT_ALT,
00197             LEFT_SHIFT,
00198             RIGHT_SHIFT,
00199             LEFT_CONTROL,
00200             RIGHT_CONTROL,
00201             LEFT_META,
00202             RIGHT_META,
00203             LEFT_SUPER,
00204             RIGHT_SUPER,
00205             INSERT,
00206             HOME,
00207             PAGE_UP,
00208             DELETE,
00209             END,
00210             PAGE_DOWN,
00211             ESCAPE,
00212             CAPS_LOCK,
00213             BACKSPACE,
00214             F1,
00215             F2,
00216             F3,
00217             F4,
00218             F5,
00219             F6,
00220             F7,
00221             F8,
00222             F9,
00223             F10,
00224             F11,
00225             F12,
00226             F13,
00227             F14,
00228             F15,
00229             PRINT_SCREEN,
00230             SCROLL_LOCK,
00231             PAUSE,
00232             NUM_LOCK,
00233             ALT_GR,
00234             LEFT,
00235             RIGHT,
00236             UP,
00237             DOWN      
00238         };
00239     
00240     protected:
00241         int mValue;
00242         bool mShiftPressed;
00243         bool mControlPressed;
00244         bool mAltPressed;
00245         bool mMetaPressed;
00246         bool mNumericPad;    
00247     };
00248 }
00249 
00250 #endif // end GCN_KEY_HPP

Generated on Tue May 17 21:23:26 2005 for Guichan by  doxygen 1.4.1