<!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.13"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>libstdc++: std::locale::id 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="navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="resize.js"></script> <script type="text/javascript" src="navtreedata.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript"> $(document).ready(initResizable); </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">libstdc++ </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.13 --> </div><!-- top --> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> <div id="nav-sync" class="sync"></div> </div> </div> <div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> $(document).ready(function(){initNavTree('a05237.html','');}); </script> <div id="doc-content"> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#friends">Friends</a> | <a href="a05234.html">List of all members</a> </div> <div class="headertitle"> <div class="title">std::locale::id Class Reference<div class="ingroups"><a class="el" href="a01442.html">Locales</a></div></div> </div> </div><!--header--> <div class="contents"> <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:a05733d8d1ad35f4fa4feef3313b1bce3"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a05237.html#a05733d8d1ad35f4fa4feef3313b1bce3">id</a> ()</td></tr> <tr class="separator:a05733d8d1ad35f4fa4feef3313b1bce3"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a12667b877cc719aeed9113c0d5b21427"><td class="memItemLeft" align="right" valign="top"><a id="a12667b877cc719aeed9113c0d5b21427"></a> size_t </td><td class="memItemRight" valign="bottom"><b>_M_id</b> () const throw ()</td></tr> <tr class="separator:a12667b877cc719aeed9113c0d5b21427"><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:ad5bc3cddb6bb375329682cb211ba0441"><td class="memTemplParams" colspan="2">template<typename _Facet > </td></tr> <tr class="memitem:ad5bc3cddb6bb375329682cb211ba0441"><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a05237.html#ad5bc3cddb6bb375329682cb211ba0441">has_facet</a> (const <a class="el" href="a05229.html">locale</a> &) throw ()</td></tr> <tr class="separator:ad5bc3cddb6bb375329682cb211ba0441"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a0a09223e17db306b813d8b07b4b344fc"><td class="memItemLeft" align="right" valign="top"><a id="a0a09223e17db306b813d8b07b4b344fc"></a> class </td><td class="memItemRight" valign="bottom"><b>locale</b></td></tr> <tr class="separator:a0a09223e17db306b813d8b07b4b344fc"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ad6cc86eddbc65fb7e6d6d09b2c42d697"><td class="memItemLeft" align="right" valign="top"><a id="ad6cc86eddbc65fb7e6d6d09b2c42d697"></a> class </td><td class="memItemRight" valign="bottom"><b>locale::_Impl</b></td></tr> <tr class="separator:ad6cc86eddbc65fb7e6d6d09b2c42d697"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac42c07b39caa9133862dd851c3fa2c7d"><td class="memTemplParams" colspan="2">template<typename _Facet > </td></tr> <tr class="memitem:ac42c07b39caa9133862dd851c3fa2c7d"><td class="memTemplItemLeft" align="right" valign="top">const _Facet & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a05237.html#ac42c07b39caa9133862dd851c3fa2c7d">use_facet</a> (const <a class="el" href="a05229.html">locale</a> &)</td></tr> <tr class="separator:ac42c07b39caa9133862dd851c3fa2c7d"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>Facet ID class.</p> <p>The ID class provides facets with an index used to identify them. Every facet class must define a public static member locale::id, or be derived from a facet that provides this member, otherwise the facet cannot be used in a locale. The locale::id ensures that each class type gets a unique identifier. </p> <p class="definition">Definition at line <a class="el" href="a00365_source.html#l00475">475</a> of file <a class="el" href="a00365_source.html">locale_classes.h</a>.</p> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> <a id="a05733d8d1ad35f4fa4feef3313b1bce3"></a> <h2 class="memtitle"><span class="permalink"><a href="#a05733d8d1ad35f4fa4feef3313b1bce3">◆ </a></span>id()</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">std::locale::id::id </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></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>Constructor. </p> <p class="definition">Definition at line <a class="el" href="a00365_source.html#l00506">506</a> of file <a class="el" href="a00365_source.html">locale_classes.h</a>.</p> <p class="reference">References <a class="el" href="a00368_source.html#l00104">std::locale::has_facet</a>, and <a class="el" href="a00368_source.html#l00132">std::locale::use_facet</a>.</p> </div> </div> <h2 class="groupheader">Friends And Related Function Documentation</h2> <a id="ad5bc3cddb6bb375329682cb211ba0441"></a> <h2 class="memtitle"><span class="permalink"><a href="#ad5bc3cddb6bb375329682cb211ba0441">◆ </a></span>has_facet</h2> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename _Facet > </div> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">bool has_facet </td> <td>(</td> <td class="paramtype">const <a class="el" href="a05229.html">locale</a> & </td> <td class="paramname"></td><td>)</td> <td></td> </tr> <tr> <td align="right">throw </td><td>(</td><td colspan="2"></td> </tr> <tr> <td align="right"></td><td>)</td><td></td><td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">friend</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Test for the presence of a facet.has_facet tests the locale argument for the presence of the facet type provided as the template parameter. Facets derived from the facet parameter will also return true. </p> <dl class="tparams"><dt>Template Parameters</dt><dd> <table class="tparams"> <tr><td class="paramname">_Facet</td><td>The facet type to test the presence of. </td></tr> </table> </dd> </dl> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">__loc</td><td>The locale to test. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>true if <code>__loc</code> contains a facet of type _Facet, else false. </dd></dl> <p class="definition">Definition at line <a class="el" href="a00368_source.html#l00104">104</a> of file <a class="el" href="a00368_source.html">locale_classes.tcc</a>.</p> </div> </div> <a id="ac42c07b39caa9133862dd851c3fa2c7d"></a> <h2 class="memtitle"><span class="permalink"><a href="#ac42c07b39caa9133862dd851c3fa2c7d">◆ </a></span>use_facet</h2> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename _Facet > </div> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">const _Facet& use_facet </td> <td>(</td> <td class="paramtype">const <a class="el" href="a05229.html">locale</a> & </td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">friend</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Return a facet.use_facet looks for and returns a reference to a facet of type Facet where Facet is the template parameter. If has_facet(locale) is true, there is a suitable facet to return. It throws std::bad_cast if the locale doesn't contain a facet of type Facet. </p> <dl class="tparams"><dt>Template Parameters</dt><dd> <table class="tparams"> <tr><td class="paramname">_Facet</td><td>The facet type to access. </td></tr> </table> </dd> </dl> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">__loc</td><td>The locale to use. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>Reference to facet of type Facet. </dd></dl> <dl class="exception"><dt>Exceptions</dt><dd> <table class="exception"> <tr><td class="paramname">std::bad_cast</td><td>if <code>__loc</code> doesn't contain a facet of type _Facet. </td></tr> </table> </dd> </dl> <p class="definition">Definition at line <a class="el" href="a00368_source.html#l00132">132</a> of file <a class="el" href="a00368_source.html">locale_classes.tcc</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="a00365_source.html">locale_classes.h</a></li> </ul> </div><!-- contents --> </div><!-- doc-content --> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="navelem"><a class="el" href="a01487.html">std</a></li><li class="navelem"><a class="el" href="a05229.html">locale</a></li><li class="navelem"><a class="el" href="a05237.html">id</a></li> <li class="footer">Generated by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li> </ul> </div> </body> </html>