Skip to content

Commit 1071194

Browse files
authored
Merge pull request #1573 from vim-jp/hh-update-textprop
Update textprop.{txt,jax}
2 parents ef5cfe6 + dfd40cb commit 1071194

File tree

2 files changed

+61
-10
lines changed

2 files changed

+61
-10
lines changed

doc/textprop.jax

Lines changed: 30 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*textprop.txt* For Vim バージョン 9.1. Last change: 2023 Apr 23
1+
*textprop.txt* For Vim バージョン 9.1. Last change: 2024 Jun 08
22

33

44
VIMリファレンスマニュアル by Bram Moolenaar
@@ -117,6 +117,8 @@ prop_list({lnum} [, {props}]) 行番号{lnum}のテキストプロパティを
117117
prop_remove({props} [, {lnum} [, {lnum-end}]])
118118
テキストプロパティを削除
119119

120+
*text-prop-functions-details*
121+
120122
*prop_add()* *E965*
121123
prop_add({lnum}, {col}, {props})
122124
{lnum}{col}桁の位置にテキストプロパティを付加する。{col}はバ
@@ -227,8 +229,10 @@ prop_add({lnum}, {col}, {props})
227229
|method| としても使用できる: >
228230
GetLnum()->prop_add(col, props)
229231
<
230-
*prop_add_list()*
231-
prop_add_list({props}, [{item}, ...])
232+
戻り値の型: |Number|
233+
234+
235+
prop_add_list({props}, [{item}, ...]) *prop_add_list()*
232236
prop_add() に似ているが、バッファ内の複数位置にテキストプロパ
233237
ティが付加される。
234238

@@ -281,8 +285,10 @@ prop_clear({lnum} [, {lnum-end} [, {props}]]) *prop_clear()*
281285
|method| としても使用できる: >
282286
GetLnum()->prop_clear()
283287
<
284-
*prop_find()*
285-
prop_find({props} [, {direction}])
288+
戻り値の型: |Number|
289+
290+
291+
prop_find({props} [, {direction}]) *prop_find()*
286292
{props}で指定されたテキストプロパティを検索する:
287293
id プロパティID
288294
type プロパティタイプ名
@@ -304,6 +310,8 @@ prop_find({props} [, {direction}])
304310
"lnum" エントリを併せた辞書が返される。
305311
一致するものが見つからなければ、空の辞書が返される。
306312

313+
戻り値の型: dict<any>
314+
307315

308316
prop_list({lnum} [, {props}]) *prop_list()*
309317
{lnum}行のすべてのテキストプロパティを持つリストを返す。
@@ -375,6 +383,7 @@ prop_list({lnum} [, {props}]) *prop_list()*
375383
|method| としても使用できる: >
376384
GetLnum()->prop_list()
377385
<
386+
戻り値の型: list<dict<any>> または list<any>
378387

379388
*prop_remove()* *E968* *E860*
380389
prop_remove({props} [, {lnum} [, {lnum-end}]])
@@ -408,6 +417,8 @@ prop_remove({props} [, {lnum} [, {lnum-end}]])
408417

409418
|method| としても使用できる: >
410419
GetProps()->prop_remove()
420+
<
421+
戻り値の型: |Number|
411422

412423

413424
prop_type_add({name}, {props}) *prop_type_add()* *E969* *E970*
@@ -433,6 +444,9 @@ prop_type_add({name}, {props}) *prop_type_add()* *E969* *E970*
433444

434445
|method| としても使用できる: >
435446
GetPropName()->prop_type_add(props)
447+
<
448+
戻り値の型: |Number|
449+
436450

437451
prop_type_change({name}, {props}) *prop_type_change()*
438452
既存のテキストプロパティタイプのプロパティを変更する。この名前
@@ -441,6 +455,9 @@ prop_type_change({name}, {props}) *prop_type_change()*
441455

442456
|method| としても使用できる: >
443457
GetPropName()->prop_type_change(props)
458+
<
459+
戻り値の型: |Number|
460+
444461

445462
prop_type_delete({name} [, {props}]) *prop_type_delete()*
446463
テキストプロパティタイプ{name}を削除する。{name}型を使用するテ
@@ -456,6 +473,9 @@ prop_type_delete({name} [, {props}]) *prop_type_delete()*
456473

457474
|method| としても使用できる: >
458475
GetPropName()->prop_type_delete()
476+
<
477+
戻り値の型: |Number|
478+
459479

460480
prop_type_get({name} [, {props}]) *prop_type_get()*
461481
プロパティタイプ{name}のプロパティを返す。これは、
@@ -468,13 +488,18 @@ prop_type_get({name} [, {props}]) *prop_type_get()*
468488

469489
|method| としても使用できる: >
470490
GetPropName()->prop_type_get()
491+
<
492+
戻り値の型: dict<any>
493+
471494

