Wt  3.3.9
Public Types | Public Member Functions | List of all members
Wt::WMouseEvent Class Reference

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

#include <Wt/WEvent>

Public Types

typedef Wt::Coordinates Coordinates
 Mouse coordinates.
 

Public Member Functions

 WMouseEvent ()
 Default constructor.
 
Button button () const
 Returns the button. More...
 
WFlags< KeyboardModifiermodifiers () const
 Returns keyboard modifiers. More...
 
Coordinates document () const
 Returns the mouse position relative to the document.
 
Coordinates window () const
 Returns the mouse position relative to the window. More...
 
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. More...
 
int wheelDelta () const
 Returns the scroll wheel delta. More...
 
bool altKey () const
 Returns whether the alt key is pressed (deprecated). More...
 
bool metaKey () const
 Returns whether the meta key is pressed (deprecated). More...
 
bool ctrlKey () const
 Returns whether the control key is pressed (deprecated). More...
 
bool shiftKey () const
 Returns whether the shift key is pressed (deprecated). More...
 

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
NoButton 

No button.

LeftButton 

Left button.

MiddleButton 

Middle button.

RightButton 

Right button.

Member Function Documentation

bool Wt::WMouseEvent::altKey ( ) const

Returns whether the alt key is pressed (deprecated).

Deprecated:
Use modifiers() instead.
WMouseEvent::Button Wt::WMouseEvent::button ( ) const

Returns the button.

If multiple buttons are currently pressed for a mouse moved or mouse dragged event, then the one with the smallest numerical value is returned.

bool Wt::WMouseEvent::ctrlKey ( ) const

Returns whether the control key is pressed (deprecated).

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

Returns the distance over which the mouse has been dragged.

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

bool Wt::WMouseEvent::metaKey ( ) const

Returns whether the meta key is pressed (deprecated).

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

Returns keyboard modifiers.

The result is a logical OR of KeyboardModifier flags.

bool Wt::WMouseEvent::shiftKey ( ) const

Returns whether the shift key is pressed (deprecated).

Deprecated:
Use modifiers() instead.
int Wt::WMouseEvent::wheelDelta ( ) const

Returns the scroll wheel delta.

This is 1 when wheel was scrolled up or -1 when wheel was scrolled down.

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

Coordinates Wt::WMouseEvent::window ( ) const

Returns the mouse position relative to the window.

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


Generated on Tue Nov 21 2017 for the C++ Web Toolkit (Wt) by doxygen 1.8.11