man SoKeyboardEvent () - keyboard key press and release events
NAME
SoKeyboardEvent - keyboard key press and release events
INHERITS FROM
SoEvent > SoButtonEvent > SoKeyboardEvent
SYNOPSIS
#include <Inventor/events/SoKeyboardEvent.h>
#define SO_KEY_PRESS_EVENT(EVENT,KEY)
(SoKeyboardEvent::isKeyPressEvent(EVENT,SoKeyboardEvent::KEY))
#define SO_KEY_RELEASE_EVENT(EVENT,KEY)
(SoKeyboardEvent::isKeyReleaseEvent(EVENT,SoKeyboardEvent::KEY))
enum Key {
c
}
c
}
Special constant for any key
c
}
c
}
Modifiers
c
}
c
}
c } c }
c } c }
c } c }
c } c }
c
}
c
}
Numbers
c
}
c
}
c } c }
c } c }
c } c }
c } c }
c } c }
c } c }
c } c }
c } c }
c
}
c
}
Letters
c
}
c
}
c } c }
c } c }
c } c }
c } c }
c } c }
c } c }
c } c }
c } c }
c } c }
c } c }
c } c }
c } c }
c } c }
c } c }
c } c }
c } c }
c } c }
c } c }
c } c }
c } c }
c } c }
c } c }
c } c }
c } c }
c
}
c
}
Cursor control and motion
c
}
c
}
c } c }
c } c }
c } c }
c } c }
c } c }
c } c }
c } c }
c } c }
c
}
c
}
Keypad functions
c
}
c
}
c } c }
c } c }
c } c }
c } c }
c } c }
c } c }
c } c }
c } c }
c } c }
c } c }
c } c }
c } c }
c } c }
c } c }
c } c }
c } c }
c } c }
c } c }
c } c }
c } c }
c } c }
c } c }
c
}
c
}
Function keys
c
}
c
}
c } c }
c } c }
c } c }
c } c }
c } c }
c } c }
c } c }
c } c }
c } c }
c } c }
c
}
c
}
Miscellaneous
c
}
c
}
c } c }
c } c }
c } c }
c } c }
c } c }
c } c }
c } c }
c } c }
c } c }
c } c }
c } c }
c } c }
c } c }
c } c }
c } c }
c } c }
c } c }
c } c }
c } c }
c } c }
c } c }
c } c }
c } c }
}
Methods from class SoKeyboardEvent:
c
}
c
}
SoKeyboardEvent()
c
}
c
}
getClassTypeId()
c
}
c
}
setKey(SoKeyboardEvent::Key whichKey)
c
}
c
}
getKey() const
c
}
c
}
isKeyPressEvent(const SoEvent *e, SoKeyboardEvent::Key whichKey)
c
}
c
}
isKeyReleaseEvent(const SoEvent *e, SoKeyboardEvent::Key whichKey)
c
}
c
}
getPrintableCharacter() const
Methods from class SoButtonEvent:
c
}
c
}
setState(SoButtonEvent::State s)
c
}
c
}
getState() const
Methods from class SoEvent:
c
}
c
}
getTypeId() const
c
}
c
}
isOfType(SoType type) const
c
}
c
}
setTime(SbTime t)
c
}
c
}
getTime() const
c
}
c
}
setPosition(const SbVec2s &p)
c
}
c
}
getPosition() const
c
}
c
}
getPosition(const SbViewportRegion &vpRgn) const
c
}
c
}
getNormalizedPosition(const SbViewportRegion &vpRgn) const
c
}
c
}
setShiftDown(SbBool isDown)
c
}
c
}
setCtrlDown(SbBool isDown)
c
}
c
}
setAltDown(SbBool isDown)
c
}
c
}
wasShiftDown() const
c
}
c
}
wasCtrlDown() const
c
}
c
}
wasAltDown() const
DESCRIPTION
SoKeyboardEvent represents keyboard key press and release events in the Inventor event model.
METHODS
c
}
c
}
SoKeyboardEvent()
Constructor.
c
}
c
}
getClassTypeId()
Return the type id for the SoKeyboardEvent class.
c
}
c
}
setKey(SoKeyboardEvent::Key whichKey)
c
}
c
}
getKey() const
Set and get which key generated the event.
c
}
c
}
isKeyPressEvent(const SoEvent *e, SoKeyboardEvent::Key whichKey)
c
}
c
}
isKeyReleaseEvent(const SoEvent *e, SoKeyboardEvent::Key whichKey)
Returns whether the passed event is a keyboard press or release event of the passed key. When SoKeyboardEvent::ANY is passed, this returns TRUE if the event represents a keyboard press or release of any key.
c
}
c
}
getPrintableCharacter() const
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