Olympe SDK

Interface: HasMouseEvents

olympe.ui.events. HasMouseEvents

Mouse events interface for the CoreThread Note: All callbacks must be executed with the same node than the one which registered the callback

Methods

<abstract> getEventClickOrTap()

Gets the 'Click' or 'Tap' events.

Returns:

Data flow for mouse events.

Type
olympe.ui.events.MouseEvent | olympe.df.Proxy.<olympe.ui.events.MouseEvent>

<abstract> getEventDoubleClick()

Gets the 'Double click' events. These events are generated when the mouse button is clicked twice in rapid succession.

Returns:

Dataflow for double click events

Type
olympe.df.Proxy.<olympe.ui.events.MouseEvent> | olympe.ui.events.MouseEvent

<abstract> getEventMouseDown()

Gets then 'Mouse Down' events.

Returns:

Dataflow of mouse down events

Type
olympe.df.Proxy.<olympe.ui.events.MouseEvent> | olympe.ui.events.MouseEvent

<abstract> getEventMouseEnter()

Gets the 'Mouse Enter' events. These events are generated when the pointer enters the bounding box of the element.

Returns:

Dataflow of mouse enter events

Type
olympe.df.Proxy.<olympe.ui.events.MouseEvent> | olympe.ui.events.MouseEvent

<abstract> getEventMouseLeave()

Gets the 'Mouse Leave' events. These events are generated when the pointer leaves the bounding box of the element.

Returns:

Dataflow of mouse leave events

Type
olympe.df.Proxy.<olympe.ui.events.MouseEvent> | olympe.ui.events.MouseEvent

<abstract> getEventMouseMove()

Gets the 'Mouse Move' events.

Returns:

Dataflow of mouse moves events

Type
olympe.df.Proxy.<olympe.ui.events.MouseEvent> | olympe.ui.events.MouseEvent

<abstract> getEventMouseOver()

Gets the 'Mouse Over' events.

Returns:

Dataflow of mouse moves events

Type
olympe.df.Proxy.<olympe.ui.events.MouseEvent> | olympe.ui.events.MouseEvent

<abstract> getEventMouseUp()

Gets the 'Mouse Up' events.

Returns:

Dataflow of mouse up events

Type
olympe.df.Proxy.<olympe.ui.events.MouseEvent> | olympe.ui.events.MouseEvent

<abstract> getEventMouseWheel()

Gets the 'Mouse Wheel' events.

Returns:

Dataflow of mouse wheel events

Type
olympe.df.Proxy.<olympe.ui.events.MouseWheelEvent> | olympe.ui.events.MouseWheelEvent

<abstract> getEventTouchCancel()

Gets the 'Touch Cancel' events.

Returns:

Dataflow of touch cancel events

Type
olympe.ui.events.TouchEvent

<abstract> getEventTouchEnd()

Gets the 'Touch End' events.

Returns:

Dataflow of touch end events

Type
olympe.ui.events.TouchEvent

<abstract> getEventTouchMove()

Gets the 'Touch Move' events.

Returns:

Dataflow of touch move events

Type
olympe.ui.events.TouchEvent

<abstract> getEventTouchStart()

Gets the 'Touch Start' events.

Returns:

Dataflow of touch start events

Type
olympe.ui.events.TouchEvent

<abstract> getMoveEvent()

Gets the 'Move' events. These events are generated when the mouse moves.

Returns:
Type
olympe.ui.events.MoveEvent | olympe.df.Proxy.<olympe.ui.events.MoveEvent>

<abstract> isMouseDown()

Checks whether the mouse button is pressed down.

Returns:

True if a mouse button is down on this object

Type
olympe.df.POBoolean

<abstract> isMouseOver()

Checks whether the pointer is over this element.

Returns:

True if mouse is over object

Type
olympe.df.POBoolean

<abstract> isMouseUp()

Checks whether the mouse button is not pressed down.

Returns:

True if a mouse button is up on this object

Type
olympe.df.POBoolean

offClickOrTap(id)

Unregisters a callback for 'click or tap' events.

