SoWxKeyboard Class Reference

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

#include <Inventor/Wx/devices/SoWxKeyboard.h>

Inheritance diagram for SoWxKeyboard:

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

Public Member Functions
	SoWxKeyboard (int eventmask=ALL_EVENTS)
virtual	~SoWxKeyboard (void)
virtual void	disable (wxWindow *widget, SoWxEventHandler *handler, void *closure)
virtual void	enable (wxWindow *widget, SoWxEventHandler *handler, void *closure)
virtual const SoEvent *	translateEvent (wxEvent &event)
Public Member Functions inherited from SoWxDevice
virtual	~SoWxDevice ()
SbVec2s	getWindowSize (void) const
void	setWindowSize (const SbVec2s size)
Public Member Functions inherited from SoWxObject
virtual SoType	getTypeId (void) const =0
SbBool	isOfType (SoType type) const

Additional Inherited Members
Static Public Member Functions inherited from SoWxDevice
static void	initClasses (void)
Static Public Member Functions inherited from SoWxObject
static SoType	getClassTypeId (void)
static void	init (void)
static void	initClass (void)
Protected Member Functions inherited from SoWxDevice
	SoWxDevice (void)
void	addEventHandler (wxWindow *, SoWxEventHandler *, void *)
void	invokeHandlers (wxEvent &event)
void	removeEventHandler (wxWindow *, SoWxEventHandler *, void *)
void	setEventPosition (SoEvent *event, int x, int y) const
Static Protected Member Functions inherited from SoWxDevice
static SbVec2s	getLastEventPosition (void)

Detailed Description

The SoWxKeyboard class is the keyboard input device abstraction.

The SoWxKeyboard class is the glue between native keyboard handling and keyboard interaction with the Inventor scene graph.

All components derived from the SoWxRenderArea have got an SoWxKeyboard device attached by default.

Member Enumeration Documentation

Events

enum SoWxKeyboard::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

SoWxKeyboard()

SoWxKeyboard::SoWxKeyboard

(

int

mask = ALL_EVENTS

)

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

~SoWxKeyboard()

SoWxKeyboard::~SoWxKeyboard ( void )

virtual

Destructor.

Member Function Documentation

disable()

void SoWxKeyboard::disable ( wxWindow * widget, SoWxEventHandler * handler, void * closure )

virtual

This method will disable the handler for the device.

Implements SoWxDevice.

enable()

void SoWxKeyboard::enable ( wxWindow * widget, SoWxEventHandler * 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 SoWxDevice.

translateEvent()

const SoEvent * SoWxKeyboard::translateEvent ( wxEvent & event )

virtual

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

Implements SoWxDevice.

---

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

• SoWxKeyboard.h
• SoWxKeyboardCommon.cpp
• SoWxKeyboard.cpp