Coin Logo Coin3D is Free Software,
published under the BSD 3-clause license.
https://bitbucket.org/Coin3D/
http://www.kongsberg.com/kogt/
SoQtKeyboard Class Reference

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

#include <Inventor/Qt/devices/SoQtKeyboard.h>

Inheritance diagram for SoQtKeyboard:
SoQtDevice SoQtObject

Public Types

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

Public Member Functions

 SoQtKeyboard (int eventmask=ALL_EVENTS)
 
virtual ~SoQtKeyboard (void)
 
virtual void enable (QWidget *widget, SoQtEventHandler *handler, void *closure)
 
virtual void disable (QWidget *widget, SoQtEventHandler *handler, void *closure)
 
virtual const SoEventtranslateEvent (QEvent *event)
 
- Public Member Functions inherited from SoQtDevice
virtual ~SoQtDevice ()
 
void setWindowSize (const SbVec2s size)
 
SbVec2s getWindowSize (void) const
 
- Public Member Functions inherited from SoQtObject
virtual SoType getTypeId (void) const =0
 
SbBool isOfType (SoType type) const
 

Additional Inherited Members

- Static Public Member Functions inherited from SoQtDevice
static void initClasses (void)
 
- Static Public Member Functions inherited from SoQtObject
static void initClass (void)
 
static SoType getClassTypeId (void)
 
static void init (void)
 
- Protected Member Functions inherited from SoQtDevice
 SoQtDevice (void)
 
void setEventPosition (SoEvent *event, int x, int y) const
 
void addEventHandler (QWidget *, SoQtEventHandler *, void *)
 
void removeEventHandler (QWidget *, SoQtEventHandler *, void *)
 
void invokeHandlers (QEvent *event)
 
- Static Protected Member Functions inherited from SoQtDevice
static SbVec2s getLastEventPosition (void)
 

Detailed Description

The SoQtKeyboard class is the keyboard input device abstraction.

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

All components derived from the SoQtRenderArea have got an SoQtKeyboard device attached by default.

Member Enumeration Documentation

◆ 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

◆ SoQtKeyboard()

SoQtKeyboard::SoQtKeyboard ( int  mask = ALL_EVENTS)

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

◆ ~SoQtKeyboard()

SoQtKeyboard::~SoQtKeyboard ( void  )
virtual

Destructor.

Member Function Documentation

◆ enable()

void SoQtKeyboard::enable ( QWidget *  widget,
SoQtEventHandler *  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 SoQtDevice.

◆ disable()

void SoQtKeyboard::disable ( QWidget *  widget,
SoQtEventHandler *  handler,
void *  closure 
)
virtual

This method will disable the handler for the device.

Implements SoQtDevice.

◆ translateEvent()

const SoEvent * SoQtKeyboard::translateEvent ( QEvent *  event)
virtual

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

Implements SoQtDevice.


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