DOM::MouseEvent

#include <dom2_events.h>

Inheritance diagram for DOM::MouseEvent:

Public Member Functions

 MouseEvent (const MouseEvent &other)
 
 MouseEvent (const Event &other)
 
bool altKey () const
 
unsigned short button () const
 
long clientX () const
 
long clientY () const
 
bool ctrlKey () const
 
void initMouseEvent (const DOMString &typeArg, bool canBubbleArg, bool cancelableArg, const AbstractView &viewArg, long detailArg, long screenXArg, long screenYArg, long clientXArg, long clientYArg, bool ctrlKeyArg, bool altKeyArg, bool shiftKeyArg, bool metaKeyArg, unsigned short buttonArg, const Node &relatedTargetArg)
 
bool metaKey () const
 
MouseEventoperator= (const MouseEvent &other)
 
MouseEventoperator= (const Event &other)
 
Node relatedTarget () const
 
long screenX () const
 
long screenY () const
 
bool shiftKey () const
 
- Public Member Functions inherited from DOM::UIEvent
 UIEvent (const UIEvent &other)
 
 UIEvent (const Event &other)
 
int charCode () const
 
long detail () const
 
void initUIEvent (const DOMString &typeArg, bool canBubbleArg, bool cancelableArg, const AbstractView &viewArg, long detailArg)
 
int keyCode () const
 
int layerX () const
 
int layerY () const
 
UIEventoperator= (const UIEvent &other)
 
UIEventoperator= (const Event &other)
 
int pageX () const
 
int pageY () const
 
AbstractView view () const
 
int which () const
 
- Public Member Functions inherited from DOM::Event
 Event (const Event &other)
 
 Event (EventImpl *i)
 
bool bubbles () const
 
bool cancelable () const
 
Node currentTarget () const
 
unsigned short eventPhase () const
 
EventImpl * handle () const
 
void initEvent (const DOMString &eventTypeArg, bool canBubbleArg, bool cancelableArg)
 
bool isNull () const
 
Eventoperator= (const Event &other)
 
void preventDefault ()
 
void stopPropagation ()
 
Node target () const
 
DOMTimeStamp timeStamp () const
 
DOMString type () const
 

Protected Member Functions

 MouseEvent (MouseEventImpl *impl)
 
- Protected Member Functions inherited from DOM::UIEvent
 UIEvent (UIEventImpl *impl)
 

Additional Inherited Members

- Public Types inherited from DOM::Event
enum  PhaseType { CAPTURING_PHASE = 1, AT_TARGET = 2, BUBBLING_PHASE = 3 }
 
- Protected Attributes inherited from DOM::Event
EventImpl * impl
 

Detailed Description

Introduced in DOM Level 2.

The MouseEvent interface provides specific contextual information associated with Mouse events.

The detail attribute inherited from UIEvent indicates the number of times a mouse button has been pressed and released over the same screen location during a user action. The attribute value is 1 when the user begins this action and increments by 1 for each full sequence of pressing and releasing. If the user moves the mouse between the mousedown and mouseup the value will be set to 0, indicating that no click is occurring.

In the case of nested elements mouse events are always targeted at the most deeply nested element. Ancestors of the targeted element may use bubbling to obtain notification of mouse events which occur within its descendent elements.

Definition at line 413 of file dom2_events.h.

Member Function Documentation

bool MouseEvent::altKey ( ) const

Used to indicate whether the 'alt' key was depressed during the firing of the event.

On some platforms this key may map to an alternative key name.

Definition at line 475 of file dom2_events.cpp.

unsigned short MouseEvent::button ( ) const

During mouse events caused by the depression or release of a mouse button, button is used to indicate which mouse button changed state.

The values for button range from zero to indicate the left button of the mouse, one to indicate the middle button if present, and two to indicate the right button. For mice configured for left handed use in which the button actions are reversed the values are instead read from right to left.

Definition at line 493 of file dom2_events.cpp.

long MouseEvent::clientX ( ) const

The horizontal coordinate at which the event occurred relative to the DOM implementation's client area.

Definition at line 439 of file dom2_events.cpp.

long MouseEvent::clientY ( ) const

The vertical coordinate at which the event occurred relative to the DOM implementation's client area.

Definition at line 448 of file dom2_events.cpp.

bool MouseEvent::ctrlKey ( ) const

Used to indicate whether the 'ctrl' key was depressed during the firing of the event.

Definition at line 457 of file dom2_events.cpp.

void MouseEvent::initMouseEvent ( const DOMString typeArg,
bool  canBubbleArg,
bool  cancelableArg,
const AbstractView viewArg,
long  detailArg,
long  screenXArg,
long  screenYArg,
long  clientXArg,
long  clientYArg,
bool  ctrlKeyArg,
bool  altKeyArg,
bool  shiftKeyArg,
bool  metaKeyArg,
unsigned short  buttonArg,
const Node relatedTargetArg 
)

The initMouseEvent method is used to initialize the value of a MouseEvent created through the DocumentEvent interface.

This method may only be called before the MouseEvent has been dispatched via the dispatchEvent method, though it may be called multiple times during that phase if necessary. If called multiple times, the final invocation takes precedence. Parameters

Parameters
typeArgSpecifies the event type.
canBubbleArgSpecifies whether or not the event can bubble.
cancelableArgSpecifies whether or not the event's default action can be prevented.
viewArgSpecifies the Event's AbstractView.
detailArgSpecifies the Event's mouse click count.
screenXArgSpecifies the Event's screen x coordinate
screenYArgSpecifies the Event's screen y coordinate
clientXArgSpecifies the Event's client x coordinate
clientYArgSpecifies the Event's client y coordinate
ctrlKeyArgSpecifies whether or not control key was depressed during the Event.
altKeyArgSpecifies whether or not alt key was depressed during the Event.
shiftKeyArgSpecifies whether or not shift key was depressed during the Event.
metaKeyArgSpecifies whether or not meta key was depressed during the Event.
buttonArgSpecifies the Event's mouse button.
relatedTargetArgSpecifies the Event's related EventTarget.

Definition at line 511 of file dom2_events.cpp.

bool MouseEvent::metaKey ( ) const

Used to indicate whether the 'meta' key was depressed during the firing of the event.

On some platforms this key may map to an alternative key name.

Definition at line 484 of file dom2_events.cpp.

Node MouseEvent::relatedTarget ( ) const

Used to identify a secondary EventTarget related to a UI event.

Currently this attribute is used with the mouseover event to indicate the EventTarget which the pointing device exited and with the mouseout event to indicate the EventTarget which the pointing device entered.

Definition at line 502 of file dom2_events.cpp.

long MouseEvent::screenX ( ) const

The horizontal coordinate at which the event occurred relative to the origin of the screen coordinate system.

Definition at line 421 of file dom2_events.cpp.

long MouseEvent::screenY ( ) const

The vertical coordinate at which the event occurred relative to the origin of the screen coordinate system.

Definition at line 430 of file dom2_events.cpp.

bool MouseEvent::shiftKey ( ) const

Used to indicate whether the 'shift' key was depressed during the firing of the event.

Definition at line 466 of file dom2_events.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 1 2020 22:35:43 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.