Mercurial > vim
annotate runtime/doc/gui.txt @ 13431:19f9b74a424e v8.0.1590
patch 8.0.1590: padding in list type wastes memory
commit https://github.com/vim/vim/commit/1a840240376f2858d489736f9eed6d2975225fdf
Author: Bram Moolenaar <Bram@vim.org>
Date: Thu Mar 8 21:46:43 2018 +0100
patch 8.0.1590: padding in list type wastes memory
Problem: Padding in list type wastes memory.
Solution: Reorder struct members to optimize padding. (Dominique Pelle,
closes #2704)
| author | Christian Brabandt <cb@256bit.org> |
|---|---|
| date | Thu, 08 Mar 2018 22:00:05 +0100 |
| parents | 6687b321fb91 |
| children | 02b3f719eacb |
| rev | line source |
|---|---|
|
12804
6687b321fb91
patch 8.0.1279: initializing menus can be slow
Christian Brabandt <cb@256bit.org>
parents:
12785
diff
changeset
|
1 *gui.txt* For Vim version 8.0. Last change: 2017 Nov 09 |
| 7 | 2 |
| 3 | |
| 4 VIM REFERENCE MANUAL by Bram Moolenaar | |
| 5 | |
| 6 | |
| 7 Vim's Graphical User Interface *gui* *GUI* | |
| 8 | |
| 9 1. Starting the GUI |gui-start| | |
| 10 2. Scrollbars |gui-scrollbars| | |
| 11 3. Mouse Control |gui-mouse| | |
| 12 4. Making GUI Selections |gui-selections| | |
| 13 5. Menus |menus| | |
| 14 6. Extras |gui-extras| | |
| 15 7. Shell Commands |gui-shell| | |
| 16 | |
| 17 Other GUI documentation: | |
| 18 |gui_x11.txt| For specific items of the X11 GUI. | |
| 19 |gui_w32.txt| For specific items of the Win32 GUI. | |
| 20 | |
| 21 {Vi does not have any of these commands} | |
| 22 | |
| 23 ============================================================================== | |
| 24 1. Starting the GUI *gui-start* *E229* *E233* | |
| 25 | |
| 26 First you must make sure you actually have a version of Vim with the GUI code | |
| 694 | 27 included. You can check this with the ":version" command, it says "with xxx |
|
8218
3456e2ebebd4
commit https://github.com/vim/vim/commit/9892189d2e7ab94b750f99e6da4cbfc3c8014517
Christian Brabandt <cb@256bit.org>
parents:
5697
diff
changeset
|
28 GUI", where "xxx" is X11-Motif, X11-Athena, Photon, GTK2, GTK3, etc., or |
| 694 | 29 "MS-Windows 32 bit GUI version". |
| 7 | 30 |
| 31 How to start the GUI depends on the system used. Mostly you can run the | |
| 32 GUI version of Vim with: | |
| 33 gvim [options] [files...] | |
| 34 | |
| 35 The X11 version of Vim can run both in GUI and in non-GUI mode. See | |
| 36 |gui-x11-start|. | |
| 37 | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
38 *gui-init* *gvimrc* *.gvimrc* *_gvimrc* *$MYGVIMRC* |
| 819 | 39 The gvimrc file is where GUI-specific startup commands should be placed. It |
| 40 is always sourced after the |vimrc| file. If you have one then the $MYGVIMRC | |
| 41 environment variable has its name. | |
| 42 | |
| 7 | 43 When the GUI starts up initializations are carried out, in this order: |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
44 - The 'term' option is set to "builtin_gui" and terminal options are reset to |
| 667 | 45 their default value for the GUI |terminal-options|. |
| 7 | 46 - If the system menu file exists, it is sourced. The name of this file is |
| 47 normally "$VIMRUNTIME/menu.vim". You can check this with ":version". Also | |
| 48 see |$VIMRUNTIME|. To skip loading the system menu include 'M' in | |
| 49 'guioptions'. *buffers-menu* *no_buffers_menu* | |
| 50 The system menu file includes a "Buffers" menu. If you don't want this, set | |
| 51 the "no_buffers_menu" variable in your .vimrc (not .gvimrc!): > | |
| 52 :let no_buffers_menu = 1 | |
| 53 < NOTE: Switching on syntax highlighting also loads the menu file, thus | |
| 54 disabling the Buffers menu must be done before ":syntax on". | |
| 55 The path names are truncated to 35 characters. You can truncate them at a | |
| 56 different length, for example 50, like this: > | |
| 57 :let bmenu_max_pathlen = 50 | |
| 58 - If the "-U {gvimrc}" command-line option has been used when starting Vim, | |
| 59 the {gvimrc} file will be read for initializations. The following | |
| 42 | 60 initializations are skipped. When {gvimrc} is "NONE" no file will be read |
| 61 for initializations. | |
| 7 | 62 - For Unix and MS-Windows, if the system gvimrc exists, it is sourced. The |
| 63 name of this file is normally "$VIM/gvimrc". You can check this with | |
| 64 ":version". Also see |$VIM|. | |
| 65 - The following are tried, and only the first one that exists is used: | |
| 66 - If the GVIMINIT environment variable exists and is not empty, it is | |
| 67 executed as an Ex command. | |
| 68 - If the user gvimrc file exists, it is sourced. The name of this file is | |
| 69 normally "$HOME/.gvimrc". You can check this with ":version". | |
| 12254 | 70 - For Win32, $HOME is set by Vim if needed, see |$HOME-windows|. |
| 7 | 71 - When a "_gvimrc" file is not found, ".gvimrc" is tried too. And vice |
| 72 versa. | |
| 819 | 73 The name of the first file found is stored in $MYGVIMRC, unless it was |
| 74 already set. | |
| 7 | 75 - If the 'exrc' option is set (which is NOT the default) the file ./.gvimrc |
| 76 is sourced, if it exists and isn't the same file as the system or user | |
| 77 gvimrc file. If this file is not owned by you, some security restrictions | |
| 78 apply. When ".gvimrc" is not found, "_gvimrc" is tried too. For Macintosh | |
| 79 and DOS/Win32 "_gvimrc" is tried first. | |
| 80 | |
| 81 NOTE: All but the first one are not carried out if Vim was started with | |
|
11763
21f3930dfe6e
Documentation updates.
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
82 "-u NONE" or "-u DEFAULTS" and no "-U" argument was given, or when started |
|
21f3930dfe6e
Documentation updates.
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
83 with "-U NONE". |
| 7 | 84 |
| 85 All this happens AFTER the normal Vim initializations, like reading your | |
| 86 .vimrc file. See |initialization|. | |
| 87 But the GUI window is only opened after all the initializations have been | |
| 88 carried out. If you want some commands to be executed just after opening the | |
| 89 GUI window, use the |GUIEnter| autocommand event. Example: > | |
| 465 | 90 :autocmd GUIEnter * winpos 100 50 |
| 7 | 91 |
| 92 You can use the gvimrc files to set up your own customized menus (see |:menu|) | |
| 93 and initialize other things that you may want to set up differently from the | |
| 94 terminal version. | |
| 95 | |
| 96 Recommended place for your personal GUI initializations: | |
|
4863
c4d4f0fc12b9
updated for version 7.3.1178
Bram Moolenaar <bram@vim.org>
parents:
3082
diff
changeset
|
97 Unix $HOME/.gvimrc or $HOME/.vim/gvimrc |
|
c4d4f0fc12b9
updated for version 7.3.1178
Bram Moolenaar <bram@vim.org>
parents:
3082
diff
changeset
|
98 OS/2 $HOME/.gvimrc, $HOME/vimfiles/gvimrc |
|
c4d4f0fc12b9
updated for version 7.3.1178
Bram Moolenaar <bram@vim.org>
parents:
3082
diff
changeset
|
99 or $VIM/.gvimrc |
|
c4d4f0fc12b9
updated for version 7.3.1178
Bram Moolenaar <bram@vim.org>
parents:
3082
diff
changeset
|
100 MS-DOS and Win32 $HOME/_gvimrc, $HOME/vimfiles/gvimrc |
|
c4d4f0fc12b9
updated for version 7.3.1178
Bram Moolenaar <bram@vim.org>
parents:
3082
diff
changeset
|
101 or $VIM/_gvimrc |
|
c4d4f0fc12b9
updated for version 7.3.1178
Bram Moolenaar <bram@vim.org>
parents:
3082
diff
changeset
|
102 Amiga s:.gvimrc, home:.gvimrc, home:vimfiles:gvimrc |
|
c4d4f0fc12b9
updated for version 7.3.1178
Bram Moolenaar <bram@vim.org>
parents:
3082
diff
changeset
|
103 or $VIM/.gvimrc |
|
c4d4f0fc12b9
updated for version 7.3.1178
Bram Moolenaar <bram@vim.org>
parents:
3082
diff
changeset
|
104 |
|
c4d4f0fc12b9
updated for version 7.3.1178
Bram Moolenaar <bram@vim.org>
parents:
3082
diff
changeset
|
105 The personal initialization files are searched in the order specified above |
|
c4d4f0fc12b9
updated for version 7.3.1178
Bram Moolenaar <bram@vim.org>
parents:
3082
diff
changeset
|
106 and only the first one that is found is read. |
| 7 | 107 |
| 108 There are a number of options which only have meaning in the GUI version of | |
| 109 Vim. These are 'guicursor', 'guifont', 'guipty' and 'guioptions'. They are | |
| 110 documented in |options.txt| with all the other options. | |
| 111 | |
| 862 | 112 If using the Motif or Athena version of the GUI (but not for the GTK+ or |
| 11 | 113 Win32 version), a number of X resources are available. See |gui-resources|. |
| 7 | 114 |
| 115 Another way to set the colors for different occasions is with highlight | |
| 116 groups. The "Normal" group is used to set the background and foreground | |
| 117 colors. Example (which looks nice): > | |
| 118 | |
| 119 :highlight Normal guibg=grey90 | |
| 120 | |
| 121 The "guibg" and "guifg" settings override the normal background and | |
| 122 foreground settings. The other settings for the Normal highlight group are | |
| 123 not used. Use the 'guifont' option to set the font. | |
| 124 | |
| 125 Also check out the 'guicursor' option, to set the colors for the cursor in | |
| 126 various modes. | |
| 127 | |
| 128 Vim tries to make the window fit on the screen when it starts up. This avoids | |
| 129 that you can't see part of it. On the X Window System this requires a bit of | |
| 130 guesswork. You can change the height that is used for the window title and a | |
| 131 task bar with the 'guiheadroom' option. | |
| 132 | |
| 133 *:winp* *:winpos* *E188* | |
| 134 :winp[os] | |
| 135 Display current position of the top left corner of the GUI vim | |
| 136 window in pixels. Does not work in all versions. | |
| 5697 | 137 Also see |getwinposx()| and |getwinposy()|. |
| 7 | 138 |
| 139 :winp[os] {X} {Y} *E466* | |
| 140 Put the GUI vim window at the given {X} and {Y} coordinates. | |
| 141 The coordinates should specify the position in pixels of the | |
| 142 top left corner of the window. Does not work in all versions. | |
| 143 Does work in an (new) xterm |xterm-color|. | |
| 144 When the GUI window has not been opened yet, the values are | |
| 145 remembered until the window is opened. The position is | |
| 146 adjusted to make the window fit on the screen (if possible). | |
| 147 | |
| 148 *:win* *:winsize* *E465* | |
| 149 :win[size] {width} {height} | |
| 150 Set the window height to {width} by {height} characters. | |
| 151 Obsolete, use ":set lines=11 columns=22". | |
| 152 If you get less lines than expected, check the 'guiheadroom' | |
| 153 option. | |
| 154 | |
| 155 If you are running the X Window System, you can get information about the | |
| 5697 | 156 window Vim is running in with these commands: > |
| 7 | 157 :!xwininfo -id $WINDOWID |
| 5697 | 158 :!xprop -id $WINDOWID |
| 159 :execute '!xwininfo -id ' . v:windowid | |
| 160 :execute '!xprop -id ' . v:windowid | |
| 3082 | 161 < |
| 162 *gui-IME* *iBus* | |
| 163 Input methods for international characters in X that rely on the XIM | |
| 164 framework, most notably iBus, have been known to produce undesirable results | |
| 12785 | 165 in gvim. These may include an inability to enter spaces, or long delays |
| 3082 | 166 between typing a character and it being recognized by the application. |
| 167 | |
| 168 One workaround that has been successful, for unknown reasons, is to prevent | |
| 169 gvim from forking into the background by starting it with the |-f| argument. | |
| 7 | 170 |
| 171 ============================================================================== | |
| 172 2. Scrollbars *gui-scrollbars* | |
| 173 | |
| 98 | 174 There are vertical scrollbars and a horizontal scrollbar. You may |
| 7 | 175 configure which ones appear with the 'guioptions' option. |
| 176 | |
| 177 The interface looks like this (with ":set guioptions=mlrb"): | |
| 178 | |
| 2642 | 179 +------------------------------+ ` |
| 180 | File Edit Help | <- Menu bar (m) ` | |
| 181 +-+--------------------------+-+ ` | |
| 182 |^| |^| ` | |
| 183 |#| Text area. |#| ` | |
| 184 | | | | ` | |
| 185 |v|__________________________|v| ` | |
| 186 Normal status line -> |-+ File.c 5,2 +-| ` | |
| 187 between Vim windows |^|""""""""""""""""""""""""""|^| ` | |
| 188 | | | | ` | |
| 189 | | Another file buffer. | | ` | |
| 190 | | | | ` | |
| 191 |#| |#| ` | |
| 192 Left scrollbar (l) -> |#| |#| <- Right ` | |
| 193 |#| |#| scrollbar (r) ` | |
| 194 | | | | ` | |
| 195 |v| |v| ` | |
| 196 +-+--------------------------+-+ ` | |
| 197 | |< #### >| | <- Bottom ` | |
| 198 +-+--------------------------+-+ scrollbar (b) ` | |
| 7 | 199 |
| 200 Any of the scrollbar or menu components may be turned off by not putting the | |
| 201 appropriate letter in the 'guioptions' string. The bottom scrollbar is | |
| 202 only useful when 'nowrap' is set. | |
| 203 | |
| 204 | |
| 205 VERTICAL SCROLLBARS *gui-vert-scroll* | |
| 206 | |
| 207 Each Vim window has a scrollbar next to it which may be scrolled up and down | |
| 208 to move through the text in that buffer. The size of the scrollbar-thumb | |
| 209 indicates the fraction of the buffer which can be seen in the window. | |
| 210 When the scrollbar is dragged all the way down, the last line of the file | |
| 211 will appear in the top of the window. | |
| 212 | |
| 213 If a window is shrunk to zero height (by the growth of another window) its | |
| 236 | 214 scrollbar disappears. It reappears when the window is restored. |
| 7 | 215 |
| 216 If a window is vertically split, it will get a scrollbar when it is the | |
| 217 current window and when, taking the middle of the current window and drawing a | |
| 218 vertical line, this line goes through the window. | |
| 219 When there are scrollbars on both sides, and the middle of the current window | |
| 220 is on the left half, the right scrollbar column will contain scrollbars for | |
| 221 the rightmost windows. The same happens on the other side. | |
| 222 | |
| 223 | |
| 224 HORIZONTAL SCROLLBARS *gui-horiz-scroll* | |
| 225 | |
| 226 The horizontal scrollbar (at the bottom of the Vim GUI) may be used to | |
| 227 scroll text sideways when the 'wrap' option is turned off. The | |
| 228 scrollbar-thumb size is such that the text of the longest visible line may be | |
| 229 scrolled as far as possible left and right. The cursor is moved when | |
| 230 necessary, it must remain on a visible character (unless 'virtualedit' is | |
| 231 set). | |
| 232 | |
| 98 | 233 Computing the length of the longest visible line takes quite a bit of |
| 234 computation, and it has to be done every time something changes. If this | |
| 235 takes too much time or you don't like the cursor jumping to another line, | |
| 236 include the 'h' flag in 'guioptions'. Then the scrolling is limited by the | |
| 237 text of the current cursor line. | |
| 7 | 238 |
| 239 *athena-intellimouse* | |
| 240 If you have an Intellimouse and an X server that supports using the wheel, | |
| 241 then you can use the wheel to scroll the text up and down in gvim. This works | |
| 242 with XFree86 4.0 and later, and with some older versions when you add patches. | |
| 243 See |scroll-mouse-wheel|. | |
| 244 | |
| 245 For older versions of XFree86 you must patch your X server. The following | |
| 246 page has a bit of information about using the Intellimouse on Linux as well as | |
| 247 links to the patches and X server binaries (may not have the one you need | |
| 248 though): | |
| 249 http://www.inria.fr/koala/colas/mouse-wheel-scroll/ | |
| 250 | |
| 251 ============================================================================== | |
| 252 3. Mouse Control *gui-mouse* | |
| 253 | |
| 254 The mouse only works if the appropriate flag in the 'mouse' option is set. | |
| 255 When the GUI is switched on, and 'mouse' wasn't set yet, the 'mouse' option is | |
| 256 automatically set to "a", enabling it for all modes except for the | |
| 257 |hit-enter| prompt. If you don't want this, a good place to change the | |
| 258 'mouse' option is the "gvimrc" file. | |
| 259 | |
| 260 Other options that are relevant: | |
| 261 'mousefocus' window focus follows mouse pointer |gui-mouse-focus| | |
| 262 'mousemodel' what mouse button does which action | |
| 263 'mousehide' hide mouse pointer while typing text | |
| 264 'selectmode' whether to start Select mode or Visual mode | |
| 265 | |
| 266 A quick way to set these is with the ":behave" command. | |
| 267 *:behave* *:be* | |
| 268 :be[have] {model} Set behavior for mouse and selection. Valid | |
| 269 arguments are: | |
| 270 mswin MS-Windows behavior | |
| 271 xterm Xterm behavior | |
| 272 | |
| 273 Using ":behave" changes these options: | |
| 274 option mswin xterm ~ | |
| 275 'selectmode' "mouse,key" "" | |
| 276 'mousemodel' "popup" "extend" | |
| 277 'keymodel' "startsel,stopsel" "" | |
| 278 'selection' "exclusive" "inclusive" | |
| 279 | |
| 280 In the $VIMRUNTIME directory, there is a script called |mswin.vim|, which will | |
| 281 also map a few keys to the MS-Windows cut/copy/paste commands. This is NOT | |
| 282 compatible, since it uses the CTRL-V, CTRL-X and CTRL-C keys. If you don't | |
| 283 mind, use this command: > | |
| 284 :so $VIMRUNTIME/mswin.vim | |
| 285 | |
| 286 For scrolling with a wheel on a mouse, see |scroll-mouse-wheel|. | |
| 287 | |
| 288 | |
| 289 3.1 Moving Cursor with Mouse *gui-mouse-move* | |
| 290 | |
| 291 Click the left mouse button somewhere in a text buffer where you want the | |
| 292 cursor to go, and it does! | |
| 293 This works in when 'mouse' contains ~ | |
| 294 Normal mode 'n' or 'a' | |
| 295 Visual mode 'v' or 'a' | |
| 296 Insert mode 'i' or 'a' | |
| 297 | |
| 298 Select mode is handled like Visual mode. | |
| 299 | |
| 300 You may use this with an operator such as 'd' to delete text from the current | |
| 301 cursor position to the position you point to with the mouse. That is, you hit | |
| 302 'd' and then click the mouse somewhere. | |
| 303 | |
| 304 *gui-mouse-focus* | |
| 305 The 'mousefocus' option can be set to make the keyboard focus follow the | |
| 306 mouse pointer. This means that the window where the mouse pointer is, is the | |
| 307 active window. Warning: this doesn't work very well when using a menu, | |
| 308 because the menu command will always be applied to the top window. | |
| 309 | |
| 310 If you are on the ':' line (or '/' or '?'), then clicking the left or right | |
| 311 mouse button will position the cursor on the ':' line (if 'mouse' contains | |
| 312 'c', 'a' or 'A'). | |
| 313 | |
| 314 In any situation the middle mouse button may be clicked to paste the current | |
| 315 selection. | |
| 316 | |
| 317 | |
| 318 3.2 Selection with Mouse *gui-mouse-select* | |
| 319 | |
| 320 The mouse can be used to start a selection. How depends on the 'mousemodel' | |
| 321 option: | |
| 322 'mousemodel' is "extend": use the right mouse button | |
| 323 'mousemodel' is "popup": use the left mouse button, while keeping the Shift | |
| 324 key pressed. | |
| 325 | |
| 326 If there was no selection yet, this starts a selection from the old cursor | |
| 327 position to the position pointed to with the mouse. If there already is a | |
| 328 selection then the closest end will be extended. | |
| 329 | |
| 330 If 'selectmode' contains "mouse", then the selection will be in Select mode. | |
| 331 This means that typing normal text will replace the selection. See | |
| 332 |Select-mode|. Otherwise, the selection will be in Visual mode. | |
| 333 | |
| 334 Double clicking may be done to make the selection word-wise, triple clicking | |
| 335 makes it line-wise, and quadruple clicking makes it rectangular block-wise. | |
| 336 | |
| 337 See |gui-selections| on how the selection is used. | |
| 338 | |
| 339 | |
| 340 3.3 Other Text Selection with Mouse *gui-mouse-modeless* | |
| 341 *modeless-selection* | |
| 342 A different kind of selection is used when: | |
| 343 - in Command-line mode | |
| 344 - in the Command-line window and pointing in another window | |
| 345 - at the |hit-enter| prompt | |
| 346 - whenever the current mode is not in the 'mouse' option | |
| 347 - when holding the CTRL and SHIFT keys in the GUI | |
| 1619 | 348 |
| 7 | 349 Since Vim continues like the selection isn't there, and there is no mode |
| 350 associated with the selection, this is called modeless selection. Any text in | |
| 351 the Vim window can be selected. Select the text by pressing the left mouse | |
| 352 button at the start, drag to the end and release. To extend the selection, | |
| 353 use the right mouse button when 'mousemodel' is "extend", or the left mouse | |
| 354 button with the shift key pressed when 'mousemodel' is "popup". | |
| 355 The selection is removed when the selected text is scrolled or changed. | |
| 1619 | 356 |
| 7 | 357 On the command line CTRL-Y can be used to copy the selection into the |
| 1619 | 358 clipboard. To do this from Insert mode, use CTRL-O : CTRL-Y <CR>. When |
| 359 'guioptions' contains a or A (default on X11), the selection is automatically | |
| 360 copied to the "* register. | |
| 361 | |
| 362 The middle mouse button can then paste the text. On non-X11 systems, you can | |
| 363 use CTRL-R +. | |
| 7 | 364 |
| 365 | |
| 366 3.4 Using Mouse on Status Lines *gui-mouse-status* | |
| 367 | |
| 368 Clicking the left or right mouse button on the status line below a Vim | |
| 369 window makes that window the current window. This actually happens on button | |
| 370 release (to be able to distinguish a click from a drag action). | |
| 371 | |
| 372 With the left mouse button a status line can be dragged up and down, thus | |
| 373 resizing the windows above and below it. This does not change window focus. | |
| 374 | |
| 375 The same can be used on the vertical separator: click to give the window left | |
| 376 of it focus, drag left and right to make windows wider and narrower. | |
| 377 | |
| 378 | |
| 379 3.5 Various Mouse Clicks *gui-mouse-various* | |
| 380 | |
| 381 <S-LeftMouse> Search forward for the word under the mouse click. | |
| 382 When 'mousemodel' is "popup" this starts or extends a | |
| 383 selection. | |
| 384 <S-RightMouse> Search backward for the word under the mouse click. | |
| 385 <C-LeftMouse> Jump to the tag name under the mouse click. | |
| 386 <C-RightMouse> Jump back to position before the previous tag jump | |
| 387 (same as "CTRL-T") | |
| 388 | |
| 389 | |
| 390 3.6 Mouse Mappings *gui-mouse-mapping* | |
| 391 | |
| 392 The mouse events, complete with modifiers, may be mapped. Eg: > | |
| 393 :map <S-LeftMouse> <RightMouse> | |
| 394 :map <S-LeftDrag> <RightDrag> | |
| 395 :map <S-LeftRelease> <RightRelease> | |
| 396 :map <2-S-LeftMouse> <2-RightMouse> | |
| 397 :map <2-S-LeftDrag> <2-RightDrag> | |
| 398 :map <2-S-LeftRelease> <2-RightRelease> | |
| 399 :map <3-S-LeftMouse> <3-RightMouse> | |
| 400 :map <3-S-LeftDrag> <3-RightDrag> | |
| 401 :map <3-S-LeftRelease> <3-RightRelease> | |
| 402 :map <4-S-LeftMouse> <4-RightMouse> | |
| 403 :map <4-S-LeftDrag> <4-RightDrag> | |
| 404 :map <4-S-LeftRelease> <4-RightRelease> | |
| 405 These mappings make selection work the way it probably should in a Motif | |
| 406 application, with shift-left mouse allowing for extending the visual area | |
| 407 rather than the right mouse button. | |
| 408 | |
| 409 Mouse mapping with modifiers does not work for modeless selection. | |
| 410 | |
| 411 | |
| 412 3.7 Drag and drop *drag-n-drop* | |
| 413 | |
| 414 You can drag and drop one or more files into the Vim window, where they will | |
| 415 be opened as if a |:drop| command was used. | |
| 416 | |
| 417 If you hold down Shift while doing this, Vim changes to the first dropped | |
| 418 file's directory. If you hold Ctrl Vim will always split a new window for the | |
| 419 file. Otherwise it's only done if the current buffer has been changed. | |
| 420 | |
| 421 You can also drop a directory on Vim. This starts the explorer plugin for | |
| 422 that directory (assuming it was enabled, otherwise you'll get an error | |
| 423 message). Keep Shift pressed to change to the directory instead. | |
| 424 | |
| 425 If Vim happens to be editing a command line, the names of the dropped files | |
| 426 and directories will be inserted at the cursor. This allows you to use these | |
| 427 names with any Ex command. Special characters (space, tab, double quote and | |
| 428 '|'; backslash on non-MS-Windows systems) will be escaped. | |
| 429 | |
| 430 ============================================================================== | |
| 431 4. Making GUI Selections *gui-selections* | |
| 432 | |
| 433 *quotestar* | |
| 434 You may make selections with the mouse (see |gui-mouse-select|), or by using | |
| 435 Vim's Visual mode (see |v|). If 'a' is present in 'guioptions', then | |
| 436 whenever a selection is started (Visual or Select mode), or when the selection | |
| 437 is changed, Vim becomes the owner of the windowing system's primary selection | |
| 438 (on MS-Windows the |gui-clipboard| is used; under X11, the |x11-selection| is | |
| 439 used - you should read whichever of these is appropriate now). | |
| 440 | |
| 441 *clipboard* | |
| 442 There is a special register for storing this selection, it is the "* | |
| 443 register. Nothing is put in here unless the information about what text is | |
| 236 | 444 selected is about to change (e.g. with a left mouse click somewhere), or when |
| 7 | 445 another application wants to paste the selected text. Then the text is put |
| 446 in the "* register. For example, to cut a line and make it the current | |
| 447 selection/put it on the clipboard: > | |
| 448 | |
| 449 "*dd | |
| 450 | |
| 451 Similarly, when you want to paste a selection from another application, e.g., | |
| 452 by clicking the middle mouse button, the selection is put in the "* register | |
| 453 first, and then 'put' like any other register. For example, to put the | |
| 454 selection (contents of the clipboard): > | |
| 455 | |
| 456 "*p | |
| 457 | |
| 458 When using this register under X11, also see |x11-selection|. This also | |
| 459 explains the related "+ register. | |
| 460 | |
| 461 Note that when pasting text from one Vim into another separate Vim, the type | |
| 462 of selection (character, line, or block) will also be copied. For other | |
| 463 applications the type is always character. However, if the text gets | |
| 464 transferred via the |x11-cut-buffer|, the selection type is ALWAYS lost. | |
| 465 | |
| 466 When the "unnamed" string is included in the 'clipboard' option, the unnamed | |
| 467 register is the same as the "* register. Thus you can yank to and paste the | |
| 468 selection without prepending "* to commands. | |
| 469 | |
| 470 ============================================================================== | |
| 471 5. Menus *menus* | |
| 472 | |
| 473 For an introduction see |usr_42.txt| in the user manual. | |
| 474 | |
| 475 | |
| 476 5.1 Using Menus *using-menus* | |
| 477 | |
| 478 Basically, menus can be used just like mappings. You can define your own | |
| 479 menus, as many as you like. | |
| 480 Long-time Vim users won't use menus much. But the power is in adding your own | |
| 481 menus and menu items. They are most useful for things that you can't remember | |
| 482 what the key sequence was. | |
| 483 | |
| 484 For creating menus in a different language, see |:menutrans|. | |
|
12756
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
485 If you don't want to use menus at all, see |'go-M'|. |
| 7 | 486 |
| 487 *menu.vim* | |
| 488 The default menus are read from the file "$VIMRUNTIME/menu.vim". See | |
| 489 |$VIMRUNTIME| for where the path comes from. You can set up your own menus. | |
| 490 Starting off with the default set is a good idea. You can add more items, or, | |
| 491 if you don't like the defaults at all, start with removing all menus | |
| 492 |:unmenu-all|. You can also avoid the default menus being loaded by adding | |
| 493 this line to your .vimrc file (NOT your .gvimrc file!): > | |
| 494 :let did_install_default_menus = 1 | |
| 495 If you also want to avoid the Syntax menu: > | |
| 496 :let did_install_syntax_menu = 1 | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
497 The first item in the Syntax menu can be used to show all available filetypes |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
498 in the menu (which can take a bit of time to load). If you want to have all |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
499 filetypes already present at startup, add: > |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
500 :let do_syntax_sel_menu = 1 |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
501 |
|
12804
6687b321fb91
patch 8.0.1279: initializing menus can be slow
Christian Brabandt <cb@256bit.org>
parents:
12785
diff
changeset
|
502 The following menuitems show all available color schemes, keymaps and compiler |
|
6687b321fb91
patch 8.0.1279: initializing menus can be slow
Christian Brabandt <cb@256bit.org>
parents:
12785
diff
changeset
|
503 settings: |
|
6687b321fb91
patch 8.0.1279: initializing menus can be slow
Christian Brabandt <cb@256bit.org>
parents:
12785
diff
changeset
|
504 Edit > Color Scheme ~ |
|
6687b321fb91
patch 8.0.1279: initializing menus can be slow
Christian Brabandt <cb@256bit.org>
parents:
12785
diff
changeset
|
505 Edit > Keymap ~ |
|
6687b321fb91
patch 8.0.1279: initializing menus can be slow
Christian Brabandt <cb@256bit.org>
parents:
12785
diff
changeset
|
506 Tools > Set Compiler ~ |
|
6687b321fb91
patch 8.0.1279: initializing menus can be slow
Christian Brabandt <cb@256bit.org>
parents:
12785
diff
changeset
|
507 However, they can also take a bit of time to load, because they search all |
|
6687b321fb91
patch 8.0.1279: initializing menus can be slow
Christian Brabandt <cb@256bit.org>
parents:
12785
diff
changeset
|
508 related files from the directories in 'runtimepath'. Therefore they are |
|
6687b321fb91
patch 8.0.1279: initializing menus can be slow
Christian Brabandt <cb@256bit.org>
parents:
12785
diff
changeset
|
509 loaded lazily (by the |CursorHold| event), or you can also load them manually. |
|
6687b321fb91
patch 8.0.1279: initializing menus can be slow
Christian Brabandt <cb@256bit.org>
parents:
12785
diff
changeset
|
510 If you want to have all these items already present at startup, add: > |
|
6687b321fb91
patch 8.0.1279: initializing menus can be slow
Christian Brabandt <cb@256bit.org>
parents:
12785
diff
changeset
|
511 :let do_no_lazyload_menus = 1 |
|
6687b321fb91
patch 8.0.1279: initializing menus can be slow
Christian Brabandt <cb@256bit.org>
parents:
12785
diff
changeset
|
512 |
|
12756
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
513 Note that the menu.vim is sourced when `:syntax on` or `:filetype on` is |
|
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
514 executed or after your .vimrc file is sourced. This means that the 'encoding' |
|
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
515 option and the language of messages (`:language messages`) must be set before |
|
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
516 that (if you want to change them). |
|
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
517 |
| 7 | 518 *console-menus* |
| 519 Although this documentation is in the GUI section, you can actually use menus | |
| 520 in console mode too. You will have to load |menu.vim| explicitly then, it is | |
| 521 not done by default. You can use the |:emenu| command and command-line | |
| 522 completion with 'wildmenu' to access the menu entries almost like a real menu | |
| 523 system. To do this, put these commands in your .vimrc file: > | |
| 524 :source $VIMRUNTIME/menu.vim | |
| 525 :set wildmenu | |
| 526 :set cpo-=< | |
| 527 :set wcm=<C-Z> | |
| 528 :map <F4> :emenu <C-Z> | |
| 529 Pressing <F4> will start the menu. You can now use the cursor keys to select | |
| 530 a menu entry. Hit <Enter> to execute it. Hit <Esc> if you want to cancel. | |
| 531 This does require the |+menu| feature enabled at compile time. | |
| 532 | |
| 533 *tear-off-menus* | |
|
8218
3456e2ebebd4
commit https://github.com/vim/vim/commit/9892189d2e7ab94b750f99e6da4cbfc3c8014517
Christian Brabandt <cb@256bit.org>
parents:
5697
diff
changeset
|
534 GTK+ 2 and Motif support Tear-off menus. These are sort of sticky menus or |
| 7 | 535 pop-up menus that are present all the time. If the resizing does not work |
| 536 correctly, this may be caused by using something like "Vim*geometry" in the | |
| 537 defaults. Use "Vim.geometry" instead. | |
| 538 | |
|
8218
3456e2ebebd4
commit https://github.com/vim/vim/commit/9892189d2e7ab94b750f99e6da4cbfc3c8014517
Christian Brabandt <cb@256bit.org>
parents:
5697
diff
changeset
|
539 As to GTK+ 3, tear-off menus have been deprecated since GTK+ 3.4. |
|
3456e2ebebd4
commit https://github.com/vim/vim/commit/9892189d2e7ab94b750f99e6da4cbfc3c8014517
Christian Brabandt <cb@256bit.org>
parents:
5697
diff
changeset
|
540 Accordingly, they are disabled if gvim is linked against GTK+ 3.4 or later. |
|
3456e2ebebd4
commit https://github.com/vim/vim/commit/9892189d2e7ab94b750f99e6da4cbfc3c8014517
Christian Brabandt <cb@256bit.org>
parents:
5697
diff
changeset
|
541 |
| 7 | 542 The Win32 GUI version emulates Motif's tear-off menus. Actually, a Motif user |
| 543 will spot the differences easily, but hopefully they're just as useful. You | |
| 544 can also use the |:tearoff| command together with |hidden-menus| to create | |
| 545 floating menus that do not appear on the main menu bar. | |
| 546 | |
| 547 | |
| 548 5.2 Creating New Menus *creating-menus* | |
| 549 | |
| 550 *:me* *:menu* *:noreme* *:noremenu* | |
| 551 *:am* *:amenu* *:an* *:anoremenu* | |
| 552 *:nme* *:nmenu* *:nnoreme* *:nnoremenu* | |
| 553 *:ome* *:omenu* *:onoreme* *:onoremenu* | |
| 554 *:vme* *:vmenu* *:vnoreme* *:vnoremenu* | |
| 788 | 555 *:xme* *:xmenu* *:xnoreme* *:xnoremenu* |
| 556 *:sme* *:smenu* *:snoreme* *:snoremenu* | |
| 7 | 557 *:ime* *:imenu* *:inoreme* *:inoremenu* |
| 558 *:cme* *:cmenu* *:cnoreme* *:cnoremenu* | |
| 559 *E330* *E327* *E331* *E336* *E333* | |
| 1120 | 560 *E328* *E329* *E337* *E792* |
| 7 | 561 To create a new menu item, use the ":menu" commands. They are mostly like |
| 562 the ":map" set of commands but the first argument is a menu item name, given | |
| 236 | 563 as a path of menus and submenus with a '.' between them, e.g.: > |
| 7 | 564 |
| 565 :menu File.Save :w<CR> | |
| 566 :inoremenu File.Save <C-O>:w<CR> | |
| 567 :menu Edit.Big\ Changes.Delete\ All\ Spaces :%s/[ ^I]//g<CR> | |
| 568 | |
| 569 This last one will create a new item in the menu bar called "Edit", holding | |
| 570 the mouse button down on this will pop up a menu containing the item | |
| 571 "Big Changes", which is a sub-menu containing the item "Delete All Spaces", | |
| 572 which when selected, performs the operation. | |
| 573 | |
| 574 Special characters in a menu name: | |
| 575 | |
| 576 & The next character is the shortcut key. Make sure each | |
| 577 shortcut key is only used once in a (sub)menu. If you want to | |
| 578 insert a literal "&" in the menu name use "&&". | |
| 579 <Tab> Separates the menu name from right-aligned text. This can be | |
| 580 used to show the equivalent typed command. The text "<Tab>" | |
| 581 can be used here for convenience. If you are using a real | |
| 1235 | 582 tab, don't forget to put a backslash before it! |
| 7 | 583 Example: > |
| 584 | |
| 585 :amenu &File.&Open<Tab>:e :browse e<CR> | |
| 586 | |
| 587 [typed literally] | |
| 588 With the shortcut "F" (while keeping the <Alt> key pressed), and then "O", | |
| 589 this menu can be used. The second part is shown as "Open :e". The ":e" | |
| 590 is right aligned, and the "O" is underlined, to indicate it is the shortcut. | |
| 591 | |
| 592 The ":amenu" command can be used to define menu entries for all modes at once. | |
| 593 To make the command work correctly, a character is automatically inserted for | |
| 594 some modes: | |
| 595 mode inserted appended ~ | |
| 596 Normal nothing nothing | |
| 597 Visual <C-C> <C-\><C-G> | |
| 2152 | 598 Insert <C-\><C-O> |
| 7 | 599 Cmdline <C-C> <C-\><C-G> |
| 600 Op-pending <C-C> <C-\><C-G> | |
| 601 | |
| 602 Appending CTRL-\ CTRL-G is for going back to insert mode when 'insertmode' is | |
| 603 set. |CTRL-\_CTRL-G| | |
| 604 | |
| 605 Example: > | |
| 606 | |
| 607 :amenu File.Next :next^M | |
| 608 | |
| 609 is equal to: > | |
| 610 | |
| 611 :nmenu File.Next :next^M | |
| 612 :vmenu File.Next ^C:next^M^\^G | |
| 2152 | 613 :imenu File.Next ^\^O:next^M |
| 7 | 614 :cmenu File.Next ^C:next^M^\^G |
| 615 :omenu File.Next ^C:next^M^\^G | |
| 616 | |
| 617 Careful: In Insert mode this only works for a SINGLE Normal mode command, | |
| 618 because of the CTRL-O. If you have two or more commands, you will need to use | |
| 619 the ":imenu" command. For inserting text in any mode, you can use the | |
| 620 expression register: > | |
| 621 | |
| 622 :amenu Insert.foobar "='foobar'<CR>P | |
| 623 | |
| 624 Note that the '<' and 'k' flags in 'cpoptions' also apply here (when | |
| 625 included they make the <> form and raw key codes not being recognized). | |
| 626 | |
| 627 Note that <Esc> in Cmdline mode executes the command, like in a mapping. This | |
| 628 is Vi compatible. Use CTRL-C to quit Cmdline mode. | |
| 629 | |
| 630 *:menu-<silent>* *:menu-silent* | |
| 631 To define a menu which will not be echoed on the command line, add | |
| 632 "<silent>" as the first argument. Example: > | |
| 633 :menu <silent> Settings.Ignore\ case :set ic<CR> | |
| 634 The ":set ic" will not be echoed when using this menu. Messages from the | |
| 635 executed command are still given though. To shut them up too, add a ":silent" | |
| 636 in the executed command: > | |
| 637 :menu <silent> Search.Header :exe ":silent normal /Header\r"<CR> | |
| 859 | 638 "<silent>" may also appear just after "<special>" or "<script>". |
| 639 | |
| 640 *:menu-<special>* *:menu-special* | |
| 641 Define a menu with <> notation for special keys, even though the "<" flag | |
| 642 may appear in 'cpoptions'. This is useful if the side effect of setting | |
| 643 'cpoptions' is not desired. Example: > | |
| 644 :menu <special> Search.Header /Header<CR> | |
| 645 "<special>" must appear as the very first argument to the ":menu" command or | |
| 646 just after "<silent>" or "<script>". | |
| 647 | |
| 7 | 648 *:menu-<script>* *:menu-script* |
| 649 The "to" part of the menu will be inspected for mappings. If you don't want | |
| 650 this, use the ":noremenu" command (or the similar one for a specific mode). | |
| 651 If you do want to use script-local mappings, add "<script>" as the very first | |
| 859 | 652 argument to the ":menu" command or just after "<silent>" or "<special>". |
| 7 | 653 |
| 654 *menu-priority* | |
| 655 You can give a priority to a menu. Menus with a higher priority go more to | |
| 656 the right. The priority is given as a number before the ":menu" command. | |
| 657 Example: > | |
| 658 :80menu Buffer.next :bn<CR> | |
| 659 | |
| 660 The default menus have these priorities: | |
| 661 File 10 | |
| 662 Edit 20 | |
| 663 Tools 40 | |
| 664 Syntax 50 | |
| 665 Buffers 60 | |
| 666 Window 70 | |
| 667 Help 9999 | |
| 668 | |
| 669 When no or zero priority is given, 500 is used. | |
| 670 The priority for the PopUp menu is not used. | |
| 671 | |
| 672 The Help menu will be placed on the far right side of the menu bar on systems | |
|
8218
3456e2ebebd4
commit https://github.com/vim/vim/commit/9892189d2e7ab94b750f99e6da4cbfc3c8014517
Christian Brabandt <cb@256bit.org>
parents:
5697
diff
changeset
|
673 which support this (Motif and GTK+). For GTK+ 2 and 3, this is not done |
|
3456e2ebebd4
commit https://github.com/vim/vim/commit/9892189d2e7ab94b750f99e6da4cbfc3c8014517
Christian Brabandt <cb@256bit.org>
parents:
5697
diff
changeset
|
674 anymore because right-aligning the Help menu is now discouraged UI design. |
| 7 | 675 |
| 676 You can use a priority higher than 9999, to make it go after the Help menu, | |
| 677 but that is non-standard and is discouraged. The highest possible priority is | |
| 678 about 32000. The lowest is 1. | |
| 679 | |
| 680 *sub-menu-priority* | |
| 681 The same mechanism can be used to position a sub-menu. The priority is then | |
| 682 given as a dot-separated list of priorities, before the menu name: > | |
| 683 :menu 80.500 Buffer.next :bn<CR> | |
| 684 Giving the sub-menu priority is only needed when the item is not to be put | |
| 685 in a normal position. For example, to put a sub-menu before the other items: > | |
| 686 :menu 80.100 Buffer.first :brew<CR> | |
| 687 Or to put a sub-menu after the other items, and further items with default | |
| 688 priority will be put before it: > | |
| 689 :menu 80.900 Buffer.last :blast<CR> | |
| 690 When a number is missing, the default value 500 will be used: > | |
| 691 :menu .900 myMenu.test :echo "text"<CR> | |
| 692 The menu priority is only used when creating a new menu. When it already | |
| 693 existed, e.g., in another mode, the priority will not change. Thus, the | |
| 694 priority only needs to be given the first time a menu is used. | |
| 695 An exception is the PopUp menu. There is a separate menu for each mode | |
| 696 (Normal, Op-pending, Visual, Insert, Cmdline). The order in each of these | |
| 697 menus can be different. This is different from menu-bar menus, which have | |
| 698 the same order for all modes. | |
| 699 NOTE: sub-menu priorities currently don't work for all versions of the GUI. | |
| 700 | |
| 701 *menu-separator* *E332* | |
| 702 Menu items can be separated by a special item that inserts some space between | |
| 703 items. Depending on the system this is displayed as a line or a dotted line. | |
| 704 These items must start with a '-' and end in a '-'. The part in between is | |
| 705 used to give it a unique name. Priorities can be used as with normal items. | |
| 706 Example: > | |
| 707 :menu Example.item1 :do something | |
| 708 :menu Example.-Sep- : | |
| 709 :menu Example.item2 :do something different | |
| 710 Note that the separator also requires a rhs. It doesn't matter what it is, | |
| 711 because the item will never be selected. Use a single colon to keep it | |
| 712 simple. | |
| 713 | |
| 714 *gui-toolbar* | |
| 11 | 715 The toolbar is currently available in the Win32, Athena, Motif, GTK+ (X11), |
| 862 | 716 and Photon GUI. It should turn up in other GUIs in due course. The |
| 236 | 717 default toolbar is setup in menu.vim. |
| 718 The display of the toolbar is controlled by the 'guioptions' letter 'T'. You | |
| 7 | 719 can thus have menu & toolbar together, or either on its own, or neither. |
|
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
720 The appearance is controlled by the 'toolbar' option. You can choose between |
| 7 | 721 an image, text or both. |
| 722 | |
| 723 *toolbar-icon* | |
| 724 The toolbar is defined as a special menu called ToolBar, which only has one | |
| 725 level. Vim interprets the items in this menu as follows: | |
| 726 1) If an "icon=" argument was specified, the file with this name is used. | |
| 727 The file can either be specified with the full path or with the base name. | |
| 728 In the last case it is searched for in the "bitmaps" directory in | |
| 236 | 729 'runtimepath', like in point 3. Examples: > |
| 7 | 730 :amenu icon=/usr/local/pixmaps/foo_icon.xpm ToolBar.Foo :echo "Foo"<CR> |
| 731 :amenu icon=FooIcon ToolBar.Foo :echo "Foo"<CR> | |
| 732 < Note that in the first case the extension is included, while in the second | |
| 733 case it is omitted. | |
| 734 If the file cannot be opened the next points are tried. | |
| 735 A space in the file name must be escaped with a backslash. | |
| 736 A menu priority must come _after_ the icon argument: > | |
| 737 :amenu icon=foo 1.42 ToolBar.Foo :echo "42!"<CR> | |
| 738 2) An item called 'BuiltIn##', where ## is a number, is taken as number ## of | |
| 236 | 739 the built-in bitmaps available in Vim. Currently there are 31 numbered |
| 7 | 740 from 0 to 30 which cover most common editing operations |builtin-tools|. > |
| 741 :amenu ToolBar.BuiltIn22 :call SearchNext("back")<CR> | |
| 742 3) An item with another name is first searched for in the directory | |
| 743 "bitmaps" in 'runtimepath'. If found, the bitmap file is used as the | |
| 744 toolbar button image. Note that the exact filename is OS-specific: For | |
| 745 example, under Win32 the command > | |
| 746 :amenu ToolBar.Hello :echo "hello"<CR> | |
| 747 < would find the file 'hello.bmp'. Under GTK+/X11 it is 'Hello.xpm'. With | |
| 748 GTK+ 2 the files 'Hello.png', 'Hello.xpm' and 'Hello.bmp' are checked for | |
| 749 existence, and the first one found would be used. | |
| 750 For MS-Windows and GTK+ 2 the bitmap is scaled to fit the button. For | |
| 751 MS-Windows a size of 18 by 18 pixels works best. | |
| 752 For MS-Windows the bitmap should have 16 colors with the standard palette. | |
| 753 The light grey pixels will be changed to the Window frame color and the | |
| 754 dark grey pixels to the window shadow color. More colors might also work, | |
| 755 depending on your system. | |
| 756 4) If the bitmap is still not found, Vim checks for a match against its list | |
| 757 of built-in names. Each built-in button image has a name. | |
| 758 So the command > | |
| 759 :amenu ToolBar.Open :e | |
| 760 < will show the built-in "open a file" button image if no open.bmp exists. | |
| 761 All the built-in names can be seen used in menu.vim. | |
| 762 5) If all else fails, a blank, but functioning, button is displayed. | |
| 763 | |
| 764 *builtin-tools* | |
| 765 nr Name Normal action ~ | |
| 766 00 New open new window | |
| 767 01 Open browse for file to open in current window | |
| 768 02 Save write buffer to file | |
| 769 03 Undo undo last change | |
| 770 04 Redo redo last undone change | |
| 771 05 Cut delete selected text to clipboard | |
| 772 06 Copy copy selected text to clipboard | |
| 773 07 Paste paste text from clipboard | |
| 774 08 Print print current buffer | |
| 775 09 Help open a buffer on Vim's builtin help | |
| 776 10 Find start a search command | |
| 777 11 SaveAll write all modified buffers to file | |
| 778 12 SaveSesn write session file for current situation | |
| 779 13 NewSesn write new session file | |
| 780 14 LoadSesn load session file | |
| 781 15 RunScript browse for file to run as a Vim script | |
| 782 16 Replace prompt for substitute command | |
| 783 17 WinClose close current window | |
| 784 18 WinMax make current window use many lines | |
| 785 19 WinMin make current window use few lines | |
| 786 20 WinSplit split current window | |
| 787 21 Shell start a shell | |
| 788 22 FindPrev search again, backward | |
| 789 23 FindNext search again, forward | |
| 790 24 FindHelp prompt for word to search help for | |
| 791 25 Make run make and jump to first error | |
| 792 26 TagJump jump to tag under the cursor | |
| 793 27 RunCtags build tags for files in current directory | |
| 794 28 WinVSplit split current window vertically | |
| 795 29 WinMaxWidth make current window use many columns | |
| 796 30 WinMinWidth make current window use few columns | |
| 797 | |
| 798 *hidden-menus* *win32-hidden-menus* | |
| 799 In the Win32 and GTK+ GUI, starting a menu name with ']' excludes that menu | |
| 800 from the main menu bar. You must then use the |:popup| or |:tearoff| command | |
| 801 to display it. | |
| 802 | |
| 12499 | 803 *window-toolbar* *WinBar* |
|
12487
3f16cf18386c
patch 8.0.1123: cannot define a toolbar for a window
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
804 Each window can have a local toolbar. This uses the first line of the window, |
| 12499 | 805 thus reduces the space for the text by one line. The items in the toolbar |
| 806 must start with "WinBar". | |
|
12487
3f16cf18386c
patch 8.0.1123: cannot define a toolbar for a window
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
807 |
| 12499 | 808 Only text can be used. When using Unicode, special characters can be used to |
|
12487
3f16cf18386c
patch 8.0.1123: cannot define a toolbar for a window
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
809 make the items look like icons. |
|
3f16cf18386c
patch 8.0.1123: cannot define a toolbar for a window
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
810 |
|
3f16cf18386c
patch 8.0.1123: cannot define a toolbar for a window
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
811 If the items do not fit then the last ones cannot be used. The toolbar does |
|
3f16cf18386c
patch 8.0.1123: cannot define a toolbar for a window
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
812 not wrap. |
|
3f16cf18386c
patch 8.0.1123: cannot define a toolbar for a window
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
813 |
| 12559 | 814 Note that Vim may be in any mode when executing these commands. The menu |
| 815 should be defined for Normal mode and will be executed without changing the | |
| 816 current mode. Thus if the current window is in Visual mode and the menu | |
| 817 command does not intentionally change the mode, Vim will remain in Visual | |
| 818 mode. Best is to use `:nnoremenu` to avoid side effects. | |
| 819 | |
|
12487
3f16cf18386c
patch 8.0.1123: cannot define a toolbar for a window
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
820 Example for debugger tools: > |
| 12559 | 821 nnoremenu 1.10 WinBar.Step :Step<CR> |
| 822 nnoremenu 1.20 WinBar.Next :Next<CR> | |
| 823 nnoremenu 1.30 WinBar.Finish :Finish<CR> | |
| 824 nnoremenu 1.40 WinBar.Cont :Continue<CR> | |
|
12487
3f16cf18386c
patch 8.0.1123: cannot define a toolbar for a window
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
825 < |
|
3f16cf18386c
patch 8.0.1123: cannot define a toolbar for a window
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
826 The window toolbar uses the ToolbarLine and ToolbarButton highlight groups. |
|
3f16cf18386c
patch 8.0.1123: cannot define a toolbar for a window
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
827 |
| 12499 | 828 When splitting the window the window toolbar is not copied to the new window. |
| 829 | |
| 7 | 830 *popup-menu* |
| 862 | 831 In the Win32, GTK+, Motif, Athena and Photon GUI, you can define the |
| 434 | 832 special menu "PopUp". This is the menu that is displayed when the right mouse |
| 833 button is pressed, if 'mousemodel' is set to popup or popup_setpos. | |
|
12487
3f16cf18386c
patch 8.0.1123: cannot define a toolbar for a window
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
834 Example: > |
|
3f16cf18386c
patch 8.0.1123: cannot define a toolbar for a window
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
835 nnoremenu 1.40 PopUp.&Paste "+gP |
|
3f16cf18386c
patch 8.0.1123: cannot define a toolbar for a window
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
836 menu PopUp |
| 7 | 837 |
| 838 | |
| 839 5.3 Showing What Menus Are Mapped To *showing-menus* | |
| 840 | |
| 841 To see what an existing menu is mapped to, use just one argument after the | |
| 842 menu commands (just like you would with the ":map" commands). If the menu | |
| 843 specified is a submenu, then all menus under that hierarchy will be shown. | |
| 844 If no argument is given after :menu at all, then ALL menu items are shown | |
| 236 | 845 for the appropriate mode (e.g., Command-line mode for :cmenu). |
| 7 | 846 |
| 847 Special characters in the list, just before the rhs: | |
| 848 * The menu was defined with "nore" to disallow remapping. | |
| 849 & The menu was defined with "<script>" to allow remapping script-local | |
| 850 mappings only. | |
| 851 - The menu was disabled. | |
| 852 | |
| 853 Note that hitting <Tab> while entering a menu name after a menu command may | |
| 854 be used to complete the name of the menu item. | |
| 855 | |
| 856 | |
| 857 5.4 Executing Menus *execute-menus* | |
| 858 | |
| 859 *:em* *:emenu* *E334* *E335* | |
| 860 :[range]em[enu] {menu} Execute {menu} from the command line. | |
| 861 The default is to execute the Normal mode | |
| 862 menu. If a range is specified, it executes | |
| 863 the Visual mode menu. | |
| 864 If used from <c-o>, it executes the | |
| 865 insert-mode menu Eg: > | |
| 866 :emenu File.Exit | |
| 867 | |
| 868 If the console-mode vim has been compiled with WANT_MENU defined, you can | |
| 869 use :emenu to access useful menu items you may have got used to from GUI | |
| 870 mode. See 'wildmenu' for an option that works well with this. See | |
| 871 |console-menus| for an example. | |
| 872 | |
| 873 When using a range, if the lines match with '<,'>, then the menu is executed | |
| 874 using the last visual selection. | |
| 875 | |
| 876 | |
| 877 5.5 Deleting Menus *delete-menus* | |
| 878 | |
| 879 *:unme* *:unmenu* | |
| 880 *:aun* *:aunmenu* | |
| 881 *:nunme* *:nunmenu* | |
| 882 *:ounme* *:ounmenu* | |
| 883 *:vunme* *:vunmenu* | |
| 788 | 884 *:xunme* *:xunmenu* |
| 885 *:sunme* *:sunmenu* | |
| 7 | 886 *:iunme* *:iunmenu* |
| 887 *:cunme* *:cunmenu* | |
| 888 To delete a menu item or a whole submenu, use the unmenu commands, which are | |
| 889 analogous to the unmap commands. Eg: > | |
| 890 :unmenu! Edit.Paste | |
| 891 | |
| 892 This will remove the Paste item from the Edit menu for Insert and | |
| 893 Command-line modes. | |
| 894 | |
| 895 Note that hitting <Tab> while entering a menu name after an umenu command | |
| 896 may be used to complete the name of the menu item for the appropriate mode. | |
| 897 | |
| 898 To remove all menus use: *:unmenu-all* > | |
| 899 :unmenu * " remove all menus in Normal and visual mode | |
| 900 :unmenu! * " remove all menus in Insert and Command-line mode | |
| 901 :aunmenu * " remove all menus in all modes | |
| 902 | |
| 903 If you want to get rid of the menu bar: > | |
| 904 :set guioptions-=m | |
| 905 | |
| 906 | |
| 907 5.6 Disabling Menus *disable-menus* | |
| 908 | |
| 909 *:menu-disable* *:menu-enable* | |
| 910 If you do not want to remove a menu, but disable it for a moment, this can be | |
| 911 done by adding the "enable" or "disable" keyword to a ":menu" command. | |
| 912 Examples: > | |
| 913 :menu disable &File.&Open\.\.\. | |
| 914 :amenu enable * | |
| 915 :amenu disable &Tools.* | |
| 916 | |
| 917 The command applies to the modes as used with all menu commands. Note that | |
| 918 characters like "&" need to be included for translated names to be found. | |
| 919 When the argument is "*", all menus are affected. Otherwise the given menu | |
| 920 name and all existing submenus below it are affected. | |
| 921 | |
| 922 | |
| 923 5.7 Examples for Menus *menu-examples* | |
| 924 | |
| 925 Here is an example on how to add menu items with menu's! You can add a menu | |
| 926 item for the keyword under the cursor. The register "z" is used. > | |
| 927 | |
| 928 :nmenu Words.Add\ Var wb"zye:menu! Words.<C-R>z <C-R>z<CR> | |
| 929 :nmenu Words.Remove\ Var wb"zye:unmenu! Words.<C-R>z<CR> | |
| 930 :vmenu Words.Add\ Var "zy:menu! Words.<C-R>z <C-R>z <CR> | |
| 931 :vmenu Words.Remove\ Var "zy:unmenu! Words.<C-R>z<CR> | |
| 932 :imenu Words.Add\ Var <Esc>wb"zye:menu! Words.<C-R>z <C-R>z<CR>a | |
| 933 :imenu Words.Remove\ Var <Esc>wb"zye:unmenu! Words.<C-R>z<CR>a | |
| 934 | |
| 935 (the rhs is in <> notation, you can copy/paste this text to try out the | |
| 936 mappings, or put these lines in your gvimrc; "<C-R>" is CTRL-R, "<CR>" is | |
| 937 the <CR> key. |<>|) | |
| 938 | |
| 939 | |
| 940 5.8 Tooltips & Menu tips | |
| 941 | |
| 942 See section |42.4| in the user manual. | |
| 943 | |
| 944 *:tmenu* *:tm* | |
| 945 :tm[enu] {menupath} {rhs} Define a tip for a menu or tool. {only in | |
| 946 X11 and Win32 GUI} | |
| 947 | |
| 948 :tm[enu] [menupath] List menu tips. {only in X11 and Win32 GUI} | |
| 949 | |
| 950 *:tunmenu* *:tu* | |
| 951 :tu[nmenu] {menupath} Remove a tip for a menu or tool. | |
| 952 {only in X11 and Win32 GUI} | |
| 953 | |
| 954 When a tip is defined for a menu item, it appears in the command-line area | |
| 955 when the mouse is over that item, much like a standard Windows menu hint in | |
| 236 | 956 the status bar. (Except when Vim is in Command-line mode, when of course |
| 7 | 957 nothing is displayed.) |
| 958 When a tip is defined for a ToolBar item, it appears as a tooltip when the | |
| 959 mouse pauses over that button, in the usual fashion. Use the |hl-Tooltip| | |
| 960 highlight group to change its colors. | |
| 961 | |
| 962 A "tip" can be defined for each menu item. For example, when defining a menu | |
| 963 item like this: > | |
| 964 :amenu MyMenu.Hello :echo "Hello"<CR> | |
| 965 The tip is defined like this: > | |
| 966 :tmenu MyMenu.Hello Displays a greeting. | |
| 967 And delete it with: > | |
| 968 :tunmenu MyMenu.Hello | |
| 969 | |
| 236 | 970 Tooltips are currently only supported for the X11 and Win32 GUI. However, they |
| 7 | 971 should appear for the other gui platforms in the not too distant future. |
| 972 | |
| 973 The ":tmenu" command works just like other menu commands, it uses the same | |
| 974 arguments. ":tunmenu" deletes an existing menu tip, in the same way as the | |
| 975 other unmenu commands. | |
| 976 | |
| 977 If a menu item becomes invalid (i.e. its actions in all modes are deleted) Vim | |
| 978 deletes the menu tip (and the item) for you. This means that :aunmenu deletes | |
| 979 a menu item - you don't need to do a :tunmenu as well. | |
| 980 | |
| 981 | |
| 982 5.9 Popup Menus | |
| 983 | |
| 984 In the Win32 and GTK+ GUI, you can cause a menu to popup at the cursor. | |
| 985 This behaves similarly to the PopUp menus except that any menu tree can | |
| 986 be popped up. | |
| 987 | |
| 988 This command is for backwards compatibility, using it is discouraged, because | |
| 989 it behaves in a strange way. | |
| 990 | |
| 991 *:popup* *:popu* | |
| 992 :popu[p] {name} Popup the menu {name}. The menu named must | |
| 993 have at least one subentry, but need not | |
| 994 appear on the menu-bar (see |hidden-menus|). | |
| 995 {only available for Win32 and GTK GUI} | |
| 996 | |
| 398 | 997 :popu[p]! {name} Like above, but use the position of the mouse |
| 998 pointer instead of the cursor. | |
| 999 | |
| 7 | 1000 Example: > |
| 1001 :popup File | |
| 398 | 1002 will make the "File" menu (if there is one) appear at the text cursor (mouse |
| 1003 pointer if ! was used). > | |
| 7 | 1004 |
| 1005 :amenu ]Toolbar.Make :make<CR> | |
| 1006 :popup ]Toolbar | |
| 1007 This creates a popup menu that doesn't exist on the main menu-bar. | |
| 1008 | |
| 1009 Note that a menu that starts with ']' will not be displayed. | |
| 1010 | |
| 1011 ============================================================================== | |
| 1012 6. Extras *gui-extras* | |
| 1013 | |
| 1014 This section describes other features which are related to the GUI. | |
| 1015 | |
| 1016 - With the GUI, there is no wait for one second after hitting escape, because | |
| 1017 the key codes don't start with <Esc>. | |
| 1018 | |
| 1019 - Typing ^V followed by a special key in the GUI will insert "<Key>", since | |
| 1020 the internal string used is meaningless. Modifiers may also be held down to | |
| 1021 get "<Modifiers-Key>". | |
| 1022 | |
| 1023 - In the GUI, the modifiers SHIFT, CTRL, and ALT (or META) may be used within | |
| 236 | 1024 mappings of special keys and mouse events. E.g.: :map <M-LeftDrag> <LeftDrag> |
| 7 | 1025 |
| 1026 - In the GUI, several normal keys may have modifiers in mappings etc, these | |
| 1027 are <Space>, <Tab>, <NL>, <CR>, <Esc>. | |
| 1028 | |
| 1029 - To check in a Vim script if the GUI is being used, you can use something | |
| 1030 like this: > | |
| 1031 | |
| 1032 if has("gui_running") | |
| 1033 echo "yes, we have a GUI" | |
| 1034 else | |
| 1035 echo "Boring old console" | |
| 1036 endif | |
| 8 | 1037 < *setting-guifont* |
| 1038 - When you use the same vimrc file on various systems, you can use something | |
| 1039 like this to set options specifically for each type of GUI: > | |
| 1040 | |
| 1041 if has("gui_running") | |
| 1042 if has("gui_gtk2") | |
| 1043 :set guifont=Luxi\ Mono\ 12 | |
| 1044 elseif has("x11") | |
| 1045 " Also for GTK 1 | |
| 1046 :set guifont=*-lucidatypewriter-medium-r-normal-*-*-180-*-*-m-*-* | |
| 1047 elseif has("gui_win32") | |
| 1048 :set guifont=Luxi_Mono:h12:cANSI | |
| 1049 endif | |
| 1050 endif | |
| 7 | 1051 |
| 678 | 1052 A recommended Japanese font is MS Mincho. You can find info here: |
| 1053 http://www.lexikan.com/mincho.htm | |
| 1054 | |
| 7 | 1055 ============================================================================== |
| 1056 7. Shell Commands *gui-shell* | |
| 1057 | |
| 1058 For the X11 GUI the external commands are executed inside the gvim window. | |
| 1059 See |gui-pty|. | |
| 1060 | |
| 1061 WARNING: Executing an external command from the X11 GUI will not always | |
| 1062 work. "normal" commands like "ls", "grep" and "make" mostly work fine. | |
| 1063 Commands that require an intelligent terminal like "less" and "ispell" won't | |
| 1064 work. Some may even hang and need to be killed from another terminal. So be | |
| 1065 careful! | |
| 1066 | |
| 1067 For the Win32 GUI the external commands are executed in a separate window. | |
| 1068 See |gui-shell-win32|. | |
| 1069 | |
| 1070 vim:tw=78:sw=4:ts=8:ft=help:norl: |