ahk Python wrapper documentation

GitHub

Contents:

• Quickstart
  • Installing AHK
• ahk
• Installation
• Usage
• Examples
  • Hotkeys
  • Hotstrings
  • Mouse
  • Keyboard
  • Windows
    • Getting windows
    • Working with windows
  • Screen
  • Clipboard
  • Sound
  • GUI
  • Global state changes
  • Add directives
  • Menu tray icon
  • Registry methods
  • non-blocking modes
  • Async API (asyncio)
  • type-hints and mypy
  • Run arbitrary AutoHotkey scripts
• Non-Python dependencies
  • Using AHK v2
    • Differences when using AutoHotkey v1 vs AutoHotkey v2
  • Extending: add your own AutoHotkey code (beta)
• Contributing
• Similar projects
• API
  • Sync API
    • FutureResult
    • Window
    • AsyncControl
    • AHK
  • Async API
    • AsyncFutureResult
    • AsyncWindow
    • AsyncControl
    • AsyncAHK
  • Available Methods
    • Mouse and Keyboard
    • Hotkeys
    • ClipBoard
    • Screen/Image
    • Registry
    • Window
    • Window functions
    • Sound
    • GUI
    • Directives
  • Directives
    • DirectiveMeta
    • Directive
    • AllowSameLineComments
    • ClipboardTimeout
    • ErrorStdOut
    • HotKeyInterval
    • HotKeyModifierTimeout
    • Include
    • IncludeAgain
    • InputLevel
    • InstallKeybdHook
    • InstallMouseHook
    • KeyHistory
    • MaxHotkeysPerInterval
    • MaxMem
    • MaxThreads
    • MaxThreadsBuffer
    • MaxThreadsPerHotkey
    • MenuMaskKey
    • NoTrayIcon
    • UseHook
    • Warn
    • WinActivateForce
  • Message
    • OutOfMessageTypes
    • Position
    • BytesLineReadable
    • is_window_control_list_response()
    • is_winget_response_type()
    • tom_generator()
    • ResponseMessage
    • TupleResponseMessage
    • CoordinateResponseMessage
    • IntegerResponseMessage
    • BooleanResponseMessage
    • StringResponseMessage
    • WindowListResponseMessage
    • NoValueResponseMessage
    • ExceptionResponseMessage
    • WindowControlListResponseMessage
    • WindowResponseMessage
    • PositionResponseMessage
    • FloatResponseMessage
    • TimeoutResponseMessage
    • B64BinaryResponseMessage
    • RequestMessage
• Extending AHK
  • Background
  • Writing an extension
    • Example
    • Includes
    • AsyncIO considerations
    • AutoHotkey V1 vs V2 compatibility
    • Extension dependencies
    • Best practices for extension authors
    • Available Message Types
    • Returning custom types (make your own message type)
    • Notes

Indices and tables

• Index

• Module Index

• Search Page