locale/doc/html/classboost_1_1locale_1_1info.html
2015-10-18 17:31:48 +03:00

428 lines
19 KiB
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.6"/>
<title>Boost.Locale: boost::locale::info 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="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</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="projectlogo"><img alt="Logo" src="boost-small.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">Boost.Locale
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
</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('classboost_1_1locale_1_1info.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="classboost_1_1locale_1_1info-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">boost::locale::info Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>a facet that holds general information about locale
<a href="classboost_1_1locale_1_1info.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="info_8hpp_source.html">boost/locale/info.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for boost::locale::info:</div>
<div class="dyncontent">
<div class="center">
<img src="classboost_1_1locale_1_1info.png" usemap="#boost::locale::info_map" alt=""/>
<map id="boost::locale::info_map" name="boost::locale::info_map">
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:ac79e3924b5473862ab15a3290b1c8d15"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1info.html#ac79e3924b5473862ab15a3290b1c8d15">string_propery</a> { <br/>
&#160;&#160;<a class="el" href="classboost_1_1locale_1_1info.html#ac79e3924b5473862ab15a3290b1c8d15a51e81de8c364b3734f4e2baf1abaddcf">language_property</a>,
<a class="el" href="classboost_1_1locale_1_1info.html#ac79e3924b5473862ab15a3290b1c8d15ab59b95580bc749f21c832a70d4b73c61">country_property</a>,
<a class="el" href="classboost_1_1locale_1_1info.html#ac79e3924b5473862ab15a3290b1c8d15a2b38cb5c60ed931f21fc9bec4984900c">variant_property</a>,
<a class="el" href="classboost_1_1locale_1_1info.html#ac79e3924b5473862ab15a3290b1c8d15a1aa0567014d09df594b4a616f20c9b26">encoding_property</a>,
<br/>
&#160;&#160;<a class="el" href="classboost_1_1locale_1_1info.html#ac79e3924b5473862ab15a3290b1c8d15ab68bcb824a19b6cfd95ad3c714369369">name_property</a>
<br/>
}</td></tr>
<tr class="separator:ac79e3924b5473862ab15a3290b1c8d15"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a53d7aa756e1b74f360913a9c9d41bb6d"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1info.html#a53d7aa756e1b74f360913a9c9d41bb6d">integer_property</a> { <a class="el" href="classboost_1_1locale_1_1info.html#a53d7aa756e1b74f360913a9c9d41bb6da4d27d781e7da56cb9b94bfd8cdcab5ea">utf8_property</a>
}</td></tr>
<tr class="separator:a53d7aa756e1b74f360913a9c9d41bb6d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:a5545bf33988c859b3b864d4d65178134"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1info.html#a5545bf33988c859b3b864d4d65178134">info</a> (size_t refs=0)</td></tr>
<tr class="separator:a5545bf33988c859b3b864d4d65178134"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7c56b9df3aba82649afc66c06192c7df"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1info.html#a7c56b9df3aba82649afc66c06192c7df">language</a> () const </td></tr>
<tr class="separator:a7c56b9df3aba82649afc66c06192c7df"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a249c20e36da6827a8dc8b12a8342a7dc"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1info.html#a249c20e36da6827a8dc8b12a8342a7dc">country</a> () const </td></tr>
<tr class="separator:a249c20e36da6827a8dc8b12a8342a7dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2e949e4362c8f0195e2a645fe875f1b4"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1info.html#a2e949e4362c8f0195e2a645fe875f1b4">variant</a> () const </td></tr>
<tr class="separator:a2e949e4362c8f0195e2a645fe875f1b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1979a5d7b90604c45e856a139c68f5ba"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1info.html#a1979a5d7b90604c45e856a139c68f5ba">encoding</a> () const </td></tr>
<tr class="separator:a1979a5d7b90604c45e856a139c68f5ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af8181bf226f369548c030220932323b9"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1info.html#af8181bf226f369548c030220932323b9">name</a> () const </td></tr>
<tr class="separator:af8181bf226f369548c030220932323b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aafbbb5c291f60ce6fc3bc056859ba181"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1info.html#aafbbb5c291f60ce6fc3bc056859ba181">utf8</a> () const </td></tr>
<tr class="separator:aafbbb5c291f60ce6fc3bc056859ba181"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:a01c274323da1367b153952ee1f056572"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a01c274323da1367b153952ee1f056572"></a>
static std::locale::id&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1info.html#a01c274323da1367b153952ee1f056572">id</a></td></tr>
<tr class="memdesc:a01c274323da1367b153952ee1f056572"><td class="mdescLeft">&#160;</td><td class="mdescRight">This member uniquely defines this facet, required by STL. <br/></td></tr>
<tr class="separator:a01c274323da1367b153952ee1f056572"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a38673d9985abd1c98713b262fadfe584"><td class="memItemLeft" align="right" valign="top">virtual std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1info.html#a38673d9985abd1c98713b262fadfe584">get_string_property</a> (<a class="el" href="classboost_1_1locale_1_1info.html#ac79e3924b5473862ab15a3290b1c8d15">string_propery</a> v) const =0</td></tr>
<tr class="separator:a38673d9985abd1c98713b262fadfe584"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aee97062cd9c8a1c6b24a160783865ee2"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1info.html#aee97062cd9c8a1c6b24a160783865ee2">get_integer_property</a> (<a class="el" href="classboost_1_1locale_1_1info.html#a53d7aa756e1b74f360913a9c9d41bb6d">integer_property</a> v) const =0</td></tr>
<tr class="separator:aee97062cd9c8a1c6b24a160783865ee2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>a facet that holds general information about locale </p>
<p>This facet should be always created in order to make all Boost.Locale functions work </p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a class="anchor" id="a53d7aa756e1b74f360913a9c9d41bb6d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classboost_1_1locale_1_1info.html#a53d7aa756e1b74f360913a9c9d41bb6d">boost::locale::info::integer_property</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Integer information about locale </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="a53d7aa756e1b74f360913a9c9d41bb6da4d27d781e7da56cb9b94bfd8cdcab5ea"></a>utf8_property</em>&#160;</td><td class="fielddoc">
<p>Non zero value if uses UTF-8 encoding. </p>
</td></tr>
</table>
</div>
</div>
<a class="anchor" id="ac79e3924b5473862ab15a3290b1c8d15"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classboost_1_1locale_1_1info.html#ac79e3924b5473862ab15a3290b1c8d15">boost::locale::info::string_propery</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>String information about the locale </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="ac79e3924b5473862ab15a3290b1c8d15a51e81de8c364b3734f4e2baf1abaddcf"></a>language_property</em>&#160;</td><td class="fielddoc">
<p>ISO 639 language id. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ac79e3924b5473862ab15a3290b1c8d15ab59b95580bc749f21c832a70d4b73c61"></a>country_property</em>&#160;</td><td class="fielddoc">
<p>ISO 3166 country id. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ac79e3924b5473862ab15a3290b1c8d15a2b38cb5c60ed931f21fc9bec4984900c"></a>variant_property</em>&#160;</td><td class="fielddoc">
<p>Variant for locale. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ac79e3924b5473862ab15a3290b1c8d15a1aa0567014d09df594b4a616f20c9b26"></a>encoding_property</em>&#160;</td><td class="fielddoc">
<p>encoding name </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ac79e3924b5473862ab15a3290b1c8d15ab68bcb824a19b6cfd95ad3c714369369"></a>name_property</em>&#160;</td><td class="fielddoc">
<p>locale name </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a5545bf33988c859b3b864d4d65178134"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">boost::locale::info::info </td>
<td>(</td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>refs</em> = <code>0</code></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>Standard facet's constructor </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a249c20e36da6827a8dc8b12a8342a7dc"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string boost::locale::info::country </td>
<td>(</td>
<td class="paramname"></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>Get country name </p>
</div>
</div>
<a class="anchor" id="a1979a5d7b90604c45e856a139c68f5ba"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string boost::locale::info::encoding </td>
<td>(</td>
<td class="paramname"></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>Get encoding </p>
</div>
</div>
<a class="anchor" id="aee97062cd9c8a1c6b24a160783865ee2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int boost::locale::info::get_integer_property </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classboost_1_1locale_1_1info.html#a53d7aa756e1b74f360913a9c9d41bb6d">integer_property</a>&#160;</td>
<td class="paramname"><em>v</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get integer property by its id <em>v</em> </p>
</div>
</div>
<a class="anchor" id="a38673d9985abd1c98713b262fadfe584"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::string boost::locale::info::get_string_property </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classboost_1_1locale_1_1info.html#ac79e3924b5473862ab15a3290b1c8d15">string_propery</a>&#160;</td>
<td class="paramname"><em>v</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get string property by its id <em>v</em> </p>
</div>
</div>
<a class="anchor" id="a7c56b9df3aba82649afc66c06192c7df"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string boost::locale::info::language </td>
<td>(</td>
<td class="paramname"></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>Get language name </p>
</div>
</div>
<a class="anchor" id="af8181bf226f369548c030220932323b9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string boost::locale::info::name </td>
<td>(</td>
<td class="paramname"></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>Get the name of the locale, like en_US.UTF-8 </p>
</div>
</div>
<a class="anchor" id="aafbbb5c291f60ce6fc3bc056859ba181"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool boost::locale::info::utf8 </td>
<td>(</td>
<td class="paramname"></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>True if the underlying encoding is UTF-8 (for char streams and strings) </p>
</div>
</div>
<a class="anchor" id="a2e949e4362c8f0195e2a645fe875f1b4"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string boost::locale::info::variant </td>
<td>(</td>
<td class="paramname"></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>Get locale variant </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>boost/locale/<a class="el" href="info_8hpp_source.html">info.hpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<li class="footer">
&copy; Copyright 2009-2012 Artyom Beilis, Distributed under the <a href="http://www.boost.org/LICENSE_1_0.txt">Boost Software License</a>, Version 1.0.
</li>
</ul>
</div>
</body>
</html>