SoXtDevice Class Reference

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

#include <Inventor/Xt/devices/SoXtDevice.h>

Inheritance diagram for SoXtDevice:

Public Member Functions
virtual	~SoXtDevice ()
virtual void	disable (Widget w, SoXtEventHandler *handler, void *closure)=0
virtual void	enable (Widget w, SoXtEventHandler *handler, void *closure)=0
SbVec2s	getWindowSize (void) const
void	setWindowSize (const SbVec2s size)
virtual const SoEvent *	translateEvent (XAnyEvent *event)=0
Public Member Functions inherited from SoXtObject
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 SoXtObject
static SoType	getClassTypeId (void)
static void	init (void)
static void	initClass (void)

Protected Member Functions
	SoXtDevice (void)
void	addEventHandler (Widget, SoXtEventHandler *, void *)
void	invokeHandlers (XAnyEvent *event)
void	removeEventHandler (Widget, SoXtEventHandler *, void *)
void	setEventPosition (SoEvent *event, int x, int y) const

Static Protected Member Functions
static SbVec2s	getLastEventPosition (void)

Detailed Description

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

The SoXt 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

~SoXtDevice()

SoXtDevice::~SoXtDevice ( )

virtual

Public virtual destructor.

SoXtDevice()

SoXtDevice::SoXtDevice ( void )

protected

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

Member Function Documentation

addEventHandler()

void SoXtDevice::addEventHandler ( Widget widget, SoXtEventHandler * handler, void * closure )

protected

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

disable()

void SoXtDevice::disable ( Widget widget, SoXtEventHandler * handler, void * closure )

pure virtual

This method will disable the handler for the device.

Implemented in SoXtKeyboard, and SoXtMouse.

enable()

void SoXtDevice::enable ( Widget widget, SoXtEventHandler * 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 SoXtKeyboard, and SoXtMouse.

getLastEventPosition()

SbVec2s SoXtDevice::getLastEventPosition ( void )

staticprotected

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

getWindowSize()

SbVec2s SoXtDevice::getWindowSize

(

void

)

const

This method returns the cached window size.

initClasses()

void SoXtDevice::initClasses ( void )

static

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

invokeHandlers()

void SoXtDevice::invokeHandlers ( XAnyEvent * event )

protected

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

removeEventHandler()

void SoXtDevice::removeEventHandler ( Widget widget, SoXtEventHandler * handler, void * closure )

protected

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

setEventPosition()

void SoXtDevice::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 SoXtDevice::setWindowSize

(

const SbVec2s

size

)

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

translateEvent()

const SoEvent * SoXtDevice::translateEvent ( XAnyEvent * event )

pure virtual

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

Implemented in SoXtKeyboard, and SoXtMouse.

---

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

• SoXtDevice.h
• SoXtDeviceCommon.cpp
• SoXtDevice.cpp