View source for Documentation/4.5/SlicerApplication/KeyboardShortcuts

<noinclude>{{documentation/versioncheck}}</noinclude>
{{warning}}This page is deprecated. Please see the following link for the actual page for Slicer 4:<br>
http://wiki.slicer.org/wiki/Documentation/4.0/SlicerApplication/MouseandKeyboardShortcuts




<!-- ---------------------------- -->
{{documentation/{{documentation/version}}/slicerapplication-header}}
<!-- ---------------------------- -->

 [[Slicer4:Developers#Projects|Back to Slicer 4 Developer projects]]

= '''Note: this page is work in progress.''' =

= Application Hot-keys (keyboard accelerators) =

* '''Alt-Left''' + '''mouse button''' should always be available as a substitute for the middle mouse button to support two button mice. On Mac, you can also use the '''command key''' + '''mouse click''' to get middle mouse events.
* '''Control-Left''' + '''mouse button''' should always be available as a substitute for the right mouse button to support one button mice (on Mac).

{{warning}}'''Developers:''' Please note the following reserved key combinations!

== General ==

{| class="wikitable"
|- border="1"
! align="left" |Key(s)
! align="left" |Action bound to key(s)
|-
| style="width:200px; background-color: lightgreen" | <font color="midnightblue"> '''Ctrl+O'''
| align="left" style="background-color: lightgreen"|Load a new scene (clears existing scene)
|-
| style="width:200px; background-color: palegoldenrod"| <font color="midnightblue"> '''Ctrl+A''' 
| align="left" style="background-color: palegoldenrod"|Import a scene (does not clear existing scene) Brings up '''Add Data''' instead
|-
| style="width:200px; background-color: lightgreen" | <font color="midnightblue"> '''Ctrl+W''' 
| align="left" style="background-color: lightgreen"| Close a scene
|-
| style="width:200px; background-color: lightpink" |<font color="midnightblue"> '''Ctrl+H ''' 
| align="left" style="background-color: lightpink"| Set the current module to be the "home" module -- the module that's exposed when Slicer starts up.
|-
| style="width:200px; background-color: lightpink" | <font color="midnightblue"> '''Ctrl+Z ''' 
| align="left" style="background-color: lightpink"| Undo the last undoable action
|-
| style="width:200px; background-color: lightpink" | <font color="midnightblue"> '''Ctrl+Y ''' 
| align="left" style="background-color: lightpink" | Redo the last lightpinkoable action
|-
| style="width:200px; background-color: lightgreen" | <font color="midnightblue"> '''Space-key ''' 
| align="left" style="background-color: lightgreen"| Toggles the display of Slicer's Edit Box.
|-
| style="width:200px; background-color: palegoldenrod" | <font color="midnightblue"> '''Ctrl+P ''' 
| align="left" style="background-color: palegoldenrod"| Display the Python console  '''Displays the QT-real console'''
|-
| style="width:200px" | <font color="midnightblue"> '''Ctrl+L ''' 
| align="left" | Create a new fiducial list.
|-
| style="width:200px" | <font color="midnightblue"> '''Ctrl+I''' 
| align="left" | Toggle between "Persistent Place" and "Transform View" interaction modes.
|-
| style="width:200px" | <font color="midnightblue"> '''Ctrl+M ''' 
| align="left" | Create a new Ruler measurement between the last two placed fiducials.
|}

== Slice Viewer Hot-keys (keyboard accelerators) ==

{| class="wikitable"
|- border="1"
! align="left" |Key(s)
! align="left" |Action bound to key(s)
|-
| style="width:200px" | <font color="midnightblue"> '''` (back-tick key)'''
| align="left" |Navigate to next fiducial in the active Slice Viewer, or in all viewers if they are linked (back-tick is the left single-quote on the key with the tilde (~) character in the upper left side of the keyboard)
|-
| style="width:200px" | <font color="midnightblue"> '''Ctrl+` (back-tick key)''' 
| align="left" |Navigate to next fiducial in all Slice Viewers, independent of their linked state
|-
| style="width:200px" | <font color="midnightblue"> '''Shift+` (back-tick key)''' 
| align="left" | Navigate to the previous fiducial in the active Slice Viewer, or in all viewers if they are linked
|-
| style="width:200px" | <font color="midnightblue"> '''Ctrl+Shift+` (back-tick key)''' 
| align="left" | Navigate to the previous fiducial in all Slice Viewers, independent of their linked state
|-
| style="width:200px" | <font color="midnightblue"> '''p-key''' 
| align="left" | Place a new fiducial in the active Slice Viewer(adds to the current fiducial list, or creates a list if there are none)
|-
| style="width:200px; background-color: lightpink" | <font color="midnightblue"> '''o-key''' 
| align="left" style="background-color: lightpink"| Turn on the Slice Plane reformat widget in the active Slice Viewer
|-
| style="width:200px; background-color: lightgreen" | <font color="midnightblue"> '''v-key''' 
| align="left" style="background-color: lightgreen" | Toggles the slice plane visibility in the main 3D Viewer
|-
| style="width:200px; background-color: lightgreen" | <span style="background-color: lightgreen"><font color="midnightblue"> '''r-key''' 
| align="left" style="background-color: lightgreen"| Fits the slice view to the volume extents in the active Slice Viewer, or in all viewers if they are linked (the first non-none volume will be used in order of Background, Foreground and Label layers)
|-
| style="width:200px; background-color: lightgreen" | <font color="midnightblue"> '''b-key''' 
| align="left" style="background-color: lightgreen"| Decrement slice in the active Slice Viewer (left or down) by one unit of background pixel spacing
|-
| style="width:200px; background-color: lightgreen" | <font color="midnightblue"> '''f-key''' 
| align="left" style="background-color: lightgreen"| Increment slice in the active Slice Viewer (right or up) by one unit of backgroun dpixel spacing
|-
| style="width:200px" | <font color="midnightblue"> '''Backspace-key''' 
| align="left" | When the mouse is hovering over a fiducial in the Slice Viewer (turning it yellow), delete that fiducial
|-
| style="width:200px" | <font color="midnightblue"> '''Delete-key''' 
| align="left" | When the mouse is hovering over a fiducial in the Slice Viewer (turning it yellow), delete that fiducial
|}

==Sliders and mouse==
*Every click is 1 step, and 1 step is 1 slice (if there are multiple volumes (Labelmap/Back/Foreground, then its the smallest spacing of the 3 that is used).
*Middle click directly jumps to the mouse.
*Home/End keys go to the beginning/end.

== Global "hot-keys" ==

=== Window Behavior ===

{| border="1" cellpadding="5"
|- style="background:#c2c2c2; color:black" align="eft"
| style="width:20%" | Action
| style="width:15%" | Slicer4 Key
| style="width:15%" | Slicer3 Key
| style="width:40%" | Meaning
|- style="background-color: lightpink"
| Toggle Maximize current window
|
| Control-m
| Make the current Slice or 3D View expand to full view space or return to previous size depending on current state
|-style="background-color: lightgreen"
| Toggle Control Pane View
|
| F5 (KWW default)
| Show or hide the Control Pane depending on state
|}
<br />

=== MRML ===
{| border="1" cellpadding="5"
|- style="background:#c2c2c2; color:black" align="eft"
| style="width:20%" | Action
| style="width:15%" | Slicer4 Key
| style="width:15%" | Slicer3 Key
| style="width:40%" | Meaning

|-style="background-color: lightgreen"
| Open Scene...
|
| Control-O
| Bring up file browser to locate .mrml file
|-style="background-color: lightgreen"
| Save Scene
|
| Control-S
| Save current scene no browser, disabled if no current file. If no current scene, does Save As...
|-
| Save Scene As...
|
| None
| Bring up file browser to locate .mrml file
|-
| Undo
|
| Control-Z
| Revert to last undo point
|-
| Redo
|
| Control-Y
| Revert to last lightpinko point
|-style="background-color: lightgreen"
| Other Menu Items
|
| Alt-<letter>
| Bring up or invoke menu or menu item corresponding to letter
|}

=== Slice Manipulation ===
{| border="1" cellpadding="5"
|- style="background:#c2c2c2; color:black" align="eft"
| style="width:20%" | Action
| style="width:15%" | Slicer4 Key
| style="width:40%" | Meaning
| style="width:15%" | Slicer3 Key
| style="width:10%" | Slicer2 Key
|-style="background-color: lightpink"
| Toggle link
|
| Toggle linking/unlinking all slices.
| l
| None
|-style="background-color: lightgreen"
| Next slice for this slice viewer
|
| Axial: move Superior, Sag: Right, Cor: Anterior 
| Right Arrow and Up Arrow and f
| Right Arrow
|-style="background-color: lightgreen"
| Previous slice for this slice viewer
|
| Axial: move Inferior, Sag: Left, Cor: Posterior
| Left Arrow and Down Arrow and b
| Left Arrow
|-
| Linked Motion
|
| Cause all other slice windows to scroll to RAS point at current cursor location
| Shift Key
| Same
|-style="background-color: lightgreen"
| Toggle Slice Visible
|
| Make the current slice window show as a plane in the 3D view (respects linking)
| v
| None
|-style="background-color: lightpink"
| Toggle Foreground/Background Opacity
|
| Change opacity of foreground overlay (respects linking) (toggles between current foreground opacity and hidden)
| t
| None
|-style="background-color: lightgreen"
| Toggle Label Overlay
|
| Show/Hide Label for this slice (respects linking) (toggles between current label opacity and hidden)
| g
| None
|-style="background-color: lightpink"
| Cycle Orientations
|
| Cycle through focus in Axial/Sagittal/Coronal/3D window
| Tab
| None
|-style="background-color: lightgreen"
| Cycle All Orientations
|
| Cycle through focus in Axial/Sagittal/Coronal/3D window in opposite direction
| Shift-Tab
| None
|-style="background-color: lightgreen"
| Fit to window
|
| Set the field of view to match the full extent of the foreground and background volumes (respects linking)
| r
| None
|-
|}

=== 3D Manipulation ===
{| border="1" cellpadding="5"
|- style="background:#c2c2c2; color:black" align="eft"
| style="width:20%" | Action
| style="width:15%" | Slicer4 Key
| style="width:15%" | Meaning
| style="width:40%" | Slicer3 Key
| style="width:10%" | Slicer2 Key
|-style="background-color: lightgreen"
| Wireframe
|
| change render mode to wireframe
| w
| Same
|-style="background-color: lightgreen"
| Shaded
|
| change render mode to shaded
| s
| Same
|-style="background-color: lightgreen"
| Reset View
|
| Set camera to see all objects
| r
| None
|-
| Toggle Rock Mode
|
| Toggle rock mode
| TBD
| None
|-
| Toggle Spin Mode
|
| Toggle spin mode
| TBD
| None
|}

=== Navigating Application ===

{| border="1" cellpadding="5"
|- style="background:#c2c2c2; color:black" align="eft"
| style="width:20%" | Action
| style="width:15%" | Slicer4 Key
| style="width:15%" | Slicer3 Key
| style="width:40%" | Meaning
|-style="background-color: lightpink"
| Application Menu
|
| Space Bar
| Brings up a popup menu with all the application operations and their key binding information
|-style="background-color: lightpink"
| Module Navigation
|
| Control-<number>
| Jumps to the numbelightpink module (number order is the same as the order of the shortcut icons in the toolbar at the top of the application.
|-style="background-color: lightpink"
| Move through module history
|
| Control-PageUp/PageDown
| Short cuts for the two arrow buttons next to the module popup menu
|-style="background-color: lightpink"
| Search for Module
|
| Control-F
| Starts an incremental search through the module names and descriptions, terminated by Enter to jump to the module. Probably needs a dialog box.
|}

== Module-specific hot-keys ==

=== Fiducials ===

{| border="1" cellpadding="5"
|- style="background:#c2c2c2; color:black" align="eft"
| style="width:20%" | Action
| style="width:15%" | Slicer4 Key
| style="width:40%" | Meaning
| style="width:10%" | Slicer3 Key
| style="width:15%" | Slicer2 Key
|-
| Add Fiducial
|
| Adds fiducial at current pointer position
| p
| Control-p
|-
| Delete Fiducial
|
| Deletes the fiducial picked from current mouse position (ignored if no fiducial is under mouse) in 2D slice window
| backspace or delete key
| Control-d
|-
| Select Fiducial
|
| Selects/Deselects the fiducial under the mouse
| q
| Control-q
|-
|
|
| To align slices with fiducials
| Hold down the Control key while moving the fiducial
|
|-
|
|
| Jump to the slices aligned to the next fiducial in the list
| `
|
|-
|
|
| Jump to the slices aligned to the previous fiducial in the list
| Control-`
|
|-
|
|
| Create a new Measurements Ruler between the last two selected fiducials
| Control-m
|
|}

=== Editor ===

{| border="1" cellpadding="5"
|- style="background:#c2c2c2; color:black" align="eft"
| style="width:20%" | Action
| style="width:15%" | Slicer4 Key
| style="width:15%" | Slicer3 Key
| style="width:40%" | Meaning
|-style="background-color: lightgreen"
| Open Editor Tool Box
|
| Space Bar
| Opens the Editor Tool Box -- normally this is a pop-up window, but you can turn it into a persistent window by clicking the 'pin open' icon
|-style="background-color: lightpink"
| Open Color Selector
|
| c
| Opens an interface for choosing a color
|-style="background-color: lightgreen"
| Move to Next Slice
|
| f
| Displays the next slicelightgreen
|-style="background-color: lightgreen"
| Move to Previous Slice
|
| b
| Displays the previous slice
|-style="background-color: lightpink"
| Color toggle to black
|
| d
| Use this while painting or drawing to quickly erase the label just specified
|-style="background-color: lightpink"
| Apply outline
|
| a
| Applies the current outline in Draw Effect
|-style="background-color: lightgreen"
| Delete last point in Draw Effect
|
| x
| Deletes the last point in Draw Effect
|-
| Fiducial cycle forward
|
| `
| Cycles through fiducials in a fiducial list (this is the backtick key, usually between tab and escape).
|-
| Fiducial cycle backward
|
| Control-`
| Cycles in reverse direction through a fiducial list.
|-
|}

== Platform-specific hot-keys ==

{| border="1" cellpadding="5"
|- style="background:#c2c2c2; color:black" align="eft"
| style="width:20%" | Action
| style="width:15%" | Slicer4 Key
| style="width:15%" | Slicer3 Key
| style="width:40%" | Meaning
|-
| Middle-mouse equivalent
|
| shift + left click on the track pad
| running either os X or windows in bootcamp on a macbook pro
|}

<!-- ---------------------------- -->
{{documentation/{{documentation/version}}/slicerapplication-footer}}
<!-- ---------------------------- -->