<!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/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>ICU 4.8.1.1: FieldPositionIterator Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">ICU 4.8.1.1
 <span id="projectnumber">4.8.1.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#friends">Friends</a> </div>
<div class="headertitle">
<div class="title">FieldPositionIterator Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="classFieldPositionIterator.html" title="FieldPositionIterator returns the field ids and their start/limit positions generated by a call to Fo...">FieldPositionIterator</a> returns the field ids and their start/limit positions generated by a call to <a class="el" href="classFormat.html#af3f0b157f07d6e9f908da69c99239600" title="Formats an object to produce a string.">Format::format</a>.
<a href="classFieldPositionIterator.html#details">More...</a></p>
<p><code>#include <<a class="el" href="fpositer_8h_source.html">fpositer.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for FieldPositionIterator:</div>
<div class="dyncontent">
<div class="center">
<img src="classFieldPositionIterator.png" usemap="#FieldPositionIterator_map" alt=""/>
<map id="FieldPositionIterator_map" name="FieldPositionIterator_map">
<area href="classUObject.html" title="UObject is the common ICU "boilerplate" class." alt="UObject" shape="rect" coords="0,56,124,80"/>
<area href="classUMemory.html" title="UMemory is the common ICU base class." alt="UMemory" shape="rect" coords="0,0,124,24"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a99c8261bcabccf7f9021048f434b8637"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classFieldPositionIterator.html#a99c8261bcabccf7f9021048f434b8637">~FieldPositionIterator</a> ()</td></tr>
<tr class="memdesc:a99c8261bcabccf7f9021048f434b8637"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a99c8261bcabccf7f9021048f434b8637"></a><br/></td></tr>
<tr class="memitem:a261336db06eddf69a2de075a930256ab"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classFieldPositionIterator.html#a261336db06eddf69a2de075a930256ab">FieldPositionIterator</a> (void)</td></tr>
<tr class="memdesc:a261336db06eddf69a2de075a930256ab"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a new, empty iterator. <a href="#a261336db06eddf69a2de075a930256ab"></a><br/></td></tr>
<tr class="memitem:a1ee7fb97b699749292f9f5751ddae729"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classFieldPositionIterator.html#a1ee7fb97b699749292f9f5751ddae729">FieldPositionIterator</a> (const <a class="el" href="classFieldPositionIterator.html">FieldPositionIterator</a> &)</td></tr>
<tr class="memdesc:a1ee7fb97b699749292f9f5751ddae729"><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <a href="#a1ee7fb97b699749292f9f5751ddae729"></a><br/></td></tr>
<tr class="memitem:aad3f5660944756a2870f27386c75bbbb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classFieldPositionIterator.html#aad3f5660944756a2870f27386c75bbbb">operator==</a> (const <a class="el" href="classFieldPositionIterator.html">FieldPositionIterator</a> &) const </td></tr>
<tr class="memdesc:aad3f5660944756a2870f27386c75bbbb"><td class="mdescLeft"> </td><td class="mdescRight">Return true if another object is semantically equal to this one. <a href="#aad3f5660944756a2870f27386c75bbbb"></a><br/></td></tr>
<tr class="memitem:a2577c8b21530671bbabebfa5710db09f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classFieldPositionIterator.html#a2577c8b21530671bbabebfa5710db09f">operator!=</a> (const <a class="el" href="classFieldPositionIterator.html">FieldPositionIterator</a> &rhs) const </td></tr>
<tr class="memdesc:a2577c8b21530671bbabebfa5710db09f"><td class="mdescLeft"> </td><td class="mdescRight">Returns the complement of the result of operator==. <a href="#a2577c8b21530671bbabebfa5710db09f"></a><br/></td></tr>
<tr class="memitem:a0f620f47a6594d0d6cb2631e3bae9b13"><td class="memItemLeft" align="right" valign="top"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classFieldPositionIterator.html#a0f620f47a6594d0d6cb2631e3bae9b13">next</a> (<a class="el" href="classFieldPosition.html">FieldPosition</a> &fp)</td></tr>
<tr class="memdesc:a0f620f47a6594d0d6cb2631e3bae9b13"><td class="mdescLeft"> </td><td class="mdescRight">If the current position is valid, updates the <a class="el" href="classFieldPosition.html" title="FieldPosition is a simple class used by Format and its subclasses to identify fields in formatted out...">FieldPosition</a> values, advances the iterator, and returns TRUE, otherwise returns FALSE. <a href="#a0f620f47a6594d0d6cb2631e3bae9b13"></a><br/></td></tr>
<tr class="inherit_header pub_methods_classUObject"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classUObject')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classUObject.html">UObject</a></td></tr>
<tr class="memitem:ace22cf29a90641ef43350deae5bedb85 inherit pub_methods_classUObject"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classUObject.html#ace22cf29a90641ef43350deae5bedb85">~UObject</a> ()</td></tr>
<tr class="memdesc:ace22cf29a90641ef43350deae5bedb85 inherit pub_methods_classUObject"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#ace22cf29a90641ef43350deae5bedb85"></a><br/></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a521af666ba6670f8c8a975d22cc0400a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a521af666ba6670f8c8a975d22cc0400a"></a>
class </td><td class="memItemRight" valign="bottom"><b>FieldPositionIteratorHandler</b></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classFieldPositionIterator.html" title="FieldPositionIterator returns the field ids and their start/limit positions generated by a call to Fo...">FieldPositionIterator</a> returns the field ids and their start/limit positions generated by a call to <a class="el" href="classFormat.html#af3f0b157f07d6e9f908da69c99239600" title="Formats an object to produce a string.">Format::format</a>. </p>
<p>See <a class="el" href="classFormat.html" title="Base class for all formats.">Format</a>, <a class="el" href="classNumberFormat.html" title="Abstract base class for all number formats.">NumberFormat</a>, <a class="el" href="classDecimalFormat.html" title="DecimalFormat is a concrete subclass of NumberFormat that formats decimal numbers.">DecimalFormat</a>. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003041">Stable:</a></b></dt><dd>ICU 4.4 </dd></dl>
<p>Definition at line <a class="el" href="fpositer_8h_source.html#l00053">53</a> of file <a class="el" href="fpositer_8h_source.html">fpositer.h</a>.</p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a99c8261bcabccf7f9021048f434b8637"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FieldPositionIterator::~FieldPositionIterator </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003042">Stable:</a></b></dt><dd>ICU 4.4 </dd></dl>
</div>
</div>
<a class="anchor" id="a261336db06eddf69a2de075a930256ab"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FieldPositionIterator::FieldPositionIterator </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs a new, empty iterator. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003043">Stable:</a></b></dt><dd>ICU 4.4 </dd></dl>
</div>
</div>
<a class="anchor" id="a1ee7fb97b699749292f9f5751ddae729"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FieldPositionIterator::FieldPositionIterator </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classFieldPositionIterator.html">FieldPositionIterator</a> & </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Copy constructor. </p>
<p>If the copy failed for some reason, the new iterator will be empty. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003044">Stable:</a></b></dt><dd>ICU 4.4 </dd></dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a0f620f47a6594d0d6cb2631e3bae9b13"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> FieldPositionIterator::next </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classFieldPosition.html">FieldPosition</a> & </td>
<td class="paramname"><em>fp</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>If the current position is valid, updates the <a class="el" href="classFieldPosition.html" title="FieldPosition is a simple class used by Format and its subclasses to identify fields in formatted out...">FieldPosition</a> values, advances the iterator, and returns TRUE, otherwise returns FALSE. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003047">Stable:</a></b></dt><dd>ICU 4.4 </dd></dl>
</div>
</div>
<a class="anchor" id="a2577c8b21530671bbabebfa5710db09f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> FieldPositionIterator::operator!= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classFieldPositionIterator.html">FieldPositionIterator</a> & </td>
<td class="paramname"><em>rhs</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the complement of the result of operator==. </p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">rhs</td><td>The <a class="el" href="classFieldPositionIterator.html" title="FieldPositionIterator returns the field ids and their start/limit positions generated by a call to Fo...">FieldPositionIterator</a> to be compared for inequality </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns:</dt><dd>the complement of the result of operator== </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003046">Stable:</a></b></dt><dd>ICU 4.4 </dd></dl>
<p>Definition at line <a class="el" href="fpositer_8h_source.html#l00090">90</a> of file <a class="el" href="fpositer_8h_source.html">fpositer.h</a>.</p>
<p>References <a class="el" href="stringpiece_8h.html#a7652049cbac0bfeae2cd2aa4514a3352">operator==()</a>.</p>
</div>
</div>
<a class="anchor" id="aad3f5660944756a2870f27386c75bbbb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> FieldPositionIterator::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classFieldPositionIterator.html">FieldPositionIterator</a> & </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Return true if another object is semantically equal to this one. </p>
<p>Return true if this <a class="el" href="classFieldPositionIterator.html" title="FieldPositionIterator returns the field ids and their start/limit positions generated by a call to Fo...">FieldPositionIterator</a> is at the same position in an equal array of run values. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003045">Stable:</a></b></dt><dd>ICU 4.4 </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="fpositer_8h_source.html">fpositer.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.1
</small></address>
</body>
</html>
