/usr/share/doc/libghc-vty-doc/html/Graphics-Vty.html is in libghc-vty-doc 4.7.0.10-2.
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 25 26 27 28 29 30 31 32 33 34 35 36 37 38 | <!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</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();setSynopsis("mini_Graphics-Vty.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Graphics-Vty.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-4.7.0.10: A simple terminal access library</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Safe Haskell</th><td>Safe-Infered</td></tr></table><p class="caption">Graphics.Vty</p></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:Vty">Vty</a> = <a href="#v:Vty">Vty</a> {<ul class="subs"><li><a href="#v:update">update</a> :: <a href="Graphics-Vty-Picture.html#t:Picture">Picture</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc-doc/html/libraries/ghc-prim-0.2.0.0/GHC-Tuple.html#t:-40--41-">()</a></li><li><a href="#v:next_event">next_event</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/System-IO.html#t:IO">IO</a> <a href="Graphics-Vty.html#t:Event">Event</a></li><li><a href="#v:terminal">terminal</a> :: <a href="Graphics-Vty-Terminal.html#t:TerminalHandle">TerminalHandle</a></li><li><a href="#v:refresh">refresh</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc-doc/html/libraries/ghc-prim-0.2.0.0/GHC-Tuple.html#t:-40--41-">()</a></li><li><a href="#v:shutdown">shutdown</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc-doc/html/libraries/ghc-prim-0.2.0.0/GHC-Tuple.html#t:-40--41-">()</a></li></ul>}</li><li class="src short"><a href="#v:mkVty">mkVty</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/System-IO.html#t:IO">IO</a> <a href="Graphics-Vty.html#t:Vty">Vty</a></li><li class="src short"><a href="#v:mkVtyEscDelay">mkVtyEscDelay</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Int.html#t:Int">Int</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/System-IO.html#t:IO">IO</a> <a href="Graphics-Vty.html#t:Vty">Vty</a></li><li class="src short">module <a href="Graphics-Vty-Terminal.html">Graphics.Vty.Terminal</a></li><li class="src short">module <a href="Graphics-Vty-Picture.html">Graphics.Vty.Picture</a></li><li class="src short">module <a href="Graphics-Vty-DisplayRegion.html">Graphics.Vty.DisplayRegion</a></li><li class="src short"><span class="keyword">data</span> <a href="#t:Key">Key</a> <ul class="subs"><li>= <a href="#v:KEsc">KEsc</a> </li><li>| <a href="#v:KFun">KFun</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Int.html#t:Int">Int</a> </li><li>| <a href="#v:KBackTab">KBackTab</a> </li><li>| <a href="#v:KPrtScr">KPrtScr</a> </li><li>| <a href="#v:KPause">KPause</a> </li><li>| <a href="#v:KASCII">KASCII</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Char.html#t:Char">Char</a> </li><li>| <a href="#v:KBS">KBS</a> </li><li>| <a href="#v:KIns">KIns</a> </li><li>| <a href="#v:KHome">KHome</a> </li><li>| <a href="#v:KPageUp">KPageUp</a> </li><li>| <a href="#v:KDel">KDel</a> </li><li>| <a href="#v:KEnd">KEnd</a> </li><li>| <a href="#v:KPageDown">KPageDown</a> </li><li>| <a href="#v:KBegin">KBegin</a> </li><li>| <a href="#v:KNP5">KNP5</a> </li><li>| <a href="#v:KUp">KUp</a> </li><li>| <a href="#v:KMenu">KMenu</a> </li><li>| <a href="#v:KLeft">KLeft</a> </li><li>| <a href="#v:KDown">KDown</a> </li><li>| <a href="#v:KRight">KRight</a> </li><li>| <a href="#v:KEnter">KEnter</a> </li></ul></li><li class="src short"><span class="keyword">data</span> <a href="#t:Modifier">Modifier</a> <ul class="subs"><li>= <a href="#v:MShift">MShift</a> </li><li>| <a href="#v:MCtrl">MCtrl</a> </li><li>| <a href="#v:MMeta">MMeta</a> </li><li>| <a href="#v:MAlt">MAlt</a> </li></ul></li><li class="src short"><span class="keyword">data</span> <a href="#t:Button">Button</a> <ul class="subs"><li>= <a href="#v:BLeft">BLeft</a> </li><li>| <a href="#v:BMiddle">BMiddle</a> </li><li>| <a href="#v:BRight">BRight</a> </li></ul></li><li class="src short"><span class="keyword">data</span> <a href="#t:Event">Event</a> <ul class="subs"><li>= <a href="#v:EvKey">EvKey</a> <a href="Graphics-Vty.html#t:Key">Key</a> [<a href="Graphics-Vty.html#t:Modifier">Modifier</a>] </li><li>| <a href="#v:EvMouse">EvMouse</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Int.html#t:Int">Int</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Int.html#t:Int">Int</a> <a href="Graphics-Vty.html#t:Button">Button</a> [<a href="Graphics-Vty.html#t:Modifier">Modifier</a>] </li><li>| <a href="#v:EvResize">EvResize</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Int.html#t:Int">Int</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Int.html#t:Int">Int</a> </li></ul></li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Vty" class="def">Vty</a> <a href="src/Graphics-Vty.html#Vty" class="link">Source</a></p><div class="doc"><p>The main object. At most one should be created.
An alternative is to use unsafePerformIO to automatically create a singleton Vty instance when
required.
</p><p>This does not assure any thread safety. In theory, as long as an update action is not executed
when another update action is already then it's safe to call this on multiple threads.
</p><p>todo: Once the Terminal interface encompasses input this interface will be deprecated.
Currently, just using the Terminal interface there is no support for input events.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:Vty" class="def">Vty</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div class="subs fields"><p class="caption">Fields</p><dl><dt class="src"><a name="v:update" class="def">update</a> :: <a href="Graphics-Vty-Picture.html#t:Picture">Picture</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc-doc/html/libraries/ghc-prim-0.2.0.0/GHC-Tuple.html#t:-40--41-">()</a></dt><dd class="doc"><p>Outputs the given Picture. Equivalent to output_picture applied to a display context
implicitly managed by Vty.
</p></dd><dt class="src"><a name="v:next_event" class="def">next_event</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/System-IO.html#t:IO">IO</a> <a href="Graphics-Vty.html#t:Event">Event</a></dt><dd class="doc"><p>Get one Event object, blocking if necessary.
</p></dd><dt class="src"><a name="v:terminal" class="def">terminal</a> :: <a href="Graphics-Vty-Terminal.html#t:TerminalHandle">TerminalHandle</a></dt><dd class="doc"><p>Handle to the terminal interface. See <code><a href="Graphics-Vty-Terminal.html#t:Terminal">Terminal</a></code>
</p><p>The use of Vty typically follows this process:
</p><ol><li> initialize vty
</li><li> use the update equation of Vty to display a picture
</li><li> repeat
</li><li> shutdown vty.
</li></ol><p>todo: provide a similar abstraction to Graphics.Vty.Terminal for input. Use haskeline's
input backend for implementation.
</p><p>todo: remove explicit <code><a href="Graphics-Vty.html#v:shutdown">shutdown</a></code> requirement.
</p></dd><dt class="src"><a name="v:refresh" class="def">refresh</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc-doc/html/libraries/ghc-prim-0.2.0.0/GHC-Tuple.html#t:-40--41-">()</a></dt><dd class="doc"><p>Refresh the display. Normally the library takes care of refreshing. Nonetheless, some
other program might output to the terminal and mess the display. In that case the user
might want to force a refresh.
</p></dd><dt class="src"><a name="v:shutdown" class="def">shutdown</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc-doc/html/libraries/ghc-prim-0.2.0.0/GHC-Tuple.html#t:-40--41-">()</a></dt><dd class="doc"><p>Clean up after vty.
</p></dd></dl><div class="clear"></div></div></td></tr></table></div></div><div class="top"><p class="src"><a name="v:mkVty" class="def">mkVty</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/System-IO.html#t:IO">IO</a> <a href="Graphics-Vty.html#t:Vty">Vty</a><a href="src/Graphics-Vty.html#mkVty" class="link">Source</a></p><div class="doc"><p>Set up the state object for using vty. At most one state object should be
created at a time.
</p></div></div><div class="top"><p class="src"><a name="v:mkVtyEscDelay" class="def">mkVtyEscDelay</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Int.html#t:Int">Int</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/System-IO.html#t:IO">IO</a> <a href="Graphics-Vty.html#t:Vty">Vty</a><a href="src/Graphics-Vty.html#mkVtyEscDelay" class="link">Source</a></p><div class="doc"><p>Set up the state object for using vty. At most one state object should be
created at a time. The delay, in microseconds, specifies the period of time to wait for a key
following reading ESC from the terminal before considering the ESC key press as a discrete event.
</p></div></div><div class="top"><p class="src">module <a href="Graphics-Vty-Terminal.html">Graphics.Vty.Terminal</a></p></div><div class="top"><p class="src">module <a href="Graphics-Vty-Picture.html">Graphics.Vty.Picture</a></p></div><div class="top"><p class="src">module <a href="Graphics-Vty-DisplayRegion.html">Graphics.Vty.DisplayRegion</a></p></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Key" class="def">Key</a> <a href="src/Graphics-Vty-LLInput.html#Key" class="link">Source</a></p><div class="doc"><p>Representations of non-modifier keys.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:KEsc" class="def">KEsc</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:KFun" class="def">KFun</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Int.html#t:Int">Int</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:KBackTab" class="def">KBackTab</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:KPrtScr" class="def">KPrtScr</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:KPause" class="def">KPause</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:KASCII" class="def">KASCII</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Char.html#t:Char">Char</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:KBS" class="def">KBS</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:KIns" class="def">KIns</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:KHome" class="def">KHome</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:KPageUp" class="def">KPageUp</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:KDel" class="def">KDel</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:KEnd" class="def">KEnd</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:KPageDown" class="def">KPageDown</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:KBegin" class="def">KBegin</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:KNP5" class="def">KNP5</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:KUp" class="def">KUp</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:KMenu" class="def">KMenu</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:KLeft" class="def">KLeft</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:KDown" class="def">KDown</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:KRight" class="def">KRight</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:KEnter" class="def">KEnter</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:Key" class="caption collapser" onclick="toggleSection('i:Key')">Instances</p><div id="section.i:Key" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Eq.html#t:Eq">Eq</a> <a href="Graphics-Vty.html#t:Key">Key</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Ord.html#t:Ord">Ord</a> <a href="Graphics-Vty.html#t:Key">Key</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Text-Show.html#t:Show">Show</a> <a href="Graphics-Vty.html#t:Key">Key</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Modifier" class="def">Modifier</a> <a href="src/Graphics-Vty-LLInput.html#Modifier" class="link">Source</a></p><div class="doc"><p>Modifier keys. Key codes are interpreted such that users are more likely to
have Meta than Alt; for instance on the PC Linux console, <code><a href="Graphics-Vty.html#v:MMeta">MMeta</a></code> will
generally correspond to the physical Alt key.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:MShift" class="def">MShift</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:MCtrl" class="def">MCtrl</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:MMeta" class="def">MMeta</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:MAlt" class="def">MAlt</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:Modifier" class="caption collapser" onclick="toggleSection('i:Modifier')">Instances</p><div id="section.i:Modifier" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Eq.html#t:Eq">Eq</a> <a href="Graphics-Vty.html#t:Modifier">Modifier</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Ord.html#t:Ord">Ord</a> <a href="Graphics-Vty.html#t:Modifier">Modifier</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Text-Show.html#t:Show">Show</a> <a href="Graphics-Vty.html#t:Modifier">Modifier</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Button" class="def">Button</a> <a href="src/Graphics-Vty-LLInput.html#Button" class="link">Source</a></p><div class="doc"><p>Mouse buttons. Not yet used.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:BLeft" class="def">BLeft</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:BMiddle" class="def">BMiddle</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:BRight" class="def">BRight</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:Button" class="caption collapser" onclick="toggleSection('i:Button')">Instances</p><div id="section.i:Button" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Eq.html#t:Eq">Eq</a> <a href="Graphics-Vty.html#t:Button">Button</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Ord.html#t:Ord">Ord</a> <a href="Graphics-Vty.html#t:Button">Button</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Text-Show.html#t:Show">Show</a> <a href="Graphics-Vty.html#t:Button">Button</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Event" class="def">Event</a> <a href="src/Graphics-Vty-LLInput.html#Event" class="link">Source</a></p><div class="doc"><p>Generic events.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:EvKey" class="def">EvKey</a> <a href="Graphics-Vty.html#t:Key">Key</a> [<a href="Graphics-Vty.html#t:Modifier">Modifier</a>]</td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:EvMouse" class="def">EvMouse</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Int.html#t:Int">Int</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Int.html#t:Int">Int</a> <a href="Graphics-Vty.html#t:Button">Button</a> [<a href="Graphics-Vty.html#t:Modifier">Modifier</a>]</td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:EvResize" class="def">EvResize</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Int.html#t:Int">Int</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Int.html#t:Int">Int</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:Event" class="caption collapser" onclick="toggleSection('i:Event')">Instances</p><div id="section.i:Event" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Eq.html#t:Eq">Eq</a> <a href="Graphics-Vty.html#t:Event">Event</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Ord.html#t:Ord">Ord</a> <a href="Graphics-Vty.html#t:Event">Event</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Text-Show.html#t:Show">Show</a> <a href="Graphics-Vty.html#t:Event">Event</a></td><td class="doc empty"> </td></tr></table></div></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.10.0</p></div></body></html>
|