SoButtonEvent(3IV)

NAME
     SoButtonEvent (SoBtnEv) - base class for all button events

INHERITS FROM
     SoEvent > SoButtonEvent

SYNOPSIS
     #include <Inventor_c/events/SoButtonEvent.h>

     typedef SoButtonEvent  SoBtnEv

     enum SoButtonEventState {
          SO_BTN_EV_UP        Button up event
          SO_BTN_EV_DOWN      Button down event
          SO_BTN_EV_UNKNOWN   Button in unknown state
     }

          Functions from class SoButtonEvent:

     SoButtonEvent *     SoBtnEvCreate()
     SoType              SoBtnEvGetClassTypeId()
     void                SoBtnEvSetState(SoBtnEv *this, SoButtonEventState s)
     SoButtonEventState  SoBtnEvGetState(const SoBtnEv *this)

          Functions from class SoEvent:

     SoType              SoBtnEvGetTypeId(const SoBtnEv *this)
     SbBool              SoBtnEvIsOfType(const SoBtnEv *this, SoType type)
     void                SoBtnEvSetTime(SoBtnEv *this, SbTime t)
     SbTime              SoBtnEvGetTime(const SoBtnEv *this)
     void                SoBtnEvSetPos(SoBtnEv *this, const SbVec2s *p)
     const SbVec2s *     SoBtnEvGetPos(const SoBtnEv *this)
     const SbVec2s *     SoBtnEvGetPosInVP(const SoBtnEv *this, const
                              SbViewportRegion *vpRgn)
     const SbVec2f *     SoBtnEvGetNormPos(const SoBtnEv *this, const
                              SbViewportRegion *vpRgn)
     void                SoBtnEvSetShiftDown(SoBtnEv *this, SbBool isDown)
     void                SoBtnEvSetCtrlDown(SoBtnEv *this, SbBool isDown)
     void                SoBtnEvSetAltDown(SoBtnEv *this, SbBool isDown)
     SbBool              SoBtnEvWasShiftDown(const SoBtnEv *this)
     SbBool              SoBtnEvWasCtrlDown(const SoBtnEv *this)
     SbBool              SoBtnEvWasAltDown(const SoBtnEv *this)


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.
FUNCTIONS
     SoButtonEvent *     SoBtnEvCreate()
          Constructor.

     SoType              SoBtnEvGetClassTypeId()
          Return the type id for the SoButtonEvent class.

     void                SoBtnEvSetState(SoBtnEv *this, SoButtonEventState s)
     SoButtonEventState  SoBtnEvGetState(const SoBtnEv *this)
          Set and get the state of the button.


SEE ALSO
     SoEvent, SoKeyboardEvent, SoLocation2Event, SoMotion3Event,
     SoMouseButtonEvent, SoSpaceballButtonEvent, SoHandleEventAction,
     SoEventCallback, SoSelection, SoInteraction, SoXtDevice