/usr/share/doc/libghc-yi-core-doc/html/Yi-Window.html is in libghc-yi-core-doc 0.14.1-1build1.
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 | <!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>Yi.Window</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_Yi-Window.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Yi-Window.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">yi-core-0.14.1: Yi editor core library</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>License</th><td>GPL-2</td></tr><tr><th>Maintainer</th><td>yi-devel@googlegroups.com</td></tr><tr><th>Stability</th><td>experimental</td></tr><tr><th>Portability</th><td>portable</td></tr><tr><th>Safe Haskell</th><td>None</td></tr><tr><th>Language</th><td>Haskell2010</td></tr><tr><th>Extensions</th><td><ul class="extension-list"><li>TemplateHaskell</li><li>TemplateHaskellQuotes</li><li>DeriveDataTypeable</li></ul></td></tr></table><p class="caption">Yi.Window</p></div><div id="description"><p class="caption">Description</p><div class="doc"><p>Operations on <code><a href="Yi-Window.html#t:Window">Window</a></code>s, in the emacs sense of the word.</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:Window">Window</a> = <a href="#v:Window">Window</a> {<ul class="subs"><li><a href="#v:isMini">isMini</a> :: !<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Bool.html#t:Bool">Bool</a></li><li><a href="#v:bufkey">bufkey</a> :: !<a href="file:///usr/share/doc/libghc-yi-language-doc/html/Yi-Buffer-Basic.html#t:BufferRef">BufferRef</a></li><li><a href="#v:bufAccessList">bufAccessList</a> :: ![<a href="file:///usr/share/doc/libghc-yi-language-doc/html/Yi-Buffer-Basic.html#t:BufferRef">BufferRef</a>]</li><li><a href="#v:height">height</a> :: !<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Int.html#t:Int">Int</a></li><li><a href="#v:width">width</a> :: !<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Int.html#t:Int">Int</a></li><li><a href="#v:winRegion">winRegion</a> :: !<a href="file:///usr/share/doc/libghc-yi-language-doc/html/Yi-Region.html#t:Region">Region</a></li><li><a href="#v:wkey">wkey</a> :: !<a href="file:///usr/share/doc/libghc-yi-language-doc/html/Yi-Buffer-Basic.html#t:WindowRef">WindowRef</a></li><li><a href="#v:actualLines">actualLines</a> :: !<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Int.html#t:Int">Int</a></li><li><a href="#v:jumpList">jumpList</a> :: !<a href="Yi-JumpList.html#t:JumpList">JumpList</a></li></ul>}</li><li class="src short"><a href="#v:wkeyA">wkeyA</a> :: Lens' <a href="Yi-Window.html#t:Window">Window</a> <a href="file:///usr/share/doc/libghc-yi-language-doc/html/Yi-Buffer-Basic.html#t:WindowRef">WindowRef</a></li><li class="src short"><a href="#v:winRegionA">winRegionA</a> :: Lens' <a href="Yi-Window.html#t:Window">Window</a> <a href="file:///usr/share/doc/libghc-yi-language-doc/html/Yi-Region.html#t:Region">Region</a></li><li class="src short"><a href="#v:widthA">widthA</a> :: Lens' <a href="Yi-Window.html#t:Window">Window</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Int.html#t:Int">Int</a></li><li class="src short"><a href="#v:jumpListA">jumpListA</a> :: Lens' <a href="Yi-Window.html#t:Window">Window</a> <a href="Yi-JumpList.html#t:JumpList">JumpList</a></li><li class="src short"><a href="#v:isMiniA">isMiniA</a> :: Lens' <a href="Yi-Window.html#t:Window">Window</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Bool.html#t:Bool">Bool</a></li><li class="src short"><a href="#v:heightA">heightA</a> :: Lens' <a href="Yi-Window.html#t:Window">Window</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Int.html#t:Int">Int</a></li><li class="src short"><a href="#v:bufkeyA">bufkeyA</a> :: Lens' <a href="Yi-Window.html#t:Window">Window</a> <a href="file:///usr/share/doc/libghc-yi-language-doc/html/Yi-Buffer-Basic.html#t:BufferRef">BufferRef</a></li><li class="src short"><a href="#v:bufAccessListA">bufAccessListA</a> :: Lens' <a href="Yi-Window.html#t:Window">Window</a> [<a href="file:///usr/share/doc/libghc-yi-language-doc/html/Yi-Buffer-Basic.html#t:BufferRef">BufferRef</a>]</li><li class="src short"><a href="#v:actualLinesA">actualLinesA</a> :: Lens' <a href="Yi-Window.html#t:Window">Window</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Int.html#t:Int">Int</a></li><li class="src short"><a href="#v:winkey">winkey</a> :: <a href="Yi-Window.html#t:Window">Window</a> -> (<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Bool.html#t:Bool">Bool</a>, <a href="file:///usr/share/doc/libghc-yi-language-doc/html/Yi-Buffer-Basic.html#t:BufferRef">BufferRef</a>)</li><li class="src short"><a href="#v:dummyWindow">dummyWindow</a> :: <a href="file:///usr/share/doc/libghc-yi-language-doc/html/Yi-Buffer-Basic.html#t:BufferRef">BufferRef</a> -> <a href="Yi-Window.html#t:Window">Window</a></li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><span class="keyword">data</span> <a id="t:Window" class="def">Window</a> <a href="src/Yi-Window.html#Window" class="link">Source</a> <a href="#t:Window" class="selflink">#</a></p><div class="doc"><p>A window onto a buffer.</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a id="v:Window" class="def">Window</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div class="subs fields"><p class="caption">Fields</p><ul><li><dfn class="src"><a id="v:isMini" class="def">isMini</a> :: !<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Bool.html#t:Bool">Bool</a></dfn><div class="doc"><p>regular or mini window?</p></div></li><li><dfn class="src"><a id="v:bufkey" class="def">bufkey</a> :: !<a href="file:///usr/share/doc/libghc-yi-language-doc/html/Yi-Buffer-Basic.html#t:BufferRef">BufferRef</a></dfn><div class="doc"><p>the buffer this window opens to</p></div></li><li><dfn class="src"><a id="v:bufAccessList" class="def">bufAccessList</a> :: ![<a href="file:///usr/share/doc/libghc-yi-language-doc/html/Yi-Buffer-Basic.html#t:BufferRef">BufferRef</a>]</dfn><div class="doc"><p>list of last accessed buffers (former bufKeys). Last
accessed one is first element</p></div></li><li><dfn class="src"><a id="v:height" class="def">height</a> :: !<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Int.html#t:Int">Int</a></dfn><div class="doc"><p>height of the window (in number of screen
lines displayed)</p></div></li><li><dfn class="src"><a id="v:width" class="def">width</a> :: !<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Int.html#t:Int">Int</a></dfn><div class="doc"><p>width of the window (in number of chars)</p></div></li><li><dfn class="src"><a id="v:winRegion" class="def">winRegion</a> :: !<a href="file:///usr/share/doc/libghc-yi-language-doc/html/Yi-Region.html#t:Region">Region</a></dfn><div class="doc"><p>view area. note that the top point is
also available as a buffer mark.</p></div></li><li><dfn class="src"><a id="v:wkey" class="def">wkey</a> :: !<a href="file:///usr/share/doc/libghc-yi-language-doc/html/Yi-Buffer-Basic.html#t:WindowRef">WindowRef</a></dfn><div class="doc"><p>identifier for the window (for UI sync)
This is required for accurate scrolling.
Scrolling depends on the actual number of buffer
lines displayed. Line wrapping changes that number
relative to the height so we can't use height for that
purpose.</p></div></li><li><dfn class="src"><a id="v:actualLines" class="def">actualLines</a> :: !<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Int.html#t:Int">Int</a></dfn><div class="doc"><p>The actual number of buffer lines displayed. Taking into
account line wrapping</p></div></li><li><dfn class="src"><a id="v:jumpList" class="def">jumpList</a> :: !<a href="Yi-JumpList.html#t:JumpList">JumpList</a></dfn><div class="doc empty"> </div></li></ul></div></td></tr></table></div><div class="subs instances"><p id="control.i:Window" class="caption collapser" onclick="toggleSection('i:Window')">Instances</p><div id="section.i:Window" class="show"><table><tr><td class="src clearfix"><span class="inst-left"><span id="control.i:id:Window:Eq:1" class="instance expander" onclick="toggleSection('i:id:Window:Eq:1')"></span> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Eq.html#t:Eq">Eq</a> <a href="Yi-Window.html#t:Window">Window</a></span> <a href="src/Yi-Window.html#line-69" class="link">Source</a> <a href="#t:Window" class="selflink">#</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div id="section.i:id:Window: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="Yi-Window.html#t:Window">Window</a> -> <a href="Yi-Window.html#t:Window">Window</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.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="Yi-Window.html#t:Window">Window</a> -> <a href="Yi-Window.html#t:Window">Window</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.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:Window:Show:2" class="instance expander" onclick="toggleSection('i:id:Window:Show:2')"></span> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Text-Show.html#t:Show">Show</a> <a href="Yi-Window.html#t:Window">Window</a></span> <a href="src/Yi-Window.html#line-64" class="link">Source</a> <a href="#t:Window" class="selflink">#</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div id="section.i:id:Window: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.1.0/Data-Int.html#t:Int">Int</a> -> <a href="Yi-Window.html#t:Window">Window</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.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="Yi-Window.html#t:Window">Window</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.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="Yi-Window.html#t:Window">Window</a>] -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Text-Show.html#t:ShowS">ShowS</a> <a href="#v:showList" class="selflink">#</a></p></div></div></td></tr><tr><td class="src clearfix"><span class="inst-left"><span id="control.i:id:Window:Binary:3" class="instance expander" onclick="toggleSection('i:id:Window:Binary:3')"></span> <a href="file:///usr/share/doc/ghc-doc/html/libraries/binary-0.8.3.0/Data-Binary.html#t:Binary">Binary</a> <a href="Yi-Window.html#t:Window">Window</a></span> <a href="src/Yi-Window.html#line-52" class="link">Source</a> <a href="#t:Window" class="selflink">#</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div id="section.i:id:Window:Binary:3" class="inst-details hide"><div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:put">put</a> :: <a href="Yi-Window.html#t:Window">Window</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/binary-0.8.3.0/Data-Binary-Put.html#t:Put">Put</a> <a href="#v:put" class="selflink">#</a></p><p class="src"><a href="#v:get">get</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/binary-0.8.3.0/Data-Binary-Get-Internal.html#t:Get">Get</a> <a href="Yi-Window.html#t:Window">Window</a> <a href="#v:get" class="selflink">#</a></p><p class="src"><a href="#v:putList">putList</a> :: [<a href="Yi-Window.html#t:Window">Window</a>] -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/binary-0.8.3.0/Data-Binary-Put.html#t:Put">Put</a> <a href="#v:putList" class="selflink">#</a></p></div></div></td></tr><tr><td class="src clearfix"><span class="inst-left"><span id="control.i:id:Window:MonadReader:4" class="instance expander" onclick="toggleSection('i:id:Window:MonadReader:4')"></span> <a href="file:///usr/share/doc/libghc-mtl-doc/html/Control-Monad-Reader-Class.html#t:MonadReader">MonadReader</a> <a href="Yi-Window.html#t:Window">Window</a> <a href="Yi-Types.html#t:BufferM">BufferM</a></span> <a href="#t:MonadReader" class="selflink">#</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div id="section.i:id:Window:MonadReader:4" class="inst-details hide"><div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:ask">ask</a> :: <a href="Yi-Types.html#t:BufferM">BufferM</a> <a href="Yi-Window.html#t:Window">Window</a> <a href="#v:ask" class="selflink">#</a></p><p class="src"><a href="#v:local">local</a> :: (<a href="Yi-Window.html#t:Window">Window</a> -> <a href="Yi-Window.html#t:Window">Window</a>) -> <a href="Yi-Types.html#t:BufferM">BufferM</a> a -> <a href="Yi-Types.html#t:BufferM">BufferM</a> a <a href="#v:local" class="selflink">#</a></p><p class="src"><a href="#v:reader">reader</a> :: (<a href="Yi-Window.html#t:Window">Window</a> -> a) -> <a href="Yi-Types.html#t:BufferM">BufferM</a> a <a href="#v:reader" class="selflink">#</a></p></div></div></td></tr></table></div></div></div><div class="top"><p class="src"><a id="v:wkeyA" class="def">wkeyA</a> :: Lens' <a href="Yi-Window.html#t:Window">Window</a> <a href="file:///usr/share/doc/libghc-yi-language-doc/html/Yi-Buffer-Basic.html#t:WindowRef">WindowRef</a> <a href="src/Yi-Window.html#line-50" class="link">Source</a> <a href="#v:wkeyA" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:winRegionA" class="def">winRegionA</a> :: Lens' <a href="Yi-Window.html#t:Window">Window</a> <a href="file:///usr/share/doc/libghc-yi-language-doc/html/Yi-Region.html#t:Region">Region</a> <a href="src/Yi-Window.html#line-50" class="link">Source</a> <a href="#v:winRegionA" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:widthA" class="def">widthA</a> :: Lens' <a href="Yi-Window.html#t:Window">Window</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Int.html#t:Int">Int</a> <a href="src/Yi-Window.html#line-50" class="link">Source</a> <a href="#v:widthA" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:jumpListA" class="def">jumpListA</a> :: Lens' <a href="Yi-Window.html#t:Window">Window</a> <a href="Yi-JumpList.html#t:JumpList">JumpList</a> <a href="src/Yi-Window.html#line-50" class="link">Source</a> <a href="#v:jumpListA" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:isMiniA" class="def">isMiniA</a> :: Lens' <a href="Yi-Window.html#t:Window">Window</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Bool.html#t:Bool">Bool</a> <a href="src/Yi-Window.html#line-50" class="link">Source</a> <a href="#v:isMiniA" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:heightA" class="def">heightA</a> :: Lens' <a href="Yi-Window.html#t:Window">Window</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Int.html#t:Int">Int</a> <a href="src/Yi-Window.html#line-50" class="link">Source</a> <a href="#v:heightA" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:bufkeyA" class="def">bufkeyA</a> :: Lens' <a href="Yi-Window.html#t:Window">Window</a> <a href="file:///usr/share/doc/libghc-yi-language-doc/html/Yi-Buffer-Basic.html#t:BufferRef">BufferRef</a> <a href="src/Yi-Window.html#line-50" class="link">Source</a> <a href="#v:bufkeyA" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:bufAccessListA" class="def">bufAccessListA</a> :: Lens' <a href="Yi-Window.html#t:Window">Window</a> [<a href="file:///usr/share/doc/libghc-yi-language-doc/html/Yi-Buffer-Basic.html#t:BufferRef">BufferRef</a>] <a href="src/Yi-Window.html#line-50" class="link">Source</a> <a href="#v:bufAccessListA" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:actualLinesA" class="def">actualLinesA</a> :: Lens' <a href="Yi-Window.html#t:Window">Window</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Int.html#t:Int">Int</a> <a href="src/Yi-Window.html#line-50" class="link">Source</a> <a href="#v:actualLinesA" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:winkey" class="def">winkey</a> :: <a href="Yi-Window.html#t:Window">Window</a> -> (<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Bool.html#t:Bool">Bool</a>, <a href="file:///usr/share/doc/libghc-yi-language-doc/html/Yi-Buffer-Basic.html#t:BufferRef">BufferRef</a>) <a href="src/Yi-Window.html#winkey" class="link">Source</a> <a href="#v:winkey" class="selflink">#</a></p><div class="doc"><p>Get the identification of a window.</p></div></div><div class="top"><p class="src"><a id="v:dummyWindow" class="def">dummyWindow</a> :: <a href="file:///usr/share/doc/libghc-yi-language-doc/html/Yi-Buffer-Basic.html#t:BufferRef">BufferRef</a> -> <a href="Yi-Window.html#t:Window">Window</a> <a href="src/Yi-Window.html#dummyWindow" class="link">Source</a> <a href="#v:dummyWindow" class="selflink">#</a></p><div class="doc"><p>Return a "fake" window onto a buffer.</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.17.3</p></div></body></html>
|