<!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>Text.Pandoc.Blocks</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_Text-Pandoc-Blocks.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Text-Pandoc-Blocks.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">pandoc-1.6.0.1: Conversion between markup formats</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Portability</th><td>portable</td></tr><tr><th>Stability</th><td>alpha</td></tr><tr><th>Maintainer</th><td>John MacFarlane <jgm@berkeley.edu></td></tr></table><p class="caption">Text.Pandoc.Blocks</p></div><div id="description"><p class="caption">Description</p><div class="doc"><p>Functions for the manipulation of fixed-width blocks of text.
These are used in the construction of plain-text tables.
</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:TextBlock">TextBlock</a> = <a href="#v:TextBlock">TextBlock</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a> [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>]</li><li class="src short"><a href="#v:docToBlock">docToBlock</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a> -> <a href="/usr/share/doc/ghc/html/libraries/pretty-1.0.1.2/Text-PrettyPrint-HughesPJ.html#t:Doc">Doc</a> -> <a href="Text-Pandoc-Blocks.html#t:TextBlock">TextBlock</a></li><li class="src short"><a href="#v:blockToDoc">blockToDoc</a> :: <a href="Text-Pandoc-Blocks.html#t:TextBlock">TextBlock</a> -> <a href="/usr/share/doc/ghc/html/libraries/pretty-1.0.1.2/Text-PrettyPrint-HughesPJ.html#t:Doc">Doc</a></li><li class="src short"><a href="#v:widthOfBlock">widthOfBlock</a> :: <a href="Text-Pandoc-Blocks.html#t:TextBlock">TextBlock</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a></li><li class="src short"><a href="#v:heightOfBlock">heightOfBlock</a> :: <a href="Text-Pandoc-Blocks.html#t:TextBlock">TextBlock</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a></li><li class="src short"><a href="#v:hcatBlocks">hcatBlocks</a> :: [<a href="Text-Pandoc-Blocks.html#t:TextBlock">TextBlock</a>] -> <a href="Text-Pandoc-Blocks.html#t:TextBlock">TextBlock</a></li><li class="src short"><a href="#v:hsepBlocks">hsepBlocks</a> :: [<a href="Text-Pandoc-Blocks.html#t:TextBlock">TextBlock</a>] -> <a href="Text-Pandoc-Blocks.html#t:TextBlock">TextBlock</a></li><li class="src short"><a href="#v:centerAlignBlock">centerAlignBlock</a> :: <a href="Text-Pandoc-Blocks.html#t:TextBlock">TextBlock</a> -> <a href="Text-Pandoc-Blocks.html#t:TextBlock">TextBlock</a></li><li class="src short"><a href="#v:leftAlignBlock">leftAlignBlock</a> :: <a href="Text-Pandoc-Blocks.html#t:TextBlock">TextBlock</a> -> <a href="Text-Pandoc-Blocks.html#t:TextBlock">TextBlock</a></li><li class="src short"><a href="#v:rightAlignBlock">rightAlignBlock</a> :: <a href="Text-Pandoc-Blocks.html#t:TextBlock">TextBlock</a> -> <a href="Text-Pandoc-Blocks.html#t:TextBlock">TextBlock</a></li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:TextBlock" class="def">TextBlock</a> <a href="src/Text-Pandoc-Blocks.html#TextBlock" class="link">Source</a></p><div class="doc"><p>A fixed-width block of text. Parameters are width of block,
height of block, and list of lines.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:TextBlock" class="def">TextBlock</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a> [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>]</td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:TextBlock" class="caption collapser" onclick="toggleSection('i:TextBlock')">Instances</p><div id="section.i:TextBlock" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Text-Show.html#t:Show">Show</a> <a href="Text-Pandoc-Blocks.html#t:TextBlock">TextBlock</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:docToBlock" class="def">docToBlock</a><a href="src/Text-Pandoc-Blocks.html#docToBlock" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a></td><td class="doc"><p>Width of text block.
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/pretty-1.0.1.2/Text-PrettyPrint-HughesPJ.html#t:Doc">Doc</a></td><td class="doc"><p><code>Doc</code> to convert.
</p></td></tr><tr><td class="src">-> <a href="Text-Pandoc-Blocks.html#t:TextBlock">TextBlock</a></td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Convert a <code>Doc</code> element into a <code>TextBlock</code> with a specified width.
</p></div></div><div class="top"><p class="src"><a name="v:blockToDoc" class="def">blockToDoc</a> :: <a href="Text-Pandoc-Blocks.html#t:TextBlock">TextBlock</a> -> <a href="/usr/share/doc/ghc/html/libraries/pretty-1.0.1.2/Text-PrettyPrint-HughesPJ.html#t:Doc">Doc</a><a href="src/Text-Pandoc-Blocks.html#blockToDoc" class="link">Source</a></p><div class="doc"><p>Convert a <code>TextBlock</code> to a <code>Doc</code> element.
</p></div></div><div class="top"><p class="src"><a name="v:widthOfBlock" class="def">widthOfBlock</a> :: <a href="Text-Pandoc-Blocks.html#t:TextBlock">TextBlock</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a><a href="src/Text-Pandoc-Blocks.html#widthOfBlock" class="link">Source</a></p><div class="doc"><p>Returns width of a <code>TextBlock</code> (number of columns).
</p></div></div><div class="top"><p class="src"><a name="v:heightOfBlock" class="def">heightOfBlock</a> :: <a href="Text-Pandoc-Blocks.html#t:TextBlock">TextBlock</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a><a href="src/Text-Pandoc-Blocks.html#heightOfBlock" class="link">Source</a></p><div class="doc"><p>Returns height of a <code>TextBlock</code> (number of rows).
</p></div></div><div class="top"><p class="src"><a name="v:hcatBlocks" class="def">hcatBlocks</a> :: [<a href="Text-Pandoc-Blocks.html#t:TextBlock">TextBlock</a>] -> <a href="Text-Pandoc-Blocks.html#t:TextBlock">TextBlock</a><a href="src/Text-Pandoc-Blocks.html#hcatBlocks" class="link">Source</a></p><div class="doc"><p>Concatenates a list of <code>TextBlock</code>s into a new <code>TextBlock</code> in
which they appear side by side.
</p></div></div><div class="top"><p class="src"><a name="v:hsepBlocks" class="def">hsepBlocks</a> :: [<a href="Text-Pandoc-Blocks.html#t:TextBlock">TextBlock</a>] -> <a href="Text-Pandoc-Blocks.html#t:TextBlock">TextBlock</a><a href="src/Text-Pandoc-Blocks.html#hsepBlocks" class="link">Source</a></p><div class="doc"><p>Like <code>hcatBlocks</code>, but inserts space between the <code>TextBlock</code>s.
</p></div></div><div class="top"><p class="src"><a name="v:centerAlignBlock" class="def">centerAlignBlock</a> :: <a href="Text-Pandoc-Blocks.html#t:TextBlock">TextBlock</a> -> <a href="Text-Pandoc-Blocks.html#t:TextBlock">TextBlock</a><a href="src/Text-Pandoc-Blocks.html#centerAlignBlock" class="link">Source</a></p><div class="doc"><p>Centers the contents of a <code>TextBlock</code> within the block.
</p></div></div><div class="top"><p class="src"><a name="v:leftAlignBlock" class="def">leftAlignBlock</a> :: <a href="Text-Pandoc-Blocks.html#t:TextBlock">TextBlock</a> -> <a href="Text-Pandoc-Blocks.html#t:TextBlock">TextBlock</a><a href="src/Text-Pandoc-Blocks.html#leftAlignBlock" class="link">Source</a></p><div class="doc"><p>Left-aligns the contents of a <code>TextBlock</code> within the block.
</p></div></div><div class="top"><p class="src"><a name="v:rightAlignBlock" class="def">rightAlignBlock</a> :: <a href="Text-Pandoc-Blocks.html#t:TextBlock">TextBlock</a> -> <a href="Text-Pandoc-Blocks.html#t:TextBlock">TextBlock</a><a href="src/Text-Pandoc-Blocks.html#rightAlignBlock" class="link">Source</a></p><div class="doc"><p>Right-aligns the contents of a <code>TextBlock</code> within the block.
</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.9.2</p></div></body></html>
