hsfm/HSFM-History.html

6 lines
5.0 KiB
HTML

<!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>HSFM.History</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_HSFM-History.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/HSFM-History.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">hsfm-gtk</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Safe Haskell</th><td>Safe</td></tr><tr><th>Language</th><td>Haskell2010</td></tr></table><p class="caption">HSFM.History</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:BrowsingHistory">BrowsingHistory</a> = <a href="#v:BrowsingHistory">BrowsingHistory</a> {<ul class="subs"><li><a href="#v:backwardsHistory">backwardsHistory</a> :: [Path Abs]</li><li><a href="#v:currentDir">currentDir</a> :: Path Abs</li><li><a href="#v:forwardHistory">forwardHistory</a> :: [Path Abs]</li><li><a href="#v:maxSize">maxSize</a> :: <a href="https://hackage.haskell.org/package/base-4.8.1.0/docs/Data-Int.html#t:Int">Int</a></li></ul>}</li><li class="src short"><a href="#v:historyNewPath">historyNewPath</a> :: Path Abs -&gt; <a href="HSFM-History.html#t:BrowsingHistory">BrowsingHistory</a> -&gt; <a href="HSFM-History.html#t:BrowsingHistory">BrowsingHistory</a></li><li class="src short"><a href="#v:historyBack">historyBack</a> :: <a href="HSFM-History.html#t:BrowsingHistory">BrowsingHistory</a> -&gt; <a href="HSFM-History.html#t:BrowsingHistory">BrowsingHistory</a></li><li class="src short"><a href="#v:historyForward">historyForward</a> :: <a href="HSFM-History.html#t:BrowsingHistory">BrowsingHistory</a> -&gt; <a href="HSFM-History.html#t:BrowsingHistory">BrowsingHistory</a></li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:BrowsingHistory" class="def">BrowsingHistory</a> <a href="src/HSFM-History.html#BrowsingHistory" class="link">Source</a></p><div class="doc"><p>Browsing history. For <code><a href="HSFM-History.html#v:forwardHistory">forwardHistory</a></code> and <code><a href="HSFM-History.html#v:backwardsHistory">backwardsHistory</a></code>
the first item is the most recent one.</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:BrowsingHistory" class="def">BrowsingHistory</a></td><td class="doc empty">&nbsp;</td></tr><tr><td colspan="2"><div class="subs fields"><p class="caption">Fields</p><dl><dt class="src"><a name="v:backwardsHistory" class="def">backwardsHistory</a> :: [Path Abs]</dt><dd class="doc empty">&nbsp;</dd><dt class="src"><a name="v:currentDir" class="def">currentDir</a> :: Path Abs</dt><dd class="doc empty">&nbsp;</dd><dt class="src"><a name="v:forwardHistory" class="def">forwardHistory</a> :: [Path Abs]</dt><dd class="doc empty">&nbsp;</dd><dt class="src"><a name="v:maxSize" class="def">maxSize</a> :: <a href="https://hackage.haskell.org/package/base-4.8.1.0/docs/Data-Int.html#t:Int">Int</a></dt><dd class="doc empty">&nbsp;</dd></dl><div class="clear"></div></div></td></tr></table></div></div><div class="top"><p class="src"><a name="v:historyNewPath" class="def">historyNewPath</a> :: Path Abs -&gt; <a href="HSFM-History.html#t:BrowsingHistory">BrowsingHistory</a> -&gt; <a href="HSFM-History.html#t:BrowsingHistory">BrowsingHistory</a> <a href="src/HSFM-History.html#historyNewPath" class="link">Source</a></p><div class="doc"><p>This is meant to be called after e.g. a new path is entered
(not navigated to via the history) and the history needs updating.</p></div></div><div class="top"><p class="src"><a name="v:historyBack" class="def">historyBack</a> :: <a href="HSFM-History.html#t:BrowsingHistory">BrowsingHistory</a> -&gt; <a href="HSFM-History.html#t:BrowsingHistory">BrowsingHistory</a> <a href="src/HSFM-History.html#historyBack" class="link">Source</a></p><div class="doc"><p>Go back one step in the history.</p></div></div><div class="top"><p class="src"><a name="v:historyForward" class="def">historyForward</a> :: <a href="HSFM-History.html#t:BrowsingHistory">BrowsingHistory</a> -&gt; <a href="HSFM-History.html#t:BrowsingHistory">BrowsingHistory</a> <a href="src/HSFM-History.html#historyForward" class="link">Source</a></p><div class="doc"><p>Go forward one step in the history.</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.16.1</p></div></body></html>