Autokey API
Note that the class paths are not relevant to everyday autokey scripting. Generally speaking you can call all of these modules directly;
keyboard.send_keys("example document")
clipboard.set_content("update clipboard")
Is all that you need to call a method in the keyboard/clipboard API, note that you do not have to worry about import statements.
For the Qt/Gtk pages, these are abstracted, Autokey will select the UI framework most appropriate, you only need to reference these in your scripts as;
dialog.info_dialog("Info dialog", "Test info dialog")
clipboard.set_content("clipboard content")
- Keyboard API
- Keys
Key
Key.LEFT
Key.RIGHT
Key.UP
Key.DOWN
Key.BACKSPACE
Key.TAB
Key.ENTER
Key.SCROLL_LOCK
Key.PRINT_SCREEN
Key.PAUSE
Key.MENU
Key.CONTROL
Key.ALT
Key.ALT_GR
Key.SHIFT
Key.SUPER
Key.HYPER
Key.CAPSLOCK
Key.NUMLOCK
Key.META
Key.F1
Key.F2
Key.F3
Key.F4
Key.F5
Key.F6
Key.F7
Key.F8
Key.F9
Key.F10
Key.F11
Key.F12
Key.F13
Key.F14
Key.F15
Key.F16
Key.F17
Key.F18
Key.F19
Key.F20
Key.F21
Key.F22
Key.F23
Key.F24
Key.F25
Key.F26
Key.F27
Key.F28
Key.F29
Key.F30
Key.F31
Key.F32
Key.F33
Key.F34
Key.F35
Key.ESCAPE
Key.INSERT
Key.DELETE
Key.HOME
Key.END
Key.PAGE_UP
Key.PAGE_DOWN
Key.NP_INSERT
Key.NP_DELETE
Key.NP_HOME
Key.NP_END
Key.NP_PAGE_UP
Key.NP_PAGE_DOWN
Key.NP_LEFT
Key.NP_RIGHT
Key.NP_UP
Key.NP_DOWN
Key.NP_DIVIDE
Key.NP_MULTIPLY
Key.NP_ADD
Key.NP_SUBTRACT
Key.NP_5
Key.is_key()
- Mouse API
Mouse
Mouse.Button
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()
- Buttons
- Store API
- QtDialog API
- QtClipboard API
- GtkDialog API
- GtkClipboard API
- System API
- Window API
- Engine API
Engine
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
- Common API