GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  SOKEYBOARDEVENT (3)

NAME

SoKeyboardEvent — keyboard key press and release events

CONTENTS

Inherits From
Synopsis
Description
Methods
See Also

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 {     SoKeyboardEvent::ANY    
                              SoKeyboardEvent::ANY          Special constant for any key    
SoKeyboardEvent::LEFT_SHIFT    
                              SoKeyboardEvent::LEFT_SHIFT   Modifiers    
SoKeyboardEvent::RIGHT_SHIFT    
                              SoKeyboardEvent::RIGHT_SHIFT 

    SoKeyboardEvent::LEFT_CONTROL    
                              SoKeyboardEvent::LEFT_CONTROL

    SoKeyboardEvent::RIGHT_CONTROL    
                              SoKeyboardEvent::RIGHT_CONTROL

    SoKeyboardEvent::LEFT_ALT    
                              SoKeyboardEvent::LEFT_ALT    

    SoKeyboardEvent::RIGHT_ALT    
                              SoKeyboardEvent::RIGHT_ALT   

    SoKeyboardEvent::NUMBER_0    
                              SoKeyboardEvent::NUMBER_0     Numbers    
SoKeyboardEvent::NUMBER_1    
                              SoKeyboardEvent::NUMBER_1    

    SoKeyboardEvent::NUMBER_2    
                              SoKeyboardEvent::NUMBER_2    

    SoKeyboardEvent::NUMBER_3    
                              SoKeyboardEvent::NUMBER_3    

    SoKeyboardEvent::NUMBER_4    
                              SoKeyboardEvent::NUMBER_4    

    SoKeyboardEvent::NUMBER_5    
                              SoKeyboardEvent::NUMBER_5    

    SoKeyboardEvent::NUMBER_6    
                              SoKeyboardEvent::NUMBER_6    

    SoKeyboardEvent::NUMBER_7    
                              SoKeyboardEvent::NUMBER_7    

    SoKeyboardEvent::NUMBER_8    
                              SoKeyboardEvent::NUMBER_8    

    SoKeyboardEvent::NUMBER_9    
                              SoKeyboardEvent::NUMBER_9    

    SoKeyboardEvent::A    
                              SoKeyboardEvent::A            Letters    
SoKeyboardEvent::B    
                              SoKeyboardEvent::B           

    SoKeyboardEvent::C    
                              SoKeyboardEvent::C           

    SoKeyboardEvent::D    
                              SoKeyboardEvent::D           

    SoKeyboardEvent::E    
                              SoKeyboardEvent::E           

    SoKeyboardEvent::F    
                              SoKeyboardEvent::F           

    SoKeyboardEvent::G    
                              SoKeyboardEvent::G           

    SoKeyboardEvent::H    
                              SoKeyboardEvent::H           

    SoKeyboardEvent::I    
                              SoKeyboardEvent::I           

    SoKeyboardEvent::J    
                              SoKeyboardEvent::J           

    SoKeyboardEvent::K    
                              SoKeyboardEvent::K           

    SoKeyboardEvent::L    
                              SoKeyboardEvent::L           

    SoKeyboardEvent::M    
                              SoKeyboardEvent::M           

    SoKeyboardEvent::N    
                              SoKeyboardEvent::N           

    SoKeyboardEvent::O    
                              SoKeyboardEvent::O           

    SoKeyboardEvent::P    
                              SoKeyboardEvent::P           

    SoKeyboardEvent::Q    
                              SoKeyboardEvent::Q           

    SoKeyboardEvent::R    
                              SoKeyboardEvent::R           

    SoKeyboardEvent::S    
                              SoKeyboardEvent::S           

    SoKeyboardEvent::T    
                              SoKeyboardEvent::T           

    SoKeyboardEvent::U    
                              SoKeyboardEvent::U           

    SoKeyboardEvent::V    
                              SoKeyboardEvent::V           

    SoKeyboardEvent::W    
                              SoKeyboardEvent::W           

    SoKeyboardEvent::X    
                              SoKeyboardEvent::X           

    SoKeyboardEvent::Y    
                              SoKeyboardEvent::Y           

    SoKeyboardEvent::Z    
                              SoKeyboardEvent::Z           

    SoKeyboardEvent::HOME    
                              SoKeyboardEvent::HOME         Cursor control and motion    
SoKeyboardEvent::LEFT_ARROW    
                              SoKeyboardEvent::LEFT_ARROW  

    SoKeyboardEvent::UP_ARROW    
                              SoKeyboardEvent::UP_ARROW    

    SoKeyboardEvent::RIGHT_ARROW    
                              SoKeyboardEvent::RIGHT_ARROW 

    SoKeyboardEvent::DOWN_ARROW    
                              SoKeyboardEvent::DOWN_ARROW  

    SoKeyboardEvent::PAGE_UP    
                              SoKeyboardEvent::PAGE_UP     

    SoKeyboardEvent::PAGE_DOWN    
                              SoKeyboardEvent::PAGE_DOWN   

    SoKeyboardEvent::PRIOR    
                              SoKeyboardEvent::PRIOR       

    SoKeyboardEvent::NEXT    
                              SoKeyboardEvent::NEXT        

    SoKeyboardEvent::END    
                              SoKeyboardEvent::END         

    SoKeyboardEvent::PAD_ENTER    
                              SoKeyboardEvent::PAD_ENTER    Keypad functions    
SoKeyboardEvent::PAD_F1    
                              SoKeyboardEvent::PAD_F1      

    SoKeyboardEvent::PAD_F2    
                              SoKeyboardEvent::PAD_F2      

    SoKeyboardEvent::PAD_F3    
                              SoKeyboardEvent::PAD_F3      

    SoKeyboardEvent::PAD_F4    
                              SoKeyboardEvent::PAD_F4      

    SoKeyboardEvent::PAD_0    
                              SoKeyboardEvent::PAD_0       

    SoKeyboardEvent::PAD_1    
                              SoKeyboardEvent::PAD_1       

    SoKeyboardEvent::PAD_2    
                              SoKeyboardEvent::PAD_2       

    SoKeyboardEvent::PAD_3    
                              SoKeyboardEvent::PAD_3       

    SoKeyboardEvent::PAD_4    
                              SoKeyboardEvent::PAD_4       

    SoKeyboardEvent::PAD_5    
                              SoKeyboardEvent::PAD_5       

    SoKeyboardEvent::PAD_6    
                              SoKeyboardEvent::PAD_6       

    SoKeyboardEvent::PAD_7    
                              SoKeyboardEvent::PAD_7       

    SoKeyboardEvent::PAD_8    
                              SoKeyboardEvent::PAD_8       

    SoKeyboardEvent::PAD_9    
                              SoKeyboardEvent::PAD_9       

    SoKeyboardEvent::PAD_ADD    
                              SoKeyboardEvent::PAD_ADD     

    SoKeyboardEvent::PAD_SUBTRACT    
                              SoKeyboardEvent::PAD_SUBTRACT

    SoKeyboardEvent::PAD_MULTIPLY    
                              SoKeyboardEvent::PAD_MULTIPLY

    SoKeyboardEvent::PAD_DIVIDE    
                              SoKeyboardEvent::PAD_DIVIDE  

    SoKeyboardEvent::PAD_SPACE    
                              SoKeyboardEvent::PAD_SPACE   

    SoKeyboardEvent::PAD_TAB    
                              SoKeyboardEvent::PAD_TAB     

    SoKeyboardEvent::PAD_INSERT    
                              SoKeyboardEvent::PAD_INSERT  

    SoKeyboardEvent::PAD_DELETE    
                              SoKeyboardEvent::PAD_DELETE  

    SoKeyboardEvent::PAD_PERIOD    
                              SoKeyboardEvent::PAD_PERIOD  

    SoKeyboardEvent::F1    
                              SoKeyboardEvent::F1           Function keys    
SoKeyboardEvent::F2    
                              SoKeyboardEvent::F2          

    SoKeyboardEvent::F3    
                              SoKeyboardEvent::F3          

    SoKeyboardEvent::F4    
                              SoKeyboardEvent::F4          

    SoKeyboardEvent::F5    
                              SoKeyboardEvent::F5          

    SoKeyboardEvent::F6    
                              SoKeyboardEvent::F6          

    SoKeyboardEvent::F7    
                              SoKeyboardEvent::F7          

    SoKeyboardEvent::F8    
                              SoKeyboardEvent::F8          

    SoKeyboardEvent::F9    
                              SoKeyboardEvent::F9          

    SoKeyboardEvent::F10    
                              SoKeyboardEvent::F10         

    SoKeyboardEvent::F11    
                              SoKeyboardEvent::F11         

    SoKeyboardEvent::F12    
                              SoKeyboardEvent::F12         

    SoKeyboardEvent::BACKSPACE    
                              SoKeyboardEvent::BACKSPACE    Miscellaneous    
SoKeyboardEvent::TAB    
                              SoKeyboardEvent::TAB         

    SoKeyboardEvent::RETURN    
                              SoKeyboardEvent::RETURN      

    SoKeyboardEvent::ENTER    
                              SoKeyboardEvent::ENTER       

    SoKeyboardEvent::PAUSE    
                              SoKeyboardEvent::PAUSE       

    SoKeyboardEvent::SCROLL_LOCK    
                              SoKeyboardEvent::SCROLL_LOCK 

    SoKeyboardEvent::ESCAPE    
                              SoKeyboardEvent::ESCAPE      

    SoKeyboardEvent::DELETE    
                              SoKeyboardEvent::DELETE      

    SoKeyboardEvent::PRINT    
                              SoKeyboardEvent::PRINT       

    SoKeyboardEvent::INSERT    
                              SoKeyboardEvent::INSERT      

    SoKeyboardEvent::NUM_LOCK    
                              SoKeyboardEvent::NUM_LOCK    

    SoKeyboardEvent::CAPS_LOCK    
                              SoKeyboardEvent::CAPS_LOCK   

    SoKeyboardEvent::SHIFT_LOCK    
                              SoKeyboardEvent::SHIFT_LOCK  

    SoKeyboardEvent::SPACE    
                              SoKeyboardEvent::SPACE       

    SoKeyboardEvent::APOSTROPHE    
                              SoKeyboardEvent::APOSTROPHE  

    SoKeyboardEvent::COMMA    
                              SoKeyboardEvent::COMMA       

    SoKeyboardEvent::MINUS    
                              SoKeyboardEvent::MINUS       

    SoKeyboardEvent::PERIOD    
                              SoKeyboardEvent::PERIOD      

    SoKeyboardEvent::SLASH    
                              SoKeyboardEvent::SLASH       

    SoKeyboardEvent::SEMICOLON    
                              SoKeyboardEvent::SEMICOLON   

    SoKeyboardEvent::EQUAL    
                              SoKeyboardEvent::EQUAL       

    SoKeyboardEvent::BRACKETLEFT    
                              SoKeyboardEvent::BRACKETLEFT 

    SoKeyboardEvent::BACKSLASH    
                              SoKeyboardEvent::BACKSLASH   

    SoKeyboardEvent::BRACKETRIGHT    
                              SoKeyboardEvent::BRACKETRIGHT

    SoKeyboardEvent::GRAVE    
                              SoKeyboardEvent::GRAVE       

}

