Mercurial > vim
annotate runtime/doc/sign.txt @ 18744:b29d8a06e72c v8.1.2362
patch 8.1.2362: cannot place signs in a popup window
Commit: https://github.com/vim/vim/commit/7257073043252c2e01c8e168e6842a1121797243
Author: Bram Moolenaar <Bram@vim.org>
Date: Sat Nov 30 14:21:53 2019 +0100
patch 8.1.2362: cannot place signs in a popup window
Problem: Cannot place signs in a popup window. (Maxim Kim)
Solution: Use the group prefix "PopUp" to specify which signs should show up
in a popup window. (closes #5277)
author | Bram Moolenaar <Bram@vim.org> |
---|---|
date | Sat, 30 Nov 2019 14:30:05 +0100 |
parents | 99586852c2db |
children | 82a28df1e2d5 |
rev | line source |
---|---|
18615 | 1 *sign.txt* For Vim version 8.1. Last change: 2019 Nov 12 |
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 < |
15378
0d76dd701e49
patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents:
15334
diff
changeset
|
56 *sign-identifier* |
0d76dd701e49
patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents:
15334
diff
changeset
|
57 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
|
58 identifier is used to jump to the sign or to remove the sign. The identifier |
15512 | 59 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
|
60 |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
|
61 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
|
62 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
|
63 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
|
64 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
|
65 |
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
66 *sign-group* |
15378
0d76dd701e49
patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents:
15334
diff
changeset
|
67 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
|
68 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
|
69 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
|
70 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
|
71 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
|
72 other plugins using signs. |
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
73 |
18615 | 74 The group name "popupmenu" is used by popup windows where 'cursorline' is set. |
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 |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
83 independent of the sign group. The default priority for a sign is 10. The |
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 |
15512 | 86 When the line on which the sign is placed is deleted, the sign is moved to the |
87 next line (or the last line of the buffer, if there is no next line). When | |
88 the delete is undone the sign does not move back. | |
89 | |
7 | 90 ============================================================================== |
91 2. Commands *sign-commands* *:sig* *:sign* | |
92 | |
2152 | 93 Here is an example that places a sign "piet", displayed with the text ">>", in |
7 | 94 line 23 of the current file: > |
95 :sign define piet text=>> texthl=Search | |
96 :exe ":sign place 2 line=23 name=piet file=" . expand("%:p") | |
97 | |
98 And here is the command to delete it again: > | |
99 :sign unplace 2 | |
100 | |
101 Note that the ":sign" command cannot be followed by another command or a | |
102 comment. If you do need that, use the |:execute| command. | |
103 | |
104 | |
105 DEFINING A SIGN. *:sign-define* *E255* *E160* *E612* | |
106 | |
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
107 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
|
108 |
7 | 109 :sign define {name} {argument}... |
110 Define a new sign or set attributes for an existing sign. | |
111 The {name} can either be a number (all digits) or a name | |
15334 | 112 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
|
113 "0012", "012" and "12" are considered the same name. |
7 | 114 About 120 different signs can be defined. |
115 | |
116 Accepted arguments: | |
117 | |
3256 | 118 icon={bitmap} |
7 | 119 Define the file name where the bitmap can be found. Should be |
120 a full path. The bitmap should fit in the place of two | |
121 characters. This is not checked. If the bitmap is too big it | |
122 will cause redraw problems. Only GTK 2 can scale the bitmap | |
123 to fit the space available. | |
124 toolkit supports ~ | |
125 GTK 1 pixmap (.xpm) | |
126 GTK 2 many | |
127 Motif pixmap (.xpm) | |
3256 | 128 Win32 .bmp, .ico, .cur |
129 pixmap (.xpm) |+xpm_w32| | |
7 | 130 |
131 linehl={group} | |
132 Highlighting group used for the whole line the sign is placed | |
133 in. Most useful is defining a background color. | |
134 | |
135 text={text} *E239* | |
136 Define the text that is displayed when there is no icon or the | |
137 GUI is not being used. Only printable characters are allowed | |
138 and they must occupy one or two display cells. | |
139 | |
140 texthl={group} | |
141 Highlighting group used for the text item. | |
142 | |
143 | |
144 DELETING A SIGN *:sign-undefine* *E155* | |
145 | |
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
146 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
|
147 |
7 | 148 :sign undefine {name} |
149 Deletes a previously defined sign. If signs with this {name} | |
150 are still placed this will cause trouble. | |
151 | |
152 | |
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
153 |
7 | 154 LISTING SIGNS *:sign-list* *E156* |
155 | |
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
156 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
|
157 |
7 | 158 :sign list Lists all defined signs and their attributes. |
159 | |
160 :sign list {name} | |
161 Lists one defined sign and its attributes. | |
162 | |
163 | |
164 PLACING SIGNS *:sign-place* *E158* | |
165 | |
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
166 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
|
167 |
7 | 168 :sign place {id} line={lnum} name={name} file={fname} |
169 Place sign defined as {name} at line {lnum} in file {fname}. | |
170 *:sign-fname* | |
171 The file {fname} must already be loaded in a buffer. The | |
172 exact file name must be used, wildcards, $ENV and ~ are not | |
173 expanded, white space must not be escaped. Trailing white | |
174 space is ignored. | |
175 | |
176 The sign is remembered under {id}, this can be used for | |
177 further manipulation. {id} must be a number. | |
178 It's up to the user to make sure the {id} is used only once in | |
179 each file (if it's used several times unplacing will also have | |
180 to be done several times and making changes may not work as | |
181 expected). | |
182 | |
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
183 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
|
184 "file=": |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
185 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
|
186 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
|
187 |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
188 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
|
189 |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
190 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
|
191 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
|
192 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
|
193 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
|
194 line. |
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
195 |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
196 Examples: > |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
197 :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
|
198 :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
|
199 :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
|
200 \ name=sign1 file=a.py |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
201 < |
15378
0d76dd701e49
patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents:
15334
diff
changeset
|
202 :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
|
203 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
|
204 given, place the sign in the current buffer. |
7 | 205 |
5908 | 206 *E885* |
7 | 207 :sign place {id} name={name} file={fname} |
208 Change the placed sign {id} in file {fname} to use the defined | |
209 sign {name}. See remark above about {fname} |:sign-fname|. | |
210 This can be used to change the displayed sign without moving | |
211 it (e.g., when the debugger has stopped at a breakpoint). | |
212 | |
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
213 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
|
214 "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
|
215 "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
|
216 of an existing sign. |
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
217 |
15378
0d76dd701e49
patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents:
15334
diff
changeset
|
218 :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
|
219 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
|
220 given, use the current buffer. |
7 | 221 |
222 | |
223 REMOVING SIGNS *:sign-unplace* *E159* | |
224 | |
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
225 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
|
226 |
7 | 227 :sign unplace {id} file={fname} |
228 Remove the previously placed sign {id} from file {fname}. | |
229 See remark above about {fname} |:sign-fname|. | |
230 | |
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
231 :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
|
232 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
|
233 |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
234 :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
|
235 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
|
236 |
3672 | 237 :sign unplace * file={fname} |
238 Remove all placed signs in file {fname}. | |
239 | |
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
240 :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
|
241 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
|
242 |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
243 :sign unplace * group=* file={fname} |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
244 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
|
245 |
7 | 246 :sign unplace {id} buffer={nr} |
3672 | 247 Remove the previously placed sign {id} from buffer {nr}. |
248 | |
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
249 :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
|
250 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
|
251 buffer {nr}. |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
252 |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
253 :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
|
254 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
|
255 buffer {nr}. |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
256 |
3672 | 257 :sign unplace * buffer={nr} |
258 Remove all placed signs in buffer {nr}. | |
7 | 259 |
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
260 :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
|
261 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
|
262 |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
263 :sign unplace * group=* buffer={nr} |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
264 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
|
265 |
7 | 266 :sign unplace {id} |
267 Remove the previously placed sign {id} from all files it | |
268 appears in. | |
269 | |
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
270 :sign unplace {id} group={group} |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
271 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
|
272 all files it appears in. |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
273 |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
274 :sign unplace {id} group=* |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
275 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
|
276 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
|
277 |
7 | 278 :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
|
279 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
|
280 |
890203d87ee5
patch 8.1.0658: deleting signs and completion for :sign is insufficient
Bram Moolenaar <Bram@vim.org>
parents:
15281
diff
changeset
|
281 :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
|
282 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
|
283 |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
284 :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
|
285 Remove all placed signs in all the groups from all the files. |
7 | 286 |
287 :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
|
288 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
|
289 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
|
290 |
890203d87ee5
patch 8.1.0658: deleting signs and completion for :sign is insufficient
Bram Moolenaar <Bram@vim.org>
parents:
15281
diff
changeset
|
291 :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
|
292 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
|
293 position. |
890203d87ee5
patch 8.1.0658: deleting signs and completion for :sign is insufficient
Bram Moolenaar <Bram@vim.org>
parents:
15281
diff
changeset
|
294 |
890203d87ee5
patch 8.1.0658: deleting signs and completion for :sign is insufficient
Bram Moolenaar <Bram@vim.org>
parents:
15281
diff
changeset
|
295 :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
|
296 Remove a placed sign in any group at the cursor position. |
7 | 297 |
298 | |
5510 | 299 LISTING PLACED SIGNS *:sign-place-list* |
7 | 300 |
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
301 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
|
302 |
7 | 303 :sign place file={fname} |
304 List signs placed in file {fname}. | |
305 See remark above about {fname} |:sign-fname|. | |
306 | |
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
307 :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
|
308 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
|
309 |
15300
890203d87ee5
patch 8.1.0658: deleting signs and completion for :sign is insufficient
Bram Moolenaar <Bram@vim.org>
parents:
15281
diff
changeset
|
310 :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
|
311 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
|
312 |
7 | 313 :sign place buffer={nr} |
314 List signs placed in buffer {nr}. | |
315 | |
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
14421
diff
changeset
|
316 :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
|
317 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
|
318 |
15300
890203d87ee5
patch 8.1.0658: deleting signs and completion for :sign is insufficient
Bram Moolenaar <Bram@vim.org>
parents:
15281
diff
changeset
|
319 :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
|
320 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
|
321 |
890203d87ee5
patch 8.1.0658: deleting signs and completion for :sign is insufficient
Bram Moolenaar <Bram@vim.org>
parents:
15281
diff
changeset
|
322 :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
|
323 |
890203d87ee5
patch 8.1.0658: deleting signs and completion for :sign is insufficient
Bram Moolenaar <Bram@vim.org>
parents:
15281
diff
changeset
|
324 :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
|
325 List placed signs with sign group {group} in all files. |
7 | 326 |
15281 | 327 :sign place group=* |
328 List placed signs in all sign groups in all files. | |
329 | |
7 | 330 |
331 JUMPING TO A SIGN *:sign-jump* *E157* | |
332 | |
15418
51b3c36b0523
patch 8.1.0717: there is no function for the ":sign jump" command
Bram Moolenaar <Bram@vim.org>
parents:
15378
diff
changeset
|
333 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
|
334 |
7 | 335 :sign jump {id} file={fname} |
336 Open the file {fname} or jump to the window that contains | |
337 {fname} and position the cursor at sign {id}. | |
338 See remark above about {fname} |:sign-fname|. | |
339 If the file isn't displayed in window and the current file can | |
340 not be |abandon|ed this fails. | |
341 | |
15300
890203d87ee5
patch 8.1.0658: deleting signs and completion for :sign is insufficient
Bram Moolenaar <Bram@vim.org>
parents:
15281
diff
changeset
|
342 :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
|
343 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
|
344 |
15378
0d76dd701e49
patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents:
15334
diff
changeset
|
345 :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
|
346 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
|
347 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
|
348 current buffer. |
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9860
diff
changeset
|
349 |
15378
0d76dd701e49
patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents:
15334
diff
changeset
|
350 :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
|
351 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
|
352 |
7 | 353 |
17456
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
354 ============================================================================== |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
355 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
|
356 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
357 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
|
358 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
|
359 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
|
360 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
|
361 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
362 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
|
363 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
|
364 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
365 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
|
366 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
|
367 are supported: |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
368 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
|
369 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
|
370 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
|
371 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
|
372 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
|
373 texthl highlight group used for the text item |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
374 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
375 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
|
376 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
|
377 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
378 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
|
379 Each list item is a dictionary with the above items in {dict} |
18719 | 380 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
|
381 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
382 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
|
383 {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
|
384 defined sign. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
385 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
386 Examples: > |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
387 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
|
388 \ "text" : "=>", |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
389 \ "texthl" : "Error", |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
390 \ "linehl" : "Search"}) |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
391 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
|
392 \ {'name' : 'sign1', |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
393 \ 'text' : '=>'}, |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
394 \ {'name' : 'sign2', |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
395 \ 'text' : '!!'} |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
396 \ ]) |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
397 < |
17998
ea916dbbb9b9
patch 8.1.1995: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17456
diff
changeset
|
398 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
|
399 GetSignList()->sign_define() |
ea916dbbb9b9
patch 8.1.1995: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17456
diff
changeset
|
400 |
17456
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
401 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
|
402 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
|
403 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
|
404 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
405 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
|
406 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
|
407 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
|
408 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
409 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
|
410 following entries: |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
411 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
|
412 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
|
413 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
|
414 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
|
415 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
|
416 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
|
417 texthl highlight group used for the text item |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
418 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
419 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
|
420 not found. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
421 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
422 Examples: > |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
423 " 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
|
424 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
|
425 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
426 " 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
|
427 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
|
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_getdefined() |
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_getplaced([{expr} [, {dict}]]) *sign_getplaced()* |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
433 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
|
434 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
|
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 optional buffer name {expr} is specified, then only the |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
437 list of signs placed in that buffer is returned. 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
|
438 of {expr}, see |bufname()|. The optional {dict} can contain |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
439 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
|
440 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
|
441 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
|
442 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
|
443 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
|
444 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
|
445 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
|
446 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
|
447 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
|
448 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
|
449 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
|
450 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
451 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
|
452 following entries: |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
453 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
|
454 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
|
455 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
|
456 entries |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
457 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
458 The dictionary for each sign contains 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
|
459 group sign group. Set to '' for the global group. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
460 id identifier 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
|
461 lnum line number where the sign is placed |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
462 name name of 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
|
463 priority sign priority |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
464 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
465 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
|
466 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
|
467 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
468 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
|
469 signs. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
470 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
471 Examples: > |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
472 " 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
|
473 " global group |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
474 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
|
475 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
476 " 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
|
477 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
|
478 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
479 " 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
|
480 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
|
481 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
482 " 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
|
483 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
|
484 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
485 " 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
|
486 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
|
487 \ 'id' : 20}) |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
488 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
489 " 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
|
490 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
|
491 < |
17998
ea916dbbb9b9
patch 8.1.1995: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17456
diff
changeset
|
492 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
|
493 GetBufname()->sign_getplaced() |
ea916dbbb9b9
patch 8.1.1995: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17456
diff
changeset
|
494 < |
17456
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
495 *sign_jump()* |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
496 sign_jump({id}, {group}, {expr}) |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
497 Open the buffer {expr} or jump to the window that contains |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
498 {expr} and position the cursor at sign {id} in group {group}. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
499 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
|
500 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
501 For the use of {expr}, see |bufname()|. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
502 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
503 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
|
504 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
|
505 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
506 Example: > |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
507 " 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
|
508 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
|
509 < |
17998
ea916dbbb9b9
patch 8.1.1995: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17456
diff
changeset
|
510 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
|
511 GetSignid()->sign_jump() |
ea916dbbb9b9
patch 8.1.1995: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17456
diff
changeset
|
512 < |
17456
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
513 *sign_place()* |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
514 sign_place({id}, {group}, {name}, {expr} [, {dict}]) |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
515 Place the sign defined as {name} at line {lnum} in file or |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
516 buffer {expr} and assign {id} and {group} to sign. This is |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
517 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
|
518 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
519 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
|
520 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
|
521 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
|
522 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
|
523 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
|
524 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
|
525 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
526 {name} refers to a defined sign. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
527 {expr} refers to a 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
|
528 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
|
529 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
530 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
|
531 lnum line number in the file or buffer |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
532 {expr} where the sign is to be placed. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
533 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
|
534 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
|
535 |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
|
536 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
537 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
|
538 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
|
539 {name}. |
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 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
|
542 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
543 Examples: > |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
544 " 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
|
545 " 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
|
546 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
|
547 \ {'lnum' : 20}) |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
548 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
549 " 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
|
550 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
|
551 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
552 " 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
|
553 " 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
|
554 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
|
555 \ {'lnum' : 30}) |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
556 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
557 " 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
|
558 " 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
|
559 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
|
560 \ {'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
|
561 < |
17998
ea916dbbb9b9
patch 8.1.1995: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17456
diff
changeset
|
562 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
|
563 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
|
564 < |
17456
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
565 *sign_placelist()* |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
566 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
|
567 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
|
568 |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
|
569 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
|
570 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
|
571 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
|
572 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
|
573 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
|
574 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
|
575 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
|
576 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
|
577 |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
|
578 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
|
579 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
|
580 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
|
581 |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
|
582 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
|
583 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
|
584 see |line()|. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
585 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
|
586 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
|
587 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
|
588 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
|
589 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
|
590 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
|
591 |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
|
592 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
593 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
|
594 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
|
595 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
596 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
|
597 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
|
598 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
599 Examples: > |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
600 " 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
|
601 " 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
|
602 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
|
603 \ {'id' : 5, |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
604 \ 'name' : 's1', |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
605 \ '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
|
606 \ 'lnum' : 20}, |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
607 \ {'id' : 10, |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
608 \ 'name' : 's1', |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
609 \ '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
|
610 \ 'lnum' : 30} |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
611 \ ]) |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
612 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
613 " 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
|
614 " 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
|
615 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
|
616 \ {'name' : 's1', |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
617 \ '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
|
618 \ 'lnum' : 40}, |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
619 \ {'name' : 's1', |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
620 \ '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
|
621 \ 'lnum' : 50} |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
622 \ ]) |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
623 < |
17998
ea916dbbb9b9
patch 8.1.1995: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17456
diff
changeset
|
624 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
|
625 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
|
626 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
627 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
|
628 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
|
629 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
|
630 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
|
631 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
|
632 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
633 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
|
634 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
|
635 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
636 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
|
637 {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
|
638 sign. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
639 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
640 Examples: > |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
641 " 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
|
642 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
|
643 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
644 " 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
|
645 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
|
646 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
647 " 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
|
648 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
|
649 < |
17998
ea916dbbb9b9
patch 8.1.1995: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17456
diff
changeset
|
650 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
|
651 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
|
652 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
653 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
|
654 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
|
655 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
|
656 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
657 {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
|
658 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
|
659 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
|
660 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
|
661 {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
|
662 supported: |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
663 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
|
664 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
|
665 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
|
666 removed. |
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 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
|
669 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
670 Examples: > |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
671 " 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
|
672 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
|
673 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
674 " 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
|
675 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
|
676 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
677 " 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
|
678 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
|
679 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
680 " 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
|
681 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
|
682 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
683 " 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
|
684 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
|
685 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
686 " 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
|
687 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
|
688 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
689 " 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
|
690 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
|
691 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
692 " 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
|
693 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
|
694 |
ea916dbbb9b9
patch 8.1.1995: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17456
diff
changeset
|
695 < 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
|
696 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
|
697 < |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
698 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
|
699 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
|
700 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
|
701 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
702 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
|
703 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
|
704 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
|
705 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
|
706 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
|
707 the buffers. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
708 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
|
709 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
|
710 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
|
711 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
|
712 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
|
713 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
|
714 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
715 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
|
716 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
|
717 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
718 Example: > |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
719 " 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
|
720 " 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
|
721 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
|
722 \ {'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
|
723 \ {'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
|
724 \ ]) |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
725 < |
17998
ea916dbbb9b9
patch 8.1.1995: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17456
diff
changeset
|
726 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
|
727 GetSignlist()->sign_unplacelist() |
ea916dbbb9b9
patch 8.1.1995: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17456
diff
changeset
|
728 < |
17456
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
729 |
14421 | 730 vim:tw=78:ts=8:noet:ft=help:norl: |