Coin Logo Coin3D is Free Software,
published under the BSD 3-clause license.
https://bitbucket.org/Coin3D/
http://www.kongsberg.com/kogt/
SoWinKeyboard Class Reference

The SoWinKeyboard class is the keyboard input device abstraction. More...

#include <Inventor/Win/devices/SoWinKeyboard.h>

Inheritance diagram for SoWinKeyboard:
SoWinDevice SoWinObject

Public Types

enum  Events { KEY_PRESS = 0x01, KEY_RELEASE = 0x02, ALL_EVENTS = KEY_PRESS | KEY_RELEASE }
 

Public Member Functions

 SoWinKeyboard (int eventmask=ALL_EVENTS)
 
virtual ~SoWinKeyboard (void)
 
virtual void enable (HWND widget, SoWinEventHandler *handler, void *closure)
 
virtual void disable (HWND widget, SoWinEventHandler *handler, void *closure)
 
virtual const SoEventtranslateEvent (MSG *event)
 
- Public Member Functions inherited from SoWinDevice
virtual ~SoWinDevice ()
 
void setWindowSize (const SbVec2s size)
 
SbVec2s getWindowSize (void) const
 
- Public Member Functions inherited from SoWinObject
virtual SoType getTypeId (void) const =0
 
SbBool isOfType (SoType type) const
 

Additional Inherited Members

- Static Public Member Functions inherited from SoWinDevice
static void initClasses (void)
 
- Static Public Member Functions inherited from SoWinObject
static void initClass (void)
 
static SoType getClassTypeId (void)
 
static void init (void)
 
- Protected Member Functions inherited from SoWinDevice
 SoWinDevice (void)
 
void setEventPosition (SoEvent *event, int x, int y) const
 
void addEventHandler (HWND, SoWinEventHandler *, void *)
 
void removeEventHandler (HWND, SoWinEventHandler *, void *)
 
void invokeHandlers (MSG *event)
 
- Static Protected Member Functions inherited from SoWinDevice
static SbVec2s getLastEventPosition (void)
 

Detailed Description

The SoWinKeyboard class is the keyboard input device abstraction.

The SoWinKeyboard class is the glue between native keyboard handling and keyboard interaction with the Inventor scenegraph.

All components derived from the SoWinRenderArea have got an SoWinKeyboard device attached by default.

Member Enumeration Documentation

◆ Events

Enumeration over supported event types.

Enumerator
KEY_PRESS 

Maskbit for a keyboard button press event.

KEY_RELEASE 

Maskbit for a keyboard button release event.

ALL_EVENTS 

Combined bitmask for all possible events.

Constructor & Destructor Documentation

◆ SoWinKeyboard()

SoWinKeyboard::SoWinKeyboard ( int  mask = ALL_EVENTS)

Constructor. The mask specifies which keyboard-related events to handle. Others will just be ignored.

◆ ~SoWinKeyboard()

SoWinKeyboard::~SoWinKeyboard ( void  )
virtual

Destructor.

Member Function Documentation

◆ enable()

void SoWinKeyboard::enable ( HWND  widget,
SoWinEventHandler *  handler,
void *  closure 
)
virtual

This method will enable the device for the widget.

handler is invoked with the closure argument when an event occur in widget.

Implements SoWinDevice.

◆ disable()

void SoWinKeyboard::disable ( HWND  widget,
SoWinEventHandler *  handler,
void *  closure 
)
virtual

This method will disable the handler for the device.

Implements SoWinDevice.

◆ translateEvent()

const SoEvent * SoWinKeyboard::translateEvent ( MSG *  event)
virtual

This method translates from native events to Open Inventor SoEvent events.

Implements SoWinDevice.


The documentation for this class was generated from the following files: