Window

class ahk.window.AsyncWindow(engine, ahk_id, encoding=None)

property always_on_top

Return type

bool

async classmethod from_mouse_position(engine, **kwargs)

async classmethod from_pid(engine, pid, **kwargs)

async get_pos(info=None)

Returns

async get_transparency()

Return type

int

property height

async is_always_on_top()

async is_maximized()

async is_minimized()

async is_minmax()

property non_max_non_min

property position

property rect

async set_transparency(value)

property title

property transparent

Return type

int

property width

class ahk.window.AsyncWindowMixin(*args, **kwargs)

async find_window(func=None, **kwargs)

Like find_windows but only returns the first found window

Parameters

• func –

• kwargs –

Returns

a Window object or None if no matching window is found

async find_window_by_class(*args, **kwargs)

Parameters

• args –

• kwargs –

Returns

a Window object or None if no matching window is found

async find_window_by_text(*args, **kwargs)

Parameters

• args –

• kwargs –

Returns

a Window object or None if no matching window is found

async find_window_by_title(title)

Like find_windows_by_title but only returns the first result.

Returns

a Window object or None if no matching window is found

find_windows(func=None, **kwargs)

Find all matching windows

Parameters

• func – a callable to filter windows

• exact (bool) – if False (the default) partial matches are found. If True, only exact matches are returned

• kwargs – keywords of attributes of the window (has no effect if func is provided)

Returns

a generator containing any matching Window objects.

find_windows_by_class(class_name, exact=False)

Parameters

• class_name –

• exact –

Returns

a generator containing any matching Window objects.

find_windows_by_text(text, exact=False)

Parameters

• text –

• exact –

Returns

a generator containing any matching Window objects.

find_windows_by_title(title, exact=False)