Parameters:
Name Type Description
id string

ID of callback (returned by onClickOrTap)

offDoubleClick(id)

Unregisters a callback for 'Double Click' events.

Parameters:
Name Type Description
id string

ID of callback (returned by onClickOrTap)

offMouseDown(id)

Unregisters a callback for 'Mouse Down' events.

Parameters:
Name Type Description
id string

ID of callback (returned by onMouseDown)

offMouseEnter(id)

Unregisters a callback for 'Mouse Enter' events.

Parameters:
Name Type Description
id string

ID of callback (returned by onMouseEnter)

offMouseLeave(id)

Unregisters a callback for 'Mouse Leave' events.

Parameters:
Name Type Description
id string

ID of callback (returned by onMouseLeave)

offMouseMove(id)

Unregisters a callback for 'Mouse Move' events.

Parameters:
Name Type Description
id string

ID of callback (returned by onMouseMove)

offMouseOver(id)

Unregisters a callback for 'Mouse Over' events.

Parameters:
Name Type Description
id string

ID of callback (returned by onMouseOver)

offMouseUp(id)

Unregisters a callback for 'Mouse Up' events.

Parameters:
Name Type Description
id string

ID of callback (returned by onMouseUp)

offMouseWheel(id)

Unregisters a callback for 'Mouse Wheel' events.

Parameters:
Name Type Description
id string

ID of callback (returned by onMouseWheel)

offMoveEnd(id)

Unregisters a callback for 'Move End' events.

Parameters:
Name Type Description
id string

ID of callback (returned by onMoveEnd)

offMoveStart(id)

Unregisters a callback for 'Move Start' events.

Parameters:
Name Type Description
id string

ID of callback (returned by onMoveStart)

offTouchCancel(id)

Unregisters a callback for 'Touch Cancel' events.

Parameters:
Name Type Description
id string

ID of callback (returned by onTouchCancel)

offTouchEnd(id)

Unregisters a callback for 'Touch End' events.

Parameters:
Name Type Description
id string

ID of callback (returned by onTouchEnd)

offTouchMove(id)

Unregisters a callback for 'Touch Move' events.

Parameters:
Name Type Description
id string

ID of callback (returned by onTouchMove)

offTouchStart(id)

Unregisters a callback for 'Touch Start' events.

Parameters:
Name Type Description
id string

ID of callback (returned by onTouchStart)

<abstract> onClickOrTap(callback [, id] [, priority])

Registers a callback for 'click or tap' events.

Parameters:
Name Type Argument Default Description
callback olympe.ui.events.OnMouseEventCallback

the function to call
id string <optional>

Id of callback, auto-generated if omitted
priority number <optional>
 0

Priority of event (higher number = higher priority)
Returns:

Id of the callback

Type
string

<abstract> onDoubleClick(callback [, id] [, priority])

Registers a callback for 'Double Click' events.

Parameters:
Name Type Argument Default Description
callback olympe.ui.events.OnMouseEventCallback

the function to call
id string <optional>

Id of callback, auto-generated if omitted
priority number <optional>
 0

Priority of event (higher number = higher priority)
Returns:

Id of the callback

Type
string

<abstract> onMouseDown(callback [, id] [, priority])

Registers a callback for the 'Mouse Down' events.

Parameters:
Name Type Argument Default Description
callback olympe.ui.events.OnMouseEventCallback

the function to call
id string <optional>

Id of callback, auto-generated if omitted
priority number <optional>
 0

Priority of event (higher number = higher priority)
Returns:

Id of the callback

Type
string

<abstract> onMouseEnter(callback [, id] [, priority])

Registers a callback for the 'Mouse Enter' events.

Parameters:
Name Type Argument Default Description
callback olympe.ui.events.OnMouseEventCallback

the function to call
id string <optional>

Id of callback, auto-generated if omitted
priority number <optional>
 0

Priority of event (higher number = higher priority)
Returns:

Id of the callback

Type
string

<abstract> onMouseLeave(callback [, id] [, priority])

