-
Notifications
You must be signed in to change notification settings - Fork 38
/
Copy pathclassCollatorFactory.html
329 lines (309 loc) · 19.2 KB
/
classCollatorFactory.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ICU 77.1: icu::CollatorFactory 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/searchdata.js"></script>
<script type="text/javascript" src="search/search.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 77.1
 <span id="projectnumber">77.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<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('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceicu.html">icu</a></li><li class="navelem"><a class="el" href="classicu_1_1CollatorFactory.html">CollatorFactory</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">icu::CollatorFactory Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>A factory, used with registerFactory, the creates multiple collators and provides display names for them.
<a href="classicu_1_1CollatorFactory.html#details">More...</a></p>
<p><code>#include <<a class="el" href="coll_8h_source.html">coll.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for icu::CollatorFactory:</div>
<div class="dyncontent">
<div class="center">
<img src="classicu_1_1CollatorFactory.png" usemap="#icu::CollatorFactory_map" alt=""/>
<map id="icu::CollatorFactory_map" name="icu::CollatorFactory_map">
<area href="classicu_1_1UObject.html" title="UObject is the common ICU "boilerplate" class." alt="icu::UObject" shape="rect" coords="0,56,123,80"/>
<area href="classicu_1_1UMemory.html" title="UMemory is the common ICU base class." alt="icu::UMemory" shape="rect" coords="0,0,123,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:ad634b34dd25149343466b88a9e0ce906"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1CollatorFactory.html#ad634b34dd25149343466b88a9e0ce906">~CollatorFactory</a> ()</td></tr>
<tr class="memdesc:ad634b34dd25149343466b88a9e0ce906"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="classicu_1_1CollatorFactory.html#ad634b34dd25149343466b88a9e0ce906">More...</a><br /></td></tr>
<tr class="separator:ad634b34dd25149343466b88a9e0ce906"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a86d6d6f87c07389f733f51aae790c4b4"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1CollatorFactory.html#a86d6d6f87c07389f733f51aae790c4b4">visible</a> () const</td></tr>
<tr class="memdesc:a86d6d6f87c07389f733f51aae790c4b4"><td class="mdescLeft"> </td><td class="mdescRight">Return true if this factory is visible. <a href="classicu_1_1CollatorFactory.html#a86d6d6f87c07389f733f51aae790c4b4">More...</a><br /></td></tr>
<tr class="separator:a86d6d6f87c07389f733f51aae790c4b4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaa21bcfd7d54876625d76c1ddd8d5d7f"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classicu_1_1Collator.html">Collator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1CollatorFactory.html#aaa21bcfd7d54876625d76c1ddd8d5d7f">createCollator</a> (const <a class="el" href="classicu_1_1Locale.html">Locale</a> &loc)=0</td></tr>
<tr class="memdesc:aaa21bcfd7d54876625d76c1ddd8d5d7f"><td class="mdescLeft"> </td><td class="mdescRight">Return a collator for the provided locale. <a href="classicu_1_1CollatorFactory.html#aaa21bcfd7d54876625d76c1ddd8d5d7f">More...</a><br /></td></tr>
<tr class="separator:aaa21bcfd7d54876625d76c1ddd8d5d7f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a750d6def7464a6f6c33989e8ec374363"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1CollatorFactory.html#a750d6def7464a6f6c33989e8ec374363">getDisplayName</a> (const <a class="el" href="classicu_1_1Locale.html">Locale</a> &objectLocale, const <a class="el" href="classicu_1_1Locale.html">Locale</a> &displayLocale, <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &result)</td></tr>
<tr class="memdesc:a750d6def7464a6f6c33989e8ec374363"><td class="mdescLeft"> </td><td class="mdescRight">Return the name of the collator for the objectLocale, localized for the displayLocale. <a href="classicu_1_1CollatorFactory.html#a750d6def7464a6f6c33989e8ec374363">More...</a><br /></td></tr>
<tr class="separator:a750d6def7464a6f6c33989e8ec374363"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a70872255141400306a4783b54f99a014"><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1CollatorFactory.html#a70872255141400306a4783b54f99a014">getSupportedIDs</a> (int32_t &count, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)=0</td></tr>
<tr class="memdesc:a70872255141400306a4783b54f99a014"><td class="mdescLeft"> </td><td class="mdescRight">Return an array of all the locale names directly supported by this factory. <a href="classicu_1_1CollatorFactory.html#a70872255141400306a4783b54f99a014">More...</a><br /></td></tr>
<tr class="separator:a70872255141400306a4783b54f99a014"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classicu_1_1UObject"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classicu_1_1UObject')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classicu_1_1UObject.html">icu::UObject</a></td></tr>
<tr class="memitem:af10026497704f510d3d1f2eff50acb18 inherit pub_methods_classicu_1_1UObject"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1UObject.html#af10026497704f510d3d1f2eff50acb18">~UObject</a> ()</td></tr>
<tr class="memdesc:af10026497704f510d3d1f2eff50acb18 inherit pub_methods_classicu_1_1UObject"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="classicu_1_1UObject.html#af10026497704f510d3d1f2eff50acb18">More...</a><br /></td></tr>
<tr class="separator:af10026497704f510d3d1f2eff50acb18 inherit pub_methods_classicu_1_1UObject"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aca1169c4978c52ce2b76eda104e9a214 inherit pub_methods_classicu_1_1UObject"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="uobject_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1UObject.html#aca1169c4978c52ce2b76eda104e9a214">getDynamicClassID</a> () const</td></tr>
<tr class="memdesc:aca1169c4978c52ce2b76eda104e9a214 inherit pub_methods_classicu_1_1UObject"><td class="mdescLeft"> </td><td class="mdescRight">ICU4C "poor man's RTTI", returns a UClassID for the actual ICU class. <a href="classicu_1_1UObject.html#aca1169c4978c52ce2b76eda104e9a214">More...</a><br /></td></tr>
<tr class="separator:aca1169c4978c52ce2b76eda104e9a214 inherit pub_methods_classicu_1_1UObject"><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 factory, used with registerFactory, the creates multiple collators and provides display names for them. </p>
<p>A factory supports some number of locales– these are the locales for which it can create collators. The factory can be visible, in which case the supported locales will be enumerated by getAvailableLocales, or invisible, in which they are not. Invisible locales are still supported, they are just not listed by getAvailableLocales. </p>
<p>If standard locale display names are sufficient, <a class="el" href="classicu_1_1Collator.html" title="The Collator class performs locale-sensitive string comparison.">Collator</a> instances can be registered using registerInstance instead.</p>
<p>Note: if the collators are to be used from C APIs, they must be instances of <a class="el" href="classicu_1_1RuleBasedCollator.html" title="The RuleBasedCollator class provides the implementation of Collator, using data-driven tables.">RuleBasedCollator</a>.</p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003733">Stable:</a></b></dt><dd>ICU 2.6 </dd></dl>
<p class="definition">Definition at line <a class="el" href="coll_8h_source.html#l01325">1325</a> of file <a class="el" href="coll_8h_source.html">coll.h</a>.</p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="ad634b34dd25149343466b88a9e0ce906"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad634b34dd25149343466b88a9e0ce906">◆ </a></span>~CollatorFactory()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual icu::CollatorFactory::~CollatorFactory </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003779">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aaa21bcfd7d54876625d76c1ddd8d5d7f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaa21bcfd7d54876625d76c1ddd8d5d7f">◆ </a></span>createCollator()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classicu_1_1Collator.html">Collator</a>* icu::CollatorFactory::createCollator </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classicu_1_1Locale.html">Locale</a> & </td>
<td class="paramname"><em>loc</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return a collator for the provided locale. </p>
<p>If the locale is not supported, return nullptr. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">loc</td><td>the locale identifying the collator to be created. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a new collator if the locale is supported, otherwise nullptr. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003781">Stable:</a></b></dt><dd>ICU 2.6 </dd></dl>
</div>
</div>
<a id="a750d6def7464a6f6c33989e8ec374363"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a750d6def7464a6f6c33989e8ec374363">◆ </a></span>getDisplayName()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a>& icu::CollatorFactory::getDisplayName </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classicu_1_1Locale.html">Locale</a> & </td>
<td class="paramname"><em>objectLocale</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classicu_1_1Locale.html">Locale</a> & </td>
<td class="paramname"><em>displayLocale</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"><em>result</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the name of the collator for the objectLocale, localized for the displayLocale. </p>
<p>If objectLocale is not supported, or the factory is not visible, set the result string to bogus. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">objectLocale</td><td>the locale identifying the collator </td></tr>
<tr><td class="paramname">displayLocale</td><td>the locale for which the display name of the collator should be localized </td></tr>
<tr><td class="paramname">result</td><td>an output parameter for the display name, set to bogus if not supported. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the display name </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003782">Stable:</a></b></dt><dd>ICU 2.6 </dd></dl>
</div>
</div>
<a id="a70872255141400306a4783b54f99a014"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a70872255141400306a4783b54f99a014">◆ </a></span>getSupportedIDs()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a>* icu::CollatorFactory::getSupportedIDs </td>
<td>(</td>
<td class="paramtype">int32_t & </td>
<td class="paramname"><em>count</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return an array of all the locale names directly supported by this factory. </p>
<p>The number of names is returned in count. This array is owned by the factory. Its contents must never change. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">count</td><td>output parameter for the number of locales supported by the factory </td></tr>
<tr><td class="paramname">status</td><td>the in/out error code </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a pointer to an array of count UnicodeStrings. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003783">Stable:</a></b></dt><dd>ICU 2.6 </dd></dl>
</div>
</div>
<a id="a86d6d6f87c07389f733f51aae790c4b4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a86d6d6f87c07389f733f51aae790c4b4">◆ </a></span>visible()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> icu::CollatorFactory::visible </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">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return true if this factory is visible. </p>
<p>Default is true. If not visible, the locales supported by this factory will not be listed by getAvailableLocales. </p><dl class="section return"><dt>Returns</dt><dd>true if the factory is visible. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003780">Stable:</a></b></dt><dd>ICU 2.6 </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>i18n/unicode/<a class="el" href="coll_8h_source.html">coll.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>