Classes | Public Types | Public Member Functions

Wt::WMouseEvent Class Reference
[Signal/slot system]

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

#include <Wt/WEvent>

List of all members.

Classes

struct  Coordinates
 A mouse coordinate. More...

Public Types

enum  Button { LeftButton, MiddleButton, RightButton }
 

Enumeration for the mouse button.

More...

Public Member Functions

 WMouseEvent ()
 Default constructor.
Button button () const
 Returns the button.
WFlags< KeyboardModifiermodifiers () const
 Returns keyboard modifiers.
Coordinates document () const
 Returns the mouse position relative to the document.
Coordinates window () const
 Returns the mouse position relative to the window.
Coordinates screen () const
 Returns the mouse position relative to the screen.
Coordinates widget () const
 Returns the mouse position relative to the widget.
Coordinates dragDelta () const
 Returns the distance over which the mouse has been dragged.
bool altKey () const
 Returns whether the alt key is pressed (deprecated).
bool metaKey () const
 Returns whether the meta key is pressed (deprecated).
bool ctrlKey () const
 Returns whether the control key is pressed (deprecated).
bool shiftKey () const
 Returns whether the shift key is pressed (deprecated).

Detailed Description

A class providing details for a mouse event.

See also:
WInteractWidget::clicked(), WInteractWidget::doubleClicked(), WInteractWidget::mouseWentDown(), WInteractWidget::mouseWentUp(), WInteractWidget::mouseWentOver(), WInteractWidget::mouseMoved()

Member Enumeration Documentation

Enumeration for the mouse button.

Enumerator:
LeftButton 

Left button.

MiddleButton 

Middle button.

RightButton 

Right button.


Member Function Documentation

bool Wt::WMouseEvent::altKey (  ) const [inline]

Returns whether the alt key is pressed (deprecated).

Deprecated:
Use modifiers() instead.
bool Wt::WMouseEvent::ctrlKey (  ) const [inline]

Returns whether the control key is pressed (deprecated).

Deprecated:
Use modifiers() instead.
Coordinates Wt::WMouseEvent::dragDelta (  ) const [inline]

Returns the distance over which the mouse has been dragged.

This is only defined for a WInteractWidget::mouseWentUp() event.

bool Wt::WMouseEvent::metaKey (  ) const [inline]

Returns whether the meta key is pressed (deprecated).

Deprecated:
Use modifiers() instead.
WFlags<KeyboardModifier> Wt::WMouseEvent::modifiers (  ) const [inline]

Returns keyboard modifiers.

The result is a logical OR of KeyboardModifier flags.

bool Wt::WMouseEvent::shiftKey (  ) const [inline]

Returns whether the shift key is pressed (deprecated).

Deprecated:
Use modifiers() instead.
Coordinates Wt::WMouseEvent::window (  ) const [inline]

Returns the mouse position relative to the window.

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


Generated on Sat Dec 4 2010 06:32:35 for Wt by doxygen 1.7.2