Terminal.Gui.Autocomplete.html 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625
  1. <!DOCTYPE html>
  2. <!--[if IE]><![endif]-->
  3. <html>
  4. <head>
  5. <meta charset="utf-8">
  6. <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
  7. <title>Class Autocomplete
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class Autocomplete
  11. ">
  12. <meta name="generator" content="docfx 2.58.5.0">
  13. <link rel="shortcut icon" href="../../favicon.ico">
  14. <link rel="stylesheet" href="../../styles/docfx.vendor.css">
  15. <link rel="stylesheet" href="../../styles/docfx.css">
  16. <link rel="stylesheet" href="../../styles/main.css">
  17. <meta property="docfx:navrel" content="../../toc.html">
  18. <meta property="docfx:tocrel" content="toc.html">
  19. <meta property="docfx:rel" content="../../">
  20. </head>
  21. <body data-spy="scroll" data-target="#affix" data-offset="120">
  22. <div id="wrapper">
  23. <header>
  24. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  25. <div class="container">
  26. <div class="navbar-header">
  27. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  28. <span class="sr-only">Toggle navigation</span>
  29. <span class="icon-bar"></span>
  30. <span class="icon-bar"></span>
  31. <span class="icon-bar"></span>
  32. </button>
  33. <a class="navbar-brand" href="../../index.html">
  34. <img id="logo" class="svg" src="../../images/logo48.png" alt="">
  35. </a>
  36. </div>
  37. <div class="collapse navbar-collapse" id="navbar">
  38. <form class="navbar-form navbar-right" role="search" id="search">
  39. <div class="form-group">
  40. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  41. </div>
  42. </form>
  43. </div>
  44. </div>
  45. </nav>
  46. <div class="subnav navbar navbar-default">
  47. <div class="container hide-when-search" id="breadcrumb">
  48. <ul class="breadcrumb">
  49. <li></li>
  50. </ul>
  51. </div>
  52. </div>
  53. </header>
  54. <div class="container body-content">
  55. <div id="search-results">
  56. <div class="search-list">Search Results for <span></span></div>
  57. <div class="sr-items">
  58. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  59. </div>
  60. <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
  61. </div>
  62. </div>
  63. <div role="main" class="container body-content hide-when-search">
  64. <div class="sidenav hide-when-search">
  65. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  66. <div class="sidetoggle collapse" id="sidetoggle">
  67. <div id="sidetoc"></div>
  68. </div>
  69. </div>
  70. <div class="article row grid-right">
  71. <div class="col-md-10">
  72. <article class="content wrap" id="_content" data-uid="Terminal.Gui.Autocomplete">
  73. <h1 id="Terminal_Gui_Autocomplete" data-uid="Terminal.Gui.Autocomplete" class="text-break">Class Autocomplete
  74. </h1>
  75. <div class="markdown level0 summary">
  76. Renders an overlay on another view at a given point that allows selecting
  77. from a range of &apos;autocomplete&apos; options.
  78. </div>
  79. <div class="markdown level0 conceptual"></div>
  80. <div class="inheritance">
  81. <h5>Inheritance</h5>
  82. <div class="level0"><span class="xref">System.Object</span></div>
  83. <div class="level1"><span class="xref">Autocomplete</span></div>
  84. </div>
  85. <div class="inheritedMembers">
  86. <h5>Inherited Members</h5>
  87. <div>
  88. <span class="xref">System.Object.Equals(System.Object)</span>
  89. </div>
  90. <div>
  91. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  92. </div>
  93. <div>
  94. <span class="xref">System.Object.GetHashCode()</span>
  95. </div>
  96. <div>
  97. <span class="xref">System.Object.GetType()</span>
  98. </div>
  99. <div>
  100. <span class="xref">System.Object.MemberwiseClone()</span>
  101. </div>
  102. <div>
  103. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  104. </div>
  105. <div>
  106. <span class="xref">System.Object.ToString()</span>
  107. </div>
  108. </div>
  109. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
  110. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  111. <h5 id="Terminal_Gui_Autocomplete_syntax">Syntax</h5>
  112. <div class="codewrapper">
  113. <pre><code class="lang-csharp hljs">public class Autocomplete</code></pre>
  114. </div>
  115. <h3 id="properties">Properties
  116. </h3>
  117. <a id="Terminal_Gui_Autocomplete_AllSuggestions_" data-uid="Terminal.Gui.Autocomplete.AllSuggestions*"></a>
  118. <h4 id="Terminal_Gui_Autocomplete_AllSuggestions" data-uid="Terminal.Gui.Autocomplete.AllSuggestions">AllSuggestions</h4>
  119. <div class="markdown level1 summary">
  120. The full set of all strings that can be suggested.
  121. </div>
  122. <div class="markdown level1 conceptual"></div>
  123. <h5 class="decalaration">Declaration</h5>
  124. <div class="codewrapper">
  125. <pre><code class="lang-csharp hljs">public List&lt;string&gt; AllSuggestions { get; set; }</code></pre>
  126. </div>
  127. <h5 class="propertyValue">Property Value</h5>
  128. <table class="table table-bordered table-striped table-condensed">
  129. <thead>
  130. <tr>
  131. <th>Type</th>
  132. <th>Description</th>
  133. </tr>
  134. </thead>
  135. <tbody>
  136. <tr>
  137. <td><span class="xref">System.Collections.Generic.List</span>&lt;<span class="xref">System.String</span>&gt;</td>
  138. <td></td>
  139. </tr>
  140. </tbody>
  141. </table>
  142. <a id="Terminal_Gui_Autocomplete_CloseKey_" data-uid="Terminal.Gui.Autocomplete.CloseKey*"></a>
  143. <h4 id="Terminal_Gui_Autocomplete_CloseKey" data-uid="Terminal.Gui.Autocomplete.CloseKey">CloseKey</h4>
  144. <div class="markdown level1 summary">
  145. The key that the user can press to close the currently popped autocomplete menu
  146. </div>
  147. <div class="markdown level1 conceptual"></div>
  148. <h5 class="decalaration">Declaration</h5>
  149. <div class="codewrapper">
  150. <pre><code class="lang-csharp hljs">public Key CloseKey { get; set; }</code></pre>
  151. </div>
  152. <h5 class="propertyValue">Property Value</h5>
  153. <table class="table table-bordered table-striped table-condensed">
  154. <thead>
  155. <tr>
  156. <th>Type</th>
  157. <th>Description</th>
  158. </tr>
  159. </thead>
  160. <tbody>
  161. <tr>
  162. <td><a class="xref" href="Terminal.Gui.Key.html">Key</a></td>
  163. <td></td>
  164. </tr>
  165. </tbody>
  166. </table>
  167. <a id="Terminal_Gui_Autocomplete_ColorScheme_" data-uid="Terminal.Gui.Autocomplete.ColorScheme*"></a>
  168. <h4 id="Terminal_Gui_Autocomplete_ColorScheme" data-uid="Terminal.Gui.Autocomplete.ColorScheme">ColorScheme</h4>
  169. <div class="markdown level1 summary">
  170. The colors to use to render the overlay. Accessing this property before
  171. the Application has been initialised will cause an error
  172. </div>
  173. <div class="markdown level1 conceptual"></div>
  174. <h5 class="decalaration">Declaration</h5>
  175. <div class="codewrapper">
  176. <pre><code class="lang-csharp hljs">public ColorScheme ColorScheme { get; set; }</code></pre>
  177. </div>
  178. <h5 class="propertyValue">Property Value</h5>
  179. <table class="table table-bordered table-striped table-condensed">
  180. <thead>
  181. <tr>
  182. <th>Type</th>
  183. <th>Description</th>
  184. </tr>
  185. </thead>
  186. <tbody>
  187. <tr>
  188. <td><a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a></td>
  189. <td></td>
  190. </tr>
  191. </tbody>
  192. </table>
  193. <a id="Terminal_Gui_Autocomplete_MaxHeight_" data-uid="Terminal.Gui.Autocomplete.MaxHeight*"></a>
  194. <h4 id="Terminal_Gui_Autocomplete_MaxHeight" data-uid="Terminal.Gui.Autocomplete.MaxHeight">MaxHeight</h4>
  195. <div class="markdown level1 summary">
  196. The maximum number of visible rows in the autocomplete dropdown to render
  197. </div>
  198. <div class="markdown level1 conceptual"></div>
  199. <h5 class="decalaration">Declaration</h5>
  200. <div class="codewrapper">
  201. <pre><code class="lang-csharp hljs">public int MaxHeight { get; set; }</code></pre>
  202. </div>
  203. <h5 class="propertyValue">Property Value</h5>
  204. <table class="table table-bordered table-striped table-condensed">
  205. <thead>
  206. <tr>
  207. <th>Type</th>
  208. <th>Description</th>
  209. </tr>
  210. </thead>
  211. <tbody>
  212. <tr>
  213. <td><span class="xref">System.Int32</span></td>
  214. <td></td>
  215. </tr>
  216. </tbody>
  217. </table>
  218. <a id="Terminal_Gui_Autocomplete_MaxWidth_" data-uid="Terminal.Gui.Autocomplete.MaxWidth*"></a>
  219. <h4 id="Terminal_Gui_Autocomplete_MaxWidth" data-uid="Terminal.Gui.Autocomplete.MaxWidth">MaxWidth</h4>
  220. <div class="markdown level1 summary">
  221. The maximum width of the autocomplete dropdown
  222. </div>
  223. <div class="markdown level1 conceptual"></div>
  224. <h5 class="decalaration">Declaration</h5>
  225. <div class="codewrapper">
  226. <pre><code class="lang-csharp hljs">public int MaxWidth { get; set; }</code></pre>
  227. </div>
  228. <h5 class="propertyValue">Property Value</h5>
  229. <table class="table table-bordered table-striped table-condensed">
  230. <thead>
  231. <tr>
  232. <th>Type</th>
  233. <th>Description</th>
  234. </tr>
  235. </thead>
  236. <tbody>
  237. <tr>
  238. <td><span class="xref">System.Int32</span></td>
  239. <td></td>
  240. </tr>
  241. </tbody>
  242. </table>
  243. <a id="Terminal_Gui_Autocomplete_ScrollOffset_" data-uid="Terminal.Gui.Autocomplete.ScrollOffset*"></a>
  244. <h4 id="Terminal_Gui_Autocomplete_ScrollOffset" data-uid="Terminal.Gui.Autocomplete.ScrollOffset">ScrollOffset</h4>
  245. <div class="markdown level1 summary">
  246. When more suggestions are available than can be rendered the user
  247. can scroll down the dropdown list. This indicates how far down they
  248. have gone
  249. </div>
  250. <div class="markdown level1 conceptual"></div>
  251. <h5 class="decalaration">Declaration</h5>
  252. <div class="codewrapper">
  253. <pre><code class="lang-csharp hljs">public int ScrollOffset { get; set; }</code></pre>
  254. </div>
  255. <h5 class="propertyValue">Property Value</h5>
  256. <table class="table table-bordered table-striped table-condensed">
  257. <thead>
  258. <tr>
  259. <th>Type</th>
  260. <th>Description</th>
  261. </tr>
  262. </thead>
  263. <tbody>
  264. <tr>
  265. <td><span class="xref">System.Int32</span></td>
  266. <td></td>
  267. </tr>
  268. </tbody>
  269. </table>
  270. <a id="Terminal_Gui_Autocomplete_SelectedIdx_" data-uid="Terminal.Gui.Autocomplete.SelectedIdx*"></a>
  271. <h4 id="Terminal_Gui_Autocomplete_SelectedIdx" data-uid="Terminal.Gui.Autocomplete.SelectedIdx">SelectedIdx</h4>
  272. <div class="markdown level1 summary">
  273. The currently selected index into <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_Suggestions">Suggestions</a> that the user has highlighted
  274. </div>
  275. <div class="markdown level1 conceptual"></div>
  276. <h5 class="decalaration">Declaration</h5>
  277. <div class="codewrapper">
  278. <pre><code class="lang-csharp hljs">public int SelectedIdx { get; set; }</code></pre>
  279. </div>
  280. <h5 class="propertyValue">Property Value</h5>
  281. <table class="table table-bordered table-striped table-condensed">
  282. <thead>
  283. <tr>
  284. <th>Type</th>
  285. <th>Description</th>
  286. </tr>
  287. </thead>
  288. <tbody>
  289. <tr>
  290. <td><span class="xref">System.Int32</span></td>
  291. <td></td>
  292. </tr>
  293. </tbody>
  294. </table>
  295. <a id="Terminal_Gui_Autocomplete_SelectionKey_" data-uid="Terminal.Gui.Autocomplete.SelectionKey*"></a>
  296. <h4 id="Terminal_Gui_Autocomplete_SelectionKey" data-uid="Terminal.Gui.Autocomplete.SelectionKey">SelectionKey</h4>
  297. <div class="markdown level1 summary">
  298. The key that the user must press to accept the currently selected autocomplete suggestion
  299. </div>
  300. <div class="markdown level1 conceptual"></div>
  301. <h5 class="decalaration">Declaration</h5>
  302. <div class="codewrapper">
  303. <pre><code class="lang-csharp hljs">public Key SelectionKey { get; set; }</code></pre>
  304. </div>
  305. <h5 class="propertyValue">Property Value</h5>
  306. <table class="table table-bordered table-striped table-condensed">
  307. <thead>
  308. <tr>
  309. <th>Type</th>
  310. <th>Description</th>
  311. </tr>
  312. </thead>
  313. <tbody>
  314. <tr>
  315. <td><a class="xref" href="Terminal.Gui.Key.html">Key</a></td>
  316. <td></td>
  317. </tr>
  318. </tbody>
  319. </table>
  320. <a id="Terminal_Gui_Autocomplete_Suggestions_" data-uid="Terminal.Gui.Autocomplete.Suggestions*"></a>
  321. <h4 id="Terminal_Gui_Autocomplete_Suggestions" data-uid="Terminal.Gui.Autocomplete.Suggestions">Suggestions</h4>
  322. <div class="markdown level1 summary">
  323. The strings that form the current list of suggestions to render
  324. based on what the user has typed so far.
  325. </div>
  326. <div class="markdown level1 conceptual"></div>
  327. <h5 class="decalaration">Declaration</h5>
  328. <div class="codewrapper">
  329. <pre><code class="lang-csharp hljs">public ReadOnlyCollection&lt;string&gt; Suggestions { get; protected set; }</code></pre>
  330. </div>
  331. <h5 class="propertyValue">Property Value</h5>
  332. <table class="table table-bordered table-striped table-condensed">
  333. <thead>
  334. <tr>
  335. <th>Type</th>
  336. <th>Description</th>
  337. </tr>
  338. </thead>
  339. <tbody>
  340. <tr>
  341. <td><span class="xref">System.Collections.ObjectModel.ReadOnlyCollection</span>&lt;<span class="xref">System.String</span>&gt;</td>
  342. <td></td>
  343. </tr>
  344. </tbody>
  345. </table>
  346. <a id="Terminal_Gui_Autocomplete_Visible_" data-uid="Terminal.Gui.Autocomplete.Visible*"></a>
  347. <h4 id="Terminal_Gui_Autocomplete_Visible" data-uid="Terminal.Gui.Autocomplete.Visible">Visible</h4>
  348. <div class="markdown level1 summary">
  349. True if the autocomplete should be considered open and visible
  350. </div>
  351. <div class="markdown level1 conceptual"></div>
  352. <h5 class="decalaration">Declaration</h5>
  353. <div class="codewrapper">
  354. <pre><code class="lang-csharp hljs">protected bool Visible { get; set; }</code></pre>
  355. </div>
  356. <h5 class="propertyValue">Property Value</h5>
  357. <table class="table table-bordered table-striped table-condensed">
  358. <thead>
  359. <tr>
  360. <th>Type</th>
  361. <th>Description</th>
  362. </tr>
  363. </thead>
  364. <tbody>
  365. <tr>
  366. <td><span class="xref">System.Boolean</span></td>
  367. <td></td>
  368. </tr>
  369. </tbody>
  370. </table>
  371. <h3 id="methods">Methods
  372. </h3>
  373. <a id="Terminal_Gui_Autocomplete_ClearSuggestions_" data-uid="Terminal.Gui.Autocomplete.ClearSuggestions*"></a>
  374. <h4 id="Terminal_Gui_Autocomplete_ClearSuggestions" data-uid="Terminal.Gui.Autocomplete.ClearSuggestions">ClearSuggestions()</h4>
  375. <div class="markdown level1 summary">
  376. Clears <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_Suggestions">Suggestions</a>
  377. </div>
  378. <div class="markdown level1 conceptual"></div>
  379. <h5 class="decalaration">Declaration</h5>
  380. <div class="codewrapper">
  381. <pre><code class="lang-csharp hljs">public void ClearSuggestions()</code></pre>
  382. </div>
  383. <a id="Terminal_Gui_Autocomplete_EnsureSelectedIdxIsValid_" data-uid="Terminal.Gui.Autocomplete.EnsureSelectedIdxIsValid*"></a>
  384. <h4 id="Terminal_Gui_Autocomplete_EnsureSelectedIdxIsValid" data-uid="Terminal.Gui.Autocomplete.EnsureSelectedIdxIsValid">EnsureSelectedIdxIsValid()</h4>
  385. <div class="markdown level1 summary">
  386. Updates <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_SelectedIdx">SelectedIdx</a> to be a valid index within <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_Suggestions">Suggestions</a>
  387. </div>
  388. <div class="markdown level1 conceptual"></div>
  389. <h5 class="decalaration">Declaration</h5>
  390. <div class="codewrapper">
  391. <pre><code class="lang-csharp hljs">public void EnsureSelectedIdxIsValid()</code></pre>
  392. </div>
  393. <a id="Terminal_Gui_Autocomplete_GenerateSuggestions_" data-uid="Terminal.Gui.Autocomplete.GenerateSuggestions*"></a>
  394. <h4 id="Terminal_Gui_Autocomplete_GenerateSuggestions_Terminal_Gui_TextView_" data-uid="Terminal.Gui.Autocomplete.GenerateSuggestions(Terminal.Gui.TextView)">GenerateSuggestions(TextView)</h4>
  395. <div class="markdown level1 summary">
  396. Populates <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_Suggestions">Suggestions</a> with all strings in <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_AllSuggestions">AllSuggestions</a> that
  397. match with the current cursor position/text in the <code data-dev-comment-type="paramref" class="paramref">hostControl</code>
  398. </div>
  399. <div class="markdown level1 conceptual"></div>
  400. <h5 class="decalaration">Declaration</h5>
  401. <div class="codewrapper">
  402. <pre><code class="lang-csharp hljs">public void GenerateSuggestions(TextView hostControl)</code></pre>
  403. </div>
  404. <h5 class="parameters">Parameters</h5>
  405. <table class="table table-bordered table-striped table-condensed">
  406. <thead>
  407. <tr>
  408. <th>Type</th>
  409. <th>Name</th>
  410. <th>Description</th>
  411. </tr>
  412. </thead>
  413. <tbody>
  414. <tr>
  415. <td><a class="xref" href="Terminal.Gui.TextView.html">TextView</a></td>
  416. <td><span class="parametername">hostControl</span></td>
  417. <td>The text view that you want suggestions for</td>
  418. </tr>
  419. </tbody>
  420. </table>
  421. <a id="Terminal_Gui_Autocomplete_IsWordChar_" data-uid="Terminal.Gui.Autocomplete.IsWordChar*"></a>
  422. <h4 id="Terminal_Gui_Autocomplete_IsWordChar_System_Rune_" data-uid="Terminal.Gui.Autocomplete.IsWordChar(System.Rune)">IsWordChar(Rune)</h4>
  423. <div class="markdown level1 summary">
  424. Return true if the given symbol should be considered part of a word
  425. and can be contained in matches. Base behaviour is to use <span class="xref">System.Char.IsLetterOrDigit(System.Char)</span>
  426. </div>
  427. <div class="markdown level1 conceptual"></div>
  428. <h5 class="decalaration">Declaration</h5>
  429. <div class="codewrapper">
  430. <pre><code class="lang-csharp hljs">public virtual bool IsWordChar(Rune rune)</code></pre>
  431. </div>
  432. <h5 class="parameters">Parameters</h5>
  433. <table class="table table-bordered table-striped table-condensed">
  434. <thead>
  435. <tr>
  436. <th>Type</th>
  437. <th>Name</th>
  438. <th>Description</th>
  439. </tr>
  440. </thead>
  441. <tbody>
  442. <tr>
  443. <td><span class="xref">System.Rune</span></td>
  444. <td><span class="parametername">rune</span></td>
  445. <td></td>
  446. </tr>
  447. </tbody>
  448. </table>
  449. <h5 class="returns">Returns</h5>
  450. <table class="table table-bordered table-striped table-condensed">
  451. <thead>
  452. <tr>
  453. <th>Type</th>
  454. <th>Description</th>
  455. </tr>
  456. </thead>
  457. <tbody>
  458. <tr>
  459. <td><span class="xref">System.Boolean</span></td>
  460. <td></td>
  461. </tr>
  462. </tbody>
  463. </table>
  464. <a id="Terminal_Gui_Autocomplete_ProcessKey_" data-uid="Terminal.Gui.Autocomplete.ProcessKey*"></a>
  465. <h4 id="Terminal_Gui_Autocomplete_ProcessKey_Terminal_Gui_TextView_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.Autocomplete.ProcessKey(Terminal.Gui.TextView,Terminal.Gui.KeyEvent)">ProcessKey(TextView, KeyEvent)</h4>
  466. <div class="markdown level1 summary">
  467. Handle key events before <code data-dev-comment-type="paramref" class="paramref">hostControl</code> e.g. to make key events like
  468. up/down apply to the autocomplete control instead of changing the cursor position in
  469. the underlying text view.
  470. </div>
  471. <div class="markdown level1 conceptual"></div>
  472. <h5 class="decalaration">Declaration</h5>
  473. <div class="codewrapper">
  474. <pre><code class="lang-csharp hljs">public bool ProcessKey(TextView hostControl, KeyEvent kb)</code></pre>
  475. </div>
  476. <h5 class="parameters">Parameters</h5>
  477. <table class="table table-bordered table-striped table-condensed">
  478. <thead>
  479. <tr>
  480. <th>Type</th>
  481. <th>Name</th>
  482. <th>Description</th>
  483. </tr>
  484. </thead>
  485. <tbody>
  486. <tr>
  487. <td><a class="xref" href="Terminal.Gui.TextView.html">TextView</a></td>
  488. <td><span class="parametername">hostControl</span></td>
  489. <td></td>
  490. </tr>
  491. <tr>
  492. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  493. <td><span class="parametername">kb</span></td>
  494. <td></td>
  495. </tr>
  496. </tbody>
  497. </table>
  498. <h5 class="returns">Returns</h5>
  499. <table class="table table-bordered table-striped table-condensed">
  500. <thead>
  501. <tr>
  502. <th>Type</th>
  503. <th>Description</th>
  504. </tr>
  505. </thead>
  506. <tbody>
  507. <tr>
  508. <td><span class="xref">System.Boolean</span></td>
  509. <td></td>
  510. </tr>
  511. </tbody>
  512. </table>
  513. <a id="Terminal_Gui_Autocomplete_RenderOverlay_" data-uid="Terminal.Gui.Autocomplete.RenderOverlay*"></a>
  514. <h4 id="Terminal_Gui_Autocomplete_RenderOverlay_Terminal_Gui_View_Terminal_Gui_Point_" data-uid="Terminal.Gui.Autocomplete.RenderOverlay(Terminal.Gui.View,Terminal.Gui.Point)">RenderOverlay(View, Point)</h4>
  515. <div class="markdown level1 summary">
  516. Renders the autocomplete dialog inside the given <code data-dev-comment-type="paramref" class="paramref">view</code> at the
  517. given point.
  518. </div>
  519. <div class="markdown level1 conceptual"></div>
  520. <h5 class="decalaration">Declaration</h5>
  521. <div class="codewrapper">
  522. <pre><code class="lang-csharp hljs">public void RenderOverlay(View view, Point renderAt)</code></pre>
  523. </div>
  524. <h5 class="parameters">Parameters</h5>
  525. <table class="table table-bordered table-striped table-condensed">
  526. <thead>
  527. <tr>
  528. <th>Type</th>
  529. <th>Name</th>
  530. <th>Description</th>
  531. </tr>
  532. </thead>
  533. <tbody>
  534. <tr>
  535. <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
  536. <td><span class="parametername">view</span></td>
  537. <td>The view the overlay should be rendered into</td>
  538. </tr>
  539. <tr>
  540. <td><a class="xref" href="Terminal.Gui.Point.html">Point</a></td>
  541. <td><span class="parametername">renderAt</span></td>
  542. <td></td>
  543. </tr>
  544. </tbody>
  545. </table>
  546. </article>
  547. </div>
  548. <div class="hidden-sm col-md-2" role="complementary">
  549. <div class="sideaffix">
  550. <div class="contribution">
  551. <ul class="nav">
  552. </ul>
  553. </div>
  554. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  555. <h5>In This Article</h5>
  556. <div></div>
  557. </nav>
  558. </div>
  559. </div>
  560. </div>
  561. </div>
  562. <footer>
  563. <div class="grad-bottom"></div>
  564. <div class="footer">
  565. <div class="container">
  566. <span class="pull-right">
  567. <a href="#top">Back to top</a>
  568. </span>
  569. <span>Generated by <strong>DocFX</strong></span>
  570. </div>
  571. </div>
  572. </footer>
  573. </div>
  574. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  575. <script type="text/javascript" src="../../styles/docfx.js"></script>
  576. <script type="text/javascript" src="../../styles/main.js"></script>
  577. </body>
  578. </html>