SoKeyboardEvent.h

/*=======================================================================
 * Copyright 1991-1996, Silicon Graphics, Inc.
 * ALL RIGHTS RESERVED
 *
 * UNPUBLISHED -- Rights reserved under the copyright laws of the United
 * States.   Use of a copyright notice is precautionary only and does not
 * imply publication or disclosure.
 *
 * U.S. GOVERNMENT RESTRICTED RIGHTS LEGEND:
 * Use, duplication or disclosure by the Government is subject to restrictions
 * as set forth in FAR 52.227.19(c)(2) or subparagraph (c)(1)(ii) of the Rights
 * in Technical Data and Computer Software clause at DFARS 252.227-7013 and/or
 * in similar or successor clauses in the FAR, or the DOD or NASA FAR
 * Supplement.  Contractor/manufacturer is Silicon Graphics, Inc.,
 * 2011 N. Shoreline Blvd. Mountain View, CA 94039-7311.
 *
 * THE CONTENT OF THIS WORK CONTAINS CONFIDENTIAL AND PROPRIETARY
 * INFORMATION OF SILICON GRAPHICS, INC. ANY DUPLICATION, MODIFICATION,
 * DISTRIBUTION, OR DISCLOSURE IN ANY FORM, IN WHOLE, OR IN PART, IS STRICTLY
 * PROHIBITED WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OF SILICON
 * GRAPHICS, INC.
**=======================================================================*/
/*=======================================================================
** Author      : David Mott (MMM yyyy)
** Modified by : Gavin Bell (MMM yyyy)
**=======================================================================*/
/*=======================================================================
 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.),            ***
 ***              AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT.                     ***
 ***                                                                                ***
 ***  REPRODUCTION, DISCLOSURE,  OR USE,  IN WHOLE OR IN PART,  OTHER THAN AS       ***
 ***  SPECIFIED  IN THE LICENSE ARE  NOT TO BE  UNDERTAKEN  EXCEPT WITH PRIOR       ***
 ***  WRITTEN AUTHORIZATION OF FEI S.A.S.                                           ***
 ***                                                                                ***
 ***                        RESTRICTED RIGHTS LEGEND                                ***
 ***  USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS      ***
 ***  WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN      ***
 ***  SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT      ***
 ***  CLAUSE  AT FAR 52.227-19  OR SUBPARAGRAPH  (C)(1)(II)  OF  THE RIGHTS IN      ***
 ***  TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013.             ***
 ***                                                                                ***
 ***                   COPYRIGHT (C) 1996-2019 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Modified by : VSG (MMM YYYY)
**=======================================================================*/
 
 
#ifndef  _SO_KEYBOARD_EVENT_
#define  _SO_KEYBOARD_EVENT_
 
#include <Inventor/SbBasic.h>
#include <Inventor/events/SoButtonEvent.h>
 
// some convenience macros for determining if an event matches
 
#define SO_KEY_PRESS_EVENT(EVENT,KEY) \
  (SoKeyboardEvent::isKeyPressEvent(EVENT,SoKeyboardEvent::KEY))
 
#define SO_KEY_RELEASE_EVENT(EVENT,KEY) \
  (SoKeyboardEvent::isKeyReleaseEvent(EVENT,SoKeyboardEvent::KEY))
 
class  SoKeyboardEvent : public SoButtonEvent {
  
  SO_EVENT_HEADER();
  
 public:
  
  enum Key {
    ANY = 0, 
      
    LEFT_SHIFT = 0xFFE1, 
    RIGHT_SHIFT = 0xFFE2, 
    LEFT_CONTROL = 0xFFE3, 
    RIGHT_CONTROL = 0xFFE4, 
    LEFT_ALT = 0xFFE9, 
    RIGHT_ALT = 0xFFEA, 
    LEFT_META = 0xFFEB,
    RIGHT_META = 0xFFEC,
    
    NUMBER_0 = 0x030, 
    NUMBER_1 = 0x031, 
    NUMBER_2 = 0x032, 
    NUMBER_3 = 0x033, 
    NUMBER_4 = 0x034, 
    NUMBER_5 = 0x035, 
    NUMBER_6 = 0x036, 
    NUMBER_7 = 0x037, 
    NUMBER_8 = 0x038, 
    NUMBER_9 = 0x039, 
    
