SoWxKeyboard Class Reference
[Wx]

VSG extension Translates and reports events for the keyboard device. More...

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

Inheritance diagram for SoWxKeyboard:
SoWxDevice

List of all members.

Public Member Functions

 SoWxKeyboard (EventMask mask=SO_WX_ALL_KEYBOARD_EVENTS)
 ~SoWxKeyboard ()
virtual void enable (wxWindow *w, XtEventHandler f, void *data, void *unused=NULL)
virtual void disable (wxWindow *w, XtEventHandler f, void *data)
virtual const SoEventtranslateEvent (wxEvent &anEvent)

Detailed Description

VSG extension Translates and reports events for the keyboard device.

This class manages events generated by the keyboard, including key press and release events (SoKeyboardEvent).

SEE ALSO

SoWxDevice, SoKeyboardEvent


Constructor & Destructor Documentation

SoWxKeyboard::SoWxKeyboard ( EventMask  mask = SO_WX_ALL_KEYBOARD_EVENTS  ) 

Constructor.

To the constructor, pass which keyboard events you are interested in as a bitwise OR of the following values:

KeyPressMask - Key press messages

KeyReleaseMask - Key release messages

Or simply pass the defined value SO_Wx_ALL_KEYBOARD_EVENTS for all keyboard events. The device will only report events of this type for the widget it is enabled on.

SoWxKeyboard::~SoWxKeyboard (  ) 

Destructor.


Member Function Documentation

virtual void SoWxKeyboard::disable ( wxWindow *  w,
XtEventHandler  f,
void *  data 
) [virtual]

Disables the device for the passed widget.

Implements SoWxDevice.

virtual void SoWxKeyboard::enable ( wxWindow *  w,
XtEventHandler  f,
void *  data,
void *  unused = NULL 
) [virtual]

Enables the device for the passed widget.

When enabled, the callback function f will be invoked when events occur in the window. data is the clientData which will be passed.

Implements SoWxDevice.

virtual const SoEvent* SoWxKeyboard::translateEvent ( wxEvent &  anEvent  )  [virtual]

Attempts to convert the passed event into an SoEvent.


Returns a pointer to an internal SoEvent object owned by the class. Do not delete this object. If the message was not generated by this device, then NULL is returned.

Implements SoWxDevice.


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

Open Inventor Toolkit reference manual, generated on 24 Mar 2020
Copyright © Thermo Fisher Scientific All rights reserved.
http://www.openinventor.com/