Equivalent to find_windows(title=title)`

Note that title is a bytes object

Parameters

• title (bytes) –

• exact –

Returns

async win_get(*args, **kwargs)

async win_wait(*, title='', text='', exclude_title='', timeout=0.5, exclude_text='', encoding=None)

WinWait Wait for a window. If found within the timeout (in seconds), returns a Window object. If not found, raises a TimeoutError

ref: https://www.autohotkey.com/docs/commands/WinWait.htm

async windows()

Returns a list of windows

Returns

class ahk.window.Control

__init__()

Initialize self. See help(type(self)) for accurate signature.

click()

REF: https://www.autohotkey.com/docs/commands/ControlClick.htm

Returns

focus()

REF: https://www.autohotkey.com/docs/commands/ControlFocus.htm

Returns

get(key)

REF: https://www.autohotkey.com/docs/commands/ControlGet.htm

Parameters

key –

Returns

has_focus()

move()

REF: https://www.autohotkey.com/docs/commands/ControlMove.htm

Returns

property position

REF: https://www.autohotkey.com/docs/commands/ControlGetPos.htm

Returns

send(raw=False)

REF: https://www.autohotkey.com/docs/commands/ControlSend.htm

Parameters

raw –

Returns

property text

REF: https://www.autohotkey.com/docs/commands/ControlGetText.htm

Returns

class ahk.window.Window(engine, ahk_id, encoding=None)

MAXIMIZED = '1'

MINIMIZED = '-1'

NON_MIN_NON_MAX = '0'

__init__(engine, ahk_id, encoding=None)

Initialize self. See help(type(self)) for accurate signature.

activate()

Activate the window.

See also: WinActivate

Returns

activate_bottom()

Calls WinActivateBottom on the window

Returns

property active

property always_on_top

Return type

bool

property class_name

click(*args, **kwargs)

Click at an x/y location on the screen. Uses ControlClick https://autohotkey.com/docs/commands/ControlClick.htm

x/y position params may also be specified as a 2-item sequence

Parameters

• x – x offset relative to topleft corner of the window

• y – y offset relative to the top of the window

• button – the button to press (default is left mouse)

• n – number of times to click

• options – per ControlClick documentation

• blocking –

Returns

close(seconds_to_wait='')

Closes the Window. See also: WinClose

Parameters

seconds_to_wait –

Returns

disable()

Distable the window

Returns

enable()

Enable the window

Returns

property exist

exists()

classmethod from_mouse_position(engine, **kwargs)

classmethod from_pid(engine, pid, **kwargs)

get(subcommand)

get_class_name()

get_pos(info=None)

Returns

get_text()

get_title()

get_transparency()

Return type

int

property height

hide()

Hides the window. See also: WinHide

Returns

is_active()

is_always_on_top()

Return type

bool

is_maximized()

is_minimized()

is_minmax()

kill(seconds_to_wait='')

maximize()

maximize the window

Returns

property maximized

minimize()

minimize the window

Returns

property minimized

move(x='', y='', width=None, height=None)

Move the window to a position and/or change its geometry

Parameters

• x –

• y –

• width –

• height –

Returns

property non_max_non_min

property position

property rect

redraw()

restore()

restore the window

Returns

send(keys, delay=10, raw=False, blocking=True, escape=False, press_duration=-1)

Send keystrokes directly to the window. Uses ControlSend https://autohotkey.com/docs/commands/Send.htm

set(subcommand, value)

set_always_on_top(value)

set_position(new_position)

set_title(value)

set_transparency(value)

show()

show the window

Returns

property text

property title

to_bottom()

Send window to bottom (behind other windows) :return:

to_top()

Bring the window to the foreground (above other windows)

Returns

property transparent

Return type

int

wait_active(seconds_to_wait='')

Parameters

seconds_to_wait –

Returns

wait_close(seconds_to_wait='')

Parameters

seconds_to_wait –

Returns

wait_not_active(seconds_to_wait='')

Parameters

seconds_to_wait –

Returns

property width

class ahk.window.WindowMixin(*args, **kwargs)

__init__(*args, **kwargs)

This class is typically not used directly. AHK components inherit from this class and the arguments for this class should usually be passed in to AHK.

Parameters

• executable_path –

  the path to the AHK executable. If not provided explicitly in this argument, the path to the AHK executable is resolved in the following order:

  • The AHK_PATH environment variable, if present

  • DEFAULT_EXECUTABLE_PATH if the file exists

  If environment variable not present, tries to look for ‘AutoHotkey.exe’ or ‘AutoHotkeyA32.exe’ with shutil.which

• directives – a set of directives to apply to all generated AHK scripts

Raises

ExecutableNotFound – if AHK executable cannot be found or the specified file does not exist

property active_window

find_window(func=None, **kwargs)

Like find_windows but only returns the first found window

Parameters

• func –

• kwargs –

Returns

a Window object or None if no matching window is found

find_window_by_class(*args, **kwargs)

Parameters

• args –

• kwargs –

Returns

a Window object or None if no matching window is found

find_window_by_text(*args, **kwargs)

Parameters

• args –

• kwargs –

Returns

a Window object or None if no matching window is found

find_window_by_title(*args, **kwargs)

Like find_windows_by_title but only returns the first result.

Returns

a Window object or None if no matching window is found

find_windows(func=None, **kwargs)

Find all matching windows

Parameters

• func – a callable to filter windows

• exact (bool) – if False (the default) partial matches are found. If True, only exact matches are returned

• kwargs – keywords of attributes of the window (has no effect if func is provided)

Returns

a generator containing any matching Window objects.

find_windows_by_class(class_name, exact=False)

Parameters

• class_name –

• exact –

Returns

a generator containing any matching Window objects.

find_windows_by_text(text, exact=False)

Parameters

• text –

• exact –

Returns

a generator containing any matching Window objects.

find_windows_by_title(title, exact=False)

Equivalent to find_windows(title=title)`

Note that title is a bytes object

Parameters

• title (bytes) –

• exact –

Returns

get_active_window()

win_get(title='', text='', exclude_title='', exclude_text='', encoding=None)

win_set(subcommand, *args, blocking=True)

win_wait(*, title='', text='', exclude_title='', timeout=0.5, exclude_text='', encoding=None)

WinWait Wait for a window. If found within the timeout (in seconds), returns a Window object. If not found, raises a TimeoutError

ref: https://www.autohotkey.com/docs/commands/WinWait.htm

windows()

Returns a list of windows

Returns

exception ahk.window.WindowNotFoundError