MouseEvent
Overview
MouseEvent is a class in Aspose.Html FOSS for Python.
Inherits from: UIEvent.
Mouse or pointer event (WHATWG UI Events §5.2).
This class provides 5 methods for working with MouseEvent objects in Python programs.
Available methods include: __init__, init_event, prevent_default, stop_immediate_propagation, stop_propagation.
All public members are accessible to any Python application after installing the Aspose.Html FOSS for Python package.
Properties: alt_key, bubbles, button, buttons, cancelable, client_x, and 19 more.
Properties
| Name | Type | Access | Description |
|---|---|---|---|
button | int | Read | Which mouse button was pressed (0 = primary, 1 = middle, 2 = secondary). |
buttons | int | Read | Bitmask of all currently pressed mouse buttons. |
client_x | int | Read | Horizontal coordinate relative to the viewport. |
client_y | int | Read | Vertical coordinate relative to the viewport. |
screen_x | int | Read | Horizontal coordinate relative to the screen. |
screen_y | int | Read | Vertical coordinate relative to the screen. |
offset_x | int | Read | Horizontal offset relative to the target element’s padding edge (always 0). |
offset_y | int | Read | Vertical offset relative to the target element’s padding edge (always 0). |
page_x | int | Read | Horizontal coordinate relative to the document (always 0 in headless mode). |
page_y | int | Read | Vertical coordinate relative to the document (always 0 in headless mode). |
alt_key | bool | Read | Whether the Alt key was active when the event fired. |
ctrl_key | bool | Read | Whether the Ctrl key was active when the event fired. |
meta_key | bool | Read | Whether the Meta key was active when the event fired. |
shift_key | bool | Read | Whether the Shift key was active when the event fired. |
related_target | "object | None" | Read | Secondary target (e.g. |
detail | int | Read | Integer detail value associated with the event. |
view | None | Read | Always None in headless mode (Window back-reference out of scope). |
type | str | Read | The event type string. |
bubbles | bool | Read | Whether the event bubbles. |
cancelable | bool | Read | Whether the default action can be prevented. |
target | "EventTarget | None" | Read | The EventTarget on which the event was dispatched. |
current_target | "EventTarget | None" | Read | The EventTarget whose listener is currently being invoked. |
event_phase | int | Read | Phase constant: NONE (0), CAPTURING_PHASE (1), AT_TARGET (2), BUBBLING_PHASE (3). |
default_prevented | bool | Read | Whether preventDefault() was called on a cancelable event. |
timestamp | float | Read | Unix epoch time (seconds) at Event creation. |
Methods
| Signature | Description |
|---|---|
__init__(type: str, bubbles: bool, cancelable: bool, detail: int, button: int, buttons: int, client_x: int, client_y: int, screen_x: int, screen_y: int, alt_key: bool, ctrl_key: bool, meta_key: bool, shift_key: bool, related_target: object) | Calls init(type, bubbles, cancelable, detail, button, buttons, client_x, client_y, screen_x, screen_y, alt_key, ctrl_key, meta_key, shift_key, related_target) on this MouseEvent instance. |
prevent_default() | Set default_prevented to True if the event is cancelable. |
stop_propagation() | Stop event propagation after all listeners on the current target finish. |
stop_immediate_propagation() | Stop propagation AND prevent remaining listeners on the current target. |
init_event(type: str, bubbles: bool, cancelable: bool) | Legacy alias for pre-dispatch event initialization. |