NAME

HTML::DOM::Event::Mouse - A Perl class for HTML DOM mouse event objects

VERSION

Version 0.055

SYNOPSIS

# ...

DESCRIPTION

This class provides MouseEvent objects for HTML::DOM, which objects are passed to event handlers for mouse events when they are invoked. It inherits from HTML::DOM::Event::UI.

METHODS

See also those inherited from HTML::DOM::Event::UI and HTML::DOM::Event.

DOM Attributes

These are all read-only and ignore their arguments.

screenX

screenY

clientX

clientY

This represent the coordinates within the screen or window (viewport), respectively, of the mouse event.

ctrlKey

shiftKey

altKey

metaKey

These are booleans that indicate which modifier keys were pressed when the event occurred.

button

A number representing the mouse button: 0 for the left (or the right button on a left-handed mouse), 1 for the middle and 2 for the right (or left).

relatedTarget

References a node which, though it is not the target, was involved in the event somehow. This is typically used for mouseover events and indicates the node that the mouse moved off.

Other Methods

initMouseEvent ( $name, $propagates_up, $cancellable, $view, $detail, $screen_x, $screen_y, $client_x, $client_y, $ctrl_key, $alt_key, $shift_key, $meta_key, $button, $related_target )

This initialises the event object. See "initEvent" in HTML::DOM::Event for more detail.

init ( ... )

Alternative to initMouseEvent that's easier to use:

init $event
    type => $type,
    propagates_up => 1,
    cancellable => 1,
    view => $view,
    detail => 1,
    screen_x => $foo,
    screen_y => $bar,
    client_x => $baz,
    client_y => $oto,
    ctrl     => $bop,
    alt      => 0,
    shift    => 0,
    meta     => 0,
    button   => 1,
    rel_target => $other_elem,
;

SEE ALSO

HTML::DOM

HTML::DOM::Event

HTML::DOM::Event::UI