# class MouseEvent

###

Module | khtml
Namespace | DOM
Class | MouseEvent
Inherits | DOM::UIEvent

### methods

- MouseEvent ( )

  returns ctor

- MouseEvent (other)

  returns ctor

  Argument | Type | Default
  --- | --- | ---
  other | DOM.MouseEvent |

- MouseEvent (other)

  returns ctor

  Argument | Type | Default
  --- | --- | ---
  other | DOM.Event |

- MouseEvent (impl)

  returns ctor
  Not implemented

  Argument | Type | Default
  --- | --- | ---
  impl | MouseEventImpl |

- altKey ( )

  returns bool

  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.

- button ( )

  returns unsigned short

  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.

- clientX ( )

  returns long

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

- clientY ( )

  returns long

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

- ctrlKey ( )

  returns bool

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

- initMouseEvent (typeArg, canBubbleArg, cancelableArg, viewArg, detailArg, screenXArg, screenYArg, clientXArg, clientYArg, ctrlKeyArg, altKeyArg, shiftKeyArg, metaKeyArg, buttonArg, relatedTargetArg)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  typeArg | DOM.DOMString |
  canBubbleArg | bool |
  cancelableArg | bool |
  viewArg | DOM.AbstractView |
  detailArg | long |
  screenXArg | long |
  screenYArg | long |
  clientXArg | long |
  clientYArg | long |
  ctrlKeyArg | bool |
  altKeyArg | bool |
  shiftKeyArg | bool |
  metaKeyArg | bool |
  buttonArg | unsigned short |
  relatedTargetArg | DOM.Node |

  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

  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.

- metaKey ( )

  returns bool

  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.

- relatedTarget ( )

  returns DOM.Node

  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.

- screenX ( )

  returns long

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

- screenY ( )

  returns long

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

- shiftKey ( )

  returns bool

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