Terminal.Gui.TextViewAutocomplete.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316
  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 TextViewAutocomplete
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class TextViewAutocomplete
  11. ">
  12. <meta name="generator" content="docfx 2.59.0.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.TextViewAutocomplete">
  73. <h1 id="Terminal_Gui_TextViewAutocomplete" data-uid="Terminal.Gui.TextViewAutocomplete" class="text-break">Class TextViewAutocomplete
  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. An implementation on a TextView.
  79. </div>
  80. <div class="markdown level0 conceptual"></div>
  81. <div class="inheritance">
  82. <h5>Inheritance</h5>
  83. <div class="level0"><span class="xref">System.Object</span></div>
  84. <div class="level1"><a class="xref" href="Terminal.Gui.Autocomplete.html">Autocomplete</a></div>
  85. <div class="level2"><span class="xref">TextViewAutocomplete</span></div>
  86. </div>
  87. <div classs="implements">
  88. <h5>Implements</h5>
  89. <div><a class="xref" href="Terminal.Gui.IAutocomplete.html">IAutocomplete</a></div>
  90. </div>
  91. <div class="inheritedMembers">
  92. <h5>Inherited Members</h5>
  93. <div>
  94. <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_HostControl">Autocomplete.HostControl</a>
  95. </div>
  96. <div>
  97. <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_PopupInsideContainer">Autocomplete.PopupInsideContainer</a>
  98. </div>
  99. <div>
  100. <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_MaxWidth">Autocomplete.MaxWidth</a>
  101. </div>
  102. <div>
  103. <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_MaxHeight">Autocomplete.MaxHeight</a>
  104. </div>
  105. <div>
  106. <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_Visible">Autocomplete.Visible</a>
  107. </div>
  108. <div>
  109. <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_Suggestions">Autocomplete.Suggestions</a>
  110. </div>
  111. <div>
  112. <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_AllSuggestions">Autocomplete.AllSuggestions</a>
  113. </div>
  114. <div>
  115. <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_SelectedIdx">Autocomplete.SelectedIdx</a>
  116. </div>
  117. <div>
  118. <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_ScrollOffset">Autocomplete.ScrollOffset</a>
  119. </div>
  120. <div>
  121. <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_ColorScheme">Autocomplete.ColorScheme</a>
  122. </div>
  123. <div>
  124. <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_SelectionKey">Autocomplete.SelectionKey</a>
  125. </div>
  126. <div>
  127. <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_CloseKey">Autocomplete.CloseKey</a>
  128. </div>
  129. <div>
  130. <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_Reopen">Autocomplete.Reopen</a>
  131. </div>
  132. <div>
  133. <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_RenderOverlay_Terminal_Gui_Point_">Autocomplete.RenderOverlay(Point)</a>
  134. </div>
  135. <div>
  136. <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_EnsureSelectedIdxIsValid">Autocomplete.EnsureSelectedIdxIsValid()</a>
  137. </div>
  138. <div>
  139. <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_ProcessKey_Terminal_Gui_KeyEvent_">Autocomplete.ProcessKey(KeyEvent)</a>
  140. </div>
  141. <div>
  142. <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_MouseEvent_Terminal_Gui_MouseEvent_System_Boolean_">Autocomplete.MouseEvent(MouseEvent, Boolean)</a>
  143. </div>
  144. <div>
  145. <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_RenderSelectedIdxByMouse_Terminal_Gui_MouseEvent_">Autocomplete.RenderSelectedIdxByMouse(MouseEvent)</a>
  146. </div>
  147. <div>
  148. <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_ClearSuggestions">Autocomplete.ClearSuggestions()</a>
  149. </div>
  150. <div>
  151. <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_GenerateSuggestions">Autocomplete.GenerateSuggestions()</a>
  152. </div>
  153. <div>
  154. <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_IsWordChar_System_Rune_">Autocomplete.IsWordChar(Rune)</a>
  155. </div>
  156. <div>
  157. <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_Select">Autocomplete.Select()</a>
  158. </div>
  159. <div>
  160. <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_InsertSelection_System_String_">Autocomplete.InsertSelection(String)</a>
  161. </div>
  162. <div>
  163. <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_IdxToWord_System_Collections_Generic_List_System_Rune__System_Int32_">Autocomplete.IdxToWord(List&lt;Rune&gt;, Int32)</a>
  164. </div>
  165. <div>
  166. <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_Close">Autocomplete.Close()</a>
  167. </div>
  168. <div>
  169. <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_MoveUp">Autocomplete.MoveUp()</a>
  170. </div>
  171. <div>
  172. <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_MoveDown">Autocomplete.MoveDown()</a>
  173. </div>
  174. <div>
  175. <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_ReopenSuggestions">Autocomplete.ReopenSuggestions()</a>
  176. </div>
  177. <div>
  178. <span class="xref">System.Object.Equals(System.Object)</span>
  179. </div>
  180. <div>
  181. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  182. </div>
  183. <div>
  184. <span class="xref">System.Object.GetHashCode()</span>
  185. </div>
  186. <div>
  187. <span class="xref">System.Object.GetType()</span>
  188. </div>
  189. <div>
  190. <span class="xref">System.Object.MemberwiseClone()</span>
  191. </div>
  192. <div>
  193. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  194. </div>
  195. <div>
  196. <span class="xref">System.Object.ToString()</span>
  197. </div>
  198. </div>
  199. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
  200. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  201. <h5 id="Terminal_Gui_TextViewAutocomplete_syntax">Syntax</h5>
  202. <div class="codewrapper">
  203. <pre><code class="lang-csharp hljs">public class TextViewAutocomplete : Autocomplete, IAutocomplete</code></pre>
  204. </div>
  205. <h3 id="methods">Methods
  206. </h3>
  207. <a id="Terminal_Gui_TextViewAutocomplete_DeleteTextBackwards_" data-uid="Terminal.Gui.TextViewAutocomplete.DeleteTextBackwards*"></a>
  208. <h4 id="Terminal_Gui_TextViewAutocomplete_DeleteTextBackwards" data-uid="Terminal.Gui.TextViewAutocomplete.DeleteTextBackwards">DeleteTextBackwards()</h4>
  209. <div class="markdown level1 summary"></div>
  210. <div class="markdown level1 conceptual"></div>
  211. <h5 class="decalaration">Declaration</h5>
  212. <div class="codewrapper">
  213. <pre><code class="lang-csharp hljs">protected override void DeleteTextBackwards()</code></pre>
  214. </div>
  215. <h5 class="overrides">Overrides</h5>
  216. <div><a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_DeleteTextBackwards">Autocomplete.DeleteTextBackwards()</a></div>
  217. <a id="Terminal_Gui_TextViewAutocomplete_GetCurrentWord_" data-uid="Terminal.Gui.TextViewAutocomplete.GetCurrentWord*"></a>
  218. <h4 id="Terminal_Gui_TextViewAutocomplete_GetCurrentWord" data-uid="Terminal.Gui.TextViewAutocomplete.GetCurrentWord">GetCurrentWord()</h4>
  219. <div class="markdown level1 summary"></div>
  220. <div class="markdown level1 conceptual"></div>
  221. <h5 class="decalaration">Declaration</h5>
  222. <div class="codewrapper">
  223. <pre><code class="lang-csharp hljs">protected override string GetCurrentWord()</code></pre>
  224. </div>
  225. <h5 class="returns">Returns</h5>
  226. <table class="table table-bordered table-striped table-condensed">
  227. <thead>
  228. <tr>
  229. <th>Type</th>
  230. <th>Description</th>
  231. </tr>
  232. </thead>
  233. <tbody>
  234. <tr>
  235. <td><span class="xref">System.String</span></td>
  236. <td></td>
  237. </tr>
  238. </tbody>
  239. </table>
  240. <h5 class="overrides">Overrides</h5>
  241. <div><a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_GetCurrentWord">Autocomplete.GetCurrentWord()</a></div>
  242. <a id="Terminal_Gui_TextViewAutocomplete_InsertText_" data-uid="Terminal.Gui.TextViewAutocomplete.InsertText*"></a>
  243. <h4 id="Terminal_Gui_TextViewAutocomplete_InsertText_System_String_" data-uid="Terminal.Gui.TextViewAutocomplete.InsertText(System.String)">InsertText(String)</h4>
  244. <div class="markdown level1 summary"></div>
  245. <div class="markdown level1 conceptual"></div>
  246. <h5 class="decalaration">Declaration</h5>
  247. <div class="codewrapper">
  248. <pre><code class="lang-csharp hljs">protected override void InsertText(string accepted)</code></pre>
  249. </div>
  250. <h5 class="parameters">Parameters</h5>
  251. <table class="table table-bordered table-striped table-condensed">
  252. <thead>
  253. <tr>
  254. <th>Type</th>
  255. <th>Name</th>
  256. <th>Description</th>
  257. </tr>
  258. </thead>
  259. <tbody>
  260. <tr>
  261. <td><span class="xref">System.String</span></td>
  262. <td><span class="parametername">accepted</span></td>
  263. <td></td>
  264. </tr>
  265. </tbody>
  266. </table>
  267. <h5 class="overrides">Overrides</h5>
  268. <div><a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_InsertText_System_String_">Autocomplete.InsertText(String)</a></div>
  269. <h3 id="implements">Implements</h3>
  270. <div>
  271. <a class="xref" href="Terminal.Gui.IAutocomplete.html">IAutocomplete</a>
  272. </div>
  273. </article>
  274. </div>
  275. <div class="hidden-sm col-md-2" role="complementary">
  276. <div class="sideaffix">
  277. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  278. <h5>In This Article</h5>
  279. <div></div>
  280. </nav>
  281. </div>
  282. </div>
  283. </div>
  284. </div>
  285. <footer>
  286. <div class="grad-bottom"></div>
  287. <div class="footer">
  288. <div class="container">
  289. <span class="pull-right">
  290. <a href="#top">Back to top</a>
  291. </span>
  292. <span>Generated by <strong>DocFX</strong></span>
  293. </div>
  294. </div>
  295. </footer>
  296. </div>
  297. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  298. <script type="text/javascript" src="../../styles/docfx.js"></script>
  299. <script type="text/javascript" src="../../styles/main.js"></script>
  300. </body>
  301. </html>