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