Interface MouseProviderInterface

A MouseActionProvider should provide access to a systems mouse input

Hierarchy

MouseProviderInterface

Implemented by

default

Index

Methods

click currentMousePosition doubleClick leftClick middleClick pressButton releaseButton rightClick scrollDown scrollLeft scrollRight scrollUp setMouseDelay setMousePosition

Methods

click

click(btn: Button): Promise<void>
click should allow to perform a single click via OS event
Parameters
- btn: Button
  
  The Button to click
Returns Promise<void>
- Defined in provider/mouse-provider.interface.ts:34

currentMousePosition

currentMousePosition(): Promise<Point>
currentMousePosition should return the current mouse pointer position

Returns
The current mouse pointer position

Returns Promise<Point>
- Defined in provider/mouse-provider.interface.ts:27

doubleClick

doubleClick(btn: Button): Promise<void>
doubleClick should allow to perform a double click via OS event
Parameters
- btn: Button
  
  The Button to click
Returns Promise<void>
- Defined in provider/mouse-provider.interface.ts:41

leftClick

leftClick(): Promise<void>
leftClick should allow to perform a left click via OS event

Deprecated
Will be deprecated with the next major release, use click instead

Returns Promise<void>
- Defined in provider/mouse-provider.interface.ts:48

middleClick

middleClick(): Promise<void>
middleClick should allow to perform a middle click via OS event

Deprecated
Will be deprecated with the next major release, use click instead

Returns Promise<void>
- Defined in provider/mouse-provider.interface.ts:62

pressButton

pressButton(btn: Button): Promise<void>
pressButton should allow to press and hold a mouse button
Parameters
- btn: Button
  
  The Button to press and hold
Returns Promise<void>
- Defined in provider/mouse-provider.interface.ts:97

releaseButton

releaseButton(btn: Button): Promise<void>
releaseButton should allow to release a pressed button
Parameters
- btn: Button
  
  The Button to release
Returns Promise<void>
- Defined in provider/mouse-provider.interface.ts:104

rightClick

rightClick(): Promise<void>
rightClick should allow to perform a right click via OS event

Deprecated
Will be deprecated with the next major release, use click instead

Returns Promise<void>
- Defined in provider/mouse-provider.interface.ts:55

scrollDown

scrollDown(amount: number): Promise<void>
scrollDown should allow to perform an downward mouse scroll
Parameters
- amount: number
  
  The scroll amount
Returns Promise<void>
- Defined in provider/mouse-provider.interface.ts:76

scrollLeft

scrollLeft(amount: number): Promise<void>
scrollLeft should allow to perform a left mouse scroll
Parameters
- amount: number
  
  The scroll amount
Returns Promise<void>
- Defined in provider/mouse-provider.interface.ts:83

scrollRight

scrollRight(amount: number): Promise<void>
scrollRight should perform a right mouse scroll
Parameters
- amount: number
  
  The scroll amount
Returns Promise<void>
- Defined in provider/mouse-provider.interface.ts:90

scrollUp

scrollUp(amount: number): Promise<void>
scrollUp should allow to perform an upward mouse scroll
Parameters
- amount: number
  
  The scroll amount
Returns Promise<void>
- Defined in provider/mouse-provider.interface.ts:69

setMouseDelay

setMouseDelay(delay: number): void
setMouseDelay should allow to configure mouse movement speed
Parameters
- delay: number
  
  The delay in milliseconds
Returns void
- Defined in provider/mouse-provider.interface.ts:13

setMousePosition

setMousePosition(p: Point): Promise<void>
setMousePosition should allow to set the mouse cursor position
Parameters
- p: Point
  
  The Point to which the mouse pointer should be set
Returns Promise<void>
- Defined in provider/mouse-provider.interface.ts:20