/usr/share/doc/libghc-text-icu-doc/html/Data-Text-ICU-Break.html is in libghc-text-icu-doc 0.6.3.7-2build1.
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 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 | <!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>Data.Text.ICU.Break</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_Data-Text-ICU-Break.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Data-Text-ICU-Break.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">text-icu-0.6.3.7: Bindings to the ICU library</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Portability</th><td>GHC</td></tr><tr><th>Stability</th><td>experimental</td></tr><tr><th>Maintainer</th><td>bos@serpentine.com</td></tr><tr><th>Safe Haskell</th><td>None</td></tr></table><p class="caption">Data.Text.ICU.Break</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">Types
</a></li><li><a href="#g:2">Breaking functions
</a></li><li><a href="#g:3">Iteration functions
</a></li><li><a href="#g:4">Iterator status
</a></li><li><a href="#g:5">Locales
</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>String breaking functions for Unicode, implemented as bindings to
the International Components for Unicode (ICU) libraries.
</p><p>The text boundary positions are found according to the rules described in
Unicode Standard Annex #29, Text Boundaries, and Unicode Standard Annex
#14, Line Breaking Properties. These are available at
<a href="http://www.unicode.org/reports/tr14/">http://www.unicode.org/reports/tr14/</a> and
<a href="http://www.unicode.org/reports/tr29/">http://www.unicode.org/reports/tr29/</a>.
</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:BreakIterator">BreakIterator</a> a</li><li class="src short"><span class="keyword">data</span> <a href="#t:Line">Line</a> <ul class="subs"><li>= <a href="#v:Soft">Soft</a> </li><li>| <a href="#v:Hard">Hard</a> </li></ul></li><li class="src short"><span class="keyword">data</span> <a href="#t:Word">Word</a> <ul class="subs"><li>= <a href="#v:Uncategorized">Uncategorized</a> </li><li>| <a href="#v:Number">Number</a> </li><li>| <a href="#v:Letter">Letter</a> </li><li>| <a href="#v:Kana">Kana</a> </li><li>| <a href="#v:Ideograph">Ideograph</a> </li></ul></li><li class="src short"><a href="#v:breakCharacter">breakCharacter</a> :: <a href="Data-Text-ICU-Types.html#t:LocaleName">LocaleName</a> -> <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> (<a href="Data-Text-ICU-Break.html#t:BreakIterator">BreakIterator</a> ())</li><li class="src short"><a href="#v:breakLine">breakLine</a> :: <a href="Data-Text-ICU-Types.html#t:LocaleName">LocaleName</a> -> <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> (<a href="Data-Text-ICU-Break.html#t:BreakIterator">BreakIterator</a> <a href="Data-Text-ICU-Break.html#t:Line">Line</a>)</li><li class="src short"><a href="#v:breakSentence">breakSentence</a> :: <a href="Data-Text-ICU-Types.html#t:LocaleName">LocaleName</a> -> <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> (<a href="Data-Text-ICU-Break.html#t:BreakIterator">BreakIterator</a> ())</li><li class="src short"><a href="#v:breakWord">breakWord</a> :: <a href="Data-Text-ICU-Types.html#t:LocaleName">LocaleName</a> -> <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> (<a href="Data-Text-ICU-Break.html#t:BreakIterator">BreakIterator</a> <a href="Data-Text-ICU-Break.html#t:Word">Word</a>)</li><li class="src short"><a href="#v:clone">clone</a> :: <a href="Data-Text-ICU-Break.html#t:BreakIterator">BreakIterator</a> a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> (<a href="Data-Text-ICU-Break.html#t:BreakIterator">BreakIterator</a> a)</li><li class="src short"><a href="#v:setText">setText</a> :: <a href="Data-Text-ICU-Break.html#t:BreakIterator">BreakIterator</a> a -> <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> ()</li><li class="src short"><a href="#v:current">current</a> :: <a href="Data-Text-ICU-Break.html#t:BreakIterator">BreakIterator</a> a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Foreign.html#t:I16">I16</a>)</li><li class="src short"><a href="#v:first">first</a> :: <a href="Data-Text-ICU-Break.html#t:BreakIterator">BreakIterator</a> a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Foreign.html#t:I16">I16</a></li><li class="src short"><a href="#v:last">last</a> :: <a href="Data-Text-ICU-Break.html#t:BreakIterator">BreakIterator</a> a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Foreign.html#t:I16">I16</a></li><li class="src short"><a href="#v:next">next</a> :: <a href="Data-Text-ICU-Break.html#t:BreakIterator">BreakIterator</a> a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Foreign.html#t:I16">I16</a>)</li><li class="src short"><a href="#v:previous">previous</a> :: <a href="Data-Text-ICU-Break.html#t:BreakIterator">BreakIterator</a> a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Foreign.html#t:I16">I16</a>)</li><li class="src short"><a href="#v:preceding">preceding</a> :: <a href="Data-Text-ICU-Break.html#t:BreakIterator">BreakIterator</a> a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Int.html#t:Int">Int</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Foreign.html#t:I16">I16</a>)</li><li class="src short"><a href="#v:following">following</a> :: <a href="Data-Text-ICU-Break.html#t:BreakIterator">BreakIterator</a> a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Int.html#t:Int">Int</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Foreign.html#t:I16">I16</a>)</li><li class="src short"><a href="#v:isBoundary">isBoundary</a> :: <a href="Data-Text-ICU-Break.html#t:BreakIterator">BreakIterator</a> a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Int.html#t:Int">Int</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Bool.html#t:Bool">Bool</a></li><li class="src short"><a href="#v:getStatus">getStatus</a> :: <a href="Data-Text-ICU-Break.html#t:BreakIterator">BreakIterator</a> a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> a</li><li class="src short"><a href="#v:getStatuses">getStatuses</a> :: <a href="Data-Text-ICU-Break.html#t:BreakIterator">BreakIterator</a> a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> [a]</li><li class="src short"><a href="#v:available">available</a> :: [<a href="Data-Text-ICU-Types.html#t:LocaleName">LocaleName</a>]</li></ul></div><div id="interface"><h1 id="g:1">Types
</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:BreakIterator" class="def">BreakIterator</a> a <a href="src/Data-Text-ICU-Break-Types.html#BreakIterator" class="link">Source</a></p></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Line" class="def">Line</a> <a href="src/Data-Text-ICU-Break.html#Line" class="link">Source</a></p><div class="doc"><p>Line break status.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:Soft" class="def">Soft</a></td><td class="doc"><p>A soft line break is a position at
which a line break is acceptable, but not
required.
</p></td></tr><tr><td class="src"><a name="v:Hard" class="def">Hard</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:Line" class="caption collapser" onclick="toggleSection('i:Line')">Instances</p><div id="section.i:Line" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Prelude.html#t:Enum">Enum</a> <a href="Data-Text-ICU-Break.html#t:Line">Line</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Eq.html#t:Eq">Eq</a> <a href="Data-Text-ICU-Break.html#t:Line">Line</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Text-Show.html#t:Show">Show</a> <a href="Data-Text-ICU-Break.html#t:Line">Line</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:Word" class="def">Word</a> <a href="src/Data-Text-ICU-Break.html#Word" class="link">Source</a></p><div class="doc"><p>Word break status.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:Uncategorized" class="def">Uncategorized</a></td><td class="doc"><p>A "word" that does not fit into another
category. Includes spaces and most
punctuation.
</p></td></tr><tr><td class="src"><a name="v:Number" class="def">Number</a></td><td class="doc"><p>A word that appears to be a number.
</p></td></tr><tr><td class="src"><a name="v:Letter" class="def">Letter</a></td><td class="doc"><p>A word containing letters, excluding
hiragana, katakana or ideographic
characters.
</p></td></tr><tr><td class="src"><a name="v:Kana" class="def">Kana</a></td><td class="doc"><p>A word containing kana characters.
</p></td></tr><tr><td class="src"><a name="v:Ideograph" class="def">Ideograph</a></td><td class="doc"><p>A word containing ideographic characters.
</p></td></tr></table></div><div class="subs instances"><p id="control.i:Word" class="caption collapser" onclick="toggleSection('i:Word')">Instances</p><div id="section.i:Word" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Prelude.html#t:Enum">Enum</a> <a href="Data-Text-ICU-Break.html#t:Word">Word</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Eq.html#t:Eq">Eq</a> <a href="Data-Text-ICU-Break.html#t:Word">Word</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Text-Show.html#t:Show">Show</a> <a href="Data-Text-ICU-Break.html#t:Word">Word</a></td><td class="doc empty"> </td></tr></table></div></div></div><h1 id="g:2">Breaking functions
</h1><div class="top"><p class="src"><a name="v:breakCharacter" class="def">breakCharacter</a> :: <a href="Data-Text-ICU-Types.html#t:LocaleName">LocaleName</a> -> <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> (<a href="Data-Text-ICU-Break.html#t:BreakIterator">BreakIterator</a> ())<a href="src/Data-Text-ICU-Break.html#breakCharacter" class="link">Source</a></p><div class="doc"><p>Break a string on character boundaries.
</p><p>Character boundary analysis identifies the boundaries of "Extended
Grapheme Clusters", which are groupings of codepoints that should be
treated as character-like units for many text operations. Please see
Unicode Standard Annex #29, Unicode Text Segmentation,
<a href="http://www.unicode.org/reports/tr29/">http://www.unicode.org/reports/tr29/</a> for additional information on
grapheme clusters and guidelines on their use.
</p></div></div><div class="top"><p class="src"><a name="v:breakLine" class="def">breakLine</a> :: <a href="Data-Text-ICU-Types.html#t:LocaleName">LocaleName</a> -> <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> (<a href="Data-Text-ICU-Break.html#t:BreakIterator">BreakIterator</a> <a href="Data-Text-ICU-Break.html#t:Line">Line</a>)<a href="src/Data-Text-ICU-Break.html#breakLine" class="link">Source</a></p><div class="doc"><p>Break a string on line boundaries.
</p><p>Line boundary analysis determines where a text string can be broken when
line wrapping. The mechanism correctly handles punctuation and hyphenated
words.
</p></div></div><div class="top"><p class="src"><a name="v:breakSentence" class="def">breakSentence</a> :: <a href="Data-Text-ICU-Types.html#t:LocaleName">LocaleName</a> -> <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> (<a href="Data-Text-ICU-Break.html#t:BreakIterator">BreakIterator</a> ())<a href="src/Data-Text-ICU-Break.html#breakSentence" class="link">Source</a></p><div class="doc"><p>Break a string on sentence boundaries.
</p><p>Sentence boundary analysis allows selection with correct interpretation
of periods within numbers and abbreviations, and trailing punctuation
marks such as quotation marks and parentheses.
</p></div></div><div class="top"><p class="src"><a name="v:breakWord" class="def">breakWord</a> :: <a href="Data-Text-ICU-Types.html#t:LocaleName">LocaleName</a> -> <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> (<a href="Data-Text-ICU-Break.html#t:BreakIterator">BreakIterator</a> <a href="Data-Text-ICU-Break.html#t:Word">Word</a>)<a href="src/Data-Text-ICU-Break.html#breakWord" class="link">Source</a></p><div class="doc"><p>Break a string on word boundaries.
</p><p>Word boundary analysis is used by search and replace functions, as well
as within text editing applications that allow the user to select words
with a double click. Word selection provides correct interpretation of
punctuation marks within and following words. Characters that are not
part of a word, such as symbols or punctuation marks, have word breaks on
both sides.
</p></div></div><div class="top"><p class="src"><a name="v:clone" class="def">clone</a> :: <a href="Data-Text-ICU-Break.html#t:BreakIterator">BreakIterator</a> a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> (<a href="Data-Text-ICU-Break.html#t:BreakIterator">BreakIterator</a> a)<a href="src/Data-Text-ICU-Break.html#clone" class="link">Source</a></p><div class="doc"><p>Thread safe cloning operation. This is substantially faster than
creating a new <code><a href="Data-Text-ICU-Break.html#t:BreakIterator">BreakIterator</a></code> from scratch.
</p></div></div><div class="top"><p class="src"><a name="v:setText" class="def">setText</a> :: <a href="Data-Text-ICU-Break.html#t:BreakIterator">BreakIterator</a> a -> <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> ()<a href="src/Data-Text-ICU-Break.html#setText" class="link">Source</a></p><div class="doc"><p>Point an existing <code><a href="Data-Text-ICU-Break.html#t:BreakIterator">BreakIterator</a></code> at a new piece of text.
</p></div></div><h1 id="g:3">Iteration functions
</h1><div class="doc"><p><em>Important note</em>: All of the indices accepted and returned by
functions in this module are offsets into the raw UTF-16 text
array, <em>not</em> a count of code points.
</p></div><div class="top"><p class="src"><a name="v:current" class="def">current</a> :: <a href="Data-Text-ICU-Break.html#t:BreakIterator">BreakIterator</a> a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Foreign.html#t:I16">I16</a>)<a href="src/Data-Text-ICU-Break.html#current" class="link">Source</a></p><div class="doc"><p>Return the character index most recently returned by <code><a href="Data-Text-ICU-Break.html#v:next">next</a></code>,
<code><a href="Data-Text-ICU-Break.html#v:previous">previous</a></code>, <code><a href="Data-Text-ICU-Break.html#v:first">first</a></code>, or <code><a href="Data-Text-ICU-Break.html#v:last">last</a></code>.
</p></div></div><div class="top"><p class="src"><a name="v:first" class="def">first</a> :: <a href="Data-Text-ICU-Break.html#t:BreakIterator">BreakIterator</a> a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Foreign.html#t:I16">I16</a><a href="src/Data-Text-ICU-Break.html#first" class="link">Source</a></p><div class="doc"><p>Reset the breaker to the beginning of the text to be scanned.
</p></div></div><div class="top"><p class="src"><a name="v:last" class="def">last</a> :: <a href="Data-Text-ICU-Break.html#t:BreakIterator">BreakIterator</a> a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Foreign.html#t:I16">I16</a><a href="src/Data-Text-ICU-Break.html#last" class="link">Source</a></p><div class="doc"><p>Reset the breaker to the end of the text to be scanned.
</p></div></div><div class="top"><p class="src"><a name="v:next" class="def">next</a> :: <a href="Data-Text-ICU-Break.html#t:BreakIterator">BreakIterator</a> a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Foreign.html#t:I16">I16</a>)<a href="src/Data-Text-ICU-Break.html#next" class="link">Source</a></p><div class="doc"><p>Advance the iterator and break at the text boundary that follows the
current text boundary.
</p></div></div><div class="top"><p class="src"><a name="v:previous" class="def">previous</a> :: <a href="Data-Text-ICU-Break.html#t:BreakIterator">BreakIterator</a> a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Foreign.html#t:I16">I16</a>)<a href="src/Data-Text-ICU-Break.html#previous" class="link">Source</a></p><div class="doc"><p>Advance the iterator and break at the text boundary that precedes the
current text boundary.
</p></div></div><div class="top"><p class="src"><a name="v:preceding" class="def">preceding</a> :: <a href="Data-Text-ICU-Break.html#t:BreakIterator">BreakIterator</a> a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Int.html#t:Int">Int</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Foreign.html#t:I16">I16</a>)<a href="src/Data-Text-ICU-Break.html#preceding" class="link">Source</a></p><div class="doc"><p>Determine the text boundary preceding the specified offset.
</p></div></div><div class="top"><p class="src"><a name="v:following" class="def">following</a> :: <a href="Data-Text-ICU-Break.html#t:BreakIterator">BreakIterator</a> a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Int.html#t:Int">Int</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Foreign.html#t:I16">I16</a>)<a href="src/Data-Text-ICU-Break.html#following" class="link">Source</a></p><div class="doc"><p>Determine the text boundary following the specified offset.
</p></div></div><div class="top"><p class="src"><a name="v:isBoundary" class="def">isBoundary</a> :: <a href="Data-Text-ICU-Break.html#t:BreakIterator">BreakIterator</a> a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Int.html#t:Int">Int</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Bool.html#t:Bool">Bool</a><a href="src/Data-Text-ICU-Break.html#isBoundary" class="link">Source</a></p><div class="doc"><p>Determine whether the specfied position is a boundary position.
As a side effect, leaves the iterator pointing to the first
boundary position at or after the given offset.
</p></div></div><h1 id="g:4">Iterator status
</h1><div class="top"><p class="src"><a name="v:getStatus" class="def">getStatus</a> :: <a href="Data-Text-ICU-Break.html#t:BreakIterator">BreakIterator</a> a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> a<a href="src/Data-Text-ICU-Break.html#getStatus" class="link">Source</a></p><div class="doc"><p>Return the status from the break rule that determined the most recently
returned break position. For rules that do not specify a status, a
default value of <code>()</code> is returned.
</p></div></div><div class="top"><p class="src"><a name="v:getStatuses" class="def">getStatuses</a> :: <a href="Data-Text-ICU-Break.html#t:BreakIterator">BreakIterator</a> a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> [a]<a href="src/Data-Text-ICU-Break.html#getStatuses" class="link">Source</a></p><div class="doc"><p>Return statuses from all of the break rules that determined the most
recently returned break position.
</p></div></div><h1 id="g:5">Locales
</h1><div class="top"><p class="src"><a name="v:available" class="def">available</a> :: [<a href="Data-Text-ICU-Types.html#t:LocaleName">LocaleName</a>]<a href="src/Data-Text-ICU-Break.html#available" class="link">Source</a></p><div class="doc"><p>Locales for which text breaking information is available. A
<code><a href="Data-Text-ICU-Break.html#t:BreakIterator">BreakIterator</a></code> in a locale in this list will perform the correct
text breaking for the locale.
</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.13.2</p></div></body></html>
|