Index

Symbols | A | B | C | D | E | F | G | H | I | K | L | M | N | O | P | R | S | T | U | V | W

Symbols

-- <arguments>
command line option
-c,--console
command line option
-d,--debug <value> (up to 3 makes sense)
command line option
-f,--logfile [<path to log file>]
command line option
-h,--help
command line option
-i,--interactive
command line option
-r,--run <sikuli-folder/file> (one or more entries seperated by space)
command line option
-s,--server [<port>] (optional port not yet supported, 50001 is used as default)
command line option
-u,--userlog [<path to log file>]
command line option

A

above() (Location method)
(Region method)
ActionLogs (Settings attribute)
addHotkey() (Env method)
addHTTPImagePath() (built-in function)
addImagePath() (built-in function)
addImportPath() (built-in function)
App (built-in class), [1]
App() (App class method)
at() (Mouse method)

B

below() (Location method)
(Region method)
Bundle Path
button() (in module guide)

C

capture() (Screen method)
circle() (in module guide)
click() (Region method)
ClickDelay (Settings attribute)
close() (App class method)
(App method)
closeApp() (built-in function)
command line option
-- <arguments>
-c,--console
-d,--debug <value> (up to 3 makes sense)
-f,--logfile [<path to log file>]
-h,--help
-i,--interactive
-r,--run <sikuli-folder/file> (one or more entries seperated by space)
-s,--server [<port>] (optional port not yet supported, 50001 is used as default)
-u,--userlog [<path to log file>]

D

debugging and logging
DebugLogs (Settings attribute)
DelayBeforeDrag (Settings attribute)
DelayBeforeDrop (Settings attribute)
DelayBeforeMouseDown (Settings attribute)
delOpt()
delOpts()
doubleClick() (Region method)
drag() (Region method)
dragDrop() (Region method)
dropAt() (Region method)

E

exact() (Pattern method)
exists() (Region method)
exit() (built-in function)

F

file and path handling
find() (Finder method)
(Region method)
findAll() (Finder method)
(Region method)
Finder (built-in class), [1]
Finder() (Finder method)
focus() (App class method)
(App method)
focusedWindow()

G

get() (Region method)
getAutoWaitTimeout() (Region method)
getBottomLeft() (Region method)
getBottomRight() (Region method)
getBounds() (Screen method)
getBundleFolder() (built-in function)
getBundlePath() (built-in function), [1]
getCell() (Region method)
getCenter() (Region method)
getChanges()
getClipboard() (App method)
(Env method)
getCol() (Region method), [1]
getCols() (Region method)
getColW() (Region method)
getCount()
getEvent() (Region method)
getEvents() (Region method)
getFilename() (Pattern method)
getFindFailedResponse() (Region method)
getH() (Region method)
getImage()
getImagePath() (built-in function)
getLastMatch() (Region method)
getLastMatches() (Region method)
getMatch()
getMouseLocation() (Env method)
getName()
(App method)
getNumberScreens() (Screen method)
getOpt()
getOptNum()
getOpts()
getOS() (Env method)
(Settings method)
getOSVersion() (Env method)
(Settings method)
getParameter() (Vision method)
getParentFolder() (built-in function)
getParentPath() (built-in function)
getPattern()
getPID() (App method)
getRegion()
getResponse()
getRow() (Region method), [1]
getRowH() (Region method)
getRows() (Region method)
getScore() (Match method)
getScreen() (Region method)
getSikuliVersion() (Env method)
(Settings method)
getTarget() (Match method)
getTargetOffset() (Pattern method)
getThrowException() (Region method)
getTime()
(Region method)
getTopLeft() (Region method)
getTopRight() (Region method)
getType()
getW() (Region method)
getWaitScanRate() (Region method)
getWindow() (App method)
getX() (Location method)
(Region method)
getY() (Location method)
(Region method)
grow() (Region method), [1]
guide (module)

H

