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