BufferLine.html 40 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <title>BufferLine Class Reference</title>
  5. <link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
  6. <link rel="stylesheet" type="text/css" href="../css/highlight.css" />
  7. <meta charset='utf-8'>
  8. <script src="../js/jquery.min.js" defer></script>
  9. <script src="../js/jazzy.js" defer></script>
  10. <script src="../js/lunr.min.js" defer></script>
  11. <script src="../js/typeahead.jquery.js" defer></script>
  12. <script src="../js/jazzy.search.js" defer></script>
  13. </head>
  14. <body>
  15. <a name="//apple_ref/swift/Class/BufferLine" class="dashAnchor"></a>
  16. <a title="BufferLine Class Reference"></a>
  17. <header>
  18. <div class="content-wrapper">
  19. <p><a href="../index.html">SwiftTerm 1.0 Docs</a> (68% documented)</p>
  20. <p class="header-right"><a href="https://github.com/migueldeicaza/SwiftTerm"><img src="../img/gh.png"/>View on GitHub</a></p>
  21. <p class="header-right"><a href="dash-feed://https%3A%2F%2Fmigueldeicaza.github.io%2FSwiftTerm%2Fdocsets%2FSwiftTerm.xml"><img src="../img/dash.png"/>Install in Dash</a></p>
  22. <p class="header-right">
  23. <form role="search" action="../search.json">
  24. <input type="text" placeholder="Search documentation" data-typeahead>
  25. </form>
  26. </p>
  27. </div>
  28. </header>
  29. <div class="content-wrapper">
  30. <p id="breadcrumbs">
  31. <a href="../index.html">SwiftTerm Reference</a>
  32. <img id="carat" src="../img/carat.png" />
  33. BufferLine Class Reference
  34. </p>
  35. </div>
  36. <div class="content-wrapper">
  37. <nav class="sidebar">
  38. <ul class="nav-groups">
  39. <li class="nav-group-name">
  40. <a href="../Classes.html">Classes</a>
  41. <ul class="nav-group-tasks">
  42. <li class="nav-group-task">
  43. <a href="../Classes/BufferLine.html">BufferLine</a>
  44. </li>
  45. <li class="nav-group-task">
  46. <a href="../Classes/Color.html">Color</a>
  47. </li>
  48. <li class="nav-group-task">
  49. <a href="../Classes/HeadlessTerminal.html">HeadlessTerminal</a>
  50. </li>
  51. <li class="nav-group-task">
  52. <a href="../Classes/ImageCell.html">ImageCell</a>
  53. </li>
  54. <li class="nav-group-task">
  55. <a href="../Classes/LocalProcess.html">LocalProcess</a>
  56. </li>
  57. <li class="nav-group-task">
  58. <a href="../Classes/LocalProcessTerminalView.html">LocalProcessTerminalView</a>
  59. </li>
  60. <li class="nav-group-task">
  61. <a href="../Classes/PseudoTerminalHelpers.html">PseudoTerminalHelpers</a>
  62. </li>
  63. <li class="nav-group-task">
  64. <a href="../Classes/Terminal.html">Terminal</a>
  65. </li>
  66. <li class="nav-group-task">
  67. <a href="../Classes/Terminal/MouseMode.html">– MouseMode</a>
  68. </li>
  69. <li class="nav-group-task">
  70. <a href="../Classes/Terminal/WindowManipulationCommand.html">– WindowManipulationCommand</a>
  71. </li>
  72. <li class="nav-group-task">
  73. <a href="../Classes/Terminal/BufferKind.html">– BufferKind</a>
  74. </li>
  75. <li class="nav-group-task">
  76. <a href="../Classes/TerminalAccessory.html">TerminalAccessory</a>
  77. </li>
  78. <li class="nav-group-task">
  79. <a href="../Classes/TerminalDebugView.html">TerminalDebugView</a>
  80. </li>
  81. <li class="nav-group-task">
  82. <a href="../Classes/TerminalView.html">TerminalView</a>
  83. </li>
  84. <li class="nav-group-task">
  85. <a href="../Classes/TerminalView.html">TerminalView</a>
  86. </li>
  87. </ul>
  88. </li>
  89. <li class="nav-group-name">
  90. <a href="../Enums.html">Enumerations</a>
  91. <ul class="nav-group-tasks">
  92. <li class="nav-group-task">
  93. <a href="../Enums/CursorStyle.html">CursorStyle</a>
  94. </li>
  95. <li class="nav-group-task">
  96. <a href="../Enums/ImageSizeRequest.html">ImageSizeRequest</a>
  97. </li>
  98. </ul>
  99. </li>
  100. <li class="nav-group-name">
  101. <a href="../Extensions.html">Extensions</a>
  102. <ul class="nav-group-tasks">
  103. <li class="nav-group-task">
  104. <a href="../Extensions/TerminalViewDelegate.html">TerminalViewDelegate</a>
  105. </li>
  106. <li class="nav-group-task">
  107. <a href="../Extensions/UIImage.html">UIImage</a>
  108. </li>
  109. </ul>
  110. </li>
  111. <li class="nav-group-name">
  112. <a href="../Protocols.html">Protocols</a>
  113. <ul class="nav-group-tasks">
  114. <li class="nav-group-task">
  115. <a href="../Protocols/LocalProcessDelegate.html">LocalProcessDelegate</a>
  116. </li>
  117. <li class="nav-group-task">
  118. <a href="../Protocols/LocalProcessTerminalViewDelegate.html">LocalProcessTerminalViewDelegate</a>
  119. </li>
  120. <li class="nav-group-task">
  121. <a href="../Protocols/TerminalDelegate.html">TerminalDelegate</a>
  122. </li>
  123. <li class="nav-group-task">
  124. <a href="../Protocols/TerminalImage.html">TerminalImage</a>
  125. </li>
  126. <li class="nav-group-task">
  127. <a href="../Protocols/TerminalViewDelegate.html">TerminalViewDelegate</a>
  128. </li>
  129. </ul>
  130. </li>
  131. <li class="nav-group-name">
  132. <a href="../Structs.html">Structures</a>
  133. <ul class="nav-group-tasks">
  134. <li class="nav-group-task">
  135. <a href="../Structs/Attribute.html">Attribute</a>
  136. </li>
  137. <li class="nav-group-task">
  138. <a href="../Structs/Attribute/Color.html">– Color</a>
  139. </li>
  140. <li class="nav-group-task">
  141. <a href="../Structs/CharData.html">CharData</a>
  142. </li>
  143. <li class="nav-group-task">
  144. <a href="../Structs/CharacterStyle.html">CharacterStyle</a>
  145. </li>
  146. <li class="nav-group-task">
  147. <a href="../Structs/TerminalOptions.html">TerminalOptions</a>
  148. </li>
  149. <li class="nav-group-task">
  150. <a href="../Structs/TinyAtom.html">TinyAtom</a>
  151. </li>
  152. </ul>
  153. </li>
  154. <li class="nav-group-name">
  155. <a href="../Typealiases.html">Type Aliases</a>
  156. <ul class="nav-group-tasks">
  157. <li class="nav-group-task">
  158. <a href="../Typealiases.html#/TTImage">TTImage</a>
  159. </li>
  160. <li class="nav-group-task">
  161. <a href="../Typealiases.html#/s:9SwiftTerm7TTImagea">TTImage</a>
  162. </li>
  163. </ul>
  164. </li>
  165. </ul>
  166. </nav>
  167. <article class="main-content">
  168. <section>
  169. <section class="section">
  170. <h1>BufferLine</h1>
  171. <div class="declaration">
  172. <div class="language">
  173. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">BufferLine</span> <span class="p">:</span> <span class="kt">CustomDebugStringConvertible</span></code></pre>
  174. </div>
  175. </div>
  176. <p>Undocumented</p>
  177. </section>
  178. <section class="section task-group-section">
  179. <div class="task-group">
  180. <ul>
  181. <li class="item">
  182. <div>
  183. <code>
  184. <a name="/s:9SwiftTerm10BufferLineC4cols8fillData9isWrappedACSi_AA04CharG0VSgSbtcfc"></a>
  185. <a name="//apple_ref/swift/Method/init(cols:fillData:isWrapped:)" class="dashAnchor"></a>
  186. <a class="token" href="#/s:9SwiftTerm10BufferLineC4cols8fillData9isWrappedACSi_AA04CharG0VSgSbtcfc">init(cols:<wbr>fillData:<wbr>isWrapped:<wbr>)</a>
  187. </code>
  188. </div>
  189. <div class="height-container">
  190. <div class="pointer-container"></div>
  191. <section class="section">
  192. <div class="pointer"></div>
  193. <div class="abstract">
  194. <p>Undocumented</p>
  195. </div>
  196. <div class="declaration">
  197. <h4>Declaration</h4>
  198. <div class="language">
  199. <p class="aside-title">Swift</p>
  200. <pre class="highlight swift"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="nv">cols</span><span class="p">:</span> <span class="kt">Int</span><span class="p">,</span> <span class="nv">fillData</span><span class="p">:</span> <span class="kt"><a href="../Structs/CharData.html">CharData</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span> <span class="nv">isWrapped</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">false</span><span class="p">)</span></code></pre>
  201. </div>
  202. </div>
  203. </section>
  204. </div>
  205. </li>
  206. <li class="item">
  207. <div>
  208. <code>
  209. <a name="/s:9SwiftTerm10BufferLineC4fromA2C_tcfc"></a>
  210. <a name="//apple_ref/swift/Method/init(from:)" class="dashAnchor"></a>
  211. <a class="token" href="#/s:9SwiftTerm10BufferLineC4fromA2C_tcfc">init(from:<wbr>)</a>
  212. </code>
  213. </div>
  214. <div class="height-container">
  215. <div class="pointer-container"></div>
  216. <section class="section">
  217. <div class="pointer"></div>
  218. <div class="abstract">
  219. <p>Undocumented</p>
  220. </div>
  221. <div class="declaration">
  222. <h4>Declaration</h4>
  223. <div class="language">
  224. <p class="aside-title">Swift</p>
  225. <pre class="highlight swift"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="n">from</span> <span class="nv">other</span><span class="p">:</span> <span class="kt">BufferLine</span><span class="p">)</span></code></pre>
  226. </div>
  227. </div>
  228. </section>
  229. </div>
  230. </li>
  231. <li class="item">
  232. <div>
  233. <code>
  234. <a name="/s:9SwiftTerm10BufferLineC5countSivp"></a>
  235. <a name="//apple_ref/swift/Property/count" class="dashAnchor"></a>
  236. <a class="token" href="#/s:9SwiftTerm10BufferLineC5countSivp">count</a>
  237. </code>
  238. </div>
  239. <div class="height-container">
  240. <div class="pointer-container"></div>
  241. <section class="section">
  242. <div class="pointer"></div>
  243. <div class="abstract">
  244. <p>Undocumented</p>
  245. </div>
  246. <div class="declaration">
  247. <h4>Declaration</h4>
  248. <div class="language">
  249. <p class="aside-title">Swift</p>
  250. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">count</span><span class="p">:</span> <span class="kt">Int</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  251. </div>
  252. </div>
  253. </section>
  254. </div>
  255. </li>
  256. <li class="item">
  257. <div>
  258. <code>
  259. <a name="/s:9SwiftTerm10BufferLineCyAA8CharDataVSicip"></a>
  260. <a name="//apple_ref/swift/Method/subscript(_:)" class="dashAnchor"></a>
  261. <a class="token" href="#/s:9SwiftTerm10BufferLineCyAA8CharDataVSicip">subscript(_:<wbr>)</a>
  262. </code>
  263. </div>
  264. <div class="height-container">
  265. <div class="pointer-container"></div>
  266. <section class="section">
  267. <div class="pointer"></div>
  268. <div class="abstract">
  269. <p>Undocumented</p>
  270. </div>
  271. <div class="declaration">
  272. <h4>Declaration</h4>
  273. <div class="language">
  274. <p class="aside-title">Swift</p>
  275. <pre class="highlight swift"><code><span class="kd">public</span> <span class="nf">subscript</span><span class="p">(</span><span class="nv">index</span><span class="p">:</span> <span class="kt">Int</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Structs/CharData.html">CharData</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
  276. </div>
  277. </div>
  278. </section>
  279. </div>
  280. </li>
  281. <li class="item">
  282. <div>
  283. <code>
  284. <a name="/s:9SwiftTerm10BufferLineC8getWidth5indexS2i_tF"></a>
  285. <a name="//apple_ref/swift/Method/getWidth(index:)" class="dashAnchor"></a>
  286. <a class="token" href="#/s:9SwiftTerm10BufferLineC8getWidth5indexS2i_tF">getWidth(index:<wbr>)</a>
  287. </code>
  288. </div>
  289. <div class="height-container">
  290. <div class="pointer-container"></div>
  291. <section class="section">
  292. <div class="pointer"></div>
  293. <div class="abstract">
  294. <p>Undocumented</p>
  295. </div>
  296. <div class="declaration">
  297. <h4>Declaration</h4>
  298. <div class="language">
  299. <p class="aside-title">Swift</p>
  300. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">getWidth</span><span class="p">(</span><span class="nv">index</span><span class="p">:</span> <span class="kt">Int</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Int</span></code></pre>
  301. </div>
  302. </div>
  303. </section>
  304. </div>
  305. </li>
  306. <li class="item">
  307. <div>
  308. <code>
  309. <a name="/s:9SwiftTerm10BufferLineC10hasContent5indexSbSi_tF"></a>
  310. <a name="//apple_ref/swift/Method/hasContent(index:)" class="dashAnchor"></a>
  311. <a class="token" href="#/s:9SwiftTerm10BufferLineC10hasContent5indexSbSi_tF">hasContent(index:<wbr>)</a>
  312. </code>
  313. </div>
  314. <div class="height-container">
  315. <div class="pointer-container"></div>
  316. <section class="section">
  317. <div class="pointer"></div>
  318. <div class="abstract">
  319. <p>Test whether contains any chars.</p>
  320. </div>
  321. <div class="declaration">
  322. <h4>Declaration</h4>
  323. <div class="language">
  324. <p class="aside-title">Swift</p>
  325. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">hasContent</span><span class="p">(</span><span class="nv">index</span><span class="p">:</span> <span class="kt">Int</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Bool</span></code></pre>
  326. </div>
  327. </div>
  328. </section>
  329. </div>
  330. </li>
  331. <li class="item">
  332. <div>
  333. <code>
  334. <a name="/s:9SwiftTerm10BufferLineC13hasAnyContentSbyF"></a>
  335. <a name="//apple_ref/swift/Method/hasAnyContent()" class="dashAnchor"></a>
  336. <a class="token" href="#/s:9SwiftTerm10BufferLineC13hasAnyContentSbyF">hasAnyContent()</a>
  337. </code>
  338. </div>
  339. <div class="height-container">
  340. <div class="pointer-container"></div>
  341. <section class="section">
  342. <div class="pointer"></div>
  343. <div class="abstract">
  344. <p>Undocumented</p>
  345. </div>
  346. <div class="declaration">
  347. <h4>Declaration</h4>
  348. <div class="language">
  349. <p class="aside-title">Swift</p>
  350. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">hasAnyContent</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="kt">Bool</span></code></pre>
  351. </div>
  352. </div>
  353. </section>
  354. </div>
  355. </li>
  356. <li class="item">
  357. <div>
  358. <code>
  359. <a name="/s:9SwiftTerm10BufferLineC11insertCells3pos1n11rightMargin8fillDataySi_S2iAA04CharK0VtF"></a>
  360. <a name="//apple_ref/swift/Method/insertCells(pos:n:rightMargin:fillData:)" class="dashAnchor"></a>
  361. <a class="token" href="#/s:9SwiftTerm10BufferLineC11insertCells3pos1n11rightMargin8fillDataySi_S2iAA04CharK0VtF">insertCells(pos:<wbr>n:<wbr>rightMargin:<wbr>fillData:<wbr>)</a>
  362. </code>
  363. </div>
  364. <div class="height-container">
  365. <div class="pointer-container"></div>
  366. <section class="section">
  367. <div class="pointer"></div>
  368. <div class="abstract">
  369. <p>Undocumented</p>
  370. </div>
  371. <div class="declaration">
  372. <h4>Declaration</h4>
  373. <div class="language">
  374. <p class="aside-title">Swift</p>
  375. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">insertCells</span><span class="p">(</span><span class="nv">pos</span><span class="p">:</span> <span class="kt">Int</span><span class="p">,</span> <span class="nv">n</span><span class="p">:</span> <span class="kt">Int</span><span class="p">,</span> <span class="nv">rightMargin</span><span class="p">:</span> <span class="kt">Int</span><span class="p">,</span> <span class="nv">fillData</span><span class="p">:</span> <span class="kt"><a href="../Structs/CharData.html">CharData</a></span><span class="p">)</span></code></pre>
  376. </div>
  377. </div>
  378. </section>
  379. </div>
  380. </li>
  381. <li class="item">
  382. <div>
  383. <code>
  384. <a name="/s:9SwiftTerm10BufferLineC11deleteCells3pos1n11rightMargin8fillDataySi_S2iAA04CharK0VtF"></a>
  385. <a name="//apple_ref/swift/Method/deleteCells(pos:n:rightMargin:fillData:)" class="dashAnchor"></a>
  386. <a class="token" href="#/s:9SwiftTerm10BufferLineC11deleteCells3pos1n11rightMargin8fillDataySi_S2iAA04CharK0VtF">deleteCells(pos:<wbr>n:<wbr>rightMargin:<wbr>fillData:<wbr>)</a>
  387. </code>
  388. </div>
  389. <div class="height-container">
  390. <div class="pointer-container"></div>
  391. <section class="section">
  392. <div class="pointer"></div>
  393. <div class="abstract">
  394. <p>Undocumented</p>
  395. </div>
  396. <div class="declaration">
  397. <h4>Declaration</h4>
  398. <div class="language">
  399. <p class="aside-title">Swift</p>
  400. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">deleteCells</span><span class="p">(</span><span class="nv">pos</span><span class="p">:</span> <span class="kt">Int</span><span class="p">,</span> <span class="nv">n</span><span class="p">:</span> <span class="kt">Int</span><span class="p">,</span> <span class="nv">rightMargin</span><span class="p">:</span> <span class="kt">Int</span><span class="p">,</span> <span class="nv">fillData</span><span class="p">:</span> <span class="kt"><a href="../Structs/CharData.html">CharData</a></span><span class="p">)</span></code></pre>
  401. </div>
  402. </div>
  403. </section>
  404. </div>
  405. </li>
  406. <li class="item">
  407. <div>
  408. <code>
  409. <a name="/s:9SwiftTerm10BufferLineC12replaceCells5start3end8fillDataySi_SiAA04CharJ0VtF"></a>
  410. <a name="//apple_ref/swift/Method/replaceCells(start:end:fillData:)" class="dashAnchor"></a>
  411. <a class="token" href="#/s:9SwiftTerm10BufferLineC12replaceCells5start3end8fillDataySi_SiAA04CharJ0VtF">replaceCells(start:<wbr>end:<wbr>fillData:<wbr>)</a>
  412. </code>
  413. </div>
  414. <div class="height-container">
  415. <div class="pointer-container"></div>
  416. <section class="section">
  417. <div class="pointer"></div>
  418. <div class="abstract">
  419. <p>Undocumented</p>
  420. </div>
  421. <div class="declaration">
  422. <h4>Declaration</h4>
  423. <div class="language">
  424. <p class="aside-title">Swift</p>
  425. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">replaceCells</span><span class="p">(</span><span class="nv">start</span><span class="p">:</span> <span class="kt">Int</span><span class="p">,</span> <span class="nv">end</span><span class="p">:</span> <span class="kt">Int</span><span class="p">,</span> <span class="nv">fillData</span><span class="p">:</span> <span class="kt"><a href="../Structs/CharData.html">CharData</a></span><span class="p">)</span></code></pre>
  426. </div>
  427. </div>
  428. </section>
  429. </div>
  430. </li>
  431. <li class="item">
  432. <div>
  433. <code>
  434. <a name="/s:9SwiftTerm10BufferLineC6resize4cols8fillDataySi_AA04CharH0VtF"></a>
  435. <a name="//apple_ref/swift/Method/resize(cols:fillData:)" class="dashAnchor"></a>
  436. <a class="token" href="#/s:9SwiftTerm10BufferLineC6resize4cols8fillDataySi_AA04CharH0VtF">resize(cols:<wbr>fillData:<wbr>)</a>
  437. </code>
  438. </div>
  439. <div class="height-container">
  440. <div class="pointer-container"></div>
  441. <section class="section">
  442. <div class="pointer"></div>
  443. <div class="abstract">
  444. <p>Undocumented</p>
  445. </div>
  446. <div class="declaration">
  447. <h4>Declaration</h4>
  448. <div class="language">
  449. <p class="aside-title">Swift</p>
  450. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">resize</span><span class="p">(</span><span class="nv">cols</span><span class="p">:</span> <span class="kt">Int</span><span class="p">,</span> <span class="nv">fillData</span><span class="p">:</span> <span class="kt"><a href="../Structs/CharData.html">CharData</a></span><span class="p">)</span></code></pre>
  451. </div>
  452. </div>
  453. </section>
  454. </div>
  455. </li>
  456. <li class="item">
  457. <div>
  458. <code>
  459. <a name="/s:9SwiftTerm10BufferLineC4fill4withyAA8CharDataV_tF"></a>
  460. <a name="//apple_ref/swift/Method/fill(with:)" class="dashAnchor"></a>
  461. <a class="token" href="#/s:9SwiftTerm10BufferLineC4fill4withyAA8CharDataV_tF">fill(with:<wbr>)</a>
  462. </code>
  463. </div>
  464. <div class="height-container">
  465. <div class="pointer-container"></div>
  466. <section class="section">
  467. <div class="pointer"></div>
  468. <div class="abstract">
  469. <p>Undocumented</p>
  470. </div>
  471. <div class="declaration">
  472. <h4>Declaration</h4>
  473. <div class="language">
  474. <p class="aside-title">Swift</p>
  475. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">fill</span><span class="p">(</span><span class="nv">with</span><span class="p">:</span> <span class="kt"><a href="../Structs/CharData.html">CharData</a></span><span class="p">)</span></code></pre>
  476. </div>
  477. </div>
  478. </section>
  479. </div>
  480. </li>
  481. <li class="item">
  482. <div>
  483. <code>
  484. <a name="/s:9SwiftTerm10BufferLineC4fill4with5atCol3lenyAA8CharDataV_S2itF"></a>
  485. <a name="//apple_ref/swift/Method/fill(with:atCol:len:)" class="dashAnchor"></a>
  486. <a class="token" href="#/s:9SwiftTerm10BufferLineC4fill4with5atCol3lenyAA8CharDataV_S2itF">fill(with:<wbr>atCol:<wbr>len:<wbr>)</a>
  487. </code>
  488. </div>
  489. <div class="height-container">
  490. <div class="pointer-container"></div>
  491. <section class="section">
  492. <div class="pointer"></div>
  493. <div class="abstract">
  494. <p>Undocumented</p>
  495. </div>
  496. <div class="declaration">
  497. <h4>Declaration</h4>
  498. <div class="language">
  499. <p class="aside-title">Swift</p>
  500. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">fill</span><span class="p">(</span><span class="nv">with</span><span class="p">:</span> <span class="kt"><a href="../Structs/CharData.html">CharData</a></span><span class="p">,</span> <span class="nv">atCol</span><span class="p">:</span> <span class="kt">Int</span><span class="p">,</span> <span class="nv">len</span><span class="p">:</span> <span class="kt">Int</span><span class="p">)</span></code></pre>
  501. </div>
  502. </div>
  503. </section>
  504. </div>
  505. </li>
  506. <li class="item">
  507. <div>
  508. <code>
  509. <a name="/s:9SwiftTerm10BufferLineC8copyFrom4lineyAC_tF"></a>
  510. <a name="//apple_ref/swift/Method/copyFrom(line:)" class="dashAnchor"></a>
  511. <a class="token" href="#/s:9SwiftTerm10BufferLineC8copyFrom4lineyAC_tF">copyFrom(line:<wbr>)</a>
  512. </code>
  513. </div>
  514. <div class="height-container">
  515. <div class="pointer-container"></div>
  516. <section class="section">
  517. <div class="pointer"></div>
  518. <div class="abstract">
  519. <p>Undocumented</p>
  520. </div>
  521. <div class="declaration">
  522. <h4>Declaration</h4>
  523. <div class="language">
  524. <p class="aside-title">Swift</p>
  525. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">copyFrom</span><span class="p">(</span><span class="nv">line</span><span class="p">:</span> <span class="kt">BufferLine</span><span class="p">)</span></code></pre>
  526. </div>
  527. </div>
  528. </section>
  529. </div>
  530. </li>
  531. <li class="item">
  532. <div>
  533. <code>
  534. <a name="/s:9SwiftTerm10BufferLineC16getTrimmedLengthSiyF"></a>
  535. <a name="//apple_ref/swift/Method/getTrimmedLength()" class="dashAnchor"></a>
  536. <a class="token" href="#/s:9SwiftTerm10BufferLineC16getTrimmedLengthSiyF">getTrimmedLength()</a>
  537. </code>
  538. </div>
  539. <div class="height-container">
  540. <div class="pointer-container"></div>
  541. <section class="section">
  542. <div class="pointer"></div>
  543. <div class="abstract">
  544. <p>Returns the trimmed length in terms of cells used from the BufferLine</p>
  545. </div>
  546. <div class="declaration">
  547. <h4>Declaration</h4>
  548. <div class="language">
  549. <p class="aside-title">Swift</p>
  550. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">getTrimmedLength</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="kt">Int</span></code></pre>
  551. </div>
  552. </div>
  553. </section>
  554. </div>
  555. </li>
  556. <li class="item">
  557. <div>
  558. <code>
  559. <a name="/s:9SwiftTerm10BufferLineC8copyFrom_6srcCol03dstH03lenyAC_S3itF"></a>
  560. <a name="//apple_ref/swift/Method/copyFrom(_:srcCol:dstCol:len:)" class="dashAnchor"></a>
  561. <a class="token" href="#/s:9SwiftTerm10BufferLineC8copyFrom_6srcCol03dstH03lenyAC_S3itF">copyFrom(_:<wbr>srcCol:<wbr>dstCol:<wbr>len:<wbr>)</a>
  562. </code>
  563. </div>
  564. <div class="height-container">
  565. <div class="pointer-container"></div>
  566. <section class="section">
  567. <div class="pointer"></div>
  568. <div class="abstract">
  569. <p>Undocumented</p>
  570. </div>
  571. <div class="declaration">
  572. <h4>Declaration</h4>
  573. <div class="language">
  574. <p class="aside-title">Swift</p>
  575. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">copyFrom</span><span class="p">(</span><span class="n">_</span> <span class="nv">src</span><span class="p">:</span> <span class="kt">BufferLine</span><span class="p">,</span> <span class="nv">srcCol</span><span class="p">:</span> <span class="kt">Int</span><span class="p">,</span> <span class="nv">dstCol</span><span class="p">:</span> <span class="kt">Int</span><span class="p">,</span> <span class="nv">len</span><span class="p">:</span> <span class="kt">Int</span><span class="p">)</span></code></pre>
  576. </div>
  577. </div>
  578. </section>
  579. </div>
  580. </li>
  581. <li class="item">
  582. <div>
  583. <code>
  584. <a name="/s:9SwiftTerm10BufferLineC17translateToString9trimRight8startCol03endK0SSSb_S2itF"></a>
  585. <a name="//apple_ref/swift/Method/translateToString(trimRight:startCol:endCol:)" class="dashAnchor"></a>
  586. <a class="token" href="#/s:9SwiftTerm10BufferLineC17translateToString9trimRight8startCol03endK0SSSb_S2itF">translateToString(trimRight:<wbr>startCol:<wbr>endCol:<wbr>)</a>
  587. </code>
  588. </div>
  589. <div class="height-container">
  590. <div class="pointer-container"></div>
  591. <section class="section">
  592. <div class="pointer"></div>
  593. <div class="abstract">
  594. <p>Returns the contents of the line as a string in the specified range</p>
  595. </div>
  596. <div class="declaration">
  597. <h4>Declaration</h4>
  598. <div class="language">
  599. <p class="aside-title">Swift</p>
  600. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">translateToString</span><span class="p">(</span><span class="nv">trimRight</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">false</span><span class="p">,</span> <span class="nv">startCol</span><span class="p">:</span> <span class="kt">Int</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> <span class="nv">endCol</span><span class="p">:</span> <span class="kt">Int</span> <span class="o">=</span> <span class="o">-</span><span class="mi">1</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">String</span></code></pre>
  601. </div>
  602. </div>
  603. <div>
  604. <h4>Parameters</h4>
  605. <table class="graybox">
  606. <tbody>
  607. <tr>
  608. <td>
  609. <code>
  610. <em>trimRight</em>
  611. </code>
  612. </td>
  613. <td>
  614. <div>
  615. <p>if <code>true</code>, then this will trim any empty space from the right side
  616. of the terminal, otherwise, blanks will be included</p>
  617. </div>
  618. </td>
  619. </tr>
  620. <tr>
  621. <td>
  622. <code>
  623. <em>startCol</em>
  624. </code>
  625. </td>
  626. <td>
  627. <div>
  628. <p>the starting column to copy the data from, defaults toe zero if not provided</p>
  629. </div>
  630. </td>
  631. </tr>
  632. <tr>
  633. <td>
  634. <code>
  635. <em>endCol</em>
  636. </code>
  637. </td>
  638. <td>
  639. <div>
  640. <p>the end column (not included) to consume. If the value -1, this copies all the way to the end</p>
  641. </div>
  642. </td>
  643. </tr>
  644. </tbody>
  645. </table>
  646. </div>
  647. <div>
  648. <h4>Return Value</h4>
  649. <p>a string containing the contents of the BufferLine from [startCol..&lt;endCol]</p>
  650. </div>
  651. </section>
  652. </div>
  653. </li>
  654. <li class="item">
  655. <div>
  656. <code>
  657. <a name="/s:9SwiftTerm10BufferLineC6attach5imageyAA13TerminalImage_p_tF"></a>
  658. <a name="//apple_ref/swift/Method/attach(image:)" class="dashAnchor"></a>
  659. <a class="token" href="#/s:9SwiftTerm10BufferLineC6attach5imageyAA13TerminalImage_p_tF">attach(image:<wbr>)</a>
  660. </code>
  661. </div>
  662. <div class="height-container">
  663. <div class="pointer-container"></div>
  664. <section class="section">
  665. <div class="pointer"></div>
  666. <div class="abstract">
  667. <p>Undocumented</p>
  668. </div>
  669. <div class="declaration">
  670. <h4>Declaration</h4>
  671. <div class="language">
  672. <p class="aside-title">Swift</p>
  673. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">attach</span><span class="p">(</span><span class="nv">image</span><span class="p">:</span> <span class="kt"><a href="../Protocols/TerminalImage.html">TerminalImage</a></span><span class="p">)</span></code></pre>
  674. </div>
  675. </div>
  676. </section>
  677. </div>
  678. </li>
  679. <li class="item">
  680. <div>
  681. <code>
  682. <a name="/s:s28CustomDebugStringConvertibleP16debugDescriptionSSvp"></a>
  683. <a name="//apple_ref/swift/Property/debugDescription" class="dashAnchor"></a>
  684. <a class="token" href="#/s:s28CustomDebugStringConvertibleP16debugDescriptionSSvp">debugDescription</a>
  685. </code>
  686. </div>
  687. <div class="height-container">
  688. <div class="pointer-container"></div>
  689. <section class="section">
  690. <div class="pointer"></div>
  691. <div class="abstract">
  692. </div>
  693. <div class="declaration">
  694. <h4>Declaration</h4>
  695. <div class="language">
  696. <p class="aside-title">Swift</p>
  697. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">debugDescription</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  698. </div>
  699. </div>
  700. </section>
  701. </div>
  702. </li>
  703. </ul>
  704. </div>
  705. </section>
  706. </section>
  707. <section id="footer">
  708. <p>&copy; 2021 <a class="link" href="https://tirania.org/" target="_blank" rel="external">Miguel de Icaza</a>. All rights reserved. (Last updated: 2021-04-28)</p>
  709. <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  710. </section>
  711. </article>
  712. </div>
  713. </body>
  714. </div>
  715. </html>