JezK
Edit File: classnumber_1_1CurrencyRounder.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/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.14"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>ICU 60.1: icu::number::CurrencyRounder 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="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 id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">ICU 60.1  <span id="projectnumber">60.1</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.14 --> <script type="text/javascript" src="menudata.js"></script> <script type="text/javascript" src="menu.js"></script> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(function() { initMenu('',false,false,'search.php','Search'); }); /* @license-end */</script> <div id="main-nav"></div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="namespaceicu.html">icu</a></li><li class="navelem"><b>number</b></li><li class="navelem"><a class="el" href="classicu_1_1number_1_1CurrencyRounder.html">CurrencyRounder</a></li> </ul> </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">icu::number::CurrencyRounder Class Reference</div> </div> </div><!--header--> <div class="contents"> <p>A class that defines a rounding strategy parameterized by a currency to be used when formatting numbers in <a class="el" href="classicu_1_1number_1_1NumberFormatter.html" title="See the main description in numberformatter.h for documentation and examples. ">NumberFormatter</a>. <a href="classicu_1_1number_1_1CurrencyRounder.html#details">More...</a></p> <p><code>#include <<a class="el" href="numberformatter_8h_source.html">numberformatter.h</a>></code></p> <div class="dynheader"> Inheritance diagram for icu::number::CurrencyRounder:</div> <div class="dyncontent"> <div class="center"> <img src="classicu_1_1number_1_1CurrencyRounder.png" usemap="#icu::number::CurrencyRounder_map" alt=""/> <map id="icu::number::CurrencyRounder_map" name="icu::number::CurrencyRounder_map"> <area href="classicu_1_1number_1_1Rounder.html" title="A class that defines the rounding strategy to be used when formatting numbers in NumberFormatter. " alt="icu::number::Rounder" shape="rect" coords="0,56,185,80"/> <area href="classicu_1_1UMemory.html" title="UMemory is the common ICU base class. " alt="icu::UMemory" shape="rect" coords="0,0,185,24"/> </map> </div></div> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:adf20387b783c4f51cda7fc6107c63f0a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1number_1_1Rounder.html">Rounder</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1number_1_1CurrencyRounder.html#adf20387b783c4f51cda7fc6107c63f0a">withCurrency</a> (const <a class="el" href="classicu_1_1CurrencyUnit.html">CurrencyUnit</a> &<a class="el" href="classicu_1_1number_1_1Rounder.html#ac8bda895ef66064c9e4fb91a2fae0225">currency</a>) const</td></tr> <tr class="memdesc:adf20387b783c4f51cda7fc6107c63f0a"><td class="mdescLeft"> </td><td class="mdescRight">Associates a currency with this rounding strategy. <a href="#adf20387b783c4f51cda7fc6107c63f0a">More...</a><br /></td></tr> <tr class="separator:adf20387b783c4f51cda7fc6107c63f0a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="inherit_header pub_methods_classicu_1_1number_1_1Rounder"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classicu_1_1number_1_1Rounder')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classicu_1_1number_1_1Rounder.html">icu::number::Rounder</a></td></tr> <tr class="memitem:afc76b8f89121600e9bf24957c47abc2f inherit pub_methods_classicu_1_1number_1_1Rounder"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1number_1_1Rounder.html">Rounder</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1number_1_1Rounder.html#afc76b8f89121600e9bf24957c47abc2f">withMode</a> (<a class="el" href="unum_8h.html#a2f46653ee48f5d8d5b8e67d4a1b8230a">UNumberFormatRoundingMode</a> roundingMode) const</td></tr> <tr class="memdesc:afc76b8f89121600e9bf24957c47abc2f inherit pub_methods_classicu_1_1number_1_1Rounder"><td class="mdescLeft"> </td><td class="mdescRight">Sets the rounding mode to use when picking the direction to round (up or down). <a href="classicu_1_1number_1_1Rounder.html#afc76b8f89121600e9bf24957c47abc2f">More...</a><br /></td></tr> <tr class="separator:afc76b8f89121600e9bf24957c47abc2f inherit pub_methods_classicu_1_1number_1_1Rounder"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a> Friends</h2></td></tr> <tr class="memitem:abdc63fe204a0bdfe906884f0205fc963"><td class="memItemLeft" align="right" valign="top"><a id="abdc63fe204a0bdfe906884f0205fc963"></a> class </td><td class="memItemRight" valign="bottom"><b>Rounder</b></td></tr> <tr class="separator:abdc63fe204a0bdfe906884f0205fc963"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a> Additional Inherited Members</h2></td></tr> <tr class="inherit_header pub_static_methods_classicu_1_1number_1_1Rounder"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_classicu_1_1number_1_1Rounder')"><img src="closed.png" alt="-"/> Static Public Member Functions inherited from <a class="el" href="classicu_1_1number_1_1Rounder.html">icu::number::Rounder</a></td></tr> <tr class="memitem:a9630302328d3e1636cddfe91a3b6ab81 inherit pub_static_methods_classicu_1_1number_1_1Rounder"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classicu_1_1number_1_1Rounder.html">Rounder</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1number_1_1Rounder.html#a9630302328d3e1636cddfe91a3b6ab81">unlimited</a> ()</td></tr> <tr class="memdesc:a9630302328d3e1636cddfe91a3b6ab81 inherit pub_static_methods_classicu_1_1number_1_1Rounder"><td class="mdescLeft"> </td><td class="mdescRight">Show all available digits to full precision. <a href="classicu_1_1number_1_1Rounder.html#a9630302328d3e1636cddfe91a3b6ab81">More...</a><br /></td></tr> <tr class="separator:a9630302328d3e1636cddfe91a3b6ab81 inherit pub_static_methods_classicu_1_1number_1_1Rounder"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a99a32b2e65760e72e63fcbb33891279f inherit pub_static_methods_classicu_1_1number_1_1Rounder"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classicu_1_1number_1_1FractionRounder.html">FractionRounder</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1number_1_1Rounder.html#a99a32b2e65760e72e63fcbb33891279f">integer</a> ()</td></tr> <tr class="memdesc:a99a32b2e65760e72e63fcbb33891279f inherit pub_static_methods_classicu_1_1number_1_1Rounder"><td class="mdescLeft"> </td><td class="mdescRight">Show numbers rounded if necessary to the nearest integer. <a href="classicu_1_1number_1_1Rounder.html#a99a32b2e65760e72e63fcbb33891279f">More...</a><br /></td></tr> <tr class="separator:a99a32b2e65760e72e63fcbb33891279f inherit pub_static_methods_classicu_1_1number_1_1Rounder"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:abef89e03be1a82c3aedd700217d678b0 inherit pub_static_methods_classicu_1_1number_1_1Rounder"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classicu_1_1number_1_1FractionRounder.html">FractionRounder</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1number_1_1Rounder.html#abef89e03be1a82c3aedd700217d678b0">fixedFraction</a> (int32_t minMaxFractionPlaces)</td></tr> <tr class="memdesc:abef89e03be1a82c3aedd700217d678b0 inherit pub_static_methods_classicu_1_1number_1_1Rounder"><td class="mdescLeft"> </td><td class="mdescRight">Show numbers rounded if necessary to a certain number of fraction places (numerals after the decimal separator). <a href="classicu_1_1number_1_1Rounder.html#abef89e03be1a82c3aedd700217d678b0">More...</a><br /></td></tr> <tr class="separator:abef89e03be1a82c3aedd700217d678b0 inherit pub_static_methods_classicu_1_1number_1_1Rounder"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aa31927d0141d83e9a076417e6abd622c inherit pub_static_methods_classicu_1_1number_1_1Rounder"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classicu_1_1number_1_1FractionRounder.html">FractionRounder</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1number_1_1Rounder.html#aa31927d0141d83e9a076417e6abd622c">minFraction</a> (int32_t minFractionPlaces)</td></tr> <tr class="memdesc:aa31927d0141d83e9a076417e6abd622c inherit pub_static_methods_classicu_1_1number_1_1Rounder"><td class="mdescLeft"> </td><td class="mdescRight">Always show at least a certain number of fraction places after the decimal separator, padding with zeros if necessary. <a href="classicu_1_1number_1_1Rounder.html#aa31927d0141d83e9a076417e6abd622c">More...</a><br /></td></tr> <tr class="separator:aa31927d0141d83e9a076417e6abd622c inherit pub_static_methods_classicu_1_1number_1_1Rounder"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a721dfa1f91dd66138672040804ef6507 inherit pub_static_methods_classicu_1_1number_1_1Rounder"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classicu_1_1number_1_1FractionRounder.html">FractionRounder</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1number_1_1Rounder.html#a721dfa1f91dd66138672040804ef6507">maxFraction</a> (int32_t maxFractionPlaces)</td></tr> <tr class="memdesc:a721dfa1f91dd66138672040804ef6507 inherit pub_static_methods_classicu_1_1number_1_1Rounder"><td class="mdescLeft"> </td><td class="mdescRight">Show numbers rounded if necessary to a certain number of fraction places (numerals after the decimal separator). <a href="classicu_1_1number_1_1Rounder.html#a721dfa1f91dd66138672040804ef6507">More...</a><br /></td></tr> <tr class="separator:a721dfa1f91dd66138672040804ef6507 inherit pub_static_methods_classicu_1_1number_1_1Rounder"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a0240b5a2a81256bfc2460990a48a871e inherit pub_static_methods_classicu_1_1number_1_1Rounder"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classicu_1_1number_1_1FractionRounder.html">FractionRounder</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1number_1_1Rounder.html#a0240b5a2a81256bfc2460990a48a871e">minMaxFraction</a> (int32_t minFractionPlaces, int32_t maxFractionPlaces)</td></tr> <tr class="memdesc:a0240b5a2a81256bfc2460990a48a871e inherit pub_static_methods_classicu_1_1number_1_1Rounder"><td class="mdescLeft"> </td><td class="mdescRight">Show numbers rounded if necessary to a certain number of fraction places (numerals after the decimal separator); in addition, always show at least a certain number of places after the decimal separator, padding with zeros if necessary. <a href="classicu_1_1number_1_1Rounder.html#a0240b5a2a81256bfc2460990a48a871e">More...</a><br /></td></tr> <tr class="separator:a0240b5a2a81256bfc2460990a48a871e inherit pub_static_methods_classicu_1_1number_1_1Rounder"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a0e3c32603c4ff11099bf465fdf8f4466 inherit pub_static_methods_classicu_1_1number_1_1Rounder"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classicu_1_1number_1_1Rounder.html">DigitRounder</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1number_1_1Rounder.html#a0e3c32603c4ff11099bf465fdf8f4466">fixedDigits</a> (int32_t minMaxSignificantDigits)</td></tr> <tr class="memdesc:a0e3c32603c4ff11099bf465fdf8f4466 inherit pub_static_methods_classicu_1_1number_1_1Rounder"><td class="mdescLeft"> </td><td class="mdescRight">Show numbers rounded if necessary to a certain number of significant digits or significant figures. <a href="classicu_1_1number_1_1Rounder.html#a0e3c32603c4ff11099bf465fdf8f4466">More...</a><br /></td></tr> <tr class="separator:a0e3c32603c4ff11099bf465fdf8f4466 inherit pub_static_methods_classicu_1_1number_1_1Rounder"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a3677fe5e17206029a4f790eb5d92aff4 inherit pub_static_methods_classicu_1_1number_1_1Rounder"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classicu_1_1number_1_1Rounder.html">DigitRounder</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1number_1_1Rounder.html#a3677fe5e17206029a4f790eb5d92aff4">minDigits</a> (int32_t minSignificantDigits)</td></tr> <tr class="memdesc:a3677fe5e17206029a4f790eb5d92aff4 inherit pub_static_methods_classicu_1_1number_1_1Rounder"><td class="mdescLeft"> </td><td class="mdescRight">Always show at least a certain number of significant digits/figures, padding with zeros if necessary. <a href="classicu_1_1number_1_1Rounder.html#a3677fe5e17206029a4f790eb5d92aff4">More...</a><br /></td></tr> <tr class="separator:a3677fe5e17206029a4f790eb5d92aff4 inherit pub_static_methods_classicu_1_1number_1_1Rounder"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a5299d450098e6968cf710d7bb9b00a84 inherit pub_static_methods_classicu_1_1number_1_1Rounder"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classicu_1_1number_1_1Rounder.html">DigitRounder</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1number_1_1Rounder.html#a5299d450098e6968cf710d7bb9b00a84">maxDigits</a> (int32_t maxSignificantDigits)</td></tr> <tr class="memdesc:a5299d450098e6968cf710d7bb9b00a84 inherit pub_static_methods_classicu_1_1number_1_1Rounder"><td class="mdescLeft"> </td><td class="mdescRight">Show numbers rounded if necessary to a certain number of significant digits/figures. <a href="classicu_1_1number_1_1Rounder.html#a5299d450098e6968cf710d7bb9b00a84">More...</a><br /></td></tr> <tr class="separator:a5299d450098e6968cf710d7bb9b00a84 inherit pub_static_methods_classicu_1_1number_1_1Rounder"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a157b5dbc9390ca6d24accb363f1afceb inherit pub_static_methods_classicu_1_1number_1_1Rounder"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classicu_1_1number_1_1Rounder.html">DigitRounder</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1number_1_1Rounder.html#a157b5dbc9390ca6d24accb363f1afceb">minMaxDigits</a> (int32_t minSignificantDigits, int32_t maxSignificantDigits)</td></tr> <tr class="memdesc:a157b5dbc9390ca6d24accb363f1afceb inherit pub_static_methods_classicu_1_1number_1_1Rounder"><td class="mdescLeft"> </td><td class="mdescRight">Show numbers rounded if necessary to a certain number of significant digits/figures; in addition, always show at least a certain number of significant digits, padding with zeros if necessary. <a href="classicu_1_1number_1_1Rounder.html#a157b5dbc9390ca6d24accb363f1afceb">More...</a><br /></td></tr> <tr class="separator:a157b5dbc9390ca6d24accb363f1afceb inherit pub_static_methods_classicu_1_1number_1_1Rounder"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a3ca08322647acdfb5b5f220717fe4e5f inherit pub_static_methods_classicu_1_1number_1_1Rounder"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classicu_1_1number_1_1IncrementRounder.html">IncrementRounder</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1number_1_1Rounder.html#a3ca08322647acdfb5b5f220717fe4e5f">increment</a> (double roundingIncrement)</td></tr> <tr class="memdesc:a3ca08322647acdfb5b5f220717fe4e5f inherit pub_static_methods_classicu_1_1number_1_1Rounder"><td class="mdescLeft"> </td><td class="mdescRight">Show numbers rounded if necessary to the closest multiple of a certain rounding increment. <a href="classicu_1_1number_1_1Rounder.html#a3ca08322647acdfb5b5f220717fe4e5f">More...</a><br /></td></tr> <tr class="separator:a3ca08322647acdfb5b5f220717fe4e5f inherit pub_static_methods_classicu_1_1number_1_1Rounder"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac8bda895ef66064c9e4fb91a2fae0225 inherit pub_static_methods_classicu_1_1number_1_1Rounder"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classicu_1_1number_1_1CurrencyRounder.html">CurrencyRounder</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1number_1_1Rounder.html#ac8bda895ef66064c9e4fb91a2fae0225">currency</a> (<a class="el" href="ucurr_8h.html#acb76397692c3225539789ce239a6c306">UCurrencyUsage</a> currencyUsage)</td></tr> <tr class="memdesc:ac8bda895ef66064c9e4fb91a2fae0225 inherit pub_static_methods_classicu_1_1number_1_1Rounder"><td class="mdescLeft"> </td><td class="mdescRight">Show numbers rounded and padded according to the rules for the currency unit. <a href="classicu_1_1number_1_1Rounder.html#ac8bda895ef66064c9e4fb91a2fae0225">More...</a><br /></td></tr> <tr class="separator:ac8bda895ef66064c9e4fb91a2fae0225 inherit pub_static_methods_classicu_1_1number_1_1Rounder"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>A class that defines a rounding strategy parameterized by a currency to be used when formatting numbers in <a class="el" href="classicu_1_1number_1_1NumberFormatter.html" title="See the main description in numberformatter.h for documentation and examples. ">NumberFormatter</a>. </p> <p>To create a <a class="el" href="classicu_1_1number_1_1CurrencyRounder.html" title="A class that defines a rounding strategy parameterized by a currency to be used when formatting numbe...">CurrencyRounder</a>, use one of the factory methods on <a class="el" href="classicu_1_1number_1_1Rounder.html" title="A class that defines the rounding strategy to be used when formatting numbers in NumberFormatter. ">Rounder</a>.</p> <dl class="draft"><dt><b><a class="el" href="draft.html#_draft000130">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 60 </dd></dl> <p class="definition">Definition at line <a class="el" href="numberformatter_8h_source.html#l00940">940</a> of file <a class="el" href="numberformatter_8h_source.html">numberformatter.h</a>.</p> </div><h2 class="groupheader">Member Function Documentation</h2> <a id="adf20387b783c4f51cda7fc6107c63f0a"></a> <h2 class="memtitle"><span class="permalink"><a href="#adf20387b783c4f51cda7fc6107c63f0a">◆ </a></span>withCurrency()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classicu_1_1number_1_1Rounder.html">Rounder</a> icu::number::CurrencyRounder::withCurrency </td> <td>(</td> <td class="paramtype">const <a class="el" href="classicu_1_1CurrencyUnit.html">CurrencyUnit</a> & </td> <td class="paramname"><em>currency</em></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> <p>Associates a currency with this rounding strategy. </p> <p><b>Calling this method is <em>not required</em></b>, because the currency specified in unit() is automatically applied to currency rounding strategies. However, this method enables you to override that automatic association.</p> <p>This method also enables numbers to be formatted using currency rounding rules without explicitly using a currency format.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">currency</td><td>The currency to associate with this rounding strategy. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>A <a class="el" href="classicu_1_1number_1_1Rounder.html" title="A class that defines the rounding strategy to be used when formatting numbers in NumberFormatter. ">Rounder</a> for chaining or passing to the <a class="el" href="classicu_1_1number_1_1NumberFormatter.html" title="See the main description in numberformatter.h for documentation and examples. ">NumberFormatter</a> rounding() setter. </dd></dl> <dl class="draft"><dt><b><a class="el" href="draft.html#_draft000159">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 60 </dd></dl> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="numberformatter_8h_source.html">numberformatter.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.14 </small></address> </body> </html>