Registers a callback for the 'Mouse Leave' events.

Parameters:
Name Type Argument Default Description
callback olympe.ui.events.OnMouseEventCallback

the function to call
id string <optional>

Id of callback, auto-generated if omitted
priority number <optional>
 0

Priority of event (higher number = higher priority)
Returns:

Id of the callback

Type
string

<abstract> onMouseMove(callback [, id] [, priority])

Registers a callback for the 'Mouse Move' events.

Parameters:
Name Type Argument Default Description
callback olympe.ui.events.OnMouseEventCallback

the function to call
id string <optional>

Id of callback, auto-generated if omitted
priority number <optional>
 0

Priority of event (higher number = higher priority)
Returns:

Id of the callback

Type
string

<abstract> onMouseOver(callback [, id] [, priority])

Registers a callback for the 'Mouse Over' events.

Parameters:
Name Type Argument Default Description
callback olympe.ui.events.OnMouseEventCallback

the function to call
id string <optional>

Id of callback, auto-generated if omitted
priority number <optional>
 0

Priority of event (higher number = higher priority)
Returns:

Id of the callback

Type
string

<abstract> onMouseUp(callback [, id] [, priority])

Registers a callback for the 'Mouse Up' events.

Parameters:
Name Type Argument Default Description
callback olympe.ui.events.OnMouseEventCallback

the function to call
id string <optional>

Id of callback, auto-generated if omitted
priority number <optional>
 0

Priority of event (higher number = higher priority)
Returns:

Id of the callback

Type
string

<abstract> onMouseWheel(callback [, id] [, priority])

Registers a callback for the 'Mouse Wheel' events.

Parameters:
Name Type Argument Default Description
callback function

the function to call
id string <optional>

Id of callback, auto-generated if omitted
priority number <optional>
 0

Priority of event (higher number = higher priority)
Returns:

Id of the callback

Type
string

<abstract> onMoveEnd(callback [, id] [, priority])

Registers a callback for the 'Move End' events.

Parameters:
Name Type Argument Default Description
callback olympe.ui.events.OnMoveEventCallback

the function to call
id string <optional>

Id of callback, auto-generated if omitted
priority number <optional>
 0

Priority of event (higher number = higher priority)
Returns:

Id of the callback

Type
string

<abstract> onMoveStart(callback [, id] [, priority])

Registers a callback for the 'Move Start' events.

Parameters:
Name Type Argument Default Description
callback olympe.ui.events.OnMoveEventCallback

the function to call
id string <optional>

Id of callback, auto-generated if omitted
priority number <optional>
 0

Priority of event (higher number = higher priority)
Returns:

Id of the callback

Type
string

<abstract> onTouchCancel(callback [, id] [, priority])

Registers a callback for the 'Touch Cancel' events.

Parameters:
Name Type Argument Default Description
callback function

the function to call
id string <optional>

Id of callback, auto-generated if omitted
priority number <optional>
 0

Priority of event (higher number = higher priority)
Returns:

Id of the callback

Type
string

<abstract> onTouchEnd(callback [, id] [, priority])

Registers a callback for the 'Touch End' events.

Parameters:
Name Type Argument Default Description
callback function

the function to call
id string <optional>

Id of callback, auto-generated if omitted
priority number <optional>
 0

Priority of event (higher number = higher priority)
Returns:

Id of the callback

Type
string

<abstract> onTouchMove(callback [, id] [, priority])

Registers a callback for the 'Touch Move' events.

Parameters:
Name Type Argument Default Description
callback function

the function to call
id string <optional>

Id of callback, auto-generated if omitted
priority number <optional>
 0

Priority of event (higher number = higher priority)
Returns:

Id of the callback

Type
string

<abstract> onTouchStart(callback [, id] [, priority])

Registers a callback for the 'Touch Start' events.

Parameters:
Name Type Argument Default Description
callback function

the function to call
id string <optional>

Id of callback, auto-generated if omitted
priority number <optional>
 0

Priority of event (higher number = higher priority)
Returns:

Id of the callback

Type
string