SoMouseButtonEvent(3IV)

NAME
     SoMouseButtonEvent (SoMouseEv) - mouse button press and release events

INHERITS FROM
     SoEvent > SoButtonEvent > SoMouseButtonEvent

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

     typedef SoMouseButtonEvent  SoMouseEv

                                      #define SO_MOUSE_PRESS_EV(EVENT,BUTTON)
                                          (SoMouseEvIsBtnPressEv(EVENT,BUTTON))
                                      #define
                                      SO_MOUSE_RELEASE_EV(EVENT,BUTTON)
                                          (SoMouseEvIsBtnReleaseEv(EVENT,BUTTON))

     enum SoMouseButtonEventButton {
          SO_MOUSE_EV_ANY      Any button
          SO_MOUSE_EV_BUTTON1  First mouse button
          SO_MOUSE_EV_BUTTON2  Second mouse button
          SO_MOUSE_EV_BUTTON3  Third mouse button
     }

          Functions from class SoMouseButtonEvent:

     SoMouseButtonEvent *      SoMouseEvCreate()
     SoType                    SoMouseEvGetClassTypeId()
     void                      SoMouseEvSetBtn(SoMouseEv *this,
                                    SoMouseButtonEventButton b)
     SoMouseButtonEventButton  SoMouseEvGetBtn(const SoMouseEv *this)
     SbBool                    SoMouseEvIsBtnPressEv(const SoEvent *e,
                                    SoMouseButtonEventButton whichButton)
     SbBool                    SoMouseEvIsBtnReleaseEv(const SoEvent *e,
                                    SoMouseButtonEventButton whichButton)

          Functions from class SoButtonEvent:

     void                SoMouseEvSetState(SoMouseEv *this, SoButtonEventState
                              s)
     SoButtonEventState  SoMouseEvGetState(const SoMouseEv *this)

          Functions from class SoEvent:

     SoType              SoMouseEvGetTypeId(const SoMouseEv *this)
     SbBool              SoMouseEvIsOfType(const SoMouseEv *this, SoType type)
     void                SoMouseEvSetTime(SoMouseEv *this, SbTime t)
     SbTime              SoMouseEvGetTime(const SoMouseEv *this)
     void                SoMouseEvSetPos(SoMouseEv *this, const SbVec2s *p)
     const SbVec2s *     SoMouseEvGetPos(const SoMouseEv *this)
     const SbVec2s *     SoMouseEvGetPosInVP(const SoMouseEv *this, const
                              SbViewportRegion *vpRgn)
     const SbVec2f *     SoMouseEvGetNormPos(const SoMouseEv *this, const
                              SbViewportRegion *vpRgn)
     void                SoMouseEvSetShiftDown(SoMouseEv *this, SbBool isDown)
     void                SoMouseEvSetCtrlDown(SoMouseEv *this, SbBool isDown)
     void                SoMouseEvSetAltDown(SoMouseEv *this, SbBool isDown)
     SbBool              SoMouseEvWasShiftDown(const SoMouseEv *this)
     SbBool              SoMouseEvWasCtrlDown(const SoMouseEv *this)
     SbBool              SoMouseEvWasAltDown(const SoMouseEv *this)


DESCRIPTION
     SoMouseButtonEvent represents mouse button press and release events in
     the Inventor event model.

FUNCTIONS
     SoMouseButtonEvent *      SoMouseEvCreate()
          Constructor.

     SoType                    SoMouseEvGetClassTypeId()
          Return the type id for the SoMouseButtonEvent class.

     void                      SoMouseEvSetBtn(SoMouseEv *this,
                                    SoMouseButtonEventButton b)
     SoMouseButtonEventButton  SoMouseEvGetBtn(const SoMouseEv *this)
          Set and get which mouse button generated the event.

     SbBool                    SoMouseEvIsBtnPressEv(const SoEvent *e,
                                    SoMouseButtonEventButton whichButton)
     SbBool                    SoMouseEvIsBtnReleaseEv(const SoEvent *e,
                                    SoMouseButtonEventButton whichButton)
          Returns whether the passed event is a mouse button press or release
          event of the passed button. When SO_MOUSE_EV_ANY is passed, this
          returns TRUE if the event represents a button press or release of
          any mouse button.


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