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 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<reference xml:id="class.intlpartsiterator" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The IntlPartsIterator class</title>
<titleabbrev>IntlPartsIterator</titleabbrev>
<partintro>
<!-- {{{ IntlPartsIterator intro -->
<section xml:id="intlpartsiterator.intro">
&reftitle.intro;
<para>
Objects of this class can be obtained from
<classname>IntlBreakIterator</classname> objects. While the break
iterators provide a sequence of boundary positions when iterated,
<classname>IntlPartsIterator</classname> objects provide, as a
convenience, the text fragments comprehended between two successive
boundaries.
</para>
<para>
The keys may represent the offset of the left boundary, right boundary, or
they may just the sequence of non-negative integers. See
<function>IntlBreakIterator::getPartsIterator</function>.
</para>
</section>
<!-- }}} -->
<section xml:id="intlpartsiterator.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis class="class">
<ooclass>
<classname>IntlPartsIterator</classname>
</ooclass>
<ooclass>
<modifier>extends</modifier>
<classname>IntlIterator</classname>
</ooclass>
<classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>const</modifier>
<type>int</type>
<varname linkend="intlpartsiterator.constants.key-sequential">IntlPartsIterator::KEY_SEQUENTIAL</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>const</modifier>
<type>int</type>
<varname linkend="intlpartsiterator.constants.key-left">IntlPartsIterator::KEY_LEFT</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>const</modifier>
<type>int</type>
<varname linkend="intlpartsiterator.constants.key-right">IntlPartsIterator::KEY_RIGHT</varname>
</fieldsynopsis>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.intlpartsiterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='IntlPartsIterator'])">
<xi:fallback/>
</xi:include>
<classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.intliterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='IntlIterator'])">
<xi:fallback/>
</xi:include>
</classsynopsis>
<!-- }}} -->
</section>
<!-- {{{ IntlPartsIterator constants -->
<section xml:id="intlpartsiterator.constants">
&reftitle.constants;
<variablelist>
<varlistentry xml:id="intlpartsiterator.constants.key-sequential">
<term>
<constant>IntlPartsIterator::KEY_SEQUENTIAL</constant>
<type>int</type>
</term>
<listitem>
<para/>
</listitem>
</varlistentry>
<varlistentry xml:id="intlpartsiterator.constants.key-left">
<term>
<constant>IntlPartsIterator::KEY_LEFT</constant>
<type>int</type>
</term>
<listitem>
<para/>
</listitem>
</varlistentry>
<varlistentry xml:id="intlpartsiterator.constants.key-right">
<term>
<constant>IntlPartsIterator::KEY_RIGHT</constant>
<type>int</type>
</term>
<listitem>
<para/>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->
<section role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.4.0</entry>
<entry>
The class constants are now typed.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</section>
</partintro>
&reference.intl.entities.intlpartsiterator;
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
|