AutoGUI

Documentation

data Key

Instances

Eq Key

Defined in AutoGUI.Keys

Methods

(==) :: Key -> Key -> Bool

(/=) :: Key -> Key -> Bool

Ord Key

Defined in AutoGUI.Keys

Methods

compare :: Key -> Key -> Ordering

(<) :: Key -> Key -> Bool

(<=) :: Key -> Key -> Bool

(>) :: Key -> Key -> Bool

(>=) :: Key -> Key -> Bool

max :: Key -> Key -> Key

min :: Key -> Key -> Key

Show Key

Defined in AutoGUI.Keys

Methods

showsPrec :: Int -> Key -> ShowS

show :: Key -> String

showList :: [Key] -> ShowS

ToPy Key

Defined in AutoGUI.Keys

Methods

toPy :: Key -> IO SomeObject

Lift Key

Defined in AutoGUI.Keys

Methods

lift :: Key -> Q Exp

liftTyped :: Key -> Q (TExp Key)

alert :: Text -> IO ()

Show a box onscreen until dismissed

click :: MouseButton -> IO ()

Click a specified mouse button

confirm :: Text -> IO Bool

Show a box onscreen until a user hits OK or Cancel Return True on OK, False on Cancel, and False if user closes the box

doubleClick :: IO ()

Double click the mouse

drag :: Integer -> Integer -> IO ()

Clicks and drags the mouse through a motion of (x, y)

dragDuration :: Integer -> Integer -> Double -> IO ()

Clicks and drags the mouse through a motion of (x, y), over a number of seconds

dragRel :: Integer -> Integer -> IO ()

Clicks and drags the mouse through a motion of (x, y)

dragRelDuration :: Integer -> Integer -> Double -> IO ()

Clicks and drags the mouse through a motion of (x, y)

dragTo :: Integer -> Integer -> IO ()

Clicks and drags the mouse to the position (x, y)

dragToDuration :: Integer -> Integer -> Double -> IO ()

Clicks and drags the mouse to the position (x, y), over a number of seconds

failsafe :: Bool -> IO ()

When set to true, move the mouse to the upper-left corner of the screen to throw a Python exception, and quit the program

hotkey :: [Key] -> IO ()

Press a key combination

initialize :: IO ()

isValidKey :: Text -> Bool

key :: QuasiQuoter

This quasiquoter lets you use [key|enter|] at compile time, so you don't get a Maybe as you would from mkKey

keyDown :: Key -> IO ()

Simulate holding a key down

keyToText :: Key -> Text

keyUp :: Key -> IO ()

Simulate releasing a key

keys :: Set Key

leftClick :: IO ()

Left click the mouse

locateCenterOnScreen :: FilePath -> IO (Maybe (Integer, Integer))

Return (x, y) of center of an image, if the image is found

locateOnScreen :: FilePath -> IO (Maybe (Integer, Integer, Integer, Integer))

Return (left, top, width, height) of first place the image is found

middleClick :: IO ()

Middle click the mouse

mkKey :: Text -> Maybe Key

mouseDown :: IO ()

Press the left mouse button down

mouseUp :: IO ()

Release the left mouse button

moveAndClick :: Integer -> Integer -> IO ()

Move the mouse to some (x, y) position and click there

moveRel :: Integer -> Integer -> IO ()

Move the mouse relative to where it is now

moveRelDuration :: Integer -> Integer -> Double -> IO ()

Move the mouse relative to where it is now, over a number of seconds

moveTo :: Integer -> Integer -> IO ()

Move the mouse to an (x, y) position

moveToDuration :: Integer -> Integer -> Double -> IO ()

Move the mouse to an (x, y) position, over a number of seconds

onScreen :: Integer -> Integer -> IO Bool

Test whether (x, y) is within the screen size

password :: Text -> IO Text

Show a box onscreen, allowing user to enter some screened text Return empty string if user closes the box

pause :: Double -> IO ()

Set a number of seconds to wait in between autogui actions

position :: IO (Integer, Integer)

(x, y) position of the mouse

press :: Key -> IO ()

Simulate a keypress

prompt :: Text -> IO Text

Show a box onscreen, allowing user to enter some text Return empty string if user closes the box

rightClick :: IO ()

Right click the mouse

scroll :: Integer -> IO ()

Scroll up (positive) or down (negative)

size :: IO (Integer, Integer)

(screenWidth, screenHeight) of the primary monitor in pixels

sleep :: Double -> IO ()

Sleep for a given fractional number of seconds

tripleClick :: IO ()

Triple click the mouse

typewrite :: Text -> IO ()

Write out some Text as though it were entered with the keyboard, newline is enter

typewriteKeys :: [Key] -> IO ()

Write out some Text as though it were entered with the keyboard, newline is enter

write :: Text -> IO ()

Write out some Text as though it were entered with the keyboard

writeWithInterval :: Text -> Double -> IO ()

Write out some Text as though it were entered with the keyboard, with a specified number of seconds between keypresses