    A = 0x061, 
    B = 0x062, 
    C = 0x063, 
    D = 0x064, 
    E = 0x065, 
    F = 0x066, 
    G = 0x067, 
    H = 0x068, 
    I = 0x069, 
    J = 0x06A, 
    K = 0x06B, 
    L = 0x06C, 
    M = 0x06D, 
    N = 0x06E, 
    O = 0x06F, 
    P = 0x070, 
    Q = 0x071, 
    R = 0x072, 
    S = 0x073, 
    T = 0x074, 
    U = 0x075, 
    V = 0x076, 
    W = 0x077, 
    X = 0x078, 
    Y = 0x079, 
    Z = 0x07A, 
    
    HOME = 0xFF50, 
    LEFT_ARROW = 0xFF51, 
    UP_ARROW = 0xFF52, 
    RIGHT_ARROW = 0xFF53, 
    DOWN_ARROW = 0xFF54, 
    PAGE_UP = 0xFF55, 
    PAGE_DOWN = 0xFF56, 
    PRIOR = 0xFF55, 
    NEXT = 0xFF56, 
    END = 0xFF57, 
    
    PAD_ENTER = 0xFF8D, 
    PAD_F1 = 0xFF91, 
    PAD_F2 = 0xFF92, 
    PAD_F3 = 0xFF93, 
    PAD_F4 = 0xFF94, 
    
    PAD_0 = 0xFF9E,
    PAD_1 = 0xFF9C, 
    PAD_2 = 0xFF99, 
    PAD_3 = 0xFF9B, 
    PAD_4 = 0xFF96, 
    PAD_5 = 0xFF9D, 
    PAD_6 = 0xFF98, 
    PAD_7 = 0xFF95, 
    PAD_8 = 0xFF97, 
    PAD_9 = 0xFF9A, 
    
    PAD_ADD = 0xFFAB, 
    PAD_SUBTRACT = 0xFFAD, 
    PAD_MULTIPLY = 0xFFAA, 
    PAD_DIVIDE = 0xFFAF, 
 
    PAD_SPACE = 0xFF8D, 
    PAD_TAB = 0xFF89,
    PAD_INSERT = 0xFF9E, 
    PAD_DELETE = 0xFF9F, 
    PAD_PERIOD = 0xFF9F, 
 
    F1 = 0xFFBE, 
    F2 = 0xFFBF, 
    F3 = 0xFFC0, 
    F4 = 0xFFC1, 
    F5 = 0xFFC2, 
    F6 = 0xFFC3, 
    F7 = 0xFFC4,
    F8 = 0xFFC5, 
    F9 = 0xFFC6, 
    F10 = 0xFFC7, 
    F11 = 0xFFC8, 
    F12 = 0xFFC9, 
    
    BACKSPACE = 0xFF08, 
    TAB = 0xFF09, 
    RETURN = 0xFF0D, 
    ENTER = 0xFF0D, 
    PAUSE = 0xFF13, 
    SCROLL_LOCK = 0xFF14, 
    ESCAPE = 0xFF1B, 
    KEY_DELETE = 0xFFFF,
#if !defined(_WIN32) 
    DELETE = 0xFFFF,
#endif
    PRINT = 0xFF61, 
    INSERT = 0xFF63, 
    NUM_LOCK = 0xFF7F, 
    CAPS_LOCK = 0xFFE5, 
    SHIFT_LOCK = 0xFFE6, 
 
    SPACE = 0x020, 
    APOSTROPHE = 0x027, 
    COMMA = 0x02C, 
    MINUS = 0x02D, 
    PERIOD = 0x02E, 
    SLASH = 0x02F, 
 
    SEMICOLON = 0x03B, 
    EQUAL = 0x03D, 
 
    BRACKETLEFT = 0x05B, 
    BACKSLASH = 0x05C, 
    BRACKETRIGHT = 0x05D, 
    GRAVE = 0x060,
    TWO_SUPERIOR = 0xB2,
    TILDE = 0x7E
  };
    
  SoKeyboardEvent();
 
#ifndef HIDDEN_FROM_DOC
  virtual ~SoKeyboardEvent();
#endif // HIDDEN_FROM_DOC
 
  void setKey(SoKeyboardEvent::Key whichKey);
 
  SoKeyboardEvent::Key getKey() const;
 
  static SbBool isKeyPressEvent(const SoEvent *e, SoKeyboardEvent::Key whichKey);
                          
  static SbBool isKeyReleaseEvent(const SoEvent *e,
                                  SoKeyboardEvent::Key whichKey);
 
  char getPrintableCharacter() const;
 
  void setUnicode(wchar_t unicode);
 
  wchar_t getUnicode() const;
 
 private:
  static void initClass();
  static void exitClass();
 
 private:
  // which key
  Key m_key;
  wchar_t m_unicode;
};
 
#endif /* _SO_KEYBOARD_EVENT_ */