Availability of the AutoKey Scripting API Methods Under X11 and Wayland
The following tables list the AutoKey script API methods and indicate whether or not they are supported in the X11 and Wayland environments. See the API documentation for information on using these methods.
Keyboard API |
X11 |
Wayland |
|---|---|---|
keyboard.fake_keypress() |
✔️ |
✔️ |
keyboard.press_key() |
✔️ |
✔️ |
keyboard.release_key() |
✔️ |
✔️ |
keyboard.send_key() |
✔️ |
✔️ |
keyboard.send_keys() |
✔️ |
✔️ |
keyboard.wait_for_keyevent() |
✔️ |
|
keyboard.wait_for_keypress() |
✔️ |
Mouse API |
X11 |
Wayland |
|---|---|---|
mouse.click_absolute() |
✔️ |
✔️ |
mouse.click_relative() |
✔️ |
✔️ |
mouse.click_relative_self() |
✔️ |
✔️ |
mouse.get_location() |
✔️ |
✔️ |
mouse.get_relative_location() |
✔️ |
✔️ |
mouse.move_cursor() |
✔️ |
✔️ |
mouse.move_relative() |
✔️ |
✔️ |
mouse.move_relative_self() |
✔️ |
✔️ |
mouse.press_button() |
✔️ |
✔️ |
mouse.release_button() |
✔️ |
✔️ |
mouse.scroll_down() |
✔️ |
✔️ |
mouse.scroll_up() |
✔️ |
✔️ |
mouse.select_area() |
✔️ |
✔️ |
mouse.wait_for_click() |
✔️ |
✔️ |
Store API |
X11 |
Wayland |
|---|---|---|
store.get_global_value() |
✔️ |
✔️ |
store.get_value() |
✔️ |
✔️ |
store.has_key() |
✔️ |
✔️ |
store.remove_global_value() |
✔️ |
✔️ |
store.remove_value() |
✔️ |
✔️ |
store.set_global_value() |
✔️ |
✔️ |
store.set_value() |
✔️ |
✔️ |
Dialog API |
X11 |
Wayland |
|---|---|---|
dialog.calendar() |
✔️ |
✔️ |
dialog.choose_colour() |
✔️ |
✔️ |
dialog.choose_directory() |
✔️ |
✔️ |
dialog.combo_menu() |
✔️ |
✔️ |
dialog.info_dialog() |
✔️ |
✔️ |
dialog.input_dialog() |
✔️ |
✔️ |
dialog.list_menu() |
✔️ |
✔️ |
dialog.list_menu_multi() |
✔️ |
✔️ |
dialog.open_file() |
✔️ |
✔️ |
dialog.password_dialog() |
✔️ |
✔️ |
dialog.save_file() |
✔️ |
✔️ |
Clipboard API |
X11 |
Wayland |
|---|---|---|
clipboard.fill_clipboard() |
✔️ |
✔️ |
clipboard.fill_selection() |
✔️ |
✔️ |
clipboard.get_clipboard() |
✔️ |
✔️ |
clipboard.get_selection() |
✔️ |
✔️ |
clipboard.set_clipboard_image() |
✔️ |
✔️ |
System API |
X11 |
Wayland |
|---|---|---|
system.create_file() |
✔️ |
✔️ |
system.exec_command() |
✔️ |
✔️ |
Window API |
X11 |
Wayland |
|---|---|---|
window.activate() |
✔️ |
✔️ |
window.center_window() |
✔️ |
✔️ |
window.close() |
✔️ |
✔️ |
window.get_active_class() |
✔️ |
✔️ |
window.get_active_geometry() |
✔️ |
✔️ |
window.get_active_title() |
✔️ |
✔️ |
window.get_window_list() |
✔️ |
✔️ |
window.move_to_desktop() |
✔️ |
✔️ |
window.resize_move() |
✔️ |
✔️ |
window.set_property() |
✔️ |
✔️ |
window.switch_desktop() |
✔️ |
✔️ |
window.wait_for_exist() |
✔️ |
✔️ |
window.wait_for_focus() |
✔️ |
✔️ |
Engine API |
X11 |
Wayland |
|---|---|---|
engine.create_abbreviation() |
✔️ |
✔️ |
engine.create_folder() |
✔️ |
✔️ |
engine.create_hotkey() |
✔️ |
✔️ |
engine.create_phrase() |
✔️ |
✔️ |
engine.get_folder() |
✔️ |
✔️ |
engine.get_macro_arguments() |
✔️ |
✔️ |
engine.get_script_arguments() |
✔️ |
✔️ |
engine.get_script_keyword_arguments() |
✔️ |
✔️ |
engine.get_triggered_abbreviation() |
✔️ |
✔️ |
engine.remove_all_temporary() |
✔️ |
✔️ |
engine.run_script() |
✔️ |
✔️ |
engine.run_script_from_macro() |
✔️ |
✔️ |
engine.run_system_command_from_macro() |
✔️ |
✔️ |
engine.set_return_value() |
✔️ |
✔️ |
HighLevel API |
X11 |
Wayland |
|---|---|---|
highlevel.visgrep() |
✔️ |
|
highlevel.get_png_dim() |
✔️ |
|
highlevel.mouse_move() |
✔️ |
|
highlevel.mouse_rmove() |
✔️ |
|
highlevel.mouse_click() |
✔️ |
|
highlevel.mouse_pos() |
✔️ |
|
highlevel.click_on_pat() |
✔️ |
|
highlevel.move_to_pat() |
✔️ |
|
highlevel.acknowledge_gnome_notification() |
✔️ |
Common API |
X11 |
Wayland |
|---|---|---|
common.ColourData.from_html() |
✔️ |
✔️ |
common.ColourData.from_zenity_tuple_str() |
✔️ |
✔️ |