Mercurial > vim
annotate runtime/doc/tabpage.txt @ 19484:0af19002b9a6
Added tag v8.2.0299 for changeset 0d3dcb4476ba48760962150ef4864cb6c63c4fa2
author | Bram Moolenaar <Bram@vim.org> |
---|---|
date | Sat, 22 Feb 2020 19:15:05 +0100 |
parents | 7be3663e2f2b |
children | 22583b9d4efd |
rev | line source |
---|---|
19404 | 1 *tabpage.txt* For Vim version 8.2. Last change: 2020 Feb 06 |
674 | 2 |
3 | |
4 VIM REFERENCE MANUAL by Bram Moolenaar | |
5 | |
6 | |
675 | 7 Editing with windows in multiple tab pages. *tab-page* *tabpage* |
674 | 8 |
9 The commands which have been added to use multiple tab pages are explained | |
10 here. Additionally, there are explanations for commands that work differently | |
11 when used in combination with more than one tab page. | |
12 | |
678 | 13 1. Introduction |tab-page-intro| |
14 2. Commands |tab-page-commands| | |
15 3. Other items |tab-page-other| | |
16 4. Setting 'tabline' |setting-tabline| | |
686 | 17 5. Setting 'guitablabel' |setting-guitablabel| |
674 | 18 |
19 {not able to use multiple tab pages when the |+windows| feature was disabled | |
20 at compile time} | |
21 | |
22 ============================================================================== | |
23 1. Introduction *tab-page-intro* | |
24 | |
25 A tab page holds one or more windows. You can easily switch between tab | |
26 pages, so that you have several collections of windows to work on different | |
27 things. | |
28 | |
29 Usually you will see a list of labels at the top of the Vim window, one for | |
30 each tab page. With the mouse you can click on the label to jump to that tab | |
31 page. There are other ways to move between tab pages, see below. | |
32 | |
33 Most commands work only in the current tab page. That includes the |CTRL-W| | |
698 | 34 commands, |:windo|, |:all| and |:ball| (when not using the |:tab| modifier). |
35 The commands that are aware of other tab pages than the current one are | |
36 mentioned below. | |
674 | 37 |
38 Tabs are also a nice way to edit a buffer temporarily without changing the | |
39 current window layout. Open a new tab page, do whatever you want to do and | |
40 close the tab page. | |
41 | |
42 ============================================================================== | |
43 2. Commands *tab-page-commands* | |
44 | |
45 OPENING A NEW TAB PAGE: | |
46 | |
47 When starting Vim "vim -p filename ..." opens each file argument in a separate | |
2326
6e563e1c8033
Make it possible to drag a tab page label to another position. (Paul B. Mahol)
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
48 tab page (up to 'tabpagemax'). See |-p| |
674 | 49 |
706 | 50 A double click with the mouse in the non-GUI tab pages line opens a new, empty |
51 tab page. It is placed left of the position of the click. The first click | |
52 may select another tab page first, causing an extra screen update. | |
53 | |
844 | 54 This also works in a few GUI versions, esp. Win32 and Motif. But only when |
55 clicking right of the labels. | |
56 | |
706 | 57 In the GUI tab pages line you can use the right mouse button to open menu. |
58 |tabline-menu|. | |
682 | 59 |
10301
07d2b5a3b7cc
commit https://github.com/vim/vim/commit/46fceaaa8d1447a9588736d86eb4908214187b08
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
60 For the related autocommands see |tabnew-autocmd|. |
07d2b5a3b7cc
commit https://github.com/vim/vim/commit/46fceaaa8d1447a9588736d86eb4908214187b08
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
61 |
2444
3fbd9bce03f1
Support syntax and filetype completion for user commands. (Christian Brabandt)
Bram Moolenaar <bram@vim.org>
parents:
2413
diff
changeset
|
62 :[count]tabe[dit] *:tabe* *:tabedit* *:tabnew* |
3fbd9bce03f1
Support syntax and filetype completion for user commands. (Christian Brabandt)
Bram Moolenaar <bram@vim.org>
parents:
2413
diff
changeset
|
63 :[count]tabnew |
3fbd9bce03f1
Support syntax and filetype completion for user commands. (Christian Brabandt)
Bram Moolenaar <bram@vim.org>
parents:
2413
diff
changeset
|
64 Open a new tab page with an empty window, after the current |
6398 | 65 tab page. If [count] is given the new tab page appears after |
66 the tab page [count] otherwise the new tab page will appear | |
67 after the current one. > | |
68 :tabnew " opens tabpage after the current one | |
69 :.tabnew " as above | |
70 :+tabnew " opens tabpage after the next tab page | |
71 " note: it is one further than :tabnew | |
72 :-tabnew " opens tabpage before the current one | |
73 :0tabnew " opens tabpage before the first one | |
74 :$tabnew " opens tabpage after the last one | |
674 | 75 |
2444
3fbd9bce03f1
Support syntax and filetype completion for user commands. (Christian Brabandt)
Bram Moolenaar <bram@vim.org>
parents:
2413
diff
changeset
|
76 :[count]tabe[dit] [++opt] [+cmd] {file} |
3fbd9bce03f1
Support syntax and filetype completion for user commands. (Christian Brabandt)
Bram Moolenaar <bram@vim.org>
parents:
2413
diff
changeset
|
77 :[count]tabnew [++opt] [+cmd] {file} |
674 | 78 Open a new tab page and edit {file}, like with |:edit|. |
6398 | 79 For [count] see |:tabnew| above. |
674 | 80 |
2444
3fbd9bce03f1
Support syntax and filetype completion for user commands. (Christian Brabandt)
Bram Moolenaar <bram@vim.org>
parents:
2413
diff
changeset
|
81 :[count]tabf[ind] [++opt] [+cmd] {file} *:tabf* *:tabfind* |
674 | 82 Open a new tab page and edit {file} in 'path', like with |
6398 | 83 |:find|. For [count] see |:tabnew| above. |
674 | 84 {not available when the |+file_in_path| feature was disabled |
85 at compile time} | |
86 | |
682 | 87 :[count]tab {cmd} *:tab* |
88 Execute {cmd} and when it opens a new window open a new tab | |
1118 | 89 page instead. Doesn't work for |:diffsplit|, |:diffpatch|, |
90 |:execute| and |:normal|. | |
9927
e1a8b2601fe0
commit https://github.com/vim/vim/commit/9b7f8ce9eb3cb704f8cc14ab659bf86b1d6dc13c
Christian Brabandt <cb@256bit.org>
parents:
7092
diff
changeset
|
91 If [count] is given the new tab page appears after the tab |
e1a8b2601fe0
commit https://github.com/vim/vim/commit/9b7f8ce9eb3cb704f8cc14ab659bf86b1d6dc13c
Christian Brabandt <cb@256bit.org>
parents:
7092
diff
changeset
|
92 page [count] otherwise the new tab page will appear after the |
e1a8b2601fe0
commit https://github.com/vim/vim/commit/9b7f8ce9eb3cb704f8cc14ab659bf86b1d6dc13c
Christian Brabandt <cb@256bit.org>
parents:
7092
diff
changeset
|
93 current one. |
2444
3fbd9bce03f1
Support syntax and filetype completion for user commands. (Christian Brabandt)
Bram Moolenaar <bram@vim.org>
parents:
2413
diff
changeset
|
94 Examples: > |
9927
e1a8b2601fe0
commit https://github.com/vim/vim/commit/9b7f8ce9eb3cb704f8cc14ab659bf86b1d6dc13c
Christian Brabandt <cb@256bit.org>
parents:
7092
diff
changeset
|
95 :tab split " opens current buffer in new tab page |
e1a8b2601fe0
commit https://github.com/vim/vim/commit/9b7f8ce9eb3cb704f8cc14ab659bf86b1d6dc13c
Christian Brabandt <cb@256bit.org>
parents:
7092
diff
changeset
|
96 :tab help gt " opens tab page with help for "gt" |
e1a8b2601fe0
commit https://github.com/vim/vim/commit/9b7f8ce9eb3cb704f8cc14ab659bf86b1d6dc13c
Christian Brabandt <cb@256bit.org>
parents:
7092
diff
changeset
|
97 :.tab help gt " as above |
e1a8b2601fe0
commit https://github.com/vim/vim/commit/9b7f8ce9eb3cb704f8cc14ab659bf86b1d6dc13c
Christian Brabandt <cb@256bit.org>
parents:
7092
diff
changeset
|
98 :+tab help " opens tab page with help after the next |
e1a8b2601fe0
commit https://github.com/vim/vim/commit/9b7f8ce9eb3cb704f8cc14ab659bf86b1d6dc13c
Christian Brabandt <cb@256bit.org>
parents:
7092
diff
changeset
|
99 " tab page |
e1a8b2601fe0
commit https://github.com/vim/vim/commit/9b7f8ce9eb3cb704f8cc14ab659bf86b1d6dc13c
Christian Brabandt <cb@256bit.org>
parents:
7092
diff
changeset
|
100 :-tab help " opens tab page with help before the |
e1a8b2601fe0
commit https://github.com/vim/vim/commit/9b7f8ce9eb3cb704f8cc14ab659bf86b1d6dc13c
Christian Brabandt <cb@256bit.org>
parents:
7092
diff
changeset
|
101 " current one |
e1a8b2601fe0
commit https://github.com/vim/vim/commit/9b7f8ce9eb3cb704f8cc14ab659bf86b1d6dc13c
Christian Brabandt <cb@256bit.org>
parents:
7092
diff
changeset
|
102 :0tab help " opens tab page with help before the |
e1a8b2601fe0
commit https://github.com/vim/vim/commit/9b7f8ce9eb3cb704f8cc14ab659bf86b1d6dc13c
Christian Brabandt <cb@256bit.org>
parents:
7092
diff
changeset
|
103 " first one |
e1a8b2601fe0
commit https://github.com/vim/vim/commit/9b7f8ce9eb3cb704f8cc14ab659bf86b1d6dc13c
Christian Brabandt <cb@256bit.org>
parents:
7092
diff
changeset
|
104 :$tab help " opens tab page with help after the last |
e1a8b2601fe0
commit https://github.com/vim/vim/commit/9b7f8ce9eb3cb704f8cc14ab659bf86b1d6dc13c
Christian Brabandt <cb@256bit.org>
parents:
7092
diff
changeset
|
105 " one |
682 | 106 |
820 | 107 CTRL-W gf Open a new tab page and edit the file name under the cursor. |
108 See |CTRL-W_gf|. | |
109 | |
839 | 110 CTRL-W gF Open a new tab page and edit the file name under the cursor |
111 and jump to the line number following the file name. | |
112 See |CTRL-W_gF|. | |
674 | 113 |
114 CLOSING A TAB PAGE: | |
115 | |
682 | 116 Closing the last window of a tab page closes the tab page too, unless there is |
117 only one tab page. | |
674 | 118 |
119 Using the mouse: If the tab page line is displayed you can click in the "X" at | |
682 | 120 the top right to close the current tab page. A custom |'tabline'| may show |
121 something else. | |
674 | 122 |
123 *:tabc* *:tabclose* | |
124 :tabc[lose][!] Close current tab page. | |
125 This command fails when: | |
126 - There is only one tab page on the screen. *E784* | |
127 - When 'hidden' is not set, [!] is not used, a buffer has | |
128 changes, and there is no other window on this buffer. | |
129 Changes to the buffer are not written and won't get lost, so | |
6398 | 130 this is a "safe" command. > |
131 :tabclose " close the current tab page | |
674 | 132 |
6398 | 133 :{count}tabc[lose][!] |
674 | 134 :tabc[lose][!] {count} |
3750 | 135 Close tab page {count}. Fails in the same way as `:tabclose` |
6398 | 136 above. > |
137 :-tabclose " close the previous tab page | |
138 :+tabclose " close the next tab page | |
139 :1tabclose " close the first tab page | |
140 :$tabclose " close the last tab page | |
19404 | 141 :tabclose -2 " close the 2nd previous tab page |
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10301
diff
changeset
|
142 :tabclose + " close the next tab page |
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10301
diff
changeset
|
143 :tabclose 3 " close the third tab page |
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10301
diff
changeset
|
144 :tabclose $ " close the last tab page |
6398 | 145 < |
674 | 146 *:tabo* *:tabonly* |
147 :tabo[nly][!] Close all other tab pages. | |
148 When the 'hidden' option is set, all buffers in closed windows | |
149 become hidden. | |
150 When 'hidden' is not set, and the 'autowrite' option is set, | |
151 modified buffers are written. Otherwise, windows that have | |
152 buffers that are modified are not removed, unless the [!] is | |
153 given, then they become hidden. But modified buffers are | |
6398 | 154 never abandoned, so changes cannot get lost. > |
155 :tabonly " close all tab pages except the current | |
9927
e1a8b2601fe0
commit https://github.com/vim/vim/commit/9b7f8ce9eb3cb704f8cc14ab659bf86b1d6dc13c
Christian Brabandt <cb@256bit.org>
parents:
7092
diff
changeset
|
156 " one |
6398 | 157 |
158 :{count}tabo[nly][!] | |
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10301
diff
changeset
|
159 :tabo[nly][!] {count} |
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10301
diff
changeset
|
160 Close all tab pages except {count} one. > |
9927
e1a8b2601fe0
commit https://github.com/vim/vim/commit/9b7f8ce9eb3cb704f8cc14ab659bf86b1d6dc13c
Christian Brabandt <cb@256bit.org>
parents:
7092
diff
changeset
|
161 :.tabonly " as above |
6398 | 162 :-tabonly " close all tab pages except the previous |
163 " one | |
164 :+tabonly " close all tab pages except the next one | |
165 :1tabonly " close all tab pages except the first one | |
166 :$tabonly " close all tab pages except the last one | |
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10301
diff
changeset
|
167 :tabonly - " close all tab pages except the previous |
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10301
diff
changeset
|
168 " one |
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10301
diff
changeset
|
169 :tabonly +2 " close all tab pages except the two next |
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10301
diff
changeset
|
170 " one |
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10301
diff
changeset
|
171 :tabonly 1 " close all tab pages except the first one |
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10301
diff
changeset
|
172 :tabonly $ " close all tab pages except the last one |
674 | 173 |
174 | |
175 SWITCHING TO ANOTHER TAB PAGE: | |
176 | |
177 Using the mouse: If the tab page line is displayed you can click in a tab page | |
682 | 178 label to switch to that tab page. Click where there is no label to go to the |
179 next tab page. |'tabline'| | |
674 | 180 |
819 | 181 :tabn[ext] *:tabn* *:tabnext* *gt* |
1118 | 182 <C-PageDown> *CTRL-<PageDown>* *<C-PageDown>* |
183 gt *i_CTRL-<PageDown>* *i_<C-PageDown>* | |
828 | 184 Go to the next tab page. Wraps around from the last to the |
674 | 185 first one. |
186 | |
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10301
diff
changeset
|
187 :{count}tabn[ext] |
1118 | 188 :tabn[ext] {count} |
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10301
diff
changeset
|
189 Go to tab page {count}. The first tab page has number one. > |
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10301
diff
changeset
|
190 :-tabnext " go to the previous tab page |
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10301
diff
changeset
|
191 :+tabnext " go to the next tab page |
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10301
diff
changeset
|
192 :+2tabnext " go to the two next tab page |
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10301
diff
changeset
|
193 :1tabnext " go to the first tab page |
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10301
diff
changeset
|
194 :$tabnext " go to the last tab page |
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10301
diff
changeset
|
195 :tabnext $ " as above |
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10301
diff
changeset
|
196 :tabnext - " go to the previous tab page |
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10301
diff
changeset
|
197 :tabnext -1 " as above |
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10301
diff
changeset
|
198 :tabnext + " go to the next tab page |
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10301
diff
changeset
|
199 :tabnext +1 " as above |
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10301
diff
changeset
|
200 |
1118 | 201 {count}<C-PageDown> |
202 {count}gt Go to tab page {count}. The first tab page has number one. | |
674 | 203 |
204 | |
1118 | 205 :tabp[revious] *:tabp* *:tabprevious* *gT* *:tabN* |
206 :tabN[ext] *:tabNext* *CTRL-<PageUp>* | |
207 <C-PageUp> *<C-PageUp>* *i_CTRL-<PageUp>* *i_<C-PageUp>* | |
682 | 208 gT Go to the previous tab page. Wraps around from the first one |
209 to the last one. | |
210 | |
211 :tabp[revious] {count} | |
212 :tabN[ext] {count} | |
1118 | 213 {count}<C-PageUp> |
682 | 214 {count}gT Go {count} tab pages back. Wraps around from the first one |
14006 | 215 to the last one. Note that the use of {count} is different |
216 from |:tabnext|, where it is used as the tab page number. | |
682 | 217 |
685 | 218 :tabr[ewind] *:tabfir* *:tabfirst* *:tabr* *:tabrewind* |
686 | 219 :tabfir[st] Go to the first tab page. |
685 | 220 |
221 *:tabl* *:tablast* | |
222 :tabl[ast] Go to the last tab page. | |
223 | |
682 | 224 |
674 | 225 Other commands: |
226 *:tabs* | |
682 | 227 :tabs List the tab pages and the windows they contain. |
228 Shows a ">" for the current window. | |
229 Shows a "+" for modified buffers. | |
10186
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9927
diff
changeset
|
230 For example: |
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9927
diff
changeset
|
231 Tab page 1 ~ |
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9927
diff
changeset
|
232 + tabpage.txt ~ |
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9927
diff
changeset
|
233 ex_docmd.c ~ |
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9927
diff
changeset
|
234 Tab page 2 ~ |
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9927
diff
changeset
|
235 > main.c ~ |
682 | 236 |
237 | |
238 REORDERING TAB PAGES: | |
239 | |
843 | 240 :tabm[ove] [N] *:tabm* *:tabmove* |
3662 | 241 :[N]tabm[ove] |
843 | 242 Move the current tab page to after tab page N. Use zero to |
14519 | 243 make the current tab page the first one. N is counted before |
244 the move, thus if the second tab is the current one, | |
14637 | 245 `:tabmove 1` and `:tabmove 2` have no effect. |
14519 | 246 Without N the tab page is made the last one. > |
6775 | 247 :.tabmove " do nothing |
6398 | 248 :-tabmove " move the tab page to the left |
6775 | 249 :+tabmove " move the tab page to the right |
6474 | 250 :0tabmove " move the tab page to the beginning of the tab |
6398 | 251 " list |
6775 | 252 :tabmove 0 " as above |
253 :tabmove " move the tab page to the last | |
254 :$tabmove " as above | |
255 :tabmove $ " as above | |
674 | 256 |
3662 | 257 :tabm[ove] +[N] |
258 :tabm[ove] -[N] | |
259 Move the current tab page N places to the right (with +) or to | |
6775 | 260 the left (with -). > |
261 :tabmove - " move the tab page to the left | |
262 :tabmove -1 " as above | |
263 :tabmove + " move the tab page to the right | |
264 :tabmove +1 " as above | |
265 | |
3662 | 266 |
267 Note that although it is possible to move a tab behind the N-th one by using | |
6775 | 268 :Ntabmove. And move it by N places by using :+Ntabmove. For clarification what |
269 +N means in this context see |[range]|. | |
3662 | 270 |
685 | 271 |
272 LOOPING OVER TAB PAGES: | |
273 | |
274 *:tabd* *:tabdo* | |
6474 | 275 :[range]tabd[o] {cmd} |
276 Execute {cmd} in each tab page or if [range] is given only in | |
277 tab pages which tab page number is in the [range]. It works | |
278 like doing this: > | |
685 | 279 :tabfirst |
280 :{cmd} | |
281 :tabnext | |
282 :{cmd} | |
283 etc. | |
284 < This only operates in the current window of each tab page. | |
285 When an error is detected on one tab page, further tab pages | |
286 will not be visited. | |
287 The last tab page (or where an error occurred) becomes the | |
288 current tab page. | |
289 {cmd} can contain '|' to concatenate several commands. | |
290 {cmd} must not open or close tab pages or reorder them. | |
7092
64e30831fa42
commit https://github.com/vim/vim/commit/aa23b379421aa214e6543b06c974594a25799b09
Christian Brabandt <cb@256bit.org>
parents:
6775
diff
changeset
|
291 Also see |:windo|, |:argdo|, |:bufdo|, |:cdo|, |:ldo|, |:cfdo| |
64e30831fa42
commit https://github.com/vim/vim/commit/aa23b379421aa214e6543b06c974594a25799b09
Christian Brabandt <cb@256bit.org>
parents:
6775
diff
changeset
|
292 and |:lfdo| |
685 | 293 |
674 | 294 ============================================================================== |
295 3. Other items *tab-page-other* | |
296 | |
706 | 297 *tabline-menu* |
298 The GUI tab pages line has a popup menu. It is accessed with a right click. | |
299 The entries are: | |
300 Close Close the tab page under the mouse pointer. The | |
301 current one if there is no label under the mouse | |
302 pointer. | |
303 New Tab Open a tab page, editing an empty buffer. It appears | |
304 to the left of the mouse pointer. | |
1118 | 305 Open Tab... Like "New Tab" and additionally use a file selector to |
706 | 306 select a file to edit. |
307 | |
674 | 308 Diff mode works per tab page. You can see the diffs between several files |
309 within one tab page. Other tab pages can show differences between other | |
310 files. | |
311 | |
819 | 312 Variables local to a tab page start with "t:". |tabpage-variable| |
313 | |
824 | 314 Currently there is only one option local to a tab page: 'cmdheight'. |
315 | |
10301
07d2b5a3b7cc
commit https://github.com/vim/vim/commit/46fceaaa8d1447a9588736d86eb4908214187b08
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
316 *tabnew-autocmd* |
675 | 317 The TabLeave and TabEnter autocommand events can be used to do something when |
318 switching from one tab page to another. The exact order depends on what you | |
319 are doing. When creating a new tab page this works as if you create a new | |
320 window on the same buffer and then edit another buffer. Thus ":tabnew" | |
321 triggers: | |
322 WinLeave leave current window | |
323 TabLeave leave current tab page | |
6474 | 324 WinEnter enter window in new tab page |
675 | 325 TabEnter enter new tab page |
326 BufLeave leave current buffer | |
327 BufEnter enter new empty buffer | |
328 | |
678 | 329 When switching to another tab page the order is: |
675 | 330 BufLeave |
331 WinLeave | |
332 TabLeave | |
333 TabEnter | |
334 WinEnter | |
335 BufEnter | |
674 | 336 |
678 | 337 ============================================================================== |
338 4. Setting 'tabline' *setting-tabline* | |
339 | |
686 | 340 The 'tabline' option specifies what the line with tab pages labels looks like. |
341 It is only used when there is no GUI tab line. | |
342 | |
678 | 343 You can use the 'showtabline' option to specify when you want the line with |
344 tab page labels to appear: never, when there is more than one tab page or | |
345 always. | |
346 | |
347 The highlighting of the tab pages line is set with the groups TabLine | |
348 TabLineSel and TabLineFill. |hl-TabLine| |hl-TabLineSel| |hl-TabLineFill| | |
349 | |
1118 | 350 A "+" will be shown for a tab page that has a modified window. The number of |
351 windows in a tabpage is also shown. Thus "3+" means three windows and one of | |
352 them has a modified buffer. | |
353 | |
678 | 354 The 'tabline' option allows you to define your preferred way to tab pages |
355 labels. This isn't easy, thus an example will be given here. | |
356 | |
357 For basics see the 'statusline' option. The same items can be used in the | |
358 'tabline' option. Additionally, the |tabpagebuflist()|, |tabpagenr()| and | |
359 |tabpagewinnr()| functions are useful. | |
360 | |
1118 | 361 Since the number of tab labels will vary, you need to use an expression for |
362 the whole option. Something like: > | |
678 | 363 :set tabline=%!MyTabLine() |
364 | |
365 Then define the MyTabLine() function to list all the tab pages labels. A | |
366 convenient method is to split it in two parts: First go over all the tab | |
367 pages and define labels for them. Then get the label for each tab page. > | |
368 | |
369 function MyTabLine() | |
370 let s = '' | |
371 for i in range(tabpagenr('$')) | |
681 | 372 " select the highlighting |
678 | 373 if i + 1 == tabpagenr() |
374 let s .= '%#TabLineSel#' | |
375 else | |
376 let s .= '%#TabLine#' | |
377 endif | |
681 | 378 |
379 " set the tab page number (for mouse clicks) | |
380 let s .= '%' . (i + 1) . 'T' | |
381 | |
382 " the label is made by MyTabLabel() | |
678 | 383 let s .= ' %{MyTabLabel(' . (i + 1) . ')} ' |
384 endfor | |
681 | 385 |
386 " after the last tab fill with TabLineFill and reset tab page nr | |
387 let s .= '%#TabLineFill#%T' | |
388 | |
389 " right-align the label to close the current tab page | |
390 if tabpagenr('$') > 1 | |
391 let s .= '%=%#TabLine#%999Xclose' | |
392 endif | |
393 | |
678 | 394 return s |
395 endfunction | |
396 | |
397 Now the MyTabLabel() function is called for each tab page to get its label. > | |
398 | |
399 function MyTabLabel(n) | |
400 let buflist = tabpagebuflist(a:n) | |
401 let winnr = tabpagewinnr(a:n) | |
402 return bufname(buflist[winnr - 1]) | |
403 endfunction | |
404 | |
405 This is just a simplistic example that results in a tab pages line that | |
406 resembles the default, but without adding a + for a modified buffer or | |
1118 | 407 truncating the names. You will want to reduce the width of labels in a |
678 | 408 clever way when there is not enough room. Check the 'columns' option for the |
681 | 409 space available. |
674 | 410 |
686 | 411 ============================================================================== |
412 5. Setting 'guitablabel' *setting-guitablabel* | |
413 | |
414 When the GUI tab pages line is displayed, 'guitablabel' can be used to | |
415 specify the label to display for each tab page. Unlike 'tabline', which | |
416 specifies the whole tab pages line at once, 'guitablabel' is used for each | |
417 label separately. | |
418 | |
839 | 419 'guitabtooltip' is very similar and is used for the tooltip of the same label. |
420 This only appears when the mouse pointer hovers over the label, thus it | |
421 usually is longer. Only supported on some systems though. | |
422 | |
686 | 423 See the 'statusline' option for the format of the value. |
424 | |
425 The "%N" item can be used for the current tab page number. The |v:lnum| | |
839 | 426 variable is also set to this number when the option is evaluated. |
690 | 427 The items that use a file name refer to the current window of the tab page. |
686 | 428 |
839 | 429 Note that syntax highlighting is not used for the option. The %T and %X |
690 | 430 items are also ignored. |
686 | 431 |
690 | 432 A simple example that puts the tab page number and the buffer name in the |
433 label: > | |
686 | 434 :set guitablabel=%N\ %f |
435 | |
839 | 436 An example that resembles the default 'guitablabel': Show the number of |
1118 | 437 windows in the tab page and a '+' if there is a modified buffer: > |
686 | 438 |
690 | 439 function GuiTabLabel() |
686 | 440 let label = '' |
441 let bufnrlist = tabpagebuflist(v:lnum) | |
442 | |
443 " Add '+' if one of the buffers in the tab page is modified | |
444 for bufnr in bufnrlist | |
445 if getbufvar(bufnr, "&modified") | |
446 let label = '+' | |
447 break | |
448 endif | |
449 endfor | |
450 | |
451 " Append the number of windows in the tab page if more than one | |
452 let wincount = tabpagewinnr(v:lnum, '$') | |
453 if wincount > 1 | |
454 let label .= wincount | |
455 endif | |
456 if label != '' | |
457 let label .= ' ' | |
458 endif | |
459 | |
460 " Append the buffer name | |
461 return label . bufname(bufnrlist[tabpagewinnr(v:lnum) - 1]) | |
462 endfunction | |
690 | 463 |
686 | 464 set guitablabel=%{GuiTabLabel()} |
690 | 465 |
466 Note that the function must be defined before setting the option, otherwise | |
467 you get an error message for the function not being known. | |
468 | |
857 | 469 If you want to fall back to the default label, return an empty string. |
470 | |
471 If you want to show something specific for a tab page, you might want to use a | |
472 tab page local variable. |t:var| | |
473 | |
686 | 474 |
14421 | 475 vim:tw=78:ts=8:noet:ft=help:norl: |