SoKeyboardEvent(3IV)
SoKeyboardEvent (SoKeyEv) - keyboard key press and release events
As shipped in IRIX 6.5.22. Added in IRIX 6.5.22.
NAME SoKeyboardEvent (SoKeyEv) - keyboard key press and release events INHERITS FROM SoEvent > SoButtonEvent > SoKeyboardEvent SYNOPSIS #include <Inventor_c/events/SoKeyboardEvent.h> typedef SoKeyboardEvent SoKeyEv #define SO_KEY_PRESS_EV(EVENT,KEY) (SoKeyEvIsKeyPressEv(EVENT,KEY)) #define SO_KEY_RELEASE_EV(EVENT,KEY) (SoKeyEvIsKeyReleaseEv(EVENT,KEY)) enum SoKeyboardEventKey { SO_KEY_EV_ANY Special constant for any key SO_KEY_EV_LEFT_SHIFT Modifiers SO_KEY_EV_RIGHT_SHIFT SO_KEY_EV_LEFT_CONTROL SO_KEY_EV_RIGHT_CONTROL SO_KEY_EV_LEFT_ALT SO_KEY_EV_RIGHT_ALT SO_KEY_EV_NUMBER_0 Numbers SO_KEY_EV_NUMBER_1 SO_KEY_EV_NUMBER_2 SO_KEY_EV_NUMBER_3 SO_KEY_EV_NUMBER_4 SO_KEY_EV_NUMBER_5 SO_KEY_EV_NUMBER_6 SO_KEY_EV_NUMBER_7 SO_KEY_EV_NUMBER_8 SO_KEY_EV_NUMBER_9 SO_KEY_EV_A Letters SO_KEY_EV_B SO_KEY_EV_C SO_KEY_EV_D SO_KEY_EV_E SO_KEY_EV_F SO_KEY_EV_G SO_KEY_EV_H SO_KEY_EV_I SO_KEY_EV_J SO_KEY_EV_K SO_KEY_EV_L SO_KEY_EV_M SO_KEY_EV_N SO_KEY_EV_O SO_KEY_EV_P SO_KEY_EV_Q SO_KEY_EV_R SO_KEY_EV_S SO_KEY_EV_T SO_KEY_EV_U SO_KEY_EV_V SO_KEY_EV_W SO_KEY_EV_X SO_KEY_EV_Y SO_KEY_EV_Z SO_KEY_EV_HOME Cursor control and motion SO_KEY_EV_LEFT_ARROW SO_KEY_EV_UP_ARROW SO_KEY_EV_RIGHT_ARROW SO_KEY_EV_DOWN_ARROW SO_KEY_EV_PAGE_UP SO_KEY_EV_PAGE_DOWN SO_KEY_EV_PRIOR SO_KEY_EV_NEXT SO_KEY_EV_END SO_KEY_EV_PAD_ENTER Keypad functions SO_KEY_EV_PAD_F1 SO_KEY_EV_PAD_F2 SO_KEY_EV_PAD_F3 SO_KEY_EV_PAD_F4 SO_KEY_EV_PAD_0 SO_KEY_EV_PAD_1 SO_KEY_EV_PAD_2 SO_KEY_EV_PAD_3 SO_KEY_EV_PAD_4 SO_KEY_EV_PAD_5 SO_KEY_EV_PAD_6 SO_KEY_EV_PAD_7 SO_KEY_EV_PAD_8 SO_KEY_EV_PAD_9 SO_KEY_EV_PAD_ADD SO_KEY_EV_PAD_SUBTRACT SO_KEY_EV_PAD_MULTIPLY SO_KEY_EV_PAD_DIVIDE SO_KEY_EV_PAD_SPACE SO_KEY_EV_PAD_TAB SO_KEY_EV_PAD_INSERT SO_KEY_EV_PAD_DELETE SO_KEY_EV_PAD_PERIOD SO_KEY_EV_F1 Function keys SO_KEY_EV_F2 SO_KEY_EV_F3 SO_KEY_EV_F4 SO_KEY_EV_F5 SO_KEY_EV_F6 SO_KEY_EV_F7 SO_KEY_EV_F8 SO_KEY_EV_F9 SO_KEY_EV_F10 SO_KEY_EV_F11 SO_KEY_EV_F12 SO_KEY_EV_BACKSPACE Miscellaneous SO_KEY_EV_TAB SO_KEY_EV_RETURN SO_KEY_EV_ENTER SO_KEY_EV_PAUSE SO_KEY_EV_SCROLL_LOCK SO_KEY_EV_ESCAPE SO_KEY_EV_DELETE SO_KEY_EV_PRINT SO_KEY_EV_INSERT SO_KEY_EV_NUM_LOCK SO_KEY_EV_CAPS_LOCK SO_KEY_EV_SHIFT_LOCK SO_KEY_EV_SPACE SO_KEY_EV_APOSTROPHE SO_KEY_EV_COMMA SO_KEY_EV_MINUS SO_KEY_EV_PERIOD SO_KEY_EV_SLASH SO_KEY_EV_SEMICOLON SO_KEY_EV_EQUAL SO_KEY_EV_BRACKETLEFT SO_KEY_EV_BACKSLASH SO_KEY_EV_BRACKETRIGHT SO_KEY_EV_GRAVE } Functions from class SoKeyboardEvent: SoKeyboardEvent * SoKeyEvCreate() SoType SoKeyEvGetClassTypeId() void SoKeyEvSetKey(SoKeyEv *this, SoKeyboardEventKey whichKey) SoKeyboardEventKey SoKeyEvGetKey(const SoKeyEv *this) SbBool SoKeyEvIsKeyPressEvent(SoKeyEv *this, const SoEvent *e, SoKeyboardEventKey whichKey) SbBool SoKeyEvIsKeyReleaseEvent(SoKeyEv *this, const SoEvent *e, SoKeyboardEventKey whichKey) char SoKeyEvGetPrintableCharacter(const SoKeyEv *this) Functions from class SoButtonEvent: void SoKeyEvSetState(SoKeyEv *this, SoButtonEventState s) SoButtonEventState SoKeyEvGetState(const SoKeyEv *this) Functions from class SoEvent: SoType SoKeyEvGetTypeId(const SoKeyEv *this) SbBool SoKeyEvIsOfType(const SoKeyEv *this, SoType type) void SoKeyEvSetTime(SoKeyEv *this, SbTime t) SbTime SoKeyEvGetTime(const SoKeyEv *this) void SoKeyEvSetPos(SoKeyEv *this, const SbVec2s *p) const SbVec2s * SoKeyEvGetPos(const SoKeyEv *this) const SbVec2s * SoKeyEvGetPosInVP(const SoKeyEv *this, const SbViewportRegion *vpRgn) const SbVec2f * SoKeyEvGetNormPos(const SoKeyEv *this, const SbViewportRegion *vpRgn) void SoKeyEvSetShiftDown(SoKeyEv *this, SbBool isDown) void SoKeyEvSetCtrlDown(SoKeyEv *this, SbBool isDown) void SoKeyEvSetAltDown(SoKeyEv *this, SbBool isDown) SbBool SoKeyEvWasShiftDown(const SoKeyEv *this) SbBool SoKeyEvWasCtrlDown(const SoKeyEv *this) SbBool SoKeyEvWasAltDown(const SoKeyEv *this) DESCRIPTION SoKeyboardEvent represents keyboard key press and release events in the Inventor event model. FUNCTIONS SoKeyboardEvent * SoKeyEvCreate() Constructor. SoType SoKeyEvGetClassTypeId() Return the type id for the SoKeyboardEvent class. void SoKeyEvSetKey(SoKeyEv *this, SoKeyboardEventKey whichKey) SoKeyboardEventKey SoKeyEvGetKey(const SoKeyEv *this) Set and get which key generated the event. SbBool SoKeyEvIsKeyPressEvent(SoKeyEv *this, const SoEvent *e, SoKeyboardEventKey whichKey) SbBool SoKeyEvIsKeyReleaseEvent(SoKeyEv *this, const SoEvent *e, SoKeyboardEventKey whichKey) Returns whether the passed event is a keyboard press or release event of the passed key. When SO_KEY_EV_ANY is passed, this returns TRUE if the event represents a keyboard press or release of any key. char SoKeyEvGetPrintableCharacter(const SoKeyEv *this) Convenience routine that returns the character representing the key, if it's printable. If not, this returns NULL ('\0'). SEE ALSO SoEvent, SoButtonEvent, SoLocation2Event, SoMotion3Event, SoMouseButtonEvent, SoSpaceballButtonEvent, SoHandleEventAction, SoEventCallback, SoSelection, SoInteraction, SoXtDevice