Welcome to AutoKey!

• Introduction to Autokey
  • Glossary of AutoKey Terms
  • How are things organized?
    • How to “source” settings on a new computer?
  • Why Would You Use AutoKey And What Does It Do For You?
    • Some examples:
  • What Is AutoKey and How Does It Work?
• Common actions
  • Adding Abbreviations
• Autokey API
  • Keyboard API
    • Keyboard
      • Keyboard.SendMode
        • Keyboard.SendMode.KEYBOARD
        • Keyboard.SendMode.CB_CTRL_V
        • Keyboard.SendMode.CB_CTRL_SHIFT_V
        • Keyboard.SendMode.CB_SHIFT_INSERT
        • Keyboard.SendMode.SELECTION
      • Keyboard.fake_keypress()
      • Keyboard.press_key()
      • Keyboard.release_key()
      • Keyboard.send_key()
      • Keyboard.send_keys()
      • Keyboard.wait_for_keyevent()
      • Keyboard.wait_for_keypress()
  • 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.Button.LEFT
        • Mouse.Button.MIDDLE
        • Mouse.Button.RIGHT
        • Mouse.Button.SCROLL_UP
        • Mouse.Button.SCROLL_DOWN
        • Mouse.Button.SCROLL_LEFT
        • Mouse.Button.SCROLL_RIGHT
        • Mouse.Button.BACKWARD
        • Mouse.Button.FORWARD
        • Mouse.Button.BUTTON10
      • 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
    • Button
      • Button.LEFT
      • Button.MIDDLE
      • Button.RIGHT
      • Button.SCROLL_UP
      • Button.SCROLL_DOWN
      • Button.SCROLL_LEFT
      • Button.SCROLL_RIGHT
      • Button.BACKWARD
      • Button.FORWARD
      • Button.BUTTON10
  • Store API
    • Store
      • Store.get_global_value()
      • Store.get_value()
      • Store.has_key()
      • Store.remove_global_value()
      • Store.remove_value()
      • Store.set_global_value()
      • Store.set_value()
  • QtDialog API
    • QtDialog
      • QtDialog.calendar()
      • QtDialog.choose_colour()
      • QtDialog.choose_directory()
      • QtDialog.combo_menu()
      • QtDialog.info_dialog()
      • QtDialog.input_dialog()
      • QtDialog.list_menu()
      • QtDialog.list_menu_multi()
      • QtDialog.open_file()
      • QtDialog.password_dialog()
      • QtDialog.save_file()
  • QtClipboard API
    • QtClipboard
      • QtClipboard.fill_clipboard()
      • QtClipboard.fill_selection()
      • QtClipboard.get_clipboard()
      • QtClipboard.get_selection()
      • QtClipboard.set_clipboard_image()
  • GtkDialog API
    • GtkDialog
      • GtkDialog.calendar()
      • GtkDialog.choose_colour()
      • GtkDialog.choose_directory()
      • GtkDialog.info_dialog()
      • GtkDialog.input_dialog()
      • GtkDialog.list_menu()
      • GtkDialog.list_menu_multi()
      • GtkDialog.open_file()
      • GtkDialog.password_dialog()
      • GtkDialog.save_file()
  • GtkClipboard API
    • GtkClipboard
      • GtkClipboard.fill_clipboard()
      • GtkClipboard.fill_selection()
      • GtkClipboard.get_clipboard()
      • GtkClipboard.get_selection()
      • GtkClipboard.selection
      • GtkClipboard.set_clipboard_image()
  • System API
    • System
      • System.create_file()
      • System.exec_command()
  • Window API
    • Window
      • Window.activate()
      • Window.close()
      • Window.get_active_class()
      • Window.get_active_geometry()
      • Window.get_active_title()
      • Window.move_to_desktop()
      • Window.resize_move()
      • Window.set_property()
      • Window.switch_desktop()
      • Window.wait_for_exist()
      • Window.wait_for_focus()
  • 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
    • PatternNotFound
    • visgrep()
    • get_png_dim()
    • mouse_move()
    • mouse_rmove()
    • mouse_click()
    • mouse_pos()
    • click_on_pat()
    • move_to_pat()
    • acknowledge_gnome_notification()
  • Common API
    • ColourData
      • ColourData.from_html()
      • ColourData.from_zenity_tuple_str()
      • ColourData.hex_code
      • ColourData.html_code
      • ColourData.zenity_tuple_str
    • DialogData
      • DialogData.successful

Indices and tables

• Index

• Module Index

• Search Page