Class MouseEvent

Mouse event

Inherits from

Object (base class)

Constructors

Name	Description
`this`	copy constructor
`this`	construct mouse event from data

Fields

Name	Type	Description
`_action`	`MouseAction`	mouse `action` code
`_button`	`MouseButton`	mouse `button` code for ButtonUp/ButtonDown
`_doNotTrackButtonDown`	`bool`	when true, no tracking of mouse on ButtonDown is necessary
`_eventTimestamp`	`long`	timestamp of event
`_flags`	`ushort`	`flags` bit set - usually from `MouseFlag` enum
`_lbutton`	`ButtonDetails`	left `button` state details
`_mbutton`	`ButtonDetails`	middle `button` state details
`_rbutton`	`ButtonDetails`	right `button` state details
`_trackingWidget`	`Widget`	widget which currently tracks mouse events
`_wheelDelta`	`short`	wheel delta
`_x`	`short`	`x` coordinate of pointer
`_y`	`short`	`y` coordinate of pointer

Properties

Name	Type	Description
`action` [get]	`MouseAction`	`action`
`button` [get]	`MouseButton`	`button` which caused ButtonUp or ButtonDown `action`
`buttonDetails` [get]	`ButtonDetails`	`button` state details for event's `button`
`buttonFlags` [get]	`ushort`	returns mouse `button` `flags` only
`doNotTrackButtonDown` [set]	`bool`	sets mouse `button` tracking flag
`doNotTrackButtonDown` [get]	`bool`	returns mouse `button` tracking flag
`doubleClick` [get]	`bool`	Returns true for ButtonDown event when `button` is pressed second time in short interval after pressing first time
`flags` [get]	`ushort`	returns `flags` (buttons and keys state)
`keyFlags` [get]	`ushort`	returns keyboard modifier `flags` only
`lbutton` [get]	`ButtonDetails`	left `button` state details
`mbutton` [get]	`ButtonDetails`	middle `button` state details
`pos` [get]	`Point`	returns point for mouse cursor position
`rbutton` [get]	`ButtonDetails`	right `button` state details
`trackingWidget` [get]	`Widget`	get event tracking widget to override
`wheelDelta` [get]	`short`	returns delta for Wheel event
`x` [get]	`short`	`x` coordinate of mouse pointer (relative to window client area)
`y` [get]	`short`	`y` coordinate of mouse pointer (relative to window client area)

Methods

Name	Description
`changeAction`	override `action` code (for usage from platform code)
`track`	override mouse tracking widget

Authors

Vadim Lopatin, coolreader.org@gmail.com

Copyright

Vadim Lopatin, 2014

License

Boost License 1.0