Mouse Actions: Double-Click, Dragging, and Keycodes

set, and the cursor is positioned within 'scrolloff' lines from the window border, the text is scrolled. A selection can be started by pressing the left mouse button on the first character, moving the mouse to the last character, then releasing the mouse button. You will not always see the selection until you release the button, only in some versions (GUI, Win32) will the dragging be shown immediately. Note that you can make the text scroll by moving the mouse at least one character in the first/last line in the window when 'scrolloff' is non-zero. In Normal, Visual and Select mode clicking the right mouse button causes the Visual area to be extended. When 'mousemodel' is "popup", the left button has to be used while keeping the shift key pressed. When clicking in a window which is editing another buffer, the Visual or Select mode is stopped. In Normal, Visual and Select mode clicking the right mouse button with the alt key pressed causes the Visual area to become blockwise. When 'mousemodel' is "popup" the left button has to be used with the alt key. Note that this won't work on systems where the window manager consumes the mouse events when the alt key is pressed (it may move the window). *double-click* *<2-LeftMouse>* *<3-LeftMouse>* *<4-LeftMouse>* Double, triple and quadruple clicks are supported. For selecting text, extra clicks extend the selection: > click select --------------------------------- double word or % match triple line quadruple rectangular block Exception: In a :help window, double-click jumps to help for the word that is clicked on. Double-click on a word selects that word. 'iskeyword' is used to specify which characters are included in a word. Double-click on a character that has a match selects until that match (like using "v%"). If the match is an #if/#else/#endif block, the selection becomes linewise. The time for double-clicking can be set with the 'mousetime' option. Example: configure double-click to jump to the tag under the cursor: >vim :map <2-LeftMouse> :exe "tag " .. expand("<cword>")<CR> Dragging the mouse with a double-click (button-down, button-up, button-down and then drag) will result in whole words to be selected. This continues until the button is released, at which point the selection is per character again. For scrolling with the mouse see |scroll-mouse-wheel|. In Insert mode, when a selection is started, Vim goes into Normal mode temporarily. When Visual or Select mode ends, it returns to Insert mode. This is like using CTRL-O in Insert mode. Select mode is used when the 'selectmode' option contains "mouse". *X1Mouse* *X1Drag* *X1Release* *X2Mouse* *X2Drag* *X2Release* *<MiddleRelease>* *<MiddleDrag>* Mouse clicks can be mapped using these |keycodes|: > code mouse button normal action --------------------------------------------------------------------------- <LeftMouse> left pressed set cursor position <LeftDrag> left moved while pressed extend selection <LeftRelease> left released set selection end <MiddleMouse> middle pressed paste text at cursor position <MiddleDrag> middle moved while pressed - <MiddleRelease> middle released - <RightMouse> right pressed extend selection <RightDrag> right moved while pressed extend selection <RightRelease> right released set selection end <X1Mouse> X1 button pressed - <X1Drag> X1 moved while pressed - <X1Release> X1 button release - <X2Mouse> X2 button pressed - <X2Drag> X2 moved while pressed - <X2Release> X2 button release - The X1 and X2 buttons

This section describes how to use mouse double-clicks to select words, lines, or rectangular blocks. It also explains how dragging the mouse after a double-click selects whole words and how to configure a double-click to jump to a tag. It describes the mouse actions in insert mode and how Vim uses Normal mode temporarily when a selection is started, before returning to insert mode. Also, it lists keycodes for mapping mouse clicks, drags, and releases for left, middle, and right mouse buttons, along with X1 and X2 buttons, specifying their normal actions in Vim.