colibrio-reader-framework/com.colibrio.readingsystem.base/MouseEngineEventData

MouseEngineEventData

open class MouseEngineEventData(val objectType: EngineEventDataObjectType = EngineEventDataObjectType.MOUSE_ENGINE_EVENT, val type: EngineEventDataType, val buttons: Int, val clientX: Double, val clientY: Double, val ctrlKey: Boolean, val mediaResource: EngineEventMediaResourceData?, val metaKey: Boolean, val pageX: Double, val pageY: Double, val readerDocumentEventState: ReaderDocumentEventState, val relativeClientX: Double, val relativeClientY: Double, val relativeScreenX: Double, val relativeScreenY: Double, val screenX: Double, val screenY: Double, val target: EngineEventTargetData?, val userGenerated: Boolean) : ReaderViewEngineEventData

The EngineEvent type used for "click" and "contextmenu" events.

Constructors

fun MouseEngineEventData(objectType: EngineEventDataObjectType = EngineEventDataObjectType.MOUSE_ENGINE_EVENT, type: EngineEventDataType, buttons: Int, clientX: Double, clientY: Double, ctrlKey: Boolean, mediaResource: EngineEventMediaResourceData?, metaKey: Boolean, pageX: Double, pageY: Double, readerDocumentEventState: ReaderDocumentEventState, relativeClientX: Double, relativeClientY: Double, relativeScreenX: Double, relativeScreenY: Double, screenX: Double, screenY: Double, target: EngineEventTargetData?, userGenerated: Boolean)

Types

Companion

object Companion

Functions

serialize

open override fun serialize(generator: JsonGenerator)

Properties

buttons

val buttons: Int

A number representing which buttons that are pressed on the mouse when a mouse event is triggered. Simultaneous buttons gives a combined value.

clientX

val clientX: Double

The x coordinate in the application's client area.

clientY

val clientY: Double

The y coordinate in the application's client area.

ctrlKey

val ctrlKey: Boolean

Indicates whether the ctrl key was pressed or not

mediaResource

val mediaResource: EngineEventMediaResourceData?

If the event was related to a media resource in the publication such as an image, audio or video resource. It contains additional information about the media resource and methods to access media content.

metaKey

val metaKey: Boolean

Indicates whether the meta key was pressed or not

objectType

val objectType: EngineEventDataObjectType

The type of engine event object this JSON structure represents.

pageX

val pageX: Double

The x coordinate relative the left edge of the application document. This includes any portion of the document not currently visible.

pageY

val pageY: Double

The y coordinate relative the top edge of the application document. This includes any portion of the document not currently visible.

readerDocumentEventState

val readerDocumentEventState: ReaderDocumentEventState

Describes how the reader document acted on the event.

relativeClientX

val relativeClientX: Double

The client X coordinate relative to the window width. Typically a number between 0 and 1.

relativeClientY

val relativeClientY: Double

The client Y coordinate relative to the window height. Typically a number between 0 and 1.

relativeScreenX

val relativeScreenX: Double

The global screen X coordinate relative to the screen width. Typically a number between 0 and 1.

relativeScreenY

val relativeScreenY: Double

The global screen Y coordinate relative to the screen height. Typically a number between 0 and 1.

screenX

val screenX: Double

The x coordinate in global screen coordinates.

screenY

val screenY: Double

The y coordinate in global screen coordinates.

target

val target: EngineEventTargetData?

Contains additional information about the original event target, such as the targeted node in the reader document.

type

val type: EngineEventDataType

The type of event.

userGenerated

val userGenerated: Boolean

If the event was emitted due to a user generated event.

Inheritors

PointerEngineEventData