structboost_1_1locale_1_1comparator.html 8.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.6"/>
  7. <title>Boost.Locale: boost::locale::comparator&lt; CharType, default_level &gt; Struct Template Reference</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="navtree.css" rel="stylesheet" type="text/css"/>
  12. <script type="text/javascript" src="resize.js"></script>
  13. <script type="text/javascript" src="navtree.js"></script>
  14. <script type="text/javascript">
  15. $(document).ready(initResizable);
  16. $(window).load(resizeHeight);
  17. </script>
  18. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  19. </head>
  20. <body>
  21. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  22. <div id="titlearea">
  23. <table cellspacing="0" cellpadding="0">
  24. <tbody>
  25. <tr style="height: 56px;">
  26. <td id="projectlogo"><img alt="Logo" src="boost-small.png"/></td>
  27. <td style="padding-left: 0.5em;">
  28. <div id="projectname">Boost.Locale
  29. </div>
  30. </td>
  31. </tr>
  32. </tbody>
  33. </table>
  34. </div>
  35. <!-- end header part -->
  36. <!-- Generated by Doxygen 1.8.6 -->
  37. <div id="navrow1" class="tabs">
  38. <ul class="tablist">
  39. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  40. <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  41. <li><a href="modules.html"><span>Modules</span></a></li>
  42. <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  43. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  44. <li><a href="files.html"><span>Files</span></a></li>
  45. <li><a href="examples.html"><span>Examples</span></a></li>
  46. </ul>
  47. </div>
  48. <div id="navrow2" class="tabs2">
  49. <ul class="tablist">
  50. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  51. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  52. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  53. </ul>
  54. </div>
  55. </div><!-- top -->
  56. <div id="side-nav" class="ui-resizable side-nav-resizable">
  57. <div id="nav-tree">
  58. <div id="nav-tree-contents">
  59. <div id="nav-sync" class="sync"></div>
  60. </div>
  61. </div>
  62. <div id="splitbar" style="-moz-user-select:none;"
  63. class="ui-resizable-handle">
  64. </div>
  65. </div>
  66. <script type="text/javascript">
  67. $(document).ready(function(){initNavTree('structboost_1_1locale_1_1comparator.html','');});
  68. </script>
  69. <div id="doc-content">
  70. <div class="header">
  71. <div class="summary">
  72. <a href="#pub-methods">Public Member Functions</a> &#124;
  73. <a href="structboost_1_1locale_1_1comparator-members.html">List of all members</a> </div>
  74. <div class="headertitle">
  75. <div class="title">boost::locale::comparator&lt; CharType, default_level &gt; Struct Template Reference<div class="ingroups"><a class="el" href="group__collation.html">Collation</a></div></div> </div>
  76. </div><!--header-->
  77. <div class="contents">
  78. <p>This class can be used in STL algorithms and containers for comparison of strings with a level other than primary.
  79. <a href="structboost_1_1locale_1_1comparator.html#details">More...</a></p>
  80. <p><code>#include &lt;<a class="el" href="collator_8hpp_source.html">boost/locale/collator.hpp</a>&gt;</code></p>
  81. <table class="memberdecls">
  82. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  83. Public Member Functions</h2></td></tr>
  84. <tr class="memitem:af40ee48c6c93b6e5d91492a3e0cb96a8"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1locale_1_1comparator.html#af40ee48c6c93b6e5d91492a3e0cb96a8">comparator</a> (std::locale const &amp;l=std::locale(), <a class="el" href="classboost_1_1locale_1_1collator__base.html#a73c12de809733273304fef7f0af28b22">collator_base::level_type</a> level=default_level)</td></tr>
  85. <tr class="separator:af40ee48c6c93b6e5d91492a3e0cb96a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="memitem:abd62dbc2af0eb6e6c261a7c88e09f752"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1locale_1_1comparator.html#abd62dbc2af0eb6e6c261a7c88e09f752">operator()</a> (std::basic_string&lt; CharType &gt; const &amp;left, std::basic_string&lt; CharType &gt; const &amp;right) const </td></tr>
  87. <tr class="separator:abd62dbc2af0eb6e6c261a7c88e09f752"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. </table>
  89. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  90. <div class="textblock"><h3>template&lt;typename CharType, collator_base::level_type default_level = collator_base::identical&gt;<br/>
  91. struct boost::locale::comparator&lt; CharType, default_level &gt;</h3>
  92. <p>This class can be used in STL algorithms and containers for comparison of strings with a level other than primary. </p>
  93. <p>For example:</p>
  94. <div class="fragment"><div class="line">std::map&lt;std::string,std::string,comparator&lt;char,collator_base::secondary&gt; &gt; data;</div>
  95. </div><!-- fragment --><p>Would create a map the keys of which are sorted using secondary collation level </p>
  96. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  97. <a class="anchor" id="af40ee48c6c93b6e5d91492a3e0cb96a8"></a>
  98. <div class="memitem">
  99. <div class="memproto">
  100. <div class="memtemplate">
  101. template&lt;typename CharType , collator_base::level_type default_level = collator_base::identical&gt; </div>
  102. <table class="mlabels">
  103. <tr>
  104. <td class="mlabels-left">
  105. <table class="memname">
  106. <tr>
  107. <td class="memname"><a class="el" href="structboost_1_1locale_1_1comparator.html">boost::locale::comparator</a>&lt; CharType, default_level &gt;::<a class="el" href="structboost_1_1locale_1_1comparator.html">comparator</a> </td>
  108. <td>(</td>
  109. <td class="paramtype">std::locale const &amp;&#160;</td>
  110. <td class="paramname"><em>l</em> = <code>std::locale()</code>, </td>
  111. </tr>
  112. <tr>
  113. <td class="paramkey"></td>
  114. <td></td>
  115. <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1collator__base.html#a73c12de809733273304fef7f0af28b22">collator_base::level_type</a>&#160;</td>
  116. <td class="paramname"><em>level</em> = <code>default_level</code>&#160;</td>
  117. </tr>
  118. <tr>
  119. <td></td>
  120. <td>)</td>
  121. <td></td><td></td>
  122. </tr>
  123. </table>
  124. </td>
  125. <td class="mlabels-right">
  126. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  127. </tr>
  128. </table>
  129. </div><div class="memdoc">
  130. <p>Create a comparator class for locale <em>l</em> and with collation leval <em>level</em> </p>
  131. <dl class="section note"><dt>Note</dt><dd>throws std::bad_cast if l does not have <a class="el" href="classboost_1_1locale_1_1collator.html">collator</a> facet installed </dd></dl>
  132. </div>
  133. </div>
  134. <h2 class="groupheader">Member Function Documentation</h2>
  135. <a class="anchor" id="abd62dbc2af0eb6e6c261a7c88e09f752"></a>
  136. <div class="memitem">
  137. <div class="memproto">
  138. <div class="memtemplate">
  139. template&lt;typename CharType , collator_base::level_type default_level = collator_base::identical&gt; </div>
  140. <table class="mlabels">
  141. <tr>
  142. <td class="mlabels-left">
  143. <table class="memname">
  144. <tr>
  145. <td class="memname">bool <a class="el" href="structboost_1_1locale_1_1comparator.html">boost::locale::comparator</a>&lt; CharType, default_level &gt;::operator() </td>
  146. <td>(</td>
  147. <td class="paramtype">std::basic_string&lt; CharType &gt; const &amp;&#160;</td>
  148. <td class="paramname"><em>left</em>, </td>
  149. </tr>
  150. <tr>
  151. <td class="paramkey"></td>
  152. <td></td>
  153. <td class="paramtype">std::basic_string&lt; CharType &gt; const &amp;&#160;</td>
  154. <td class="paramname"><em>right</em>&#160;</td>
  155. </tr>
  156. <tr>
  157. <td></td>
  158. <td>)</td>
  159. <td></td><td> const</td>
  160. </tr>
  161. </table>
  162. </td>
  163. <td class="mlabels-right">
  164. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  165. </tr>
  166. </table>
  167. </div><div class="memdoc">
  168. <p>Compare two strings &ndash; equivalent to return left &lt; right according to collation rules </p>
  169. </div>
  170. </div>
  171. <hr/>The documentation for this struct was generated from the following file:<ul>
  172. <li>boost/locale/<a class="el" href="collator_8hpp_source.html">collator.hpp</a></li>
  173. </ul>
  174. </div><!-- contents -->
  175. </div><!-- doc-content -->
  176. <li class="footer">
  177. &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.
  178. </li>
  179. </ul>
  180. </div>
  181. </body>
  182. </html>