Skip to content

Commit 3576cbd

Browse files
authored
Merge pull request #1571 from vim-jp/hh-update-popup
Update popup.{txt,jax}
2 parents 1071194 + b51ea40 commit 3576cbd

File tree

2 files changed

+97
-2
lines changed

2 files changed

+97
-2
lines changed

doc/popup.jax

Lines changed: 51 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*popup.txt* For Vim バージョン 9.1. Last change: 2022 Oct 07
1+
*popup.txt* For Vim バージョン 9.1. Last change: 2024 Jun 08
22

33

44
VIMリファレンスマニュアル by Bram Moolenaar
@@ -220,6 +220,8 @@ popup_atcursor({what}, {options}) *popup_atcursor()*
220220

221221
|method| としても使用できる: >
222222
GetText()->popup_atcursor({})
223+
<
224+
戻り値の型: |Number|
223225

224226

225227
popup_beval({what}, {options}) *popup_beval()*
@@ -238,6 +240,8 @@ popup_beval({what}, {options}) *popup_beval()*
238240
|method| としても使用できる: >
239241
GetText()->popup_beval({})
240242
<
243+
戻り値の型: |Number|
244+
241245
*popup_clear()*
242246
popup_clear([{force}])
243247
不作法にふるまうプラグインに対する緊急の解決策: グローバルポッ
@@ -249,6 +253,8 @@ popup_clear([{force}])
249253
ポップアップになっていても閉じられる。ポップアップで端末が動作
250254
しているなら強制終了される。
251255

256+
戻り値の型: |Number|
257+
252258

253259
popup_close({id} [, {result}]) *popup_close()*
254260
ポップアップ {id} を閉じる。ウィンドウと関連するバッファは削除
@@ -261,6 +267,8 @@ popup_close({id} [, {result}]) *popup_close()*
261267

262268
|method| としても使用できる: >
263269
GetPopup()->popup_close()
270+
<
271+
戻り値の型: |Number|
264272

265273

266274
popup_create({what}, {options}) *popup_create()*
@@ -293,6 +301,8 @@ popup_create({what}, {options}) *popup_create()*
293301

294302
|method| としても使用できる: >
295303
GetText()->popup_create({})
304+
<
305+
戻り値の型: |Number|
296306

297307

298308
popup_dialog({what}, {options}) *popup_dialog()*
@@ -319,6 +329,8 @@ popup_dialog({what}, {options}) *popup_dialog()*
319329

320330
|method| としても使用できる: >
321331
GetText()->popup_dialog({})
332+
<
333+
戻り値の型: |Number|
322334

323335

324336
popup_filter_menu({id}, {key}) *popup_filter_menu()*
@@ -341,6 +353,9 @@ popup_filter_menu({id}, {key}) *popup_filter_menu()*
341353
ショートカットキーを追加する場合
342354
|popup_menu-shortcut-example| を参照。
343355

356+
戻り値の型: |Number|
357+
358+
344359
popup_filter_yesno({id}, {key}) *popup_filter_yesno()*
345360
ポップアップに使用できるフィルタ。キー 'y'、'Y' および 'n' ま
346361
たは 'N' のみを処理する。第2引数として 'y' または 'Y' に1、'n'
@@ -350,12 +365,17 @@ popup_filter_yesno({id}, {key}) *popup_filter_yesno()*
350365
れる。
351366
|popup_dialog-example| を参照。
352367

368+
戻り値の型: |Number|
369+
353370

354371
popup_findecho() *popup_findecho()*
355372
メッセージを表示している `:echowindow` コマンドのポップアップ
356373
|window-ID| を取得する。存在しなければ0を返す。
357374
主にポップアップを非表示にするのに便利である。
358375

376+
戻り値の型: |Number|
377+
378+
359379
popup_findinfo() *popup_findinfo()*
360380
ポップアップメニューで使用されているポップアップ情報ウィンドウ
361381
|window-ID| を取得する。|complete-popup| を参照。ポップアッ
@@ -364,11 +384,16 @@ popup_findinfo() *popup_findinfo()*
364384
目に再配置するには |popup_show()| を使用する。
365385
ない場合は 0 を返す。
366386