472495
prop_type_list([{props}]) *prop_type_list()*
473496
すべてのプロパティタイプ名のリストを返す。
474497

475498
{props}には "bufnr" 項目を含めることができる。指定すると、グ
476499
ローバルプロパティタイプの代わりにこのバッファを使用する。
477500

501+
戻り値の型: list<string> または list<any>
502+
478503

479504
==============================================================================
480505
3. テキストが変更された場合 *text-prop-changes*

en/textprop.txt

Lines changed: 31 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
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
22

33

44
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -118,6 +118,8 @@ prop_list({lnum} [, {props}]) text properties in {lnum}
118118
prop_remove({props} [, {lnum} [, {lnum-end}]])
119119
remove a text property
120120

121+
*text-prop-functions-details*
122+
121123
*prop_add()* *E965*
122124
prop_add({lnum}, {col}, {props})
123125
Attach a text property at position {lnum}, {col}. {col} is
@@ -234,8 +236,10 @@ prop_add({lnum}, {col}, {props})
234236
Can also be used as a |method|: >
235237
GetLnum()->prop_add(col, props)
236238
<
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()*
239243
Similar to prop_add(), but attaches a text property at
240244
multiple positions in a buffer.
241245

@@ -284,8 +288,10 @@ prop_clear({lnum} [, {lnum-end} [, {props}]]) *prop_clear()*
284288
Can also be used as a |method|: >
285289
GetLnum()->prop_clear()
286290
<
287-
*prop_find()*
288-
prop_find({props} [, {direction}])
291+
Return type: |Number|
292+
293+
294+
prop_find({props} [, {direction}]) *prop_find()*
289295
Search for a text property as specified with {props}:
290296
id property with this ID
291297
type property with this type name
@@ -310,6 +316,8 @@ prop_find({props} [, {direction}])
310316
as with prop_list(), and additionally an "lnum" entry.
311317
If no match is found then an empty Dict is returned.
312318

319+
Return type: dict<any>
320+
313321

314322
prop_list({lnum} [, {props}]) *prop_list()*
315323
Returns a List with all the text properties in line {lnum}.
@@ -380,6 +388,8 @@ prop_list({lnum} [, {props}]) *prop_list()*
380388
Can also be used as a |method|: >
381389
GetLnum()->prop_list()
382390
<
391+
Return type: list<dict<any>> or list<any>
392+
383393
*prop_remove()* *E968* *E860*
384394
prop_remove({props} [, {lnum} [, {lnum-end}]])
385395
Remove a matching text property from line {lnum}. When
@@ -409,6 +419,8 @@ prop_remove({props} [, {lnum} [, {lnum-end}]])
409419

410420
Can also be used as a |method|: >
411421
GetProps()->prop_remove()
422+
<
423+
Return type: |Number|
412424

413425

414426
prop_type_add({name}, {props}) *prop_type_add()* *E969* *E970*
@@ -436,6 +448,9 @@ prop_type_add({name}, {props}) *prop_type_add()* *E969* *E970*
436448

437449
Can also be used as a |method|: >
438450
GetPropName()->prop_type_add(props)
451+
<
452+
Return type: |Number|
453+
439454

440455
prop_type_change({name}, {props}) *prop_type_change()*
441456
Change properties of an existing text property type. If a
@@ -444,6 +459,9 @@ prop_type_change({name}, {props}) *prop_type_change()*
444459

445460
Can also be used as a |method|: >
446461
GetPropName()->prop_type_change(props)
462+
<
463+
Return type: |Number|
464+
447465

448466
prop_type_delete({name} [, {props}]) *prop_type_delete()*
449467
Remove the text property type {name}. When text properties
@@ -458,6 +476,9 @@ prop_type_delete({name} [, {props}]) *prop_type_delete()*
458476

459477
Can also be used as a |method|: >
460478
GetPropName()->prop_type_delete()
479+
<
480+
Return type: |Number|
481+
461482

462483
prop_type_get({name} [, {props}]) *prop_type_get()*
463484
Returns the properties of property type {name}. This is a
@@ -471,13 +492,18 @@ prop_type_get({name} [, {props}]) *prop_type_get()*
471492

472493
Can also be used as a |method|: >
473494
GetPropName()->prop_type_get()
495+
<
496+
Return type: dict<any>
497+
474498

475499
prop_type_list([{props}]) *prop_type_list()*
476500
Returns a list with all property type names.
477501

478502
{props} can contain a "bufnr" item. When it is given, use
479503
this buffer instead of the global property types.
480504

505+
Return type: list<string> or list<any>
506+
481507

482508
==============================================================================
483509
3. When text changes *text-prop-changes*

0 commit comments

Comments
 (0)