1
- *textprop.txt* For Vim version 9.1. Last change: 2023 Apr 23
1
+ *textprop.txt* For Vim version 9.1. Last change: 2024 Jun 08
2
2
3
3
4
4
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -118,6 +118,8 @@ prop_list({lnum} [, {props}]) text properties in {lnum}
118
118
prop_remove({props} [, {lnum} [, {lnum-end} ]])
119
119
remove a text property
120
120
121
+ *text-prop-functions-details*
122
+
121
123
*prop_add()* *E965*
122
124
prop_add({lnum} , {col} , {props} )
123
125
Attach a text property at position {lnum} , {col} . {col} is
@@ -234,8 +236,10 @@ prop_add({lnum}, {col}, {props})
234
236
Can also be used as a | method | : >
235
237
GetLnum()->prop_add(col, props)
236
238
<
237
- *prop_add_list()*
238
- prop_add_list({props} , [{item} , ...])
239
+ Return type: | Number |
240
+
241
+
242
+ prop_add_list({props} , [{item} , ...]) *prop_add_list()*
239
243
Similar to prop_add(), but attaches a text property at
240
244
multiple positions in a buffer.
241
245
@@ -284,8 +288,10 @@ prop_clear({lnum} [, {lnum-end} [, {props}]]) *prop_clear()*
284
288
Can also be used as a | method | : >
285
289
GetLnum()->prop_clear()
286
290
<
287
- *prop_find()*
288
- prop_find({props} [, {direction} ])
291
+ Return type: | Number |
292
+
293
+
294
+ prop_find({props} [, {direction} ]) *prop_find()*
289
295
Search for a text property as specified with {props} :
290
296
id property with this ID
291
297
type property with this type name
@@ -310,6 +316,8 @@ prop_find({props} [, {direction}])
310
316
as with prop_list(), and additionally an "lnum" entry.
311
317
If no match is found then an empty Dict is returned.
312
318
319
+ Return type: dict<any>
320
+
313
321
314
322
prop_list({lnum} [, {props} ]) *prop_list()*
315
323
Returns a List with all the text properties in line {lnum} .
@@ -380,6 +388,8 @@ prop_list({lnum} [, {props}]) *prop_list()*
380
388
Can also be used as a | method | : >
381
389
GetLnum()->prop_list()
382
390
<
391
+ Return type: list<dict<any> > or list<any>
392
+
383
393
*prop_remove()* *E968* *E860*
384
394
prop_remove({props} [, {lnum} [, {lnum-end} ]])
385
395
Remove a matching text property from line {lnum} . When
@@ -409,6 +419,8 @@ prop_remove({props} [, {lnum} [, {lnum-end}]])
409
419
410
420
Can also be used as a | method | : >
411
421
GetProps()->prop_remove()
422
+ <
423
+ Return type: | Number |
412
424
413
425
414
426
prop_type_add({name} , {props} ) *prop_type_add()* *E969* *E970*
@@ -436,6 +448,9 @@ prop_type_add({name}, {props}) *prop_type_add()* *E969* *E970*
436
448
437
449
Can also be used as a | method | : >
438
450
GetPropName()->prop_type_add(props)
451
+ <
452
+ Return type: | Number |
453
+
439
454
440
455
prop_type_change({name} , {props} ) *prop_type_change()*
441
456
Change properties of an existing text property type. If a
@@ -444,6 +459,9 @@ prop_type_change({name}, {props}) *prop_type_change()*
444
459
445
460
Can also be used as a | method | : >
446
461
GetPropName()->prop_type_change(props)
462
+ <
463
+ Return type: | Number |
464
+
447
465
448
466
prop_type_delete({name} [, {props} ]) *prop_type_delete()*
449
467
Remove the text property type {name} . When text properties
@@ -458,6 +476,9 @@ prop_type_delete({name} [, {props}]) *prop_type_delete()*
458
476
459
477
Can also be used as a | method | : >
460
478
GetPropName()->prop_type_delete()
479
+ <
480
+ Return type: | Number |
481
+
461
482
462
483
prop_type_get({name} [, {props} ]) *prop_type_get()*
463
484
Returns the properties of property type {name} . This is a
@@ -471,13 +492,18 @@ prop_type_get({name} [, {props}]) *prop_type_get()*
471
492
472
493
Can also be used as a | method | : >
473
494
GetPropName()->prop_type_get()
495
+ <
496
+ Return type: dict<any>
497
+
474
498
475
499
prop_type_list([{props} ]) *prop_type_list()*
476
500
Returns a list with all property type names.
477
501
478
502
{props} can contain a "bufnr" item. When it is given, use
479
503
this buffer instead of the global property types.
480
504
505
+ Return type: list<string> or list<any>
506
+
481
507
482
508
==============================================================================
483
509
3. When text changes *text-prop-changes*
0 commit comments