Mercurial > vim
annotate runtime/doc/sign.txt @ 26323:3841da4eac23 v8.2.3692
patch 8.2.3692: Vim9: cannot use :func inside a :def function
Commit: https://github.com/vim/vim/commit/38453528c3372293d70c8e85471a6188749ff331
Author: Bram Moolenaar <Bram@vim.org>
Date: Sun Nov 28 22:00:12 2021 +0000
patch 8.2.3692: Vim9: cannot use :func inside a :def function
Problem: Vim9: cannot use :func inside a :def function.
Solution: Make it work.
author | Bram Moolenaar <Bram@vim.org> |
---|---|
date | Sun, 28 Nov 2021 23:15:03 +0100 |
parents | bb2175e5ccee |
children | c725b8e17f1f |
rev | line source |
---|---|
24103 | 1 *sign.txt* For Vim version 8.2. Last change: 2021 Mar 07 |
7 | 2 |
3 | |
4 VIM REFERENCE MANUAL by Gordon Prieur | |
5 and Bram Moolenaar | |
6 | |
7 | |
8 Sign Support Features *sign-support* | |
9 | |
10 1. Introduction |sign-intro| | |
11 2. Commands |sign-commands| | |
17456
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
12 3. Functions |sign-functions-details| |
7 | 13 |
14 {only available when compiled with the |+signs| feature} | |
15 | |
16 ============================================================================== | |
17 1. Introduction *sign-intro* *signs* | |
18 | |
19 When a debugger or other IDE tool is driving an editor it needs to be able | |
20 to give specific highlights which quickly tell the user useful information | |
236 | 21 about the file. One example of this would be a debugger which had an icon |
22 in the left-hand column denoting a breakpoint. Another example might be an | |
23 arrow representing the Program Counter (PC). The sign features allow both | |
7 | 24 placement of a sign, or icon, in the left-hand side of the window and |
236 | 25 definition of a highlight which will be applied to that line. Displaying the |
7 | 26 sign as an image is most likely only feasible in gvim (although Sun |
236 | 27 Microsystem's dtterm does support this it's the only terminal emulator I know |
7 | 28 of which does). A text sign and the highlight should be feasible in any color |
29 terminal emulator. | |
30 | |
236 | 31 Signs and highlights are not useful just for debuggers. Sun's Visual |
7 | 32 WorkShop uses signs and highlights to mark build errors and SourceBrowser |
236 | 33 hits. Additionally, the debugger supports 8 to 10 different signs and |
15512 | 34 highlight colors, see |NetBeans|. |
7 | 35 |
36 There are two steps in using signs: | |
37 | |
38 1. Define the sign. This specifies the image, text and highlighting. For | |
39 example, you can define a "break" sign with an image of a stop roadsign and | |
40 text "!!". | |
41 | |
42 2. Place the sign. This specifies the file and line number where the sign is | |
43 displayed. A defined sign can be placed several times in different lines | |
44 and files. | |
45 | |
15512 | 46 *sign-column* |
7 | 47 When signs are defined for a file, Vim will automatically add a column of two |
48 characters to display them in. When the last sign is unplaced the column | |
9860
9eaf8ef656e9
commit https://github.com/vim/vim/commit/0952131376a517fc12dc5ae908a97018b4ee23f0
Christian Brabandt <cb@256bit.org>
parents:
5908
diff
changeset
|
49 disappears again. This behavior can be changed with the 'signcolumn' option. |
9eaf8ef656e9
commit https://github.com/vim/vim/commit/0952131376a517fc12dc5ae908a97018b4ee23f0
Christian Brabandt <cb@256bit.org>
parents:
5908
diff
changeset
|
50 |
18615 | 51 The color of the column is set with the SignColumn highlight group |
52 |hl-SignColumn|. Example to set the color: > | |
7 | 53 |
54 :highlight SignColumn guibg=darkgrey | |
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
55 < |
26266
365e7f083f02
patch 8.2.3664: cannot adjust sign highlighting for 'cursorline'
Bram Moolenaar <Bram@vim.org>
parents:
25822
diff
changeset
|
56 If 'cursorline' is enabled, then the CursorLineSign highlight group is used |
365e7f083f02
patch 8.2.3664: cannot adjust sign highlighting for 'cursorline'
Bram Moolenaar <Bram@vim.org>
parents:
25822
diff
changeset
|
57 |hl-CursorLineSign|. |
15378
0d76dd701e49
patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents:
15334
diff
changeset
|
58 *sign-identifier* |
0d76dd701e49
patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents:
15334
diff
changeset
|
59 Each placed sign is identified by a number called the sign identifier. This |
0d76dd701e49
patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents:
15334
diff
changeset
|
60 identifier is used to jump to the sign or to remove the sign. The identifier |
15512 | 61 is assigned when placing the sign using the |:sign-place| command or the |
15378
0d76dd701e49
patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents:
15334
diff
changeset
|
62 |sign_place()| function. Each sign identifier should be a unique number. If |
0d76dd701e49
patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents:
15334
diff
changeset
|
63 multiple placed signs use the same identifier, then jumping to or removing a |
0d76dd701e49
patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents:
15334
diff
changeset
|
64 sign becomes unpredictable. To avoid overlapping identifiers, sign groups can |
0d76dd701e49
patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents:
15334
diff
changeset
|
65 be used. The |sign_place()| function can be called with a zero sign identifier |
0d76dd701e49
patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents:
15334
diff
changeset
|
66 to allocate the next available identifier. |
0d76dd701e49
patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents:
15334
diff
changeset
|
67 |
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
68 *sign-group* |
15378
0d76dd701e49
patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents:
15334
diff
changeset
|
69 Each placed sign can be assigned to either the global group or a named group. |
0d76dd701e49
patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents:
15334
diff
changeset
|
70 When placing a sign, if a group name is not supplied, or an empty string is |
0d76dd701e49
patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents:
15334
diff
changeset
|
71 used, then the sign is placed in the global group. Otherwise the sign is |
0d76dd701e49
patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents:
15334
diff
changeset
|
72 placed in the named group. The sign identifier is unique within a group. The |
0d76dd701e49
patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents:
15334
diff
changeset
|
73 sign group allows Vim plugins to use unique signs without interfering with |
0d76dd701e49
patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents:
15334
diff
changeset
|
74 other plugins using signs. |
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
75 |
18744
b29d8a06e72c
patch 8.1.2362: cannot place signs in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
18719
diff
changeset
|
76 To place a sign in a popup window the group name must start with "PopUp". |
b29d8a06e72c
patch 8.1.2362: cannot place signs in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
18719
diff
changeset
|
77 Other signs will not show in a popup window. The group name "PopUpMenu" is |
b29d8a06e72c
patch 8.1.2362: cannot place signs in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
18719
diff
changeset
|
78 used by popup windows where 'cursorline' is set. |
b29d8a06e72c
patch 8.1.2362: cannot place signs in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
18719
diff
changeset
|
79 |
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
80 *sign-priority* |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
81 Each placed sign is assigned a priority value. When multiple signs are placed |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
82 on the same line, the attributes of the sign with the highest priority is used |
21499 | 83 independently of the sign group. The default priority for a sign is 10. The |
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
84 priority is assigned at the time of placing a sign. |
7 | 85 |
22824 | 86 When two signs with the same priority are present, and one has an icon or text |
87 in the signcolumn while the other has line highlighting, then both are | |
88 displayed. | |
89 | |
15512 | 90 When the line on which the sign is placed is deleted, the sign is moved to the |
91 next line (or the last line of the buffer, if there is no next line). When | |
92 the delete is undone the sign does not move back. | |
93 | |
22013
125051dff419
patch 8.2.1556: cursorline highlighting always overrules sign highlighting
Bram Moolenaar <Bram@vim.org>
parents:
21499
diff
changeset
|
94 When a sign with line highlighting and 'cursorline' highlighting are both |
125051dff419
patch 8.2.1556: cursorline highlighting always overrules sign highlighting
Bram Moolenaar <Bram@vim.org>
parents:
21499
diff
changeset
|
95 present, if the priority is 100 or more then the sign highlighting takes |
125051dff419
patch 8.2.1556: cursorline highlighting always overrules sign highlighting
Bram Moolenaar <Bram@vim.org>
parents:
21499
diff
changeset
|
96 precedence, otherwise the 'cursorline' highlighting. |
125051dff419
patch 8.2.1556: cursorline highlighting always overrules sign highlighting
Bram Moolenaar <Bram@vim.org>
parents:
21499
diff
changeset
|
97 |
7 | 98 ============================================================================== |
99 2. Commands *sign-commands* *:sig* *:sign* | |
100 | |
2152 | 101 Here is an example that places a sign "piet", displayed with the text ">>", in |
7 | 102 line 23 of the current file: > |
103 :sign define piet text=>> texthl=Search | |
104 :exe ":sign place 2 line=23 name=piet file=" . expand("%:p") | |
105 | |
106 And here is the command to delete it again: > | |
107 :sign unplace 2 | |
108 | |
109 Note that the ":sign" command cannot be followed by another command or a | |
110 comment. If you do need that, use the |:execute| command. | |
111 | |
112 | |
113 DEFINING A SIGN. *:sign-define* *E255* *E160* *E612* | |
114 | |
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
115 See |sign_define()| for the equivalent Vim script function. |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
116 |
7 | 117 :sign define {name} {argument}... |
118 Define a new sign or set attributes for an existing sign. | |
119 The {name} can either be a number (all digits) or a name | |
15334 | 120 starting with a non-digit. Leading zeros are ignored, thus |
2608
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2577
diff
changeset
|
121 "0012", "012" and "12" are considered the same name. |
7 | 122 About 120 different signs can be defined. |
123 | |
124 Accepted arguments: | |
125 | |
3256 | 126 icon={bitmap} |
7 | 127 Define the file name where the bitmap can be found. Should be |
128 a full path. The bitmap should fit in the place of two | |
129 characters. This is not checked. If the bitmap is too big it | |
130 will cause redraw problems. Only GTK 2 can scale the bitmap | |
131 to fit the space available. | |
132 toolkit supports ~ | |
133 GTK 1 pixmap (.xpm) | |
134 GTK 2 many | |
135 Motif pixmap (.xpm) | |
3256 | 136 Win32 .bmp, .ico, .cur |
137 pixmap (.xpm) |+xpm_w32| | |
7 | 138 |
139 linehl={group} | |
140 Highlighting group used for the whole line the sign is placed | |
141 in. Most useful is defining a background color. | |
142 | |
143 text={text} *E239* | |
144 Define the text that is displayed when there is no icon or the | |
145 GUI is not being used. Only printable characters are allowed | |
146 and they must occupy one or two display cells. | |
147 | |
148 texthl={group} | |
149 Highlighting group used for the text item. | |
150 | |
26304 | 151 culhl={group} |
152 Highlighting group used for the text item when the cursor is | |
153 on the same line as the sign and 'cursorline' is enabled. | |
154 | |
24103 | 155 Example: > |
156 :sign define MySign text=>> texthl=Search linehl=DiffText | |
157 < | |
7 | 158 |
159 DELETING A SIGN *:sign-undefine* *E155* | |
160 | |
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
161 See |sign_undefine()| for the equivalent Vim script function. |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
162 |
7 | 163 :sign undefine {name} |
164 Deletes a previously defined sign. If signs with this {name} | |
165 are still placed this will cause trouble. | |
166 | |
24103 | 167 Example: > |
168 :sign undefine MySign | |
169 < | |
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
170 |
7 | 171 LISTING SIGNS *:sign-list* *E156* |
172 | |
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
173 See |sign_getdefined()| for the equivalent Vim script function. |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
174 |
7 | 175 :sign list Lists all defined signs and their attributes. |
176 | |
177 :sign list {name} | |
178 Lists one defined sign and its attributes. | |
179 | |
180 | |
181 PLACING SIGNS *:sign-place* *E158* | |
182 | |
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
183 See |sign_place()| for the equivalent Vim script function. |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
184 |
7 | 185 :sign place {id} line={lnum} name={name} file={fname} |
186 Place sign defined as {name} at line {lnum} in file {fname}. | |
187 *:sign-fname* | |
188 The file {fname} must already be loaded in a buffer. The | |
189 exact file name must be used, wildcards, $ENV and ~ are not | |
190 expanded, white space must not be escaped. Trailing white | |
191 space is ignored. | |
192 | |
193 The sign is remembered under {id}, this can be used for | |
194 further manipulation. {id} must be a number. | |
195 It's up to the user to make sure the {id} is used only once in | |
196 each file (if it's used several times unplacing will also have | |
197 to be done several times and making changes may not work as | |
198 expected). | |
199 | |
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
200 The following optional sign attributes can be specified before |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
201 "file=": |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
202 group={group} Place sign in sign group {group} |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
203 priority={prio} Assign priority {prio} to sign |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
204 |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
205 By default, the sign is placed in the global sign group. |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
206 |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
207 By default, the sign is assigned a default priority of 10. To |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
208 assign a different priority value, use "priority={prio}" to |
16930
1689b52cf297
patch 8.1.1466: not updating priority on existing sign
Bram Moolenaar <Bram@vim.org>
parents:
16553
diff
changeset
|
209 specify a value. The priority is used to determine the sign |
1689b52cf297
patch 8.1.1466: not updating priority on existing sign
Bram Moolenaar <Bram@vim.org>
parents:
16553
diff
changeset
|
210 that is displayed when multiple signs are placed on the same |
1689b52cf297
patch 8.1.1466: not updating priority on existing sign
Bram Moolenaar <Bram@vim.org>
parents:
16553
diff
changeset
|
211 line. |
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
212 |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
213 Examples: > |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
214 :sign place 5 line=3 name=sign1 file=a.py |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
215 :sign place 6 group=g2 line=2 name=sign2 file=x.py |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
216 :sign place 9 group=g2 priority=50 line=5 |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
217 \ name=sign1 file=a.py |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
218 < |
15378
0d76dd701e49
patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents:
15334
diff
changeset
|
219 :sign place {id} line={lnum} name={name} [buffer={nr}] |
0d76dd701e49
patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents:
15334
diff
changeset
|
220 Same, but use buffer {nr}. If the buffer argument is not |
0d76dd701e49
patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents:
15334
diff
changeset
|
221 given, place the sign in the current buffer. |
7 | 222 |
24103 | 223 Example: > |
224 :sign place 10 line=99 name=sign3 | |
225 :sign place 10 line=99 name=sign3 buffer=3 | |
226 < | |
5908 | 227 *E885* |
7 | 228 :sign place {id} name={name} file={fname} |
229 Change the placed sign {id} in file {fname} to use the defined | |
230 sign {name}. See remark above about {fname} |:sign-fname|. | |
231 This can be used to change the displayed sign without moving | |
232 it (e.g., when the debugger has stopped at a breakpoint). | |
233 | |
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
234 The optional "group={group}" attribute can be used before |
16930
1689b52cf297
patch 8.1.1466: not updating priority on existing sign
Bram Moolenaar <Bram@vim.org>
parents:
16553
diff
changeset
|
235 "file=" to select a sign in a particular group. The optional |
1689b52cf297
patch 8.1.1466: not updating priority on existing sign
Bram Moolenaar <Bram@vim.org>
parents:
16553
diff
changeset
|
236 "priority={prio}" attribute can be used to change the priority |
1689b52cf297
patch 8.1.1466: not updating priority on existing sign
Bram Moolenaar <Bram@vim.org>
parents:
16553
diff
changeset
|
237 of an existing sign. |
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
238 |
24103 | 239 Example: > |
240 :sign place 23 name=sign1 file=/path/to/edit.py | |
241 < | |
15378
0d76dd701e49
patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents:
15334
diff
changeset
|
242 :sign place {id} name={name} [buffer={nr}] |
0d76dd701e49
patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents:
15334
diff
changeset
|
243 Same, but use buffer {nr}. If the buffer argument is not |
0d76dd701e49
patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents:
15334
diff
changeset
|
244 given, use the current buffer. |
7 | 245 |
24103 | 246 Example: > |
247 :sign place 23 name=sign1 | |
248 :sign place 23 name=sign1 buffer=7 | |
249 < | |
7 | 250 |
251 REMOVING SIGNS *:sign-unplace* *E159* | |
252 | |
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
253 See |sign_unplace()| for the equivalent Vim script function. |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
254 |
7 | 255 :sign unplace {id} file={fname} |
256 Remove the previously placed sign {id} from file {fname}. | |
257 See remark above about {fname} |:sign-fname|. | |
258 | |
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
259 :sign unplace {id} group={group} file={fname} |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
260 Same but remove the sign {id} in sign group {group}. |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
261 |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
262 :sign unplace {id} group=* file={fname} |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
263 Same but remove the sign {id} from all the sign groups. |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
264 |
3672 | 265 :sign unplace * file={fname} |
266 Remove all placed signs in file {fname}. | |
267 | |
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
268 :sign unplace * group={group} file={fname} |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
269 Remove all placed signs in group {group} from file {fname}. |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
270 |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
271 :sign unplace * group=* file={fname} |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
272 Remove all placed signs in all the groups from file {fname}. |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
273 |
7 | 274 :sign unplace {id} buffer={nr} |
3672 | 275 Remove the previously placed sign {id} from buffer {nr}. |
276 | |
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
277 :sign unplace {id} group={group} buffer={nr} |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
278 Remove the previously placed sign {id} in group {group} from |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
279 buffer {nr}. |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
280 |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
281 :sign unplace {id} group=* buffer={nr} |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
282 Remove the previously placed sign {id} in all the groups from |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
283 buffer {nr}. |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
284 |
3672 | 285 :sign unplace * buffer={nr} |
286 Remove all placed signs in buffer {nr}. | |
7 | 287 |
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
288 :sign unplace * group={group} buffer={nr} |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
289 Remove all placed signs in group {group} from buffer {nr}. |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
290 |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
291 :sign unplace * group=* buffer={nr} |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
292 Remove all placed signs in all the groups from buffer {nr}. |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
293 |
7 | 294 :sign unplace {id} |
295 Remove the previously placed sign {id} from all files it | |
296 appears in. | |
297 | |
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
298 :sign unplace {id} group={group} |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
299 Remove the previously placed sign {id} in group {group} from |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
300 all files it appears in. |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
301 |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
302 :sign unplace {id} group=* |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
303 Remove the previously placed sign {id} in all the groups from |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
304 all the files it appears in. |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
305 |
7 | 306 :sign unplace * |
15418
51b3c36b0523
patch 8.1.0717: there is no function for the ":sign jump" command
Bram Moolenaar <Bram@vim.org>
parents:
15378
diff
changeset
|
307 Remove all placed signs in the global group from all the files. |
15300
890203d87ee5
patch 8.1.0658: deleting signs and completion for :sign is insufficient
Bram Moolenaar <Bram@vim.org>
parents:
15281
diff
changeset
|
308 |
890203d87ee5
patch 8.1.0658: deleting signs and completion for :sign is insufficient
Bram Moolenaar <Bram@vim.org>
parents:
15281
diff
changeset
|
309 :sign unplace * group={group} |
15418
51b3c36b0523
patch 8.1.0717: there is no function for the ":sign jump" command
Bram Moolenaar <Bram@vim.org>
parents:
15378
diff
changeset
|
310 Remove all placed signs in group {group} from all the files. |
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
311 |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
312 :sign unplace * group=* |
15418
51b3c36b0523
patch 8.1.0717: there is no function for the ":sign jump" command
Bram Moolenaar <Bram@vim.org>
parents:
15378
diff
changeset
|
313 Remove all placed signs in all the groups from all the files. |
7 | 314 |
315 :sign unplace | |
15300
890203d87ee5
patch 8.1.0658: deleting signs and completion for :sign is insufficient
Bram Moolenaar <Bram@vim.org>
parents:
15281
diff
changeset
|
316 Remove a placed sign at the cursor position. If multiple signs |
890203d87ee5
patch 8.1.0658: deleting signs and completion for :sign is insufficient
Bram Moolenaar <Bram@vim.org>
parents:
15281
diff
changeset
|
317 are placed in the line, then only one is removed. |
890203d87ee5
patch 8.1.0658: deleting signs and completion for :sign is insufficient
Bram Moolenaar <Bram@vim.org>
parents:
15281
diff
changeset
|
318 |
890203d87ee5
patch 8.1.0658: deleting signs and completion for :sign is insufficient
Bram Moolenaar <Bram@vim.org>
parents:
15281
diff
changeset
|
319 :sign unplace group={group} |
890203d87ee5
patch 8.1.0658: deleting signs and completion for :sign is insufficient
Bram Moolenaar <Bram@vim.org>
parents:
15281
diff
changeset
|
320 Remove a placed sign in group {group} at the cursor |
890203d87ee5
patch 8.1.0658: deleting signs and completion for :sign is insufficient
Bram Moolenaar <Bram@vim.org>
parents:
15281
diff
changeset
|
321 position. |
890203d87ee5
patch 8.1.0658: deleting signs and completion for :sign is insufficient
Bram Moolenaar <Bram@vim.org>
parents:
15281
diff
changeset
|
322 |
890203d87ee5
patch 8.1.0658: deleting signs and completion for :sign is insufficient
Bram Moolenaar <Bram@vim.org>
parents:
15281
diff
changeset
|
323 :sign unplace group=* |
890203d87ee5
patch 8.1.0658: deleting signs and completion for :sign is insufficient
Bram Moolenaar <Bram@vim.org>
parents:
15281
diff
changeset
|
324 Remove a placed sign in any group at the cursor position. |
7 | 325 |
326 | |
5510 | 327 LISTING PLACED SIGNS *:sign-place-list* |
7 | 328 |
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
329 See |sign_getplaced()| for the equivalent Vim script function. |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
330 |
7 | 331 :sign place file={fname} |
332 List signs placed in file {fname}. | |
333 See remark above about {fname} |:sign-fname|. | |
334 | |
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
335 :sign place group={group} file={fname} |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
336 List signs in group {group} placed in file {fname}. |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
337 |
15300
890203d87ee5
patch 8.1.0658: deleting signs and completion for :sign is insufficient
Bram Moolenaar <Bram@vim.org>
parents:
15281
diff
changeset
|
338 :sign place group=* file={fname} |
890203d87ee5
patch 8.1.0658: deleting signs and completion for :sign is insufficient
Bram Moolenaar <Bram@vim.org>
parents:
15281
diff
changeset
|
339 List signs in all the groups placed in file {fname}. |
890203d87ee5
patch 8.1.0658: deleting signs and completion for :sign is insufficient
Bram Moolenaar <Bram@vim.org>
parents:
15281
diff
changeset
|
340 |
7 | 341 :sign place buffer={nr} |
342 List signs placed in buffer {nr}. | |
343 | |
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
344 :sign place group={group} buffer={nr} |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
345 List signs in group {group} placed in buffer {nr}. |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
346 |
15300
890203d87ee5
patch 8.1.0658: deleting signs and completion for :sign is insufficient
Bram Moolenaar <Bram@vim.org>
parents:
15281
diff
changeset
|
347 :sign place group=* buffer={nr} |
890203d87ee5
patch 8.1.0658: deleting signs and completion for :sign is insufficient
Bram Moolenaar <Bram@vim.org>
parents:
15281
diff
changeset
|
348 List signs in all the groups placed in buffer {nr}. |
890203d87ee5
patch 8.1.0658: deleting signs and completion for :sign is insufficient
Bram Moolenaar <Bram@vim.org>
parents:
15281
diff
changeset
|
349 |
890203d87ee5
patch 8.1.0658: deleting signs and completion for :sign is insufficient
Bram Moolenaar <Bram@vim.org>
parents:
15281
diff
changeset
|
350 :sign place List placed signs in the global group in all files. |
890203d87ee5
patch 8.1.0658: deleting signs and completion for :sign is insufficient
Bram Moolenaar <Bram@vim.org>
parents:
15281
diff
changeset
|
351 |
890203d87ee5
patch 8.1.0658: deleting signs and completion for :sign is insufficient
Bram Moolenaar <Bram@vim.org>
parents:
15281
diff
changeset
|
352 :sign place group={group} |
890203d87ee5
patch 8.1.0658: deleting signs and completion for :sign is insufficient
Bram Moolenaar <Bram@vim.org>
parents:
15281
diff
changeset
|
353 List placed signs with sign group {group} in all files. |
7 | 354 |
15281 | 355 :sign place group=* |
356 List placed signs in all sign groups in all files. | |
357 | |
7 | 358 |
359 JUMPING TO A SIGN *:sign-jump* *E157* | |
360 | |
15418
51b3c36b0523
patch 8.1.0717: there is no function for the ":sign jump" command
Bram Moolenaar <Bram@vim.org>
parents:
15378
diff
changeset
|
361 See |sign_jump()| for the equivalent Vim script function. |
51b3c36b0523
patch 8.1.0717: there is no function for the ":sign jump" command
Bram Moolenaar <Bram@vim.org>
parents:
15378
diff
changeset
|
362 |
7 | 363 :sign jump {id} file={fname} |
364 Open the file {fname} or jump to the window that contains | |
365 {fname} and position the cursor at sign {id}. | |
366 See remark above about {fname} |:sign-fname|. | |
367 If the file isn't displayed in window and the current file can | |
368 not be |abandon|ed this fails. | |
369 | |
15300
890203d87ee5
patch 8.1.0658: deleting signs and completion for :sign is insufficient
Bram Moolenaar <Bram@vim.org>
parents:
15281
diff
changeset
|
370 :sign jump {id} group={group} file={fname} |
890203d87ee5
patch 8.1.0658: deleting signs and completion for :sign is insufficient
Bram Moolenaar <Bram@vim.org>
parents:
15281
diff
changeset
|
371 Same but jump to the sign in group {group} |
890203d87ee5
patch 8.1.0658: deleting signs and completion for :sign is insufficient
Bram Moolenaar <Bram@vim.org>
parents:
15281
diff
changeset
|
372 |
15378
0d76dd701e49
patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents:
15334
diff
changeset
|
373 :sign jump {id} [buffer={nr}] *E934* |
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9860
diff
changeset
|
374 Same, but use buffer {nr}. This fails if buffer {nr} does not |
15378
0d76dd701e49
patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents:
15334
diff
changeset
|
375 have a name. If the buffer argument is not given, use the |
0d76dd701e49
patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents:
15334
diff
changeset
|
376 current buffer. |
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9860
diff
changeset
|
377 |
15378
0d76dd701e49
patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents:
15334
diff
changeset
|
378 :sign jump {id} group={group} [buffer={nr}] |
15300
890203d87ee5
patch 8.1.0658: deleting signs and completion for :sign is insufficient
Bram Moolenaar <Bram@vim.org>
parents:
15281
diff
changeset
|
379 Same but jump to the sign in group {group} |
890203d87ee5
patch 8.1.0658: deleting signs and completion for :sign is insufficient
Bram Moolenaar <Bram@vim.org>
parents:
15281
diff
changeset
|
380 |
7 | 381 |
17456
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
382 ============================================================================== |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
383 3. Functions *sign-functions-details* |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
384 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
385 sign_define({name} [, {dict}]) *sign_define()* |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
386 sign_define({list}) |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
387 Define a new sign named {name} or modify the attributes of an |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
388 existing sign. This is similar to the |:sign-define| command. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
389 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
390 Prefix {name} with a unique text to avoid name collisions. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
391 There is no {group} like with placing signs. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
392 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
393 The {name} can be a String or a Number. The optional {dict} |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
394 argument specifies the sign attributes. The following values |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
395 are supported: |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
396 icon full path to the bitmap file for the sign. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
397 linehl highlight group used for the whole line the |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
398 sign is placed in. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
399 text text that is displayed when there is no icon |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
400 or the GUI is not being used. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
401 texthl highlight group used for the text item |
26266
365e7f083f02
patch 8.2.3664: cannot adjust sign highlighting for 'cursorline'
Bram Moolenaar <Bram@vim.org>
parents:
25822
diff
changeset
|
402 culhl highlight group used for the text item when |
365e7f083f02
patch 8.2.3664: cannot adjust sign highlighting for 'cursorline'
Bram Moolenaar <Bram@vim.org>
parents:
25822
diff
changeset
|
403 the cursor is on the same line as the sign and |
365e7f083f02
patch 8.2.3664: cannot adjust sign highlighting for 'cursorline'
Bram Moolenaar <Bram@vim.org>
parents:
25822
diff
changeset
|
404 'cursorline' is enabled. |
17456
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
405 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
406 If the sign named {name} already exists, then the attributes |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
407 of the sign are updated. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
408 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
409 The one argument {list} can be used to define a list of signs. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
410 Each list item is a dictionary with the above items in {dict} |
18719 | 411 and a "name" item for the sign name. |
17456
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
412 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
413 Returns 0 on success and -1 on failure. When the one argument |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
414 {list} is used, then returns a List of values one for each |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
415 defined sign. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
416 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
417 Examples: > |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
418 call sign_define("mySign", { |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
419 \ "text" : "=>", |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
420 \ "texthl" : "Error", |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
421 \ "linehl" : "Search"}) |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
422 call sign_define([ |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
423 \ {'name' : 'sign1', |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
424 \ 'text' : '=>'}, |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
425 \ {'name' : 'sign2', |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
426 \ 'text' : '!!'} |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
427 \ ]) |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
428 < |
17998
ea916dbbb9b9
patch 8.1.1995: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17456
diff
changeset
|
429 Can also be used as a |method|: > |
ea916dbbb9b9
patch 8.1.1995: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17456
diff
changeset
|
430 GetSignList()->sign_define() |
ea916dbbb9b9
patch 8.1.1995: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17456
diff
changeset
|
431 |
17456
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
432 sign_getdefined([{name}]) *sign_getdefined()* |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
433 Get a list of defined signs and their attributes. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
434 This is similar to the |:sign-list| command. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
435 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
436 If the {name} is not supplied, then a list of all the defined |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
437 signs is returned. Otherwise the attribute of the specified |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
438 sign is returned. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
439 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
440 Each list item in the returned value is a dictionary with the |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
441 following entries: |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
442 icon full path to the bitmap file of the sign |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
443 linehl highlight group used for the whole line the |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
444 sign is placed in. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
445 name name of the sign |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
446 text text that is displayed when there is no icon |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
447 or the GUI is not being used. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
448 texthl highlight group used for the text item |
26266
365e7f083f02
patch 8.2.3664: cannot adjust sign highlighting for 'cursorline'
Bram Moolenaar <Bram@vim.org>
parents:
25822
diff
changeset
|
449 culhl highlight group used for the text item when |
365e7f083f02
patch 8.2.3664: cannot adjust sign highlighting for 'cursorline'
Bram Moolenaar <Bram@vim.org>
parents:
25822
diff
changeset
|
450 the cursor is on the same line as the sign and |
365e7f083f02
patch 8.2.3664: cannot adjust sign highlighting for 'cursorline'
Bram Moolenaar <Bram@vim.org>
parents:
25822
diff
changeset
|
451 'cursorline' is enabled. |
17456
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
452 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
453 Returns an empty List if there are no signs and when {name} is |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
454 not found. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
455 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
456 Examples: > |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
457 " Get a list of all the defined signs |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
458 echo sign_getdefined() |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
459 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
460 " Get the attribute of the sign named mySign |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
461 echo sign_getdefined("mySign") |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
462 < |
17998
ea916dbbb9b9
patch 8.1.1995: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17456
diff
changeset
|
463 Can also be used as a |method|: > |
ea916dbbb9b9
patch 8.1.1995: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17456
diff
changeset
|
464 GetSignList()->sign_getdefined() |
ea916dbbb9b9
patch 8.1.1995: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17456
diff
changeset
|
465 |
25619 | 466 sign_getplaced([{buf} [, {dict}]]) *sign_getplaced()* |
17456
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
467 Return a list of signs placed in a buffer or all the buffers. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
468 This is similar to the |:sign-place-list| command. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
469 |
25619 | 470 If the optional buffer name {buf} is specified, then only the |
17456
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
471 list of signs placed in that buffer is returned. For the use |
25619 | 472 of {buf}, see |bufname()|. The optional {dict} can contain |
17456
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
473 the following entries: |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
474 group select only signs in this group |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
475 id select sign with this identifier |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
476 lnum select signs placed in this line. For the use |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
477 of {lnum}, see |line()|. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
478 If {group} is '*', then signs in all the groups including the |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
479 global group are returned. If {group} is not supplied or is an |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
480 empty string, then only signs in the global group are |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
481 returned. If no arguments are supplied, then signs in the |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
482 global group placed in all the buffers are returned. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
483 See |sign-group|. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
484 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
485 Each list item in the returned value is a dictionary with the |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
486 following entries: |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
487 bufnr number of the buffer with the sign |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
488 signs list of signs placed in {bufnr}. Each list |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
489 item is a dictionary with the below listed |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
490 entries |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
491 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
492 The dictionary for each sign contains the following entries: |
22824 | 493 group sign group. Set to '' for the global group. |
494 id identifier of the sign | |
495 lnum line number where the sign is placed | |
496 name name of the defined sign | |
497 priority sign priority | |
17456
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
498 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
499 The returned signs in a buffer are ordered by their line |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
500 number and priority. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
501 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
502 Returns an empty list on failure or if there are no placed |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
503 signs. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
504 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
505 Examples: > |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
506 " Get a List of signs placed in eval.c in the |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
507 " global group |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
508 echo sign_getplaced("eval.c") |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
509 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
510 " Get a List of signs in group 'g1' placed in eval.c |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
511 echo sign_getplaced("eval.c", {'group' : 'g1'}) |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
512 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
513 " Get a List of signs placed at line 10 in eval.c |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
514 echo sign_getplaced("eval.c", {'lnum' : 10}) |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
515 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
516 " Get sign with identifier 10 placed in a.py |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
517 echo sign_getplaced("a.py", {'id' : 10}) |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
518 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
519 " Get sign with id 20 in group 'g1' placed in a.py |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
520 echo sign_getplaced("a.py", {'group' : 'g1', |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
521 \ 'id' : 20}) |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
522 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
523 " Get a List of all the placed signs |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
524 echo sign_getplaced() |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
525 < |
17998
ea916dbbb9b9
patch 8.1.1995: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17456
diff
changeset
|
526 Can also be used as a |method|: > |
ea916dbbb9b9
patch 8.1.1995: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17456
diff
changeset
|
527 GetBufname()->sign_getplaced() |
ea916dbbb9b9
patch 8.1.1995: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17456
diff
changeset
|
528 < |
17456
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
529 *sign_jump()* |
25619 | 530 sign_jump({id}, {group}, {buf}) |
531 Open the buffer {buf} or jump to the window that contains | |
532 {buf} and position the cursor at sign {id} in group {group}. | |
17456
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
533 This is similar to the |:sign-jump| command. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
534 |
25822
42723b535ab3
patch 8.2.3446: not enough tests for empty string arguments
Bram Moolenaar <Bram@vim.org>
parents:
25619
diff
changeset
|
535 If {group} is an empty string, then the global group is used. |
25619 | 536 For the use of {buf}, see |bufname()|. |
17456
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
537 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
538 Returns the line number of the sign. Returns -1 if the |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
539 arguments are invalid. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
540 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
541 Example: > |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
542 " Jump to sign 10 in the current buffer |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
543 call sign_jump(10, '', '') |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
544 < |
17998
ea916dbbb9b9
patch 8.1.1995: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17456
diff
changeset
|
545 Can also be used as a |method|: > |
ea916dbbb9b9
patch 8.1.1995: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17456
diff
changeset
|
546 GetSignid()->sign_jump() |
ea916dbbb9b9
patch 8.1.1995: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17456
diff
changeset
|
547 < |
17456
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
548 *sign_place()* |
25619 | 549 sign_place({id}, {group}, {name}, {buf} [, {dict}]) |
17456
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
550 Place the sign defined as {name} at line {lnum} in file or |
25619 | 551 buffer {buf} and assign {id} and {group} to sign. This is |
17456
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
552 similar to the |:sign-place| command. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
553 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
554 If the sign identifier {id} is zero, then a new identifier is |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
555 allocated. Otherwise the specified number is used. {group} is |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
556 the sign group name. To use the global sign group, use an |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
557 empty string. {group} functions as a namespace for {id}, thus |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
558 two groups can use the same IDs. Refer to |sign-identifier| |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
559 and |sign-group| for more information. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
560 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
561 {name} refers to a defined sign. |
25619 | 562 {buf} refers to a buffer name or number. For the accepted |
17456
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
563 values, see |bufname()|. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
564 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
565 The optional {dict} argument supports the following entries: |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
566 lnum line number in the file or buffer |
25619 | 567 {buf} where the sign is to be placed. |
17456
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
568 For the accepted values, see |line()|. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
569 priority priority of the sign. See |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
570 |sign-priority| for more information. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
571 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
572 If the optional {dict} is not specified, then it modifies the |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
573 placed sign {id} in group {group} to use the defined sign |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
574 {name}. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
575 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
576 Returns the sign identifier on success and -1 on failure. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
577 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
578 Examples: > |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
579 " Place a sign named sign1 with id 5 at line 20 in |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
580 " buffer json.c |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
581 call sign_place(5, '', 'sign1', 'json.c', |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
582 \ {'lnum' : 20}) |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
583 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
584 " Updates sign 5 in buffer json.c to use sign2 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
585 call sign_place(5, '', 'sign2', 'json.c') |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
586 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
587 " Place a sign named sign3 at line 30 in |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
588 " buffer json.c with a new identifier |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
589 let id = sign_place(0, '', 'sign3', 'json.c', |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
590 \ {'lnum' : 30}) |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
591 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
592 " Place a sign named sign4 with id 10 in group 'g3' |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
593 " at line 40 in buffer json.c with priority 90 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
594 call sign_place(10, 'g3', 'sign4', 'json.c', |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
595 \ {'lnum' : 40, 'priority' : 90}) |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
596 < |
17998
ea916dbbb9b9
patch 8.1.1995: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17456
diff
changeset
|
597 Can also be used as a |method|: > |
ea916dbbb9b9
patch 8.1.1995: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17456
diff
changeset
|
598 GetSignid()->sign_place(group, name, expr) |
ea916dbbb9b9
patch 8.1.1995: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17456
diff
changeset
|
599 < |
17456
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
600 *sign_placelist()* |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
601 sign_placelist({list}) |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
602 Place one or more signs. This is similar to the |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
603 |sign_place()| function. The {list} argument specifies the |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
604 List of signs to place. Each list item is a dict with the |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
605 following sign attributes: |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
606 buffer buffer name or number. For the accepted |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
607 values, see |bufname()|. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
608 group sign group. {group} functions as a namespace |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
609 for {id}, thus two groups can use the same |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
610 IDs. If not specified or set to an empty |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
611 string, then the global group is used. See |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
612 |sign-group| for more information. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
613 id sign identifier. If not specified or zero, |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
614 then a new unique identifier is allocated. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
615 Otherwise the specified number is used. See |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
616 |sign-identifier| for more information. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
617 lnum line number in the buffer {expr} where the |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
618 sign is to be placed. For the accepted values, |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
619 see |line()|. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
620 name name of the sign to place. See |sign_define()| |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
621 for more information. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
622 priority priority of the sign. When multiple signs are |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
623 placed on a line, the sign with the highest |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
624 priority is used. If not specified, the |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
625 default value of 10 is used. See |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
626 |sign-priority| for more information. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
627 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
628 If {id} refers to an existing sign, then the existing sign is |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
629 modified to use the specified {name} and/or {priority}. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
630 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
631 Returns a List of sign identifiers. If failed to place a |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
632 sign, the corresponding list item is set to -1. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
633 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
634 Examples: > |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
635 " Place sign s1 with id 5 at line 20 and id 10 at line |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
636 " 30 in buffer a.c |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
637 let [n1, n2] = sign_placelist([ |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
638 \ {'id' : 5, |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
639 \ 'name' : 's1', |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
640 \ 'buffer' : 'a.c', |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
641 \ 'lnum' : 20}, |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
642 \ {'id' : 10, |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
643 \ 'name' : 's1', |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
644 \ 'buffer' : 'a.c', |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
645 \ 'lnum' : 30} |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
646 \ ]) |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
647 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
648 " Place sign s1 in buffer a.c at line 40 and 50 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
649 " with auto-generated identifiers |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
650 let [n1, n2] = sign_placelist([ |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
651 \ {'name' : 's1', |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
652 \ 'buffer' : 'a.c', |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
653 \ 'lnum' : 40}, |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
654 \ {'name' : 's1', |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
655 \ 'buffer' : 'a.c', |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
656 \ 'lnum' : 50} |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
657 \ ]) |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
658 < |
17998
ea916dbbb9b9
patch 8.1.1995: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17456
diff
changeset
|
659 Can also be used as a |method|: > |
ea916dbbb9b9
patch 8.1.1995: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17456
diff
changeset
|
660 GetSignlist()->sign_placelist() |
17456
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
661 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
662 sign_undefine([{name}]) *sign_undefine()* |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
663 sign_undefine({list}) |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
664 Deletes a previously defined sign {name}. This is similar to |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
665 the |:sign-undefine| command. If {name} is not supplied, then |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
666 deletes all the defined signs. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
667 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
668 The one argument {list} can be used to undefine a list of |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
669 signs. Each list item is the name of a sign. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
670 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
671 Returns 0 on success and -1 on failure. For the one argument |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
672 {list} call, returns a list of values one for each undefined |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
673 sign. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
674 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
675 Examples: > |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
676 " Delete a sign named mySign |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
677 call sign_undefine("mySign") |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
678 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
679 " Delete signs 'sign1' and 'sign2' |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
680 call sign_undefine(["sign1", "sign2"]) |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
681 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
682 " Delete all the signs |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
683 call sign_undefine() |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
684 < |
17998
ea916dbbb9b9
patch 8.1.1995: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17456
diff
changeset
|
685 Can also be used as a |method|: > |
ea916dbbb9b9
patch 8.1.1995: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17456
diff
changeset
|
686 GetSignlist()->sign_undefine() |
17456
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
687 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
688 sign_unplace({group} [, {dict}]) *sign_unplace()* |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
689 Remove a previously placed sign in one or more buffers. This |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
690 is similar to the |:sign-unplace| command. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
691 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
692 {group} is the sign group name. To use the global sign group, |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
693 use an empty string. If {group} is set to '*', then all the |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
694 groups including the global group are used. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
695 The signs in {group} are selected based on the entries in |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
696 {dict}. The following optional entries in {dict} are |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
697 supported: |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
698 buffer buffer name or number. See |bufname()|. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
699 id sign identifier |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
700 If {dict} is not supplied, then all the signs in {group} are |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
701 removed. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
702 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
703 Returns 0 on success and -1 on failure. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
704 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
705 Examples: > |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
706 " Remove sign 10 from buffer a.vim |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
707 call sign_unplace('', {'buffer' : "a.vim", 'id' : 10}) |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
708 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
709 " Remove sign 20 in group 'g1' from buffer 3 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
710 call sign_unplace('g1', {'buffer' : 3, 'id' : 20}) |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
711 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
712 " Remove all the signs in group 'g2' from buffer 10 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
713 call sign_unplace('g2', {'buffer' : 10}) |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
714 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
715 " Remove sign 30 in group 'g3' from all the buffers |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
716 call sign_unplace('g3', {'id' : 30}) |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
717 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
718 " Remove all the signs placed in buffer 5 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
719 call sign_unplace('*', {'buffer' : 5}) |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
720 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
721 " Remove the signs in group 'g4' from all the buffers |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
722 call sign_unplace('g4') |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
723 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
724 " Remove sign 40 from all the buffers |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
725 call sign_unplace('*', {'id' : 40}) |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
726 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
727 " Remove all the placed signs from all the buffers |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
728 call sign_unplace('*') |
17998
ea916dbbb9b9
patch 8.1.1995: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17456
diff
changeset
|
729 |
ea916dbbb9b9
patch 8.1.1995: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17456
diff
changeset
|
730 < Can also be used as a |method|: > |
ea916dbbb9b9
patch 8.1.1995: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17456
diff
changeset
|
731 GetSigngroup()->sign_unplace() |
17456
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
732 < |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
733 sign_unplacelist({list}) *sign_unplacelist()* |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
734 Remove previously placed signs from one or more buffers. This |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
735 is similar to the |sign_unplace()| function. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
736 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
737 The {list} argument specifies the List of signs to remove. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
738 Each list item is a dict with the following sign attributes: |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
739 buffer buffer name or number. For the accepted |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
740 values, see |bufname()|. If not specified, |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
741 then the specified sign is removed from all |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
742 the buffers. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
743 group sign group name. If not specified or set to an |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
744 empty string, then the global sign group is |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
745 used. If set to '*', then all the groups |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
746 including the global group are used. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
747 id sign identifier. If not specified, then all |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
748 the signs in the specified group are removed. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
749 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
750 Returns a List where an entry is set to 0 if the corresponding |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
751 sign was successfully removed or -1 on failure. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
752 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
753 Example: > |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
754 " Remove sign with id 10 from buffer a.vim and sign |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
755 " with id 20 from buffer b.vim |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
756 call sign_unplacelist([ |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
757 \ {'id' : 10, 'buffer' : "a.vim"}, |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
758 \ {'id' : 20, 'buffer' : 'b.vim'}, |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
759 \ ]) |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
760 < |
17998
ea916dbbb9b9
patch 8.1.1995: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17456
diff
changeset
|
761 Can also be used as a |method|: > |
ea916dbbb9b9
patch 8.1.1995: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17456
diff
changeset
|
762 GetSignlist()->sign_unplacelist() |
ea916dbbb9b9
patch 8.1.1995: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17456
diff
changeset
|
763 < |
17456
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
764 |
14421 | 765 vim:tw=78:ts=8:noet:ft=help:norl: |