SoWxDevice Class Reference

The SoWxDevice class is the base class for the translation devices. More...

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

Inheritance diagram for SoWxDevice:

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

Static Public Member Functions
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
	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
static SbVec2s	getLastEventPosition (void)

Detailed Description

The SoWxDevice class is the base class for the translation devices.

The SoWx device classes provide glue functionality for translating native GUI events from the underlying toolkit to Inventor scene graph SoEvent events.

The device classes are mainly of interest to application programmers when writing extensions for new types of devices, and seldom in other contexts – so they can most often be ignored.

Constructor & Destructor Documentation

~SoWxDevice()

SoWxDevice::~SoWxDevice ( )

virtual

Public virtual destructor.

SoWxDevice()

SoWxDevice::SoWxDevice ( void )

protected

Constructor. Protected to only enable invocation from derived device classes.

Member Function Documentation

addEventHandler()

void SoWxDevice::addEventHandler ( wxWindow * widget, SoWxEventHandler * handler, void * closure )

protected

Stores an event handler for the widget, which can later be invoked with SoWxDevice::invokeHandlers(). Used by extension device types.

disable()

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

pure virtual

This method will disable the handler for the device.

Implemented in SoWxKeyboard, and SoWxMouse.

enable()

void SoWxDevice::enable ( wxWindow * widget, SoWxEventHandler * handler, void * closure )

pure virtual

This method will enable the device for the widget.

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

Implemented in SoWxKeyboard, and SoWxMouse.

getLastEventPosition()

SbVec2s SoWxDevice::getLastEventPosition ( void )

staticprotected

Returns last event position that was set with SoWxDevice::setEventPosition().

getWindowSize()

SbVec2s SoWxDevice::getWindowSize

(

void

)

const

This method returns the cached window size.

initClasses()

void SoWxDevice::initClasses ( void )

static

This function initializes the type system for all the SoWx device classes. It is called indirectly when calling SoWx::init(), so the application programmer doesn't have to bother with it.

invokeHandlers()

void SoWxDevice::invokeHandlers ( wxEvent & event )

protected

Invoke all handlers registered with SoWxDevice::addEventHandler().

removeEventHandler()

void SoWxDevice::removeEventHandler ( wxWindow * widget, SoWxEventHandler * handler, void * closure )

protected

Remove a handler registered with SoWxDevice::addEventHandler().

setEventPosition()

void SoWxDevice::setEventPosition ( SoEvent * event, int x, int y ) const

protected

This method fills in the position information of event, translating the coordinates into the correct coordinate system.

setWindowSize()

void SoWxDevice::setWindowSize

(

const SbVec2s

size

)

This method sets the cached size of the window the device is "attached" to.

translateEvent()

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

pure virtual

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

Implemented in SoWxKeyboard, and SoWxMouse.

---

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

• SoWxDevice.h
• SoWxDeviceCommon.cpp
• SoWxDevice.cpp