iris.api.core.mouse Namespace Reference

Classes
class	Mouse

Functions
def	mouse_press (where=None, button=None, in_region=None)
def	mouse_release (where=None, button=None, in_region=None)
def	mouse_move (where=None, duration=None, in_region=None)
def	click (where=None, duration=None, in_region=None)
def	right_click (where=None, duration=None, in_region=None)
def	double_click (where=None, duration=None, in_region=None)
def	to_location (ps=None, in_region=None, align='top_left')
def	drag_drop (drag_from, drop_to, duration=None)
def	scroll (clicks)

Function Documentation

click()

def iris.api.core.mouse.click	(		where = None,
			duration = None,
			in_region = None
	)

Mouse left click. Wrapper over _general_click.

:param where: Location , image name or Pattern.
:param duration: Speed of hovering from current location to target.
:param in_region: Region object in order to minimize the area.
:return: None.

double_click()

def iris.api.core.mouse.double_click	(		where = None,
			duration = None,
			in_region = None
	)

Mouse double click. Wrapper over _general_click.

:param where: Location , image name or Pattern.
:param duration: Speed of hovering from current location to target.
:param in_region: Region object in order to minimize the area.
:return: None.

drag_drop()

def iris.api.core.mouse.drag_drop	(		drag_from,
			drop_to,
			duration = None
	)

Mouse drag and drop.

:param drag_from: Starting point for drag and drop. Can be pattern, string or location.
:param drop_to: Ending point for drag and drop. Can be pattern, string or location.
:param duration: Speed of drag and drop.
:return: None.

mouse_move()

def iris.api.core.mouse.mouse_move	(		where = None,
			duration = None,
			in_region = None
	)

Mouse move. Wrapper over _general_click.

:param where: Location , image name or Pattern.
:param duration: Speed of hovering from current location to target.
:param in_region: Region object in order to minimize the area.
:return: None.

mouse_press()

def iris.api.core.mouse.mouse_press	(		where = None,
			button = None,
			in_region = None
	)

Mouse press. Wrapper over _mouse_press_release.

:param where: Location , image name or Pattern.
:param button: 'left','right' or 'middle'.
:param in_region: Region object in order to minimize the area.
:return: Call the _mouse_press_release() method with the 'press' option.

mouse_release()

def iris.api.core.mouse.mouse_release	(		where = None,
			button = None,
			in_region = None
	)

Mouse release. Wrapper over _mouse_press_release.

:param where: Location , image name or Pattern.
:param button: 'left','right' or 'middle'.
:param in_region: Region object in order to minimize the area.
:return: Call the _mouse_press_release() method with the 'release' option.

right_click()

def iris.api.core.mouse.right_click	(		where = None,
			duration = None,
			in_region = None
	)

Mouse right click. Wrapper over _general_click.

:param where: Location , image name or Pattern.
:param duration: Speed of hovering from current location to target.
:param in_region: Region object in order to minimize the area.
:return: None.

scroll()

def iris.api.core.mouse.scroll

(

clicks

)

Performs a scroll of the mouse scroll wheel.

:param clicks: The amount of scrolling to perform.
:return: None.

to_location()

def iris.api.core.mouse.to_location	(		ps = None,
			in_region = None,
			align = 'top_left'
	)

Transform pattern or string to location.

:param ps: Pattern or string input.
:param in_region: Region object in order to minimize the area.
:param align: Alignment could be top_left, center.
:return: Location object.