iris.api.core.key Namespace Reference

Classes
class	_IrisKey
class	Key
class	KeyModifier

Functions
def	key_down (key)
def	key_up (key)
def	type (text=None, modifier=None, interval=None)
def	paste (text)
def	check_keyboard_state ()

Function Documentation

check_keyboard_state()

def iris.api.core.key.check_keyboard_state

(

)

Check Keyboard state.

Iris cannot run in case Key.CAPS_LOCK, Key.NUM_LOCK or Key.SCROLL_LOCK are pressed.

key_down()

def iris.api.core.key.key_down

(

key

)

Performs a keyboard key press without the release. This will put that key in a held down state.

:param key: The key to be pressed down.
:return: None.

key_up()

def iris.api.core.key.key_up

(

key

)

Performs a keyboard key release (without the press down beforehand).

:param key: The key to be released up.
:return: None.

paste()

def iris.api.core.key.paste

(

text

)

:param text: Text to be pasted.
:return: None.

type()

def iris.api.core.key.type	(		text = None,
			modifier = None,
			interval = None
	)

:param str || list text: If a string, then the characters to be pressed. If a list, then the key names of the keys
                         to press in order.
:param modifier: Key modifier.
:param interval: The number of seconds in between each press. By default it is 0 seconds.
:return: None.