hasEvents() (Region method)
hasNext() (Finder method)
hasObserver() (Region method)
hasOpt()
hasOpts()
hasWindow() (App method)
highlight() (Region method)
hover() (Region method)

I

Image Search Path
SIKULI_IMAGE_PATH
import .sikuli
InfoLogs (Settings attribute)
input() (built-in function)
inputText() (built-in function)
inside() (Region method)
isAppear()
isLinux() (Settings method)
isLockOn() (Env method)
(Key method)
isMac() (Settings method)
isObserving() (Region method)
isRasterValid() (Region method)
isRegionValid() (Region method)
isRunning() (App method)
isWindows() (Settings method)

K

Key (built-in class)
keyDown() (Region method)
keyUp() (Region method)

L

left() (Location method)
(Region method)
load() (built-in function), [1]
loadOpts()
Location (built-in class)
Location() (Location method)

M

makeFolder() (built-in function)
makeOpts()
makePath() (built-in function)
Match (built-in class), [1]
MinSimilarity (Settings attribute)
morphTo() (Region method)
mouseDown() (Region method)
mouseMove() (Region method), [1]
mouseUp() (Region method)
MoveMouseDelay (Settings attribute)
moveTo() (Region method)

N

nearby() (Region method)
next() (Finder method)

O

observe() (Region method), [1]
ObserveEvent (built-in class)
observeInBackground() (Region method)
ObserveMinChangedPixels (Settings attribute)
ObserveScanRate (Settings attribute)
offset() (Location method)
(Region method)
onAppear() (Region method)
onChange() (Region method)
onVanish() (Region method)
open() (App class method)
(App method)
openApp() (built-in function)

P

paste() (Region method)
Pattern (built-in class), [1]
Pattern() (Pattern method)
pause() (App class method)
popAsk() (built-in function)
popat() (built-in function), [1], [2], [3]
popError() (built-in function)
popFile() (built-in function)
popup() (built-in function)
prefLoad() (Sikulix method)
prefRemove() (Sikulix method), [1]
prefStore() (Sikulix method)

R

rectangle() (in module guide)
Region (built-in class), [1], [2], [3], [4], [5], [6], [7], [8], [9], [10], [11], [12], [13], [14], [15], [16]
Region() (Region method)
removeHotkey() (Env method)
removeImagePath() (built-in function)
repeat()
resetImagePath() (built-in function)
right() (Location method)
(Region method)
rightClick() (Region method)
run scripts
run scripts from command line
run() (built-in function)
runScript() (built-in function), [1]

S

saveOpts(), [1]
Screen (built-in class), [1], [2]
Screen() (Screen method)
select() (built-in function)
selectRegion() (Screen method)
setActive() (Region method)
setAutoWaitTimeout() (Region method)
setBundlePath() (built-in function)
setCols() (Region method)
setFindFailedHandler()
(Region method)
setFindFailedResponse() (Region method)
setH() (Region method)
setImageMissingHandler()
setInactive() (Region method)
setLocation() (Location method)
setOpt()
setOptNum()
setOpts()
setParameter() (Vision method)
setRaster() (Region method)
setRect() (Region method)
setResponse()
setROI() (Region method)
setRows() (Region method)
setShowActions() (built-in function)
setThrowException() (Region method)
Settings (built-in class)
setUsing() (App method)
setW() (Region method)
setWaitScanRate() (Region method)
setX() (Region method)
setY() (Region method)
show() (in module guide)
SIKULI_IMAGE_PATH
Image Search Path
similar() (Pattern method)
SlowMotionDelay (Settings attribute)
stop()
stopObserver()
(Region method)
switchApp() (built-in function)

T

targetOffset() (Pattern method)
text() (in module guide)
(Region method)
tooltip() (in module guide)
type() (Region method)
TypeDelay (Settings attribute)

U

unzip() (built-in function)

V

vncStart()

W

wait() (Region method)
WaitScanRate (Settings attribute)
waitVanish() (Region method)
wheel() (Region method)
window()
with