Methods from class SoKeyboardEvent:

       
                      
                       SoKeyboardEvent()    
static SoType    
                      
static SoType          getClassTypeId()    
void    
                      
void                   setKey(SoKeyboardEvent::Key whichKey)    
SoKeyboardEvent::Key    
                      
SoKeyboardEvent::Key   getKey() const    
static SbBool    
                      
static SbBool          isKeyPressEvent(const SoEvent *e, SoKeyboardEvent::Key whichKey)    
static SbBool    
                      
static SbBool          isKeyReleaseEvent(const SoEvent *e, SoKeyboardEvent::Key whichKey)    
char    
                      
char                   getPrintableCharacter() const

Methods from class SoButtonEvent:

    void    
                      
void                   setState(SoButtonEvent::State s)    
SoButtonEvent::State    
                      
SoButtonEvent::State   getState() const

Methods from class SoEvent:

    virtual SoType    
                    
virtual SoType       getTypeId() const    
SbBool    
                    
SbBool               isOfType(SoType type) const    
void    
                    
void                 setTime(SbTime t)    
SbTime    
                    
SbTime               getTime() const    
void    
                    
void                 setPosition(const SbVec2s &p)    
const SbVec2s &    
                    
const SbVec2s &      getPosition() const    
const SbVec2s &    
                    
