khtml Library API Documentation

DOM::MouseEvent Class Reference

Introduced in DOM Level 2. More...

#include <dom2_events.h>

Inheritance diagram for DOM::MouseEvent:

DOM::UIEvent DOM::Event List of all members.

Public Methods

MouseEvent & operator= (const Event &other)
long screenX () const
 The horizontal coordinate at which the event occurred relative to the origin of the screen coordinate system.

long screenY () const
 The vertical coordinate at which the event occurred relative to the origin of the screen coordinate system.

long clientX () const
 The horizontal coordinate at which the event occurred relative to the DOM implementation's client area.

long clientY () const
 The vertical coordinate at which the event occurred relative to the DOM implementation's client area.

bool ctrlKey () const
 Used to indicate whether the 'ctrl' key was depressed during the firing of the event.

bool shiftKey () const
 Used to indicate whether the 'shift' key was depressed during the firing of the event.

bool altKey () const
 Used to indicate whether the 'alt' key was depressed during the firing of the event.

bool metaKey () const
 Used to indicate whether the 'meta' key was depressed during the firing of the event.

unsigned short 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.

Node relatedTarget () const
 Used to identify a secondary EventTarget related to a UI event.

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)
 The initMouseEvent method is used to initialize the value of a MouseEvent created through the DocumentEvent interface.


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 383 of file dom2_events.h.


Member Function Documentation

long MouseEvent::screenX  
 

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

Definition at line 313 of file dom2_events.cpp.

long MouseEvent::screenY  
 

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

Definition at line 321 of file dom2_events.cpp.

long MouseEvent::clientX  
 

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

Definition at line 329 of file dom2_events.cpp.

long MouseEvent::clientY  
 

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

Definition at line 337 of file dom2_events.cpp.

bool MouseEvent::ctrlKey  
 

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

Definition at line 345 of file dom2_events.cpp.

bool MouseEvent::shiftKey  
 

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

Definition at line 353 of file dom2_events.cpp.

bool MouseEvent::altKey  
 

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 361 of file dom2_events.cpp.

bool MouseEvent::metaKey  
 

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 369 of file dom2_events.cpp.

unsigned short MouseEvent::button  
 

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 377 of file dom2_events.cpp.

Node MouseEvent::relatedTarget  
 

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 385 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:
typeArg  Specifies the event type.
canBubbleArg  Specifies whether or not the event can bubble.
cancelableArg  Specifies whether or not the event's default action can be prevented.
viewArg  Specifies the Event's AbstractView.
detailArg  Specifies the Event's mouse click count.
screenXArg  Specifies the Event's screen x coordinate
screenYArg  Specifies the Event's screen y coordinate
clientXArg  Specifies the Event's client x coordinate
clientYArg  Specifies the Event's client y coordinate
ctrlKeyArg  Specifies whether or not control key was depressed during the Event.
altKeyArg  Specifies whether or not alt key was depressed during the Event.
shiftKeyArg  Specifies whether or not shift key was depressed during the Event.
metaKeyArg  Specifies whether or not meta key was depressed during the Event.
buttonArg  Specifies the Event's mouse button.
relatedTargetArg  Specifies the Event's related EventTarget.

Definition at line 393 of file dom2_events.cpp.


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kdelibs Version 3.1.0.
Documentation copyright © 1996-2002 the KDE developers.
Generated on Wed Oct 8 12:22:45 2003 by doxygen 1.2.18 written by Dimitri van Heesch, © 1997-2001