Available Methods

Most useful methods from autohotkey are implemented in this wrapper. However, not everything is implemented (yet). This page can serve as a quick reference of AutoHotkey methods that are implemented in the wrapper.

(Coming soon: links to equivalent Python method(s))

Mouse and Keyboard

AutoHotkey Command

Status

Notes

#KeyHistory

Not Implemented

BlockInput

Implemented

Click

Implemented

ControlClick

Implemented

ControlSend[Raw]

Implemented

CoordMode

Implemented

GetKeyName()

Not Implemented

GetKeySC()

Not Implemented

GetKeyState

Implemented

GetKeyVK()

Not Implemented

KeyHistory

Not Implemented

KeyWait

Implemented

Input

Not Implemented

Use python input() instead

InputHook()

Not Implemented

MouseClick

Implemented

MouseClickDrag

Implemented

MouseGetPos

Implemented

MouseMove

Implemented

SendLevel

Implemented

SendMode

Not Implemented

SetCapsLockState

Implemented

SetDefaultMouseSpeed

Implemented

Speed is controlled by the speed keyword argument of relevant methods

SetKeyDelay

Implemented

Delay is controlled by the delay keyword argument of relevant methods

SetMouseDelay

Not Implemented

Delays between mouse movements can be controlled in Python code

SetNumLockState

Implemented

SetScrollLockState

Implemented

SetStoreCapsLockMode

Not Implemented

note

Hotkeys

AutoHotkey Command

Status

Notes

Hotkeys

Implemented

Before 1.0, callbacks were only supported as Autohotkey Scripts
In 1.0 and later, callbacks are supported as Python functions

Hotstrings

Implemented

Available in 1.0+

Suspend

Implemented*

Use stop_hotkeys and start_hotkeys to enable/disable hotkeys

ClipBoard

AutoHotkey Command

Status

Notes

OnClipboardChange()

Implemented

Clipboard/ClipboardAll

Implemented

ClipWAit

Implemented

note

Screen/Image

AutoHotkey Command

Status

Notes

ImageSearch

Implemented

PixelGetColor

Implemented

PixelSearch

Implemented

note

Registry

AutoHotkey Command

Status

Notes

RegDelete

Implemented

RegRead

Implemented

RegWrite

Implemented

SetRegView

Not Implemented

note

Window

Window | Controls

AutoHotkey Command

Status

Notes

Control

Implemented

ControlClick

Implemented

ControlFocus

Not Implemented

ControlGet

Implemented

ControlGetFocus

Not Implemented

ControlGetPos

Implemented

ControlGetText

Implemented

ControlMove

Implemented

ControlSend[Raw]

Implemented

ControlSetText

Implemented

Menu

Not Implemented

PostMessage/SendMessage

Not Implemented

SetControlDelay

Not Implemented

WinMenuSelectItem

Not Implemented

note

Window | Groups

AutoHotkey Command

Status

Notes

GroupActivate

GroupAdd

GroupClose

GroupDeactivate

note

Window functions

AutoHotkey Command

Status

Notes

#WinActivateForce

Implemented

Any directive can be added to the daemon

DetectHiddenText

Planned

DetectHiddenWindows

Implemented

IfWin[Not]Active

Not Implemented

Use Python if with win_active/win.is_active

IfWin[Not]Exist

Not Implemented

Use Python if with win_exists/win.exists

SetTitleMatchMode

Implemented

SetWinDelay

Not Implemented

Delays can be controlled in Python code

StatusBarGetText

Not Implemented

StatusBarWait

Not Implemented

WinActivate

Implemented

WinActivateBottom

Implemented

WinActive()

Implemented

WinClose

Implemented

WinExist()

Implemented

WinGet

Implemented

WinGetActiveStats

Not Implemented

WinGetActiveTitle

Not Implemented

WinGetClass

Implemented

WinGetPos

Implemented

WinGetText

Implemented

WinGetTitle

Implemented

WinHide

Implemented

WinKill

Implemented

WinMaximize

Implemented

WinMinimize

Implemented

WinMinimizeAll[Undo]

Not Implemented

WinMove

Implemented

WinRestore

Implemented

WinSet

Implemented

WinSetTitle

Implemented

WinShow

Implemented

WinWait

Implemented

WinWait[Not]Active

Implemented

WinWaitClose

Implemented

note

Sound

AutoHotkey Command

Status

Notes

SoundBeep

Implemented

SoundGet

Implemented

SoundGetWaveVolume

Not Implemented

SoundPlay

Implemented

SoundSet

Implemented

SoundSetWaveVolume

Not Implemented

note

GUI

GUI methods are largely unimplmented, except ToolTip and TrayTip. We recommend using one of the many Python GUI libraries, such as easygui, pysimplegui or similar.

AutoHotkey Command

Status

Notes

Gui

Not Implemented

Gui control types

Not Implemented

GuiControl

Not Implemented

GuiControlGet

Not Implemented

Gui ListView control

Not Implemented

Gui TreeView control

Not Implemented

IfMsgBox

Not Implemented

InputBox

Not Implemented

LoadPicture()

Not Implemented

Menu

Not Implemented

MenuGetHandle()

Not Implemented

MenuGetName()

Not Implemented

MsgBox

Not Implemented

OnMessage()

Not Implemented

Progress

Not Implemented

SplashImage

Not Implemented

SplashTextOn/Off

Not Implemented

ToolTip

Implemented

TrayTip

Implemented

note

Directives

In general, all directives are technically usable, however many do not have applicable context in the Python library.

Some directives are mentioned in tables above and are omitted from this table.

AutoHotkey Command

Notes

#HotkeyInterval

#HotkeyModifierTimeout

#Hotstring

#Include[Again]

Using this directive is strongly discouraged as it is very likely to cause issues. Use with extreme caution.

#InputLevel

#KeyHistory

#MaxHotkeysPerInterval

#MaxMem

#MaxThreads

#MaxThreadsBuffer

#MaxThreadsPerHotkey

Hotkey callbacks are run in Python, so this largely won’t have any significant effect

#MenuMaskKey

#NoEnv

#NoTrayIcon

If you use hotkeys or hotstrings, you probably also want to configure this as a hotkey transport option

#Persistent

This is on by default in scripts run by this library

#Requires

#SingleInstance

This directive is provided by default (SingleInstance Off for the main thread)

#UseHook

#Warn

Not relevant for this library

#AllowSameLineComments

Not relevant for this library

#ClipboardTimeout

Not relevant for this library

#CommentFlag

Not relevant for this library

#ErrorStdOut

Not relevant for this library

#EscapeChar

Not relevant for this library

#InstallKeybdHook

Not relevant for this library

#InstallMouseHook

Not relevant for this library

#If

Not relevant for this library

#IfTimeout

Not relevant for this library