const SbVec2s &      getPosition(const SbViewportRegion &vpRgn) const    
const SbVec2f &    
                    
const SbVec2f &      getNormalizedPosition(const SbViewportRegion &vpRgn) const    
void    
                    
void                 setShiftDown(SbBool isDown)    
void    
                    
void                 setCtrlDown(SbBool isDown)    
void    
                    
void                 setAltDown(SbBool isDown)    
SbBool    
                    
SbBool               wasShiftDown() const    
SbBool    
                    
SbBool               wasCtrlDown() const    
SbBool    
                    
SbBool               wasAltDown() const

DESCRIPTION

SoKeyboardEvent represents keyboard key press and release events in the Inventor event model.

METHODS

       
                      
                       SoKeyboardEvent()
Constructor.

    static SoType    
                      
static SoType          getClassTypeId()
Return the type id for the SoKeyboardEvent class.

    void    
                      
void                   setKey(SoKeyboardEvent::Key whichKey)    
SoKeyboardEvent::Key    
                      
SoKeyboardEvent::Key   getKey() const
Set and get which key generated the event.

    static SbBool    
                      
static SbBool          isKeyPressEvent(const SoEvent *e, SoKeyboardEvent::Key whichKey)    
static SbBool    
                      
static SbBool          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.

    char    
                      
char                   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

Search for    or go to Top of page |  Section 3 |  Main Index


SOKEYBOARDEVENT(3IV) (-->)

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.