Wt::WMouseEvent Class Reference

A class providing details for a mouse event. More...

#include <WEvent>

List of all members.

Public Types

enum  Button { LeftButton, MiddleButton, RightButton }
 Enumeration for the mouse button. More...

Public Member Functions

 WMouseEvent ()
 Default constructor.
Button button () const
 Get the button.
bool altKey () const
 Is the alt key pressed ?
bool metaKey () const
 Is the meta key pressed ?
bool ctrlKey () const
 Is the ctrl key pressed ?
bool shiftKey () const
 Is the shift key pressed ?
Coordinates document () const
 Get the mouse position relative to the document.
Coordinates window () const
 Get the mouse position relative to the window.
Coordinates screen () const
 Get the mouse position relative to the screen.
Coordinates widget () const
 Get the mouse position relative to the widget.
Coordinates dragDelta () const
 Get the distance over which the mouse has been dragged.

Classes

struct  Coordinates
 A mouse coordinate. More...


Detailed Description

A class providing details for a mouse event.

See also:
WInteractWidget::clicked

Member Enumeration Documentation

enum Wt::WMouseEvent::Button

Enumeration for the mouse button.

Enumerator:
LeftButton  Left button.
MiddleButton  Middle button.
RightButton  Right button.


Member Function Documentation

Coordinates Wt::WMouseEvent::window (  )  const [inline]

Get the mouse position relative to the window.

This differs from documentX() only through scrolling through the document.

Coordinates Wt::WMouseEvent::dragDelta (  )  const [inline]

Get the distance over which the mouse has been dragged.

This is only defined for a mouseWentUp event.


The documentation for this class was generated from the following files:
Generated on Mon Apr 14 15:15:01 2008 for Wt by doxygen 1.5.3