/usr/share/doc/libghc-vty-doc/html/Graphics-Vty-Span.html is in libghc-vty-doc 5.11.3-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Graphics.Vty.Span</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script src="file:///usr/share/javascript/mathjax/MathJax.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();setSynopsis("mini_Graphics-Vty-Span.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Graphics-Vty-Span.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">vty-5.11.3: A simple terminal UI library</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Safe Haskell</th><td>None</td></tr><tr><th>Language</th><td>Haskell2010</td></tr></table><p class="caption">Graphics.Vty.Span</p></div><div id="description"><p class="caption">Description</p><div class="doc"><p>A picture is translated into a sequences of state changes and character spans.
- State changes are currently limited to new attribute values. The attribute is applied to all
- following spans. Including spans of the next row. The nth element of the sequence represents the
- nth row (from top to bottom) of the picture to render.
-
- A span op sequence will be defined for all rows and columns (and no more) of the region provided
- with the picture to <code>spansForPic</code>.
-
- todo: Partition attribute changes into multiple categories according to the serialized
- representation of the various attributes.</p></div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><span class="keyword">data</span> <a href="#t:SpanOp">SpanOp</a><ul class="subs"><li>= <a href="#v:TextSpan">TextSpan</a> { <ul class="subs"><li><a href="#v:textSpanAttr">textSpanAttr</a> :: !<a href="Graphics-Vty-Attributes.html#t:Attr">Attr</a></li><li><a href="#v:textSpanOutputWidth">textSpanOutputWidth</a> :: !<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a></li><li><a href="#v:textSpanCharWidth">textSpanCharWidth</a> :: !<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a></li><li><a href="#v:textSpanText">textSpanText</a> :: <a href="Graphics-Vty-Image.html#t:DisplayText">DisplayText</a></li></ul> }</li><li>| <a href="#v:Skip">Skip</a> !<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a></li><li>| <a href="#v:RowEnd">RowEnd</a> !<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a></li></ul></li><li class="src short"><span class="keyword">type</span> <a href="#t:SpanOps">SpanOps</a> = <a href="file:///usr/share/doc/libghc-vector-doc/html/Data-Vector.html#t:Vector">Vector</a> <a href="Graphics-Vty-Span.html#t:SpanOp">SpanOp</a></li><li class="src short"><a href="#v:dropOps">dropOps</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a> -> <a href="Graphics-Vty-Span.html#t:SpanOps">SpanOps</a> -> <a href="Graphics-Vty-Span.html#t:SpanOps">SpanOps</a></li><li class="src short"><a href="#v:splitOpsAt">splitOpsAt</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a> -> <a href="Graphics-Vty-Span.html#t:SpanOps">SpanOps</a> -> (<a href="Graphics-Vty-Span.html#t:SpanOps">SpanOps</a>, <a href="Graphics-Vty-Span.html#t:SpanOps">SpanOps</a>)</li><li class="src short"><span class="keyword">type</span> <a href="#t:DisplayOps">DisplayOps</a> = <a href="file:///usr/share/doc/libghc-vector-doc/html/Data-Vector.html#t:Vector">Vector</a> <a href="Graphics-Vty-Span.html#t:SpanOps">SpanOps</a></li><li class="src short"><a href="#v:displayOpsColumns">displayOpsColumns</a> :: <a href="Graphics-Vty-Span.html#t:DisplayOps">DisplayOps</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a></li><li class="src short"><a href="#v:displayOpsRows">displayOpsRows</a> :: <a href="Graphics-Vty-Span.html#t:DisplayOps">DisplayOps</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a></li><li class="src short"><a href="#v:effectedRegion">effectedRegion</a> :: <a href="Graphics-Vty-Span.html#t:DisplayOps">DisplayOps</a> -> <a href="Graphics-Vty-Prelude.html#t:DisplayRegion">DisplayRegion</a></li><li class="src short"><a href="#v:spanOpsEffectedColumns">spanOpsEffectedColumns</a> :: <a href="Graphics-Vty-Span.html#t:SpanOps">SpanOps</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a></li><li class="src short"><a href="#v:spanOpHasWidth">spanOpHasWidth</a> :: <a href="Graphics-Vty-Span.html#t:SpanOp">SpanOp</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Maybe.html#t:Maybe">Maybe</a> (<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a>, <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a>)</li><li class="src short"><a href="#v:columnsToCharOffset">columnsToCharOffset</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a> -> <a href="Graphics-Vty-Span.html#t:SpanOp">SpanOp</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a></li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><span class="keyword">data</span> <a id="t:SpanOp" class="def">SpanOp</a> <a href="src/Graphics-Vty-Span.html#SpanOp" class="link">Source</a> <a href="#t:SpanOp" class="selflink">#</a></p><div class="doc"><p>This represents an operation on the terminal. Either an attribute change or the output of a
text string.</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a id="v:TextSpan" class="def">TextSpan</a></td><td class="doc"><p>a span of UTF-8 text occupies a specific number of screen space columns. A single UTF
character does not necessarially represent 1 colunm. See Codec.Binary.UTF8.Width
TextSpan [Attr] [output width in columns] [number of characters] [data]</p></td></tr><tr><td colspan="2"><div class="subs fields"><p class="caption">Fields</p><ul><li><dfn class="src"><a id="v:textSpanAttr" class="def">textSpanAttr</a> :: !<a href="Graphics-Vty-Attributes.html#t:Attr">Attr</a></dfn><div class="doc empty"> </div></li><li><dfn class="src"><a id="v:textSpanOutputWidth" class="def">textSpanOutputWidth</a> :: !<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a></dfn><div class="doc empty"> </div></li><li><dfn class="src"><a id="v:textSpanCharWidth" class="def">textSpanCharWidth</a> :: !<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a></dfn><div class="doc empty"> </div></li><li><dfn class="src"><a id="v:textSpanText" class="def">textSpanText</a> :: <a href="Graphics-Vty-Image.html#t:DisplayText">DisplayText</a></dfn><div class="doc empty"> </div></li></ul></div></td></tr><tr><td class="src"><a id="v:Skip" class="def">Skip</a> !<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a></td><td class="doc"><p>Skips the given number of columns
A skip is transparent.... maybe? I am not sure how attribute changes interact.
todo: separate from this type.</p></td></tr><tr><td class="src"><a id="v:RowEnd" class="def">RowEnd</a> !<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a></td><td class="doc"><p>Marks the end of a row. specifies how many columns are remaining. These columns will not be
explicitly overwritten with the span ops. The terminal is require to assure the remaining
columns are clear.
todo: separate from this type.</p></td></tr></table></div><div class="subs instances"><p id="control.i:SpanOp" class="caption collapser" onclick="toggleSection('i:SpanOp')">Instances</p><div id="section.i:SpanOp" class="show"><table><tr><td class="src clearfix"><span class="inst-left"><span id="control.i:id:SpanOp:Eq:1" class="instance expander" onclick="toggleSection('i:id:SpanOp:Eq:1')"></span> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Eq.html#t:Eq">Eq</a> <a href="Graphics-Vty-Span.html#t:SpanOp">SpanOp</a></span> <a href="src/Graphics-Vty-Span.html#line-49" class="link">Source</a> <a href="#t:SpanOp" class="selflink">#</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div id="section.i:id:SpanOp:Eq:1" class="inst-details hide"><div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:-61--61-">(==)</a> :: <a href="Graphics-Vty-Span.html#t:SpanOp">SpanOp</a> -> <a href="Graphics-Vty-Span.html#t:SpanOp">SpanOp</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Bool.html#t:Bool">Bool</a> <a href="#v:-61--61-" class="selflink">#</a></p><p class="src"><a href="#v:-47--61-">(/=)</a> :: <a href="Graphics-Vty-Span.html#t:SpanOp">SpanOp</a> -> <a href="Graphics-Vty-Span.html#t:SpanOp">SpanOp</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Bool.html#t:Bool">Bool</a> <a href="#v:-47--61-" class="selflink">#</a></p></div></div></td></tr><tr><td class="src clearfix"><span class="inst-left"><span id="control.i:id:SpanOp:Show:2" class="instance expander" onclick="toggleSection('i:id:SpanOp:Show:2')"></span> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Text-Show.html#t:Show">Show</a> <a href="Graphics-Vty-Span.html#t:SpanOp">SpanOp</a></span> <a href="src/Graphics-Vty-Span.html#line-97" class="link">Source</a> <a href="#t:SpanOp" class="selflink">#</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div id="section.i:id:SpanOp:Show:2" class="inst-details hide"><div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:showsPrec">showsPrec</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a> -> <a href="Graphics-Vty-Span.html#t:SpanOp">SpanOp</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Text-Show.html#t:ShowS">ShowS</a> <a href="#v:showsPrec" class="selflink">#</a></p><p class="src"><a href="#v:show">show</a> :: <a href="Graphics-Vty-Span.html#t:SpanOp">SpanOp</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-String.html#t:String">String</a> <a href="#v:show" class="selflink">#</a></p><p class="src"><a href="#v:showList">showList</a> :: [<a href="Graphics-Vty-Span.html#t:SpanOp">SpanOp</a>] -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Text-Show.html#t:ShowS">ShowS</a> <a href="#v:showList" class="selflink">#</a></p></div></div></td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">type</span> <a id="t:SpanOps" class="def">SpanOps</a> = <a href="file:///usr/share/doc/libghc-vector-doc/html/Data-Vector.html#t:Vector">Vector</a> <a href="Graphics-Vty-Span.html#t:SpanOp">SpanOp</a> <a href="src/Graphics-Vty-Span.html#SpanOps" class="link">Source</a> <a href="#t:SpanOps" class="selflink">#</a></p><div class="doc"><p>vector of span operations. executed in succession. This represents the operations required to
render a row of the terminal. The operations in one row may effect subsequent rows.
EG: Setting the foreground color in one row will effect all subsequent rows until the foreground
color is changed.</p></div></div><div class="top"><p class="src"><a id="v:dropOps" class="def">dropOps</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a> -> <a href="Graphics-Vty-Span.html#t:SpanOps">SpanOps</a> -> <a href="Graphics-Vty-Span.html#t:SpanOps">SpanOps</a> <a href="src/Graphics-Vty-Span.html#dropOps" class="link">Source</a> <a href="#v:dropOps" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:splitOpsAt" class="def">splitOpsAt</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a> -> <a href="Graphics-Vty-Span.html#t:SpanOps">SpanOps</a> -> (<a href="Graphics-Vty-Span.html#t:SpanOps">SpanOps</a>, <a href="Graphics-Vty-Span.html#t:SpanOps">SpanOps</a>) <a href="src/Graphics-Vty-Span.html#splitOpsAt" class="link">Source</a> <a href="#v:splitOpsAt" class="selflink">#</a></p></div><div class="top"><p class="src"><span class="keyword">type</span> <a id="t:DisplayOps" class="def">DisplayOps</a> = <a href="file:///usr/share/doc/libghc-vector-doc/html/Data-Vector.html#t:Vector">Vector</a> <a href="Graphics-Vty-Span.html#t:SpanOps">SpanOps</a> <a href="src/Graphics-Vty-Span.html#DisplayOps" class="link">Source</a> <a href="#t:DisplayOps" class="selflink">#</a></p><div class="doc"><p>vector of span operation vectors for display. One per row of the output region.</p></div></div><div class="top"><p class="src"><a id="v:displayOpsColumns" class="def">displayOpsColumns</a> :: <a href="Graphics-Vty-Span.html#t:DisplayOps">DisplayOps</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a> <a href="src/Graphics-Vty-Span.html#displayOpsColumns" class="link">Source</a> <a href="#v:displayOpsColumns" class="selflink">#</a></p><div class="doc"><p>Number of columns the DisplayOps are defined for</p><p>All spans are verified to define same number of columns. See: VerifySpanOps</p></div></div><div class="top"><p class="src"><a id="v:displayOpsRows" class="def">displayOpsRows</a> :: <a href="Graphics-Vty-Span.html#t:DisplayOps">DisplayOps</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a> <a href="src/Graphics-Vty-Span.html#displayOpsRows" class="link">Source</a> <a href="#v:displayOpsRows" class="selflink">#</a></p><div class="doc"><p>Number of rows the DisplayOps are defined for</p></div></div><div class="top"><p class="src"><a id="v:effectedRegion" class="def">effectedRegion</a> :: <a href="Graphics-Vty-Span.html#t:DisplayOps">DisplayOps</a> -> <a href="Graphics-Vty-Prelude.html#t:DisplayRegion">DisplayRegion</a> <a href="src/Graphics-Vty-Span.html#effectedRegion" class="link">Source</a> <a href="#v:effectedRegion" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:spanOpsEffectedColumns" class="def">spanOpsEffectedColumns</a> :: <a href="Graphics-Vty-Span.html#t:SpanOps">SpanOps</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a> <a href="src/Graphics-Vty-Span.html#spanOpsEffectedColumns" class="link">Source</a> <a href="#v:spanOpsEffectedColumns" class="selflink">#</a></p><div class="doc"><p>The number of columns a SpanOps effects.</p></div></div><div class="top"><p class="src"><a id="v:spanOpHasWidth" class="def">spanOpHasWidth</a> :: <a href="Graphics-Vty-Span.html#t:SpanOp">SpanOp</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Maybe.html#t:Maybe">Maybe</a> (<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a>, <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a>) <a href="src/Graphics-Vty-Span.html#spanOpHasWidth" class="link">Source</a> <a href="#v:spanOpHasWidth" class="selflink">#</a></p><div class="doc"><p>The width of a single SpanOp in columns</p></div></div><div class="top"><p class="src"><a id="v:columnsToCharOffset" class="def">columnsToCharOffset</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a> -> <a href="Graphics-Vty-Span.html#t:SpanOp">SpanOp</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a> <a href="src/Graphics-Vty-Span.html#columnsToCharOffset" class="link">Source</a> <a href="#v:columnsToCharOffset" class="selflink">#</a></p><div class="doc"><p>returns the number of columns to the character at the given position in the span op</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.17.2</p></div></body></html>
|