'\"! tbl | mmdoc
'\"macro stdmacro
.ie n \{\
.   ds Cr \fB
.   ds Cb \fB
.\}
.el \{\
.   ds Cr \f7
.   ds Cb \f8
.\}
.TH SoXtMouse(3IV)
.SH NAME
SoXtMouse \(em translates and reports events for the mouse
.SH INHERITS FROM
SoXtDevice > SoXtMouse
.SH SYNOPSIS
.ps -1
\*(Cr#include <Inventor/Xt/devices/SoXtMouse.h>
.sp
\*(Cr#define SO_XT_ALL_MOUSE_EVENTS
    (ButtonPressMask | ButtonReleaseMask |
     PointerMotionMask | ButtonMotionMask) 
.sp
.in 1i
\f1Methods from class SoXtMouse:
.in 0.5i
.sp
.ta 20m
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Cr
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbSoXtMouse\*(Cr(EventMask mask = SO_XT_ALL_MOUSE_EVENTS)
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Cr
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(Cb~SoXtMouse\*(Cr()
.sp
.in 1i
\f1Methods from class SoXtDevice:
.in 0.5i
.sp
.ta 25m
.in 1i+25n
.ti 0.5i
.ta 25m
.ds Pt \*(Crvirtual void
.ie \w'\*(Pt'>=25n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(Cbenable\*(Cr(Widget w, XtEventHandler f, XtPointer data, Window win = NULL)
.br
.in 1i+25n
.ti 0.5i
.ta 25m
.ds Pt \*(Crvirtual void
.ie \w'\*(Pt'>=25n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(Cbdisable\*(Cr(Widget w, XtEventHandler f, XtPointer data)
.br
.in 1i+25n
.ti 0.5i
.ta 25m
.ds Pt \*(Crvirtual const SoEvent *
.ie \w'\*(Pt'>=25n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbtranslateEvent\*(Cr(XAnyEvent *xevent)
.br
.in 1i+25n
.ti 0.5i
.ta 25m
.ds Pt \*(Crvoid
.ie \w'\*(Pt'>=25n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbsetWindowSize\*(Cr(const SbVec2s &size)
.br
.in 1i+25n
.ti 0.5i
.ta 25m
.ds Pt \*(Crconst SbVec2s &
.ie \w'\*(Pt'>=25n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbgetWindowSize\*(Cr() const
.sp
.SH DESCRIPTION
This class manages events generated by the mouse, including mouse motion (\*(CbSoLocation2Event\f1), and mouse button press and release events (\*(CbSoMouseButtonEvent\f1). 
.SH METHODS
.ta 20m
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Cr
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbSoXtMouse\*(Cr(EventMask mask = SO_XT_ALL_MOUSE_EVENTS)
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Cr
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(Cb~SoXtMouse\*(Cr()
.br
.in 1i
\f1Constructor and destructor. To the constructor, pass which mouse events you are interested in as a bitwise OR of the following values: 
.sp
ButtonPressMask \(em Mouse press events 
.sp
ButtonReleaseMask \(em Mouse
\&release events 
.sp
PointerMotionMask \(em Mouse motion with no buttons 
.sp
ButtonMotionMask \(em Mouse motion with buttons pressed 
.sp
Or simply pass the defined value SO_XT_ALL_MOUSE_EVENTS for all mouse events. The
\&device will only report events of this type for the widget it is enabled on. 
.sp
.in 0.5i
.SH SEE ALSO
\*(CbSoXtDevice, SoLocation2Event, SoMouseButtonEvent