Coin Logo http://www.sim.no
http://www.coin3d.org

SoXtKeyboard Class Reference
[Xt Device Classes]

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

Inheritance diagram for SoXtKeyboard:

SoXtDevice SoXtObject List of all members.

Detailed Description

The SoXtKeyboard class is the keyboard input device abstraction.

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

All components derived from the SoXtRenderArea have got an SoXtKeyboard device attached by default.


Public Types

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

Public Member Functions

 SoXtKeyboard (int eventmask=ALL_EVENTS)
virtual ~SoXtKeyboard (void)
virtual void enable (Widget widget, SoXtEventHandler *handler, void *closure)
virtual void disable (Widget widget, SoXtEventHandler *handler, void *closure)
virtual const SoEvent * translateEvent (XAnyEvent *event)

Friends

class SoXtKeyboardP
class SoGuiKeyboardP

Member Enumeration Documentation

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

SoXtKeyboard::SoXtKeyboard ( int  mask = ALL_EVENTS  ) 

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

SoXtKeyboard::~SoXtKeyboard ( void   )  [virtual]

Destructor.

Member Function Documentation

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

void SoXtKeyboard::disable ( Widget  widget,
SoXtEventHandler *  handler,
void *  closure 
) [virtual]

This method will disable the handler for the device.

Implements SoXtDevice.

const SoEvent * SoXtKeyboard::translateEvent ( XAnyEvent *  event  )  [virtual]

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

Implements SoXtDevice.

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

Copyright © 1998-2005 by Systems in Motion AS. All rights reserved.

Generated on Tue Dec 2 23:15:46 2008 for SoXt by Doxygen. 1.4.7