387+
戻り値の型: |Number|
388+
367389

368390
popup_findpreview() *popup_findpreview()*
369391
ポップアッププレビューウィンドウの |window-ID| を取得する。
370392
ない場合は 0 を返す。
371393

394+
戻り値の型: |Number|
395+
396+
372397
popup_getoptions({id}) *popup_getoptions()*
373398
popup {id}{options} を辞書で返す。
374399
ゼロ値はオプションが設定されなかったことを意味する。"zindex"
@@ -403,6 +428,8 @@ popup_getoptions({id}) *popup_getoptions()*
403428

404429
|method| としても使用できる: >
405430
GetPopup()->popup_getoptions()
431+
<
432+
戻り値の型: dict<any>
406433

407434

408435
popup_getpos({id}) *popup_getpos()*
@@ -433,6 +460,8 @@ popup_getpos({id}) *popup_getpos()*
433460

434461
|method| としても使用できる: >
435462
GetPopup()->popup_getpos()
463+
<
464+
戻り値の型: dict<number> または dict<any>
436465

437466

438467
popup_hide({id}) *popup_hide()*
@@ -447,15 +476,24 @@ popup_hide({id}) *popup_hide()*
447476

448477
|method| としても使用できる: >
449478
GetPopup()->popup_hide()
479+
<
480+
戻り値の型: |Number|
481+
450482

451483
popup_list() *popup_list()*
452484
存在する全ポップアップの |window-ID| のリストを返す。
453485

486+
戻り値の型: list<number> または list<any>
487+
488+
454489
popup_locate({row}, {col}) *popup_locate()*
455490
画面位置 {row} および {col} のポップアップの |window-ID| を返
456491
す。複数のポップアップがある場合、最も高い zindex のポップアッ
457492
プが返される。この位置にポップアップがない場合、0 が返される。
458493

494+
戻り値の型: |Number|
495+
496+
459497
popup_menu({what}, {options}) *popup_menu()*
460498
カーソルの近くに {what} を表示し、カーソルキーで項目の1つを選
461499
択して処理し、それを閉じるには、SpaceまたはEnterで項目を選択す
@@ -487,6 +525,8 @@ popup_menu({what}, {options}) *popup_menu()*
487525
488526
< |method| としても使用できる: >
489527
GetChoices()->popup_menu({})
528+
<
529+
戻り値の型: |Number|
490530

491531

492532
popup_move({id}, {options}) *popup_move()*
@@ -506,6 +546,8 @@ popup_move({id}, {options}) *popup_move()*
506546

507547
|method| としても使用できる: >
508548
GetPopup()->popup_move(options)
549+
<
550+
戻り値の型: |Number|
509551

510552

511553
popup_notification({what}, {options}) *popup_notification()*
@@ -535,6 +577,8 @@ popup_notification({what}, {options}) *popup_notification()*
535577

536578
|method| としても使用できる: >
537579
GetText()->popup_notification({})
580+
<
581+
戻り値の型: |Number|
538582

539583

540584
popup_setoptions({id}, {options}) *popup_setoptions()*
@@ -572,6 +616,8 @@ popup_setoptions({id}, {options}) *popup_setoptions()*
572616

573617
|method| としても使用できる: >
574618
GetPopup()->popup_setoptions(options)
619+
<
620+
戻り値の型: |Number|
575621

576622

577623
popup_settext({id}, {text}) *popup_settext()*
@@ -583,6 +629,8 @@ popup_settext({id}, {text}) *popup_settext()*
583629

584630
|method| としても使用できる: >
585631
GetPopup()->popup_settext('hello')
632+
<
633+
戻り値の型: |Number|
586634

587635

588636
popup_show({id}) *popup_show()*
@@ -591,6 +639,8 @@ popup_show({id}) *popup_show()*
591639
{id} が情報ポップアップの場合、現在のポップアップメニュー項目
592640
の隣に配置される。
593641

642+
戻り値の型: |Number|
643+
594644

595645
==============================================================================
596646
3. 使用方法 *popup-usage*

0 commit comments

Comments
 (0)