qt-creator/doc/src/howto/creator-keyboard-shortcuts.qdoc

/****************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2012 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: http://www.qt-project.org/
**
**
** GNU Free Documentation License
**
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of this
** file.
**
**
****************************************************************************/

// **********************************************************************
// NOTE: the sections are not ordered by their logical order to avoid
// reshuffling the file each time the index order changes (i.e., often).
// Run the fixnavi.pl script to adjust the links to the index order.
// **********************************************************************

/*!
    \contentspage index.html
    \previouspage creator-cli.html
    \page creator-keyboard-shortcuts.html
    \nextpage creator-editor-external.html

    \title Keyboard Shortcuts

    \QC provides various keyboard shortcuts to speed up your development
    process.

    To view all keyboard shortcuts defined in \QC, and to change them, select
    \gui {Tools > Options > Environment > Keyboard}. The shortcuts are listed by
    category. To find a keyboard
    shortcut in the list, enter a function name or shortcut in the \gui Filter
    field.

    \image qtcreator-keyboard-shortcuts.png

    The shortcuts that are displayed in red color are associated with several
    functions. \QC executes the function that is available in the current
    context. If several functions are available for the same shortcut at a
    time, there is a conflict and \QC cannot execute any function.

    A keyboard shortcut might also conflict with a shortcut that a Window
    manager uses for its own purposes. In that case, \QC shortcuts do not work.
    Typically, you can configure the shortcuts in the window manager, but if
    that is not allowed, you can change the \QC shortcuts. For example, Unity on
    Ubuntu 11.10 uses \key F10 in its window manager, and therefore the default
    \QC keyboard shortcut \key F10 (Step Over) does not work on that system.

    \section1 Configuring Keyboard Shortcuts

    To customize a keyboard shortcut:

    \list 1

        \o  Select \gui Tools > \gui Options > \gui Environment > \gui Keyboard.

        \o  Select a command from the list.

        \o  In \gui{Key Sequence} enter the shortcut key you want to associate
            with the selected command.

        \o  To revert to the default shortcut, select \gui Reset.

    \endlist

    \QC allows you to use different keyboard shortcut mapping schemes:

    \list

        \o  To import a keyboard shortcut mapping scheme, click \gui Import
            and select the .kms file containing the keyboard shortcut mapping scheme
            you want to import.

        \o  To export the current keyboard shortcut mapping scheme, click
            \gui Export and select the location where you want to save the
            exported .kms file.

    \endlist

    \section1 Default Keyboard Shortcuts

    The following tables list the default keyboard shortcuts. They are
    categorized by actions.

    \section2 General Keyboard Shortcuts

    \table
        \header
            \o Action
            \o Keyboard shortcut
        \row
            \o Open file or project
            \o Ctrl+O
        \row
            \o New file or project
            \o Ctrl+N
        \row
            \o Open in external editor
            \o Alt+V, Alt+I
        \row
            \o Select all
            \o Ctrl+A
        \row
            \o Delete
            \o Del
        \row
            \o Cut
            \o Ctrl+X
        \row
            \o Copy
            \o Ctrl+C
        \row
            \o Paste
            \o Ctrl+V
        \row
            \o Redo
            \o Ctrl+Y
        \row
            \o Print
            \o Ctrl+P
        \row
            \o Save
            \o Ctrl+S
        \row
            \o Save all
            \o Ctrl+Shift+S
        \row
            \o Close window
            \o Ctrl+W
        \row
            \o Close all
            \o Ctrl+Shift+W
        \row
            \o Close current file
            \o Ctrl+F4
        \row
            \o Go back
            \o Alt+Left
        \row
            \o Go forward
            \o Alt+Right
        \row
            \o Go to line
            \o Ctrl+L
        \row
            \o Next open document in history
            \o Ctrl+Shift+Tab
        \row
            \o Go to other split
            \o Ctrl+E, O
        \row
            \o Previous open document in history
            \o Ctrl+Tab
        \row
            \o Activate \gui Locator
            \o Ctrl+K
        \row
            \o Switch to \gui Welcome mode
            \o Ctrl+1
        \row
            \o Switch to \gui Edit mode
            \o Ctrl+2
        \row
            \o Switch to \gui Design mode
            \o Ctrl+3
        \row
            \o Switch to \gui Debug mode
            \o Ctrl+4
        \row
            \o Switch to \gui Projects mode
            \o Ctrl+5
        \row
            \o Switch to \gui Analyze mode
            \o Ctrl+6
        \row
            \o Switch to \gui Help mode
            \o Ctrl+7
        \row
            \o Toggle \gui{Issues} pane
            \o Alt+1 (Cmd+1 on Mac OS X)
        \row
            \o Toggle \gui{Search Results} pane
            \o Alt+2 (Cmd+2 on Mac OS X)
        \row
            \o Toggle \gui{Application Output} pane
            \o Alt+3 (Cmd+3 on Mac OS X)
        \row
            \o Toggle \gui{Compile Output} pane
            \o Alt+4 (Cmd+4 on Mac OS X)
        \row
            \o Activate \gui Bookmarks pane
            \o Alt+M
        \row
            \o Activate \gui{File System} pane
            \o Alt+Y
        \row
            \o Activate \gui{Open Documents} pane
            \o Alt+O
        \row
            \o Maximize output panes
            \o Alt+9
        \row
            \o Move to next item in output panes
            \o F6
        \row
            \o Move to previous item in output panes
            \o Shift+F6
        \row
            \o Activate \gui Projects pane
            \o Alt+X
        \row
            \o Full screen
            \o Ctrl+Shift+F11
        \row
            \o Toggle the sidebar
            \o Alt+0 (Cmd+0 on Mac OS X)
        \row
            \o Undo
            \o Ctrl+Z
        \row
            \o Move to \gui Edit mode

               In \gui Edit mode:
               \list
                \o The first press moves focus to the editor
                \o The second press closes secondary windows
               \endlist
            \o Esc
        \row
            \o Exit \QC
            \o Ctrl+Q
    \endtable

    \section2 Editing Keyboard Shortcuts

    \table
        \header
            \o Action
            \o Keyboard shortcut
        \row
            \o Auto-indent selection
            \o Ctrl+I
        \row
            \o Collapse
            \o Ctrl+<
        \row
            \o Expand
            \o Ctrl+>
        \row
            \o Trigger a completion in this scope
            \o Ctrl+Space
        \row
            \o Copy line
            \o Ctrl+Ins
        \row
            \o Copy line down
            \o Ctrl+Alt+Down
        \row
            \o Copy line up
            \o Ctrl+Alt+Up
        \row
            \o Paste from the clipboard history
            \o Ctrl+Shift+V

               Subsequent presses move you back in the history
        \row
            \o Cut line
            \o Shift+Del
        \row
            \o Join lines
            \o Ctrl+J
        \row
            \o Insert line above current line
            \o Ctrl+Shift+Enter
        \row
            \o Insert line below current line
            \o Ctrl+Enter
        \row
            \o Decrease font size
            \o Ctrl+- (Ctrl+Roll mouse wheel down)
        \row
            \o Increase font size
            \o Ctrl++ (Ctrl+Roll mouse wheel up)
        \row
            \o Reset font size
            \o Ctrl+0
        \row
            \o Toggle Vim-style editing
            \o Alt+V, Alt+V
        \row
            \o Split
            \o Ctrl+E, 2
        \row
            \o Split side by side
            \o Ctrl+E, 3
        \row
            \o Remove all splits
            \o Ctrl+E, 1
        \row
            \o Remove current split
            \o Ctrl+E, 0
        \row
            \o Select all
            \o Ctrl+A
        \row
            \o Go to block end
            \o Ctrl+]
        \row
            \o Go to block start
            \o Ctrl+[
        \row
            \o Go to block end with selection
            \o Ctrl+}
        \row
            \o Go to block start with selection
            \o Ctrl+{
        \row
            \o Move current line down
            \o Ctrl+Shift+Down
        \row
            \o Move current line up
            \o Ctrl+Shift+Up
        \row
            \o Trigger a refactoring action in this scope
            \o Alt+Enter
        \row
            \o Rewrap paragraph
            \o Ctrl+E, R
        \row
            \o Select the current block

               The second press extends the selection to the parent block
            \o Ctrl+U
        \row
            \o Enable text wrapping
            \o Ctrl+E, Ctrl+W
        \row
            \o Toggle comment for selection
            \o Ctrl+/
        \row
            \o Visualize whitespace
            \o Ctrl+E, Ctrl+V
        \row
            \o Adjust size
            \o Ctrl+J
        \row
            \o Lay out in a grid
            \o Ctrl+G
        \row
            \o Lay out horizontally
            \o Ctrl+H
        \row
            \o Lay out vertically
            \o Ctrl+L
        \row
            \o Preview
            \o Alt+Shift+R
        \row
            \o Edit signals and slots
            \o F4
        \row
            \o Toggle bookmark
            \o Ctrl+M
        \row
            \o Go to next bookmark
            \o Ctrl+.
        \row
            \o Go to previous bookmark
            \o Ctrl+,
        \row
            \o Fetch snippet
            \o Alt+C, Alt+F
        \row
            \o Paste snippet
            \o Alt+C, Alt+P
        \row
            \o Find usages
            \o Ctrl+Shift+U
        \row
            \o Follow symbol under cursor

               Works with namespaces, classes, methods, variables, include
               statements and macros
            \o F2
        \row
            \o Rename symbol under cursor
            \o Ctrl+Shift+R
        \row
            \o Switch between method declaration and definition
            \o Shift+F2
        \row
            \o Open type hierarchy
            \o Ctrl+Shift+T
        \row
            \o Switch between header and source file
            \o F4
        \row
            \o Turn selected text into lowercase
            \o Alt+U
        \row
            \o Turn selected text into uppercase
            \o Alt+Shift+U
        \row
            \o Run static checks on JavaScript code to find common problems
            \o Ctrl+Shift+C
        \row
            \o Find and replace
            \o Ctrl+F
        \row
            \o Find next
            \o F3
        \row
            \o Find previous
            \o Shift+F3
        \row
            \o Find next occurrence of selected text
            \o Ctrl+F3
        \row
            \o Find previous occurrence of selected text
            \o Ctrl+Shift+F3
        \row
            \o Replace next
            \o Ctrl+=
        \row
            \o Open advanced find
            \o Ctrl+Shift+F
        \row
            \o Record a text-editing macro
            \o Alt+(
        \row
            \o Stop recording a macro
            \o Alt+)
        \row
            \o Play last macro
            \o Alt+R
        \row
            \o Show Qt Quick toolbars
            \o Ctrl+Alt+Space
        \row
            \o Execute user actions in FakeVim mode
            \o Alt+V, n, where n is the number of the user action, from 1 to 9
    \endtable

    \section2 Image Viewer Shortcuts

    \table
        \header
            \o Action
            \o Keyboard shortcut
        \row
            \o Switch to background
            \o Ctrl+[
        \row
            \o Switch to outline
            \o Ctrl+]
        \row
            \o Zoom in
            \o Ctrl++
        \row
            \o Zoom out
            \o Ctrl+-
        \row
            \o Fit to screen
            \o Ctrl+=
        \row
            \o Original size
            \o Ctrl+0
    \endtable

    \section2 Qt Quick Designer Keyboard Shortcuts

    \table
        \header
            \o Action
            \o Keyboard shortcut
        \row
            \o Open the QML file that defines the selected component
            \o F2
        \row
            \o Move between code editor and visual editor
            \o F4
        \row
            \o Toggle left sidebar
            \o Ctrl+Alt+0
        \row
            \o Toggle right sidebar
            \o Ctrl+Alt+Shift+0
    \endtable

    \section2 Debugging Keyboard Shortcuts

    \table
        \header
            \o Action
            \o Keyboard shortcut
        \row
            \o Start or continue debugging
            \o F5
        \row
            \o Exit debugger
            \o Shift+F5
        \row
            \o Step over
            \o F10
        \row
            \o Step into
            \o F11
        \row
            \o Step out
            \o Shift+F11
        \row
            \o Toggle breakpoint
            \o F9
        \row
            \o Run to selected function
            \o Ctrl+F6
        \row
            \o Run to line
            \o Ctrl+F10
        \row
            \o Reverse direction
            \o F12
    \endtable

    \section2 Project Keyboard Shortcuts

    \table
        \header
            \o Action
            \o Keyboard shortcut
        \row
            \o Build project
            \o Ctrl+B
        \row
            \o Build all
            \o Ctrl+Shift+B
        \row
            \o New project
            \o Ctrl+Shift+N
        \row
            \o Open project
            \o Ctrl+Shift+O
        \row
            \o Select the \l{glossary-buildandrun-kit}{kit} to build and run your project with
            \o Ctrl+T
        \row
            \o Run
            \o Ctrl+R
    \endtable

    \section2 Help Keyboard Shortcuts

    \table
        \header
            \o Action
            \o Keyboard shortcut
        \row
            \o View context-sensitive help
            \o F1
        \row
            \o Activate contents in \gui Help mode
            \o Ctrl+T
        \row
            \o Add bookmark in \gui Help mode
            \o Ctrl+M
        \row
            \o Activate index in \gui Help mode
            \o Ctrl+I
        \row
            \o Reset font size
            \o Ctrl+0
        \row
            \o Activate search in \gui Help mode
            \o Ctrl+S
    \endtable

    \section2 Version Control Keyboard Shortcuts

    \table
        \header
            \o {1,2} Action
            \o {6,1} Version control system
        \header
            \o Bazaar
            \o CVS
            \o Git
            \o Mercurial
            \o Perforce
            \o Subversion
        \row
            \o Add
            \o
            \o Alt+C, Alt+A
            \o Alt+G, Alt+A
            \o
            \o Alt+P, Alt+A
            \o Alt+S, Alt+A
        \row
            \o Commit/Submit
            \o Alt+Z, Alt+C
            \o Alt+C, Alt+C
            \o Alt+G, Alt+C
            \o Alt+H, Alt+C
            \o Alt+P, Alt+S
            \o Alt+S, Alt+C
        \row
            \o Diff
            \o Alt+Z, Alt+D
            \o Alt+C, Alt+D
            \o Alt+G, Alt+D
            \o Alt+H, Alt+D
            \o
            \o Alt+S, Alt+D
        \row
            \o Diff project
            \o
            \o
            \o Alt+G, Alt+Shift+D
            \o
            \o Alt+P, Alt+D
            \o
        \row
            \o Blame/Annotate
            \o
            \o
            \o Alt+G, Alt+B
            \o
            \o
            \o
        \row
            \o Log/Filelog
            \o Alt+Z, Alt+L
            \o
            \o Alt+G, Alt+L
            \o Alt+H, Alt+L
            \o Alt+P, Alt+F
            \o
        \row
            \o Log project
            \o
            \o
            \o Alt+G, Alt+K
            \o
            \o
            \o
        \row
            \o Status
            \o Alt+Z, Alt+S
            \o
            \o
            \o Alt+H, Alt+S
            \o
            \o
        \row
            \o Undo changes/Revert
            \o
            \o
            \o Alt+G, Alt+U
            \o
            \o Alt+P, Alt+R
            \o
        \row
            \o Edit
            \o
            \o
            \o
            \o
            \o Alt+P, Alt+E
            \o
        \row
            \o Opened
            \o
            \o
            \o
            \o
            \o Alt+P, Alt+O
            \o
    \endtable
*/