123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757 |
- <!DOCTYPE html>
- <html lang="en">
- <head>
- <title>BufferLine Class Reference</title>
- <link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
- <link rel="stylesheet" type="text/css" href="../css/highlight.css" />
- <meta charset='utf-8'>
- <script src="../js/jquery.min.js" defer></script>
- <script src="../js/jazzy.js" defer></script>
-
- <script src="../js/lunr.min.js" defer></script>
- <script src="../js/typeahead.jquery.js" defer></script>
- <script src="../js/jazzy.search.js" defer></script>
- </head>
- <body>
- <a name="//apple_ref/swift/Class/BufferLine" class="dashAnchor"></a>
- <a title="BufferLine Class Reference"></a>
- <header>
- <div class="content-wrapper">
- <p><a href="../index.html">SwiftTerm 1.0 Docs</a> (68% documented)</p>
- <p class="header-right"><a href="https://github.com/migueldeicaza/SwiftTerm"><img src="../img/gh.png"/>View on GitHub</a></p>
- <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>
- <p class="header-right">
- <form role="search" action="../search.json">
- <input type="text" placeholder="Search documentation" data-typeahead>
- </form>
- </p>
- </div>
- </header>
- <div class="content-wrapper">
- <p id="breadcrumbs">
- <a href="../index.html">SwiftTerm Reference</a>
- <img id="carat" src="../img/carat.png" />
- BufferLine Class Reference
- </p>
- </div>
- <div class="content-wrapper">
- <nav class="sidebar">
- <ul class="nav-groups">
- <li class="nav-group-name">
- <a href="../Classes.html">Classes</a>
- <ul class="nav-group-tasks">
- <li class="nav-group-task">
- <a href="../Classes/BufferLine.html">BufferLine</a>
- </li>
- <li class="nav-group-task">
- <a href="../Classes/Color.html">Color</a>
- </li>
- <li class="nav-group-task">
- <a href="../Classes/HeadlessTerminal.html">HeadlessTerminal</a>
- </li>
- <li class="nav-group-task">
- <a href="../Classes/ImageCell.html">ImageCell</a>
- </li>
- <li class="nav-group-task">
- <a href="../Classes/LocalProcess.html">LocalProcess</a>
- </li>
- <li class="nav-group-task">
- <a href="../Classes/LocalProcessTerminalView.html">LocalProcessTerminalView</a>
- </li>
- <li class="nav-group-task">
- <a href="../Classes/PseudoTerminalHelpers.html">PseudoTerminalHelpers</a>
- </li>
- <li class="nav-group-task">
- <a href="../Classes/Terminal.html">Terminal</a>
- </li>
- <li class="nav-group-task">
- <a href="../Classes/Terminal/MouseMode.html">– MouseMode</a>
- </li>
- <li class="nav-group-task">
- <a href="../Classes/Terminal/WindowManipulationCommand.html">– WindowManipulationCommand</a>
- </li>
- <li class="nav-group-task">
- <a href="../Classes/Terminal/BufferKind.html">– BufferKind</a>
- </li>
- <li class="nav-group-task">
- <a href="../Classes/TerminalAccessory.html">TerminalAccessory</a>
- </li>
- <li class="nav-group-task">
- <a href="../Classes/TerminalDebugView.html">TerminalDebugView</a>
- </li>
- <li class="nav-group-task">
- <a href="../Classes/TerminalView.html">TerminalView</a>
- </li>
- <li class="nav-group-task">
- <a href="../Classes/TerminalView.html">TerminalView</a>
- </li>
- </ul>
- </li>
- <li class="nav-group-name">
- <a href="../Enums.html">Enumerations</a>
- <ul class="nav-group-tasks">
- <li class="nav-group-task">
- <a href="../Enums/CursorStyle.html">CursorStyle</a>
- </li>
- <li class="nav-group-task">
- <a href="../Enums/ImageSizeRequest.html">ImageSizeRequest</a>
- </li>
- </ul>
- </li>
- <li class="nav-group-name">
- <a href="../Extensions.html">Extensions</a>
- <ul class="nav-group-tasks">
- <li class="nav-group-task">
- <a href="../Extensions/TerminalViewDelegate.html">TerminalViewDelegate</a>
- </li>
- <li class="nav-group-task">
- <a href="../Extensions/UIImage.html">UIImage</a>
- </li>
- </ul>
- </li>
- <li class="nav-group-name">
- <a href="../Protocols.html">Protocols</a>
- <ul class="nav-group-tasks">
- <li class="nav-group-task">
- <a href="../Protocols/LocalProcessDelegate.html">LocalProcessDelegate</a>
- </li>
- <li class="nav-group-task">
- <a href="../Protocols/LocalProcessTerminalViewDelegate.html">LocalProcessTerminalViewDelegate</a>
- </li>
- <li class="nav-group-task">
- <a href="../Protocols/TerminalDelegate.html">TerminalDelegate</a>
- </li>
- <li class="nav-group-task">
- <a href="../Protocols/TerminalImage.html">TerminalImage</a>
- </li>
- <li class="nav-group-task">
- <a href="../Protocols/TerminalViewDelegate.html">TerminalViewDelegate</a>
- </li>
- </ul>
- </li>
- <li class="nav-group-name">
- <a href="../Structs.html">Structures</a>
- <ul class="nav-group-tasks">
- <li class="nav-group-task">
- <a href="../Structs/Attribute.html">Attribute</a>
- </li>
- <li class="nav-group-task">
- <a href="../Structs/Attribute/Color.html">– Color</a>
- </li>
- <li class="nav-group-task">
- <a href="../Structs/CharData.html">CharData</a>
- </li>
- <li class="nav-group-task">
- <a href="../Structs/CharacterStyle.html">CharacterStyle</a>
- </li>
- <li class="nav-group-task">
- <a href="../Structs/TerminalOptions.html">TerminalOptions</a>
- </li>
- <li class="nav-group-task">
- <a href="../Structs/TinyAtom.html">TinyAtom</a>
- </li>
- </ul>
- </li>
- <li class="nav-group-name">
- <a href="../Typealiases.html">Type Aliases</a>
- <ul class="nav-group-tasks">
- <li class="nav-group-task">
- <a href="../Typealiases.html#/TTImage">TTImage</a>
- </li>
- <li class="nav-group-task">
- <a href="../Typealiases.html#/s:9SwiftTerm7TTImagea">TTImage</a>
- </li>
- </ul>
- </li>
- </ul>
- </nav>
- <article class="main-content">
- <section>
- <section class="section">
- <h1>BufferLine</h1>
- <div class="declaration">
- <div class="language">
-
- <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>
- </div>
- </div>
- <p>Undocumented</p>
- </section>
- <section class="section task-group-section">
- <div class="task-group">
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:9SwiftTerm10BufferLineC4cols8fillData9isWrappedACSi_AA04CharG0VSgSbtcfc"></a>
- <a name="//apple_ref/swift/Method/init(cols:fillData:isWrapped:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9SwiftTerm10BufferLineC4cols8fillData9isWrappedACSi_AA04CharG0VSgSbtcfc">init(cols:<wbr>fillData:<wbr>isWrapped:<wbr>)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9SwiftTerm10BufferLineC4fromA2C_tcfc"></a>
- <a name="//apple_ref/swift/Method/init(from:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9SwiftTerm10BufferLineC4fromA2C_tcfc">init(from:<wbr>)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9SwiftTerm10BufferLineC5countSivp"></a>
- <a name="//apple_ref/swift/Property/count" class="dashAnchor"></a>
- <a class="token" href="#/s:9SwiftTerm10BufferLineC5countSivp">count</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9SwiftTerm10BufferLineCyAA8CharDataVSicip"></a>
- <a name="//apple_ref/swift/Method/subscript(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9SwiftTerm10BufferLineCyAA8CharDataVSicip">subscript(_:<wbr>)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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">-></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>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9SwiftTerm10BufferLineC8getWidth5indexS2i_tF"></a>
- <a name="//apple_ref/swift/Method/getWidth(index:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9SwiftTerm10BufferLineC8getWidth5indexS2i_tF">getWidth(index:<wbr>)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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">-></span> <span class="kt">Int</span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9SwiftTerm10BufferLineC10hasContent5indexSbSi_tF"></a>
- <a name="//apple_ref/swift/Method/hasContent(index:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9SwiftTerm10BufferLineC10hasContent5indexSbSi_tF">hasContent(index:<wbr>)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Test whether contains any chars.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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">-></span> <span class="kt">Bool</span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9SwiftTerm10BufferLineC13hasAnyContentSbyF"></a>
- <a name="//apple_ref/swift/Method/hasAnyContent()" class="dashAnchor"></a>
- <a class="token" href="#/s:9SwiftTerm10BufferLineC13hasAnyContentSbyF">hasAnyContent()</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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">-></span> <span class="kt">Bool</span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9SwiftTerm10BufferLineC11insertCells3pos1n11rightMargin8fillDataySi_S2iAA04CharK0VtF"></a>
- <a name="//apple_ref/swift/Method/insertCells(pos:n:rightMargin:fillData:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9SwiftTerm10BufferLineC11insertCells3pos1n11rightMargin8fillDataySi_S2iAA04CharK0VtF">insertCells(pos:<wbr>n:<wbr>rightMargin:<wbr>fillData:<wbr>)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9SwiftTerm10BufferLineC11deleteCells3pos1n11rightMargin8fillDataySi_S2iAA04CharK0VtF"></a>
- <a name="//apple_ref/swift/Method/deleteCells(pos:n:rightMargin:fillData:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9SwiftTerm10BufferLineC11deleteCells3pos1n11rightMargin8fillDataySi_S2iAA04CharK0VtF">deleteCells(pos:<wbr>n:<wbr>rightMargin:<wbr>fillData:<wbr>)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9SwiftTerm10BufferLineC12replaceCells5start3end8fillDataySi_SiAA04CharJ0VtF"></a>
- <a name="//apple_ref/swift/Method/replaceCells(start:end:fillData:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9SwiftTerm10BufferLineC12replaceCells5start3end8fillDataySi_SiAA04CharJ0VtF">replaceCells(start:<wbr>end:<wbr>fillData:<wbr>)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9SwiftTerm10BufferLineC6resize4cols8fillDataySi_AA04CharH0VtF"></a>
- <a name="//apple_ref/swift/Method/resize(cols:fillData:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9SwiftTerm10BufferLineC6resize4cols8fillDataySi_AA04CharH0VtF">resize(cols:<wbr>fillData:<wbr>)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9SwiftTerm10BufferLineC4fill4withyAA8CharDataV_tF"></a>
- <a name="//apple_ref/swift/Method/fill(with:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9SwiftTerm10BufferLineC4fill4withyAA8CharDataV_tF">fill(with:<wbr>)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9SwiftTerm10BufferLineC4fill4with5atCol3lenyAA8CharDataV_S2itF"></a>
- <a name="//apple_ref/swift/Method/fill(with:atCol:len:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9SwiftTerm10BufferLineC4fill4with5atCol3lenyAA8CharDataV_S2itF">fill(with:<wbr>atCol:<wbr>len:<wbr>)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9SwiftTerm10BufferLineC8copyFrom4lineyAC_tF"></a>
- <a name="//apple_ref/swift/Method/copyFrom(line:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9SwiftTerm10BufferLineC8copyFrom4lineyAC_tF">copyFrom(line:<wbr>)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9SwiftTerm10BufferLineC16getTrimmedLengthSiyF"></a>
- <a name="//apple_ref/swift/Method/getTrimmedLength()" class="dashAnchor"></a>
- <a class="token" href="#/s:9SwiftTerm10BufferLineC16getTrimmedLengthSiyF">getTrimmedLength()</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Returns the trimmed length in terms of cells used from the BufferLine</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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">-></span> <span class="kt">Int</span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9SwiftTerm10BufferLineC8copyFrom_6srcCol03dstH03lenyAC_S3itF"></a>
- <a name="//apple_ref/swift/Method/copyFrom(_:srcCol:dstCol:len:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9SwiftTerm10BufferLineC8copyFrom_6srcCol03dstH03lenyAC_S3itF">copyFrom(_:<wbr>srcCol:<wbr>dstCol:<wbr>len:<wbr>)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9SwiftTerm10BufferLineC17translateToString9trimRight8startCol03endK0SSSb_S2itF"></a>
- <a name="//apple_ref/swift/Method/translateToString(trimRight:startCol:endCol:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9SwiftTerm10BufferLineC17translateToString9trimRight8startCol03endK0SSSb_S2itF">translateToString(trimRight:<wbr>startCol:<wbr>endCol:<wbr>)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Returns the contents of the line as a string in the specified range</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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">-></span> <span class="kt">String</span></code></pre>
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>trimRight</em>
- </code>
- </td>
- <td>
- <div>
- <p>if <code>true</code>, then this will trim any empty space from the right side
- of the terminal, otherwise, blanks will be included</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>startCol</em>
- </code>
- </td>
- <td>
- <div>
- <p>the starting column to copy the data from, defaults toe zero if not provided</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>endCol</em>
- </code>
- </td>
- <td>
- <div>
- <p>the end column (not included) to consume. If the value -1, this copies all the way to the end</p>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>a string containing the contents of the BufferLine from [startCol..<endCol]</p>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9SwiftTerm10BufferLineC6attach5imageyAA13TerminalImage_p_tF"></a>
- <a name="//apple_ref/swift/Method/attach(image:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9SwiftTerm10BufferLineC6attach5imageyAA13TerminalImage_p_tF">attach(image:<wbr>)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:s28CustomDebugStringConvertibleP16debugDescriptionSSvp"></a>
- <a name="//apple_ref/swift/Property/debugDescription" class="dashAnchor"></a>
- <a class="token" href="#/s:s28CustomDebugStringConvertibleP16debugDescriptionSSvp">debugDescription</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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>
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- </section>
- </section>
- <section id="footer">
- <p>© 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>
- <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>
- </section>
- </article>
- </div>
- </body>
- </div>
- </html>
|