Open Inventor Reference
SoButtonEvent Class Reference

Base class for all button events. More...

#include <Inventor/events/SoButtonEvent.h>

Inheritance diagram for SoButtonEvent:
SoEvent SoKeyboardEvent SoMouseButtonEvent SoSpaceballButtonEvent

List of all members.

Public Types

enum  State { UP, DOWN, UNKNOWN }

Public Member Functions

 SoButtonEvent ()
 Constructor.
virtual ~SoButtonEvent ()
void setState (SoButtonEvent::State s)
 get state of the button
SoButtonEvent::State getState () const

Static Public Member Functions

static void initClass ()
 Initializes base event class.

Detailed Description

SoButtonEvent represents generic button press and release events in the Inventor event model. It is the base class for device-specific button events, namely SoKeyboardEvent, SoMouseButtonEvent, and SoSpaceballButtonEvent. This class stores the down/up state of the button when the event occurred.

See Also
SoEvent, SoKeyboardEvent, SoLocation2Event, SoMotion3Event, SoMouseButtonEvent, SoSpaceballButtonEvent, SoHandleEventAction, SoEventCallback, SoSelection, SoInteraction

Definition at line 82 of file SoButtonEvent.h.


Member Enumeration Documentation

Enumerator:
UP 
DOWN 
UNKNOWN 

Definition at line 92 of file SoButtonEvent.h.


Constructor & Destructor Documentation

SoButtonEvent::SoButtonEvent ( )
virtual SoButtonEvent::~SoButtonEvent ( ) [virtual]

Member Function Documentation

SoButtonEvent::State SoButtonEvent::getState ( ) const [inline]

Definition at line 100 of file SoButtonEvent.h.

static void SoButtonEvent::initClass ( ) [static]

Reimplemented from SoEvent.

Reimplemented in SoKeyboardEvent, SoMouseButtonEvent, and SoSpaceballButtonEvent.

void SoButtonEvent::setState ( SoButtonEvent::State  s) [inline]

Definition at line 99 of file SoButtonEvent.h.


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