dialogs.d.ts 6.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143
  1. /**
  2. * dialogs 模块提供了简单的对话框支持,可以通过对话框和用户进行交互。
  3. */
  4. declare namespace dialogs {
  5. /**
  6. * 显示一个只包含“确定”按钮的提示对话框。直至用户点击确定脚本才继续运行。
  7. */
  8. function alert(title: string, content?: string): void;
  9. /**
  10. * UI模式
  11. *
  12. * 显示一个只包含“确定”按钮的提示对话框。直至用户点击确定脚本才继续运行。
  13. */
  14. function alert(title: string, content?: string, callback?: () => void): Promise<void>;
  15. /**
  16. * 显示一个包含“确定”和“取消”按钮的提示对话框。如果用户点击“确定”则返回 true ,否则返回 false 。
  17. */
  18. function confirm(title: string, content?: string): boolean;
  19. /**
  20. * UI模式
  21. *
  22. * 显示一个包含“确定”和“取消”按钮的提示对话框。如果用户点击“确定”则返回 true ,否则返回 false 。
  23. */
  24. function confirm(title: string, content?: string, callback?: (value: boolean) => void): Promise<boolean>;
  25. /**
  26. * 显示一个包含输入框的对话框,等待用户输入内容,并在用户点击确定时将输入的字符串返回。如果用户取消了输入,返回null。
  27. */
  28. function rawInput(title: string, prefill?: string): string;
  29. /**
  30. * UI模式
  31. *
  32. * 显示一个包含输入框的对话框,等待用户输入内容,并在用户点击确定时将输入的字符串返回。如果用户取消了输入,返回null。
  33. */
  34. function rawInput(title: string, prefill?: string, callback?: (value: string) => void): Promise<string>;
  35. /**
  36. * 等效于 eval(dialogs.rawInput(title, prefill, callback)), 该函数和rawInput的区别在于,会把输入的字符串用eval计算一遍再返回,返回的可能不是字符串。
  37. */
  38. function input(title: string, prefill?: string): any;
  39. /**
  40. * UI模式
  41. *
  42. * 等效于 eval(dialogs.rawInput(title, prefill, callback)), 该函数和rawInput的区别在于,会把输入的字符串用eval计算一遍再返回,返回的可能不是字符串。
  43. */
  44. function input(title: string, prefill?: string, callback?: (value: any) => void): Promise<any>;
  45. /**
  46. * 显示一个包含输入框的对话框,等待用户输入内容,并在用户点击确定时将输入的字符串返回。如果用户取消了输入,返回null。
  47. */
  48. function prompt(title: string, prefill?: string): string;
  49. /**
  50. * UI模式
  51. *
  52. * 显示一个包含输入框的对话框,等待用户输入内容,并在用户点击确定时将输入的字符串返回。如果用户取消了输入,返回null。
  53. */
  54. function prompt(title: string, prefill?: string, callback?: (value: string) => void): Promise<string>;
  55. /**
  56. * 显示一个带有选项列表的对话框,等待用户选择,返回用户选择的选项索引(0 ~ item.length - 1)。如果用户取消了选择,返回-1。
  57. */
  58. function select(title: string, items: string[]): number;
  59. /**
  60. * UI模式
  61. *
  62. * 显示一个带有选项列表的对话框,等待用户选择,返回用户选择的选项索引(0 ~ item.length - 1)。如果用户取消了选择,返回-1。
  63. */
  64. function select(title: string, items: string[], callback?: (value: number) => void): Promise<number>;
  65. /**
  66. * 显示一个单选列表对话框,等待用户选择,返回用户选择的选项索引(0 ~ item.length - 1)。如果用户取消了选择,返回-1。
  67. */
  68. function singleChoice(title: string, items: string[], index?: number): number;
  69. /**
  70. * UI模式
  71. *
  72. * 显示一个单选列表对话框,等待用户选择,返回用户选择的选项索引(0 ~ item.length - 1)。如果用户取消了选择,返回-1。
  73. */
  74. function singleChoice(title: string, items: string[], index?: number, callback?: (choice: number) => void): Promise<number>;
  75. /**
  76. * 显示一个多选列表对话框,等待用户选择,返回用户选择的选项索引的数组。如果用户取消了选择,返回[]。
  77. */
  78. function multiChoice(title: string, items: string[], indices?: number[]): number[];
  79. /**
  80. * UI模式
  81. *
  82. * 显示一个多选列表对话框,等待用户选择,返回用户选择的选项索引的数组。如果用户取消了选择,返回[]。
  83. */
  84. function multiChoice(title: string, items: string[], indices?: number[], callback?: (choices: number[]) => void): Promise<number[]>;
  85. }
  86. /**
  87. * 显示一个只包含“确定”按钮的提示对话框。直至用户点击确定脚本才继续运行。
  88. */
  89. declare function alert(title: string, content?: string): void;
  90. /**
  91. * UI模式
  92. *
  93. * 显示一个只包含“确定”按钮的提示对话框。直至用户点击确定脚本才继续运行。
  94. *
  95. * 在ui模式下该函数返回一个Promise。
  96. */
  97. declare function alert(title: string, content?: string, callback?: () => void): Promise<void>;
  98. /**
  99. * 显示一个包含“确定”和“取消”按钮的提示对话框。如果用户点击“确定”则返回 true ,否则返回 false 。
  100. */
  101. declare function confirm(title: string, content?: string): boolean;
  102. /**
  103. * UI模式
  104. *
  105. * 显示一个包含“确定”和“取消”按钮的提示对话框。如果用户点击“确定”则返回 true ,否则返回 false 。
  106. *
  107. * 在ui模式下该函数返回一个Promise。
  108. */
  109. declare function confirm(title: string, content?: string, callback?: (value: boolean) => void): Promise<boolean>;
  110. /**
  111. * 显示一个包含输入框的对话框,等待用户输入内容,并在用户点击确定时将输入的字符串返回。如果用户取消了输入,返回null。
  112. */
  113. declare function rawInput(title: string, prefill?: string): string;
  114. /**
  115. * UI模式
  116. *
  117. * 显示一个包含输入框的对话框,等待用户输入内容,并在用户点击确定时将输入的字符串返回。如果用户取消了输入,返回null。
  118. */
  119. declare function rawInput(title: string, prefill?: string, callback?: (value: string) => void): Promise<string>;