QMouseEvent - Parameters that describe a mouse event

       #include <qevent.h>

       Inherits QEvent.

   Public Members
       QMouseEvent ( Type type, const QPoint & pos, int button,
           int state )
       QMouseEvent ( Type type, const QPoint & pos, const QPoint
           & globalPos, int button, int state )
       const QPoint& pos () const
       const QPoint& globalPos () const
       int x () const
       int y () const
       int globalX () const
       int globalY () const
       ButtonState button () const
       ButtonState state () const
       ButtonState stateAfter () const


DESCRIPTION

       The QMouseEvent class contains parameters that describe a
       mouse event.

       Mouse events occur when a mouse button is pressed or
       released inside a widget, or when the mouse cursor is
       moved.

       Mouse move events will only occur when some mouse button
       is pressed down, unless mouse tracking has been enabled
       with QWidget::setMouseTracking().

       Qt automatically grabs the mouse when a mouse button is
       pressed inside a widget, and the widget will continue to
       receive mouse events until the last mouse button is
       released.

       The functions pos(), x() and y() give the cursor position
       relative to the widget that receives the mouse event. If
       you move the widget as a result of the mouse event, use
       the global position returned by globalPos() to avoid a
       shaking motion.

       The QWidget::setEnable() function can be used to enable or
       disable mouse and keyboard events for a widget.

       The event handlers QWidget::mousePressEvent(),
       QWidget::mouseReleaseEvent(),
       QWidget::mouseDoubleClickEvent() and
       QWidget::mouseMoveEvent() receive mouse events.

       and QCursor::pos().

       Examples: qtimage/qtimage.cpp drawlines/connect.cpp
       popup/popup.cpp qmag/qmag.cpp scrollview/scrollview.cpp
       trivial/trivial.cpp movies/main.cpp


MEMBER FUNCTION DOCUMENTATION


QMouseEvent::QMouseEvent ( Type type, const QPoint & pos, const

       QPoint & globalPos, int button, int state )
       Constructs a mouse event object.

       The type parameter must be QEvent::MouseButtonPress,
       QEvent::MouseButtonRelease, QEvent::MouseButtonDblClick or
       QEvent::MouseMove.

       The pos parameter specifies the position relative to the
       receiving widget; globalPos is the position in absolute
       coordinates; button specifies the ButtonState of the
       button that caused the event, which should be 0 if type is
       MouseMove; and state is the ButtonState at the time of the
       event.


QMouseEvent::QMouseEvent ( Type type, const QPoint & pos, int

       button, int state )
       Constructs a mouse event object.

       The type parameter must be one of
       QEvent::MouseButtonPress, QEvent::MouseButtonRelease,
       QEvent::MouseButtonDblClick or QEvent::MouseMove.

       The pos parameter specifies the position relative to the
       receiving widget; button specifies the ButtonState of the
       button that caused the event, which should be 0 if type is
       MouseMove; state is the ButtonState at the time of the
       event.

       The globalPos() is initialized to QCursor::pos(), which
       may not be appropriate. Use the other constructor to
       specify the global position explicitly.


ButtonState QMouseEvent::button () const

       Returns the button that caused the event.

       Possible return values are LeftButton, RightButton,
       MidButton and NoButton.

       Note that the returned value is always NoButton (0) for
       mouse move events.

       See also state().

       Examples: movies/main.cpp

       Returns the global position of the mouse pointer at the
       time of the event. This is important on asynchronous
       window systems like X11: Whenever you move your widgets
       around in response to mouse evens, globalPos() can differ
       a lot from the current pointer position QCursor::pos(),
       and from  QWidget::mapToGlobal( pos() ) .

       See also globalX() and globalY().


int QMouseEvent::globalX () const

       Returns the global X position of the mouse pointer at the
       time of the event

       See also globalY() and globalPos().


int QMouseEvent::globalY () const

       Returns the global Y position of the mouse pointer at the
       time of the event

       See also globalX() and globalPos().


const QPoint & QMouseEvent::pos () const

       Returns the position of the mouse pointer, relative to the
       widget that received the event.

       If you move the widget as a result of the mouse event, use
       the global position returned by globalPos() to avoid a
       shaking motion.

       See also x(), y() and globalPos().

       Examples: qtimage/qtimage.cpp drawlines/connect.cpp
       qmag/qmag.cpp


ButtonState QMouseEvent::state () const

       Returns the button state (a combination of mouse buttons
       and keyboard modifiers), i.e. what buttons and keys were
       being held depressed immediately before the event was
       generated.

       Note that this means that for QEvent::MouseButtonPress and
       QEvent::MouseButtonDblClick, the flag for the button()
       itself will not be set in the state; while for
       QEvent::MouseButtonRelease, it will.

       This value is mainly interesting for QEvent::MouseMove,
       for the other cases, button() is more useful.

       The returned value is LeftButton, RightButton, MidButton,
       ShiftButton, ControlButton and AltButton OR'ed together.

       See also button() and stateAfter().



ButtonState QMouseEvent::stateAfter () const

       Returns the state of buttons after the event.

       See also state().


int QMouseEvent::x () const

       Returns the X position of the mouse pointer, relative to
       the widget that received the event.

       See also y() and pos().

       Examples: scrollview/scrollview.cpp


int QMouseEvent::y () const

       Returns the Y position of the mouse pointer, relative to
       the widget that received the event.

       See also x() and pos().

       Examples: scrollview/scrollview.cpp


SEE ALSO

       http://doc.trolltech.com/qmouseevent.html
       http://www.trolltech.com/faq/tech.html


COPYRIGHT

       Copyright 1992-2001 Trolltech AS,
       http://www.trolltech.com.  See the license file included
       in the distribution for a complete license statement.


AUTHOR

       Generated automatically from the source code.


BUGS

       If you find a bug in Qt, please report it as described in
       http://doc.trolltech.com/bughowto.html.  Good bug reports
       make our job much simpler. Thank you.

       In case of content or formattting problems with this
       manual page, please report them to qt-bugs@trolltech.com.
       Please include the name of the manual page
       (qmouseevent.3qt) and the Qt version (2.3.1).


Man(1) output converted with man2html