-
Notifications
You must be signed in to change notification settings - Fork 38
/
Copy pathclassAlphabeticIndex.html
1383 lines (1284 loc) · 95.7 KB
/
classAlphabeticIndex.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
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ICU 76.1: icu::AlphabeticIndex 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 id="projectrow">
<td id="projectalign">
<div id="projectname">ICU 76.1<span id="projectnumber"> 76.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</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_1AlphabeticIndex.html">AlphabeticIndex</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle"><div class="title">icu::AlphabeticIndex Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="classicu_1_1AlphabeticIndex.html" title="AlphabeticIndex supports the creation of a UI index appropriate for a given language.">AlphabeticIndex</a> supports the creation of a UI index appropriate for a given language.
<a href="classicu_1_1AlphabeticIndex.html#details">More...</a></p>
<p><code>#include <<a class="el" href="alphaindex_8h_source.html">alphaindex.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for icu::AlphabeticIndex:</div>
<div class="dyncontent">
<div class="center">
<img src="classicu_1_1AlphabeticIndex.png" usemap="#icu::AlphabeticIndex_map" alt=""/>
<map id="icu::AlphabeticIndex_map" name="icu::AlphabeticIndex_map">
<area href="classicu_1_1UObject.html" title="UObject is the common ICU "boilerplate" class." alt="icu::UObject" shape="rect" coords="0,56,125,80"/>
<area href="classicu_1_1UMemory.html" title="UMemory is the common ICU base class." alt="icu::UMemory" shape="rect" coords="0,0,125,24"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1AlphabeticIndex_1_1Bucket.html">Bucket</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">An index "bucket" with a label string and type. <a href="classicu_1_1AlphabeticIndex_1_1Bucket.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1AlphabeticIndex_1_1ImmutableIndex.html">ImmutableIndex</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Immutable, thread-safe version of <a class="el" href="classicu_1_1AlphabeticIndex.html" title="AlphabeticIndex supports the creation of a UI index appropriate for a given language.">AlphabeticIndex</a>. <a href="classicu_1_1AlphabeticIndex_1_1ImmutableIndex.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a803432b44141fc56a51739570bf259fc" id="r_a803432b44141fc56a51739570bf259fc"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1AlphabeticIndex.html#a803432b44141fc56a51739570bf259fc">AlphabeticIndex</a> (<a class="el" href="classicu_1_1LocalPointerBase.html">const</a> <a class="el" href="classicu_1_1Locale.html">Locale</a> &locale, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &<a class="el" href="classicu_1_1LocalPointerBase.html">status</a>)</td></tr>
<tr class="memdesc:a803432b44141fc56a51739570bf259fc"><td class="mdescLeft"> </td><td class="mdescRight">Construct an <a class="el" href="classicu_1_1AlphabeticIndex.html" title="AlphabeticIndex supports the creation of a UI index appropriate for a given language.">AlphabeticIndex</a> object for the specified locale. <br /></td></tr>
<tr class="separator:a803432b44141fc56a51739570bf259fc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2af8a73527a5ca7d320b258b0dcd299c" id="r_a2af8a73527a5ca7d320b258b0dcd299c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1AlphabeticIndex.html#a2af8a73527a5ca7d320b258b0dcd299c">AlphabeticIndex</a> (<a class="el" href="classicu_1_1RuleBasedCollator.html">RuleBasedCollator</a> *collator, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &<a class="el" href="classicu_1_1LocalPointerBase.html">status</a>)</td></tr>
<tr class="memdesc:a2af8a73527a5ca7d320b258b0dcd299c"><td class="mdescLeft"> </td><td class="mdescRight">Construct an <a class="el" href="classicu_1_1AlphabeticIndex.html" title="AlphabeticIndex supports the creation of a UI index appropriate for a given language.">AlphabeticIndex</a> that uses a specific collator. <br /></td></tr>
<tr class="separator:a2af8a73527a5ca7d320b258b0dcd299c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1ee642894d40ee57c84e91f8df8b20ef" id="r_a1ee642894d40ee57c84e91f8df8b20ef"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1LocalPointerBase.html">virtual</a> <a class="el" href="classicu_1_1AlphabeticIndex.html">AlphabeticIndex</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1AlphabeticIndex.html#a1ee642894d40ee57c84e91f8df8b20ef">addLabels</a> (<a class="el" href="classicu_1_1LocalPointerBase.html">const</a> <a class="el" href="classicu_1_1UnicodeSet.html">UnicodeSet</a> &<a class="el" href="classicu_1_1LocalPointerBase.html">additions</a>, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &<a class="el" href="classicu_1_1LocalPointerBase.html">status</a>)</td></tr>
<tr class="memdesc:a1ee642894d40ee57c84e91f8df8b20ef"><td class="mdescLeft"> </td><td class="mdescRight">Add Labels to this Index. <br /></td></tr>
<tr class="separator:a1ee642894d40ee57c84e91f8df8b20ef"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab084e3fbc3bbccc6eaf58903af5f3188" id="r_ab084e3fbc3bbccc6eaf58903af5f3188"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1LocalPointerBase.html">virtual</a> <a class="el" href="classicu_1_1AlphabeticIndex.html">AlphabeticIndex</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1AlphabeticIndex.html#ab084e3fbc3bbccc6eaf58903af5f3188">addLabels</a> (<a class="el" href="classicu_1_1LocalPointerBase.html">const</a> <a class="el" href="classicu_1_1Locale.html">Locale</a> &locale, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &<a class="el" href="classicu_1_1LocalPointerBase.html">status</a>)</td></tr>
<tr class="memdesc:ab084e3fbc3bbccc6eaf58903af5f3188"><td class="mdescLeft"> </td><td class="mdescRight">Add the index characters from a <a class="el" href="classicu_1_1Locale.html" title="A Locale object represents a specific geographical, political, or cultural region.">Locale</a> to the index. <br /></td></tr>
<tr class="separator:ab084e3fbc3bbccc6eaf58903af5f3188"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a32244f2579e2b0f0061d9d2d0a4a0323" id="r_a32244f2579e2b0f0061d9d2d0a4a0323"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1LocalPointerBase.html">virtual</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1AlphabeticIndex.html#a32244f2579e2b0f0061d9d2d0a4a0323">~AlphabeticIndex</a> ()</td></tr>
<tr class="memdesc:a32244f2579e2b0f0061d9d2d0a4a0323"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:a32244f2579e2b0f0061d9d2d0a4a0323"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a869d3fd2c47e3197257ea56be7a8549c" id="r_a869d3fd2c47e3197257ea56be7a8549c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1AlphabeticIndex_1_1ImmutableIndex.html">ImmutableIndex</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1AlphabeticIndex.html#a869d3fd2c47e3197257ea56be7a8549c">buildImmutableIndex</a> (<a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &errorCode)</td></tr>
<tr class="memdesc:a869d3fd2c47e3197257ea56be7a8549c"><td class="mdescLeft"> </td><td class="mdescRight">Builds an immutable, thread-safe version of this instance, without data records. <br /></td></tr>
<tr class="separator:a869d3fd2c47e3197257ea56be7a8549c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a17ff93b36d701a8da0cfadf0fde0f489" id="r_a17ff93b36d701a8da0cfadf0fde0f489"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1LocalPointerBase.html">virtual</a> <a class="el" href="classicu_1_1LocalPointerBase.html">const</a> <a class="el" href="classicu_1_1RuleBasedCollator.html">RuleBasedCollator</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1AlphabeticIndex.html#a17ff93b36d701a8da0cfadf0fde0f489">getCollator</a> () <a class="el" href="classicu_1_1LocalPointerBase.html">const</a></td></tr>
<tr class="memdesc:a17ff93b36d701a8da0cfadf0fde0f489"><td class="mdescLeft"> </td><td class="mdescRight">Get the <a class="el" href="classicu_1_1Collator.html" title="The Collator class performs locale-sensitive string comparison.">Collator</a> that establishes the ordering of the items in this index. <br /></td></tr>
<tr class="separator:a17ff93b36d701a8da0cfadf0fde0f489"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6db8ebc8094f43505bd41312d12359e6" id="r_a6db8ebc8094f43505bd41312d12359e6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1LocalPointerBase.html">virtual</a> <a class="el" href="classicu_1_1LocalPointerBase.html">const</a> <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1AlphabeticIndex.html#a6db8ebc8094f43505bd41312d12359e6">getInflowLabel</a> () <a class="el" href="classicu_1_1LocalPointerBase.html">const</a></td></tr>
<tr class="memdesc:a6db8ebc8094f43505bd41312d12359e6"><td class="mdescLeft"> </td><td class="mdescRight">Get the default label used for abbreviated buckets <em>between</em> other index characters. <br /></td></tr>
<tr class="separator:a6db8ebc8094f43505bd41312d12359e6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a90c27ce1e2620ce62ee32daa68c46090" id="r_a90c27ce1e2620ce62ee32daa68c46090"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1LocalPointerBase.html">virtual</a> <a class="el" href="classicu_1_1AlphabeticIndex.html">AlphabeticIndex</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1AlphabeticIndex.html#a90c27ce1e2620ce62ee32daa68c46090">setInflowLabel</a> (<a class="el" href="classicu_1_1LocalPointerBase.html">const</a> <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &<a class="el" href="classicu_1_1LocalPointerBase.html">inflowLabel</a>, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &<a class="el" href="classicu_1_1LocalPointerBase.html">status</a>)</td></tr>
<tr class="memdesc:a90c27ce1e2620ce62ee32daa68c46090"><td class="mdescLeft"> </td><td class="mdescRight">Set the default label used for abbreviated buckets <em>between</em> other index characters. <br /></td></tr>
<tr class="separator:a90c27ce1e2620ce62ee32daa68c46090"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab61215544c693712aae915d1617ea136" id="r_ab61215544c693712aae915d1617ea136"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1LocalPointerBase.html">virtual</a> <a class="el" href="classicu_1_1LocalPointerBase.html">const</a> <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1AlphabeticIndex.html#ab61215544c693712aae915d1617ea136">getOverflowLabel</a> () <a class="el" href="classicu_1_1LocalPointerBase.html">const</a></td></tr>
<tr class="memdesc:ab61215544c693712aae915d1617ea136"><td class="mdescLeft"> </td><td class="mdescRight">Get the special label used for items that sort after the last normal label, and that would not otherwise have an appropriate label. <br /></td></tr>
<tr class="separator:ab61215544c693712aae915d1617ea136"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0b6afba947bebf96c19a4d2adc3d73cb" id="r_a0b6afba947bebf96c19a4d2adc3d73cb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1LocalPointerBase.html">virtual</a> <a class="el" href="classicu_1_1AlphabeticIndex.html">AlphabeticIndex</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1AlphabeticIndex.html#a0b6afba947bebf96c19a4d2adc3d73cb">setOverflowLabel</a> (<a class="el" href="classicu_1_1LocalPointerBase.html">const</a> <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &<a class="el" href="classicu_1_1LocalPointerBase.html">overflowLabel</a>, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &<a class="el" href="classicu_1_1LocalPointerBase.html">status</a>)</td></tr>
<tr class="memdesc:a0b6afba947bebf96c19a4d2adc3d73cb"><td class="mdescLeft"> </td><td class="mdescRight">Set the label used for items that sort after the last normal label, and that would not otherwise have an appropriate label. <br /></td></tr>
<tr class="separator:a0b6afba947bebf96c19a4d2adc3d73cb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5e5e9c580c3b1c101027473d04ebac45" id="r_a5e5e9c580c3b1c101027473d04ebac45"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1LocalPointerBase.html">virtual</a> <a class="el" href="classicu_1_1LocalPointerBase.html">const</a> <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1AlphabeticIndex.html#a5e5e9c580c3b1c101027473d04ebac45">getUnderflowLabel</a> () <a class="el" href="classicu_1_1LocalPointerBase.html">const</a></td></tr>
<tr class="memdesc:a5e5e9c580c3b1c101027473d04ebac45"><td class="mdescLeft"> </td><td class="mdescRight">Get the special label used for items that sort before the first normal label, and that would not otherwise have an appropriate label. <br /></td></tr>
<tr class="separator:a5e5e9c580c3b1c101027473d04ebac45"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adf124aee01a1168c753638ee17742127" id="r_adf124aee01a1168c753638ee17742127"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1LocalPointerBase.html">virtual</a> <a class="el" href="classicu_1_1AlphabeticIndex.html">AlphabeticIndex</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1AlphabeticIndex.html#adf124aee01a1168c753638ee17742127">setUnderflowLabel</a> (<a class="el" href="classicu_1_1LocalPointerBase.html">const</a> <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &<a class="el" href="classicu_1_1LocalPointerBase.html">underflowLabel</a>, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &<a class="el" href="classicu_1_1LocalPointerBase.html">status</a>)</td></tr>
<tr class="memdesc:adf124aee01a1168c753638ee17742127"><td class="mdescLeft"> </td><td class="mdescRight">Set the label used for items that sort before the first normal label, and that would not otherwise have an appropriate label. <br /></td></tr>
<tr class="separator:adf124aee01a1168c753638ee17742127"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aff2a5c09badb0e65cd6a6cba233b23bc" id="r_aff2a5c09badb0e65cd6a6cba233b23bc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1LocalPointerBase.html">virtual</a> <a class="el" href="classicu_1_1LocalPointerBase.html">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1AlphabeticIndex.html#aff2a5c09badb0e65cd6a6cba233b23bc">getMaxLabelCount</a> () <a class="el" href="classicu_1_1LocalPointerBase.html">const</a></td></tr>
<tr class="memdesc:aff2a5c09badb0e65cd6a6cba233b23bc"><td class="mdescLeft"> </td><td class="mdescRight">Get the limit on the number of labels permitted in the index. <br /></td></tr>
<tr class="separator:aff2a5c09badb0e65cd6a6cba233b23bc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9b16105796f7996a5eb9b04a39d1b0f3" id="r_a9b16105796f7996a5eb9b04a39d1b0f3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1LocalPointerBase.html">virtual</a> <a class="el" href="classicu_1_1AlphabeticIndex.html">AlphabeticIndex</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1AlphabeticIndex.html#a9b16105796f7996a5eb9b04a39d1b0f3">setMaxLabelCount</a> (<a class="el" href="classicu_1_1LocalPointerBase.html">int32_t</a> <a class="el" href="classicu_1_1LocalPointerBase.html">maxLabelCount</a>, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &<a class="el" href="classicu_1_1LocalPointerBase.html">status</a>)</td></tr>
<tr class="memdesc:a9b16105796f7996a5eb9b04a39d1b0f3"><td class="mdescLeft"> </td><td class="mdescRight">Set a limit on the number of labels permitted in the index. <br /></td></tr>
<tr class="separator:a9b16105796f7996a5eb9b04a39d1b0f3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a57d68dd57ee114b7eaa4bd0ba1a25f9d" id="r_a57d68dd57ee114b7eaa4bd0ba1a25f9d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1LocalPointerBase.html">virtual</a> <a class="el" href="classicu_1_1AlphabeticIndex.html">AlphabeticIndex</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1AlphabeticIndex.html#a57d68dd57ee114b7eaa4bd0ba1a25f9d">addRecord</a> (<a class="el" href="classicu_1_1LocalPointerBase.html">const</a> <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &name, <a class="el" href="classicu_1_1LocalPointerBase.html">const</a> <a class="el" href="classicu_1_1LocalPointerBase.html">void</a> *data, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &<a class="el" href="classicu_1_1LocalPointerBase.html">status</a>)</td></tr>
<tr class="memdesc:a57d68dd57ee114b7eaa4bd0ba1a25f9d"><td class="mdescLeft"> </td><td class="mdescRight">Add a record to the index. <br /></td></tr>
<tr class="separator:a57d68dd57ee114b7eaa4bd0ba1a25f9d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a844f00cfc958ea965550379465c51647" id="r_a844f00cfc958ea965550379465c51647"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1LocalPointerBase.html">virtual</a> <a class="el" href="classicu_1_1AlphabeticIndex.html">AlphabeticIndex</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1AlphabeticIndex.html#a844f00cfc958ea965550379465c51647">clearRecords</a> (<a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &<a class="el" href="classicu_1_1LocalPointerBase.html">status</a>)</td></tr>
<tr class="memdesc:a844f00cfc958ea965550379465c51647"><td class="mdescLeft"> </td><td class="mdescRight">Remove all Records from the Index. <br /></td></tr>
<tr class="separator:a844f00cfc958ea965550379465c51647"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af0bb2d389a1051a3d8872063b06e8f49" id="r_af0bb2d389a1051a3d8872063b06e8f49"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1LocalPointerBase.html">virtual</a> <a class="el" href="classicu_1_1LocalPointerBase.html">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1AlphabeticIndex.html#af0bb2d389a1051a3d8872063b06e8f49">getBucketCount</a> (<a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &<a class="el" href="classicu_1_1LocalPointerBase.html">status</a>)</td></tr>
<tr class="memdesc:af0bb2d389a1051a3d8872063b06e8f49"><td class="mdescLeft"> </td><td class="mdescRight">Get the number of labels in this index. <br /></td></tr>
<tr class="separator:af0bb2d389a1051a3d8872063b06e8f49"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a30ac7565e8a1dacea468a6a05e1253db" id="r_a30ac7565e8a1dacea468a6a05e1253db"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1LocalPointerBase.html">virtual</a> <a class="el" href="classicu_1_1LocalPointerBase.html">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1AlphabeticIndex.html#a30ac7565e8a1dacea468a6a05e1253db">getRecordCount</a> (<a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &<a class="el" href="classicu_1_1LocalPointerBase.html">status</a>)</td></tr>
<tr class="memdesc:a30ac7565e8a1dacea468a6a05e1253db"><td class="mdescLeft"> </td><td class="mdescRight">Get the total number of Records in this index, that is, the number of <name, data> pairs added. <br /></td></tr>
<tr class="separator:a30ac7565e8a1dacea468a6a05e1253db"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9c1fc4ff54b7267c3fceafa0cf5f9f04" id="r_a9c1fc4ff54b7267c3fceafa0cf5f9f04"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1LocalPointerBase.html">virtual</a> <a class="el" href="classicu_1_1LocalPointerBase.html">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1AlphabeticIndex.html#a9c1fc4ff54b7267c3fceafa0cf5f9f04">getBucketIndex</a> (<a class="el" href="classicu_1_1LocalPointerBase.html">const</a> <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &<a class="el" href="classicu_1_1LocalPointerBase.html">itemName</a>, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &<a class="el" href="classicu_1_1LocalPointerBase.html">status</a>)</td></tr>
<tr class="memdesc:a9c1fc4ff54b7267c3fceafa0cf5f9f04"><td class="mdescLeft"> </td><td class="mdescRight">Given the name of a record, return the zero-based index of the <a class="el" href="classicu_1_1AlphabeticIndex_1_1Bucket.html" title="An index "bucket" with a label string and type.">Bucket</a> in which the item should appear. <br /></td></tr>
<tr class="separator:a9c1fc4ff54b7267c3fceafa0cf5f9f04"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aac626348bc56a95f560d654057175db1" id="r_aac626348bc56a95f560d654057175db1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1LocalPointerBase.html">virtual</a> <a class="el" href="classicu_1_1LocalPointerBase.html">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1AlphabeticIndex.html#aac626348bc56a95f560d654057175db1">getBucketIndex</a> () <a class="el" href="classicu_1_1LocalPointerBase.html">const</a></td></tr>
<tr class="memdesc:aac626348bc56a95f560d654057175db1"><td class="mdescLeft"> </td><td class="mdescRight">Get the zero based index of the current <a class="el" href="classicu_1_1AlphabeticIndex_1_1Bucket.html" title="An index "bucket" with a label string and type.">Bucket</a> from an iteration over the Buckets of this index. <br /></td></tr>
<tr class="separator:aac626348bc56a95f560d654057175db1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6e78dc3fc44d1649ecb81bb5627625dc" id="r_a6e78dc3fc44d1649ecb81bb5627625dc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1LocalPointerBase.html">virtual</a> <a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1AlphabeticIndex.html#a6e78dc3fc44d1649ecb81bb5627625dc">nextBucket</a> (<a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &<a class="el" href="classicu_1_1LocalPointerBase.html">status</a>)</td></tr>
<tr class="memdesc:a6e78dc3fc44d1649ecb81bb5627625dc"><td class="mdescLeft"> </td><td class="mdescRight">Advance the iteration over the Buckets of this index. <br /></td></tr>
<tr class="separator:a6e78dc3fc44d1649ecb81bb5627625dc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6ba9f08d7bef00306110253e940732c0" id="r_a6ba9f08d7bef00306110253e940732c0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1LocalPointerBase.html">virtual</a> <a class="el" href="classicu_1_1LocalPointerBase.html">const</a> <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1AlphabeticIndex.html#a6ba9f08d7bef00306110253e940732c0">getBucketLabel</a> () <a class="el" href="classicu_1_1LocalPointerBase.html">const</a></td></tr>
<tr class="memdesc:a6ba9f08d7bef00306110253e940732c0"><td class="mdescLeft"> </td><td class="mdescRight">Return the name of the Label of the current bucket from an iteration over the buckets. <br /></td></tr>
<tr class="separator:a6ba9f08d7bef00306110253e940732c0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af58c25fdb90decd8de2f2cd14dbee3b6" id="r_af58c25fdb90decd8de2f2cd14dbee3b6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1LocalPointerBase.html">virtual</a> <a class="el" href="alphaindex_8h.html#a969464092cba264934f2c66c7c621dc8">UAlphabeticIndexLabelType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1AlphabeticIndex.html#af58c25fdb90decd8de2f2cd14dbee3b6">getBucketLabelType</a> () <a class="el" href="classicu_1_1LocalPointerBase.html">const</a></td></tr>
<tr class="memdesc:af58c25fdb90decd8de2f2cd14dbee3b6"><td class="mdescLeft"> </td><td class="mdescRight">Return the type of the label for the current <a class="el" href="classicu_1_1AlphabeticIndex_1_1Bucket.html" title="An index "bucket" with a label string and type.">Bucket</a> (selected by the iteration over Buckets.) <br /></td></tr>
<tr class="separator:af58c25fdb90decd8de2f2cd14dbee3b6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aebfae2c51f0a3645dd479df4eccca21d" id="r_aebfae2c51f0a3645dd479df4eccca21d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1LocalPointerBase.html">virtual</a> <a class="el" href="classicu_1_1LocalPointerBase.html">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1AlphabeticIndex.html#aebfae2c51f0a3645dd479df4eccca21d">getBucketRecordCount</a> () <a class="el" href="classicu_1_1LocalPointerBase.html">const</a></td></tr>
<tr class="memdesc:aebfae2c51f0a3645dd479df4eccca21d"><td class="mdescLeft"> </td><td class="mdescRight">Get the number of <name, data> Records in the current <a class="el" href="classicu_1_1AlphabeticIndex_1_1Bucket.html" title="An index "bucket" with a label string and type.">Bucket</a>. <br /></td></tr>
<tr class="separator:aebfae2c51f0a3645dd479df4eccca21d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac1e3ec297e73b7865e8ac15a36667c96" id="r_ac1e3ec297e73b7865e8ac15a36667c96"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1LocalPointerBase.html">virtual</a> <a class="el" href="classicu_1_1AlphabeticIndex.html">AlphabeticIndex</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1AlphabeticIndex.html#ac1e3ec297e73b7865e8ac15a36667c96">resetBucketIterator</a> (<a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &<a class="el" href="classicu_1_1LocalPointerBase.html">status</a>)</td></tr>
<tr class="memdesc:ac1e3ec297e73b7865e8ac15a36667c96"><td class="mdescLeft"> </td><td class="mdescRight">Reset the <a class="el" href="classicu_1_1AlphabeticIndex_1_1Bucket.html" title="An index "bucket" with a label string and type.">Bucket</a> iteration for this index. <br /></td></tr>
<tr class="separator:ac1e3ec297e73b7865e8ac15a36667c96"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1371ce575d6804778e6c5a6499465a46" id="r_a1371ce575d6804778e6c5a6499465a46"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1LocalPointerBase.html">virtual</a> <a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1AlphabeticIndex.html#a1371ce575d6804778e6c5a6499465a46">nextRecord</a> (<a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &<a class="el" href="classicu_1_1LocalPointerBase.html">status</a>)</td></tr>
<tr class="memdesc:a1371ce575d6804778e6c5a6499465a46"><td class="mdescLeft"> </td><td class="mdescRight">Advance to the next record in the current <a class="el" href="classicu_1_1AlphabeticIndex_1_1Bucket.html" title="An index "bucket" with a label string and type.">Bucket</a>. <br /></td></tr>
<tr class="separator:a1371ce575d6804778e6c5a6499465a46"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6c182ca06b204660f9994b55b27b8c7e" id="r_a6c182ca06b204660f9994b55b27b8c7e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1LocalPointerBase.html">virtual</a> <a class="el" href="classicu_1_1LocalPointerBase.html">const</a> <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1AlphabeticIndex.html#a6c182ca06b204660f9994b55b27b8c7e">getRecordName</a> () <a class="el" href="classicu_1_1LocalPointerBase.html">const</a></td></tr>
<tr class="memdesc:a6c182ca06b204660f9994b55b27b8c7e"><td class="mdescLeft"> </td><td class="mdescRight">Get the name of the current Record. <br /></td></tr>
<tr class="separator:a6c182ca06b204660f9994b55b27b8c7e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a11188d4d0e9aa385a0e8ff9cf048f47e" id="r_a11188d4d0e9aa385a0e8ff9cf048f47e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1LocalPointerBase.html">virtual</a> <a class="el" href="classicu_1_1LocalPointerBase.html">const</a> <a class="el" href="classicu_1_1LocalPointerBase.html">void</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1AlphabeticIndex.html#a11188d4d0e9aa385a0e8ff9cf048f47e">getRecordData</a> () <a class="el" href="classicu_1_1LocalPointerBase.html">const</a></td></tr>
<tr class="memdesc:a11188d4d0e9aa385a0e8ff9cf048f47e"><td class="mdescLeft"> </td><td class="mdescRight">Return the data pointer of the Record currently being iterated over. <br /></td></tr>
<tr class="separator:a11188d4d0e9aa385a0e8ff9cf048f47e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a65818ff5316863c2af2f5275a8dc5d35" id="r_a65818ff5316863c2af2f5275a8dc5d35"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1LocalPointerBase.html">virtual</a> <a class="el" href="classicu_1_1AlphabeticIndex.html">AlphabeticIndex</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1AlphabeticIndex.html#a65818ff5316863c2af2f5275a8dc5d35">resetRecordIterator</a> ()</td></tr>
<tr class="memdesc:a65818ff5316863c2af2f5275a8dc5d35"><td class="mdescLeft"> </td><td class="mdescRight">Reset the Record iterator position to before the first Record in the current <a class="el" href="classicu_1_1AlphabeticIndex_1_1Bucket.html" title="An index "bucket" with a label string and type.">Bucket</a>. <br /></td></tr>
<tr class="separator:a65818ff5316863c2af2f5275a8dc5d35"><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" id="r_af10026497704f510d3d1f2eff50acb18"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1LocalPointerBase.html">virtual</a> </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. <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" id="r_aca1169c4978c52ce2b76eda104e9a214"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1LocalPointerBase.html">virtual</a> <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> () <a class="el" href="classicu_1_1LocalPointerBase.html">const</a></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. <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 class="el" href="classicu_1_1AlphabeticIndex.html" title="AlphabeticIndex supports the creation of a UI index appropriate for a given language.">AlphabeticIndex</a> supports the creation of a UI index appropriate for a given language. </p>
<p>It can support either direct use, or use with a client that doesn't support localized collation. The following is an example of what an index might look like in a UI:</p>
<pre>
<b>... A B C D E F G H I J K L M N O P Q R S T U V W X Y Z ...</b>
<b>A</b>
Addison
Albertson
Azensky
<b>B</b>
Baker
...
</pre><p>The class can generate a list of labels for use as a UI "index", that is, a list of clickable characters (or character sequences) that allow the user to see a segment (bucket) of a larger "target" list. That is, each label corresponds to a bucket in the target list, where everything in the bucket is greater than or equal to the character (according to the locale's collation). Strings can be added to the index; they will be in sorted order in the right bucket. </p>
<p>The class also supports having buckets for strings before the first (underflow), after the last (overflow), and between scripts (inflow). For example, if the index is constructed with labels for Russian and English, Greek characters would fall into an inflow bucket between the other two scripts. </p>
<p>The <a class="el" href="classicu_1_1AlphabeticIndex.html" title="AlphabeticIndex supports the creation of a UI index appropriate for a given language.">AlphabeticIndex</a> class is not intended for public subclassing.</p>
<p><em>Note:</em> If you expect to have a lot of ASCII or Latin characters as well as characters from the user's language, then it is a good idea to call addLabels(Locale::getEnglish(), status).</p>
<h2>Direct Use</h2>
<p>The following shows an example of building an index directly. The "show..." methods below are just to illustrate usage.</p>
<pre>
// Create a simple index. "Item" is assumed to be an application
// defined type that the application's UI and other processing knows about,
// and that has a name.
UErrorCode status = U_ZERO_ERROR;
<a class="el" href="classicu_1_1AlphabeticIndex.html" title="AlphabeticIndex supports the creation of a UI index appropriate for a given language.">AlphabeticIndex</a> index = new AlphabeticIndex(desiredLocale, status);
index->addLabels(additionalLocale, status);
for (Item *item in some source of Items ) {
index->addRecord(item->name(), item, status);
}
...
// Show index at top. We could skip or gray out empty buckets
while (index->nextBucket(status)) {
if (showAll || index-><a class="el" href="classicu_1_1AlphabeticIndex.html#aebfae2c51f0a3645dd479df4eccca21d" title="Get the number of <name, data> Records in the current Bucket.">getBucketRecordCount()</a> != 0) {
showLabelAtTop(UI, index-><a class="el" href="classicu_1_1AlphabeticIndex.html#a6ba9f08d7bef00306110253e940732c0" title="Return the name of the Label of the current bucket from an iteration over the buckets.">getBucketLabel()</a>);
}
}
...
// Show the buckets with their contents, skipping empty buckets
index->resetBucketIterator(status);
while (index->nextBucket(status)) {
if (index-><a class="el" href="classicu_1_1AlphabeticIndex.html#aebfae2c51f0a3645dd479df4eccca21d" title="Get the number of <name, data> Records in the current Bucket.">getBucketRecordCount()</a> != 0) {
showLabelInList(UI, index-><a class="el" href="classicu_1_1AlphabeticIndex.html#a6ba9f08d7bef00306110253e940732c0" title="Return the name of the Label of the current bucket from an iteration over the buckets.">getBucketLabel()</a>);
while (index->nextRecord(status)) {
showIndexedItem(UI, static_cast<Item *>(index-><a class="el" href="classicu_1_1AlphabeticIndex.html#a11188d4d0e9aa385a0e8ff9cf048f47e" title="Return the data pointer of the Record currently being iterated over.">getRecordData()</a>))
</pre><p>The caller can build different UIs using this class. For example, an index character could be omitted or grayed-out if its bucket is empty. Small buckets could also be combined based on size, such as:</p>
<pre>
<b>... A-F G-N O-Z ...</b>
</pre><h2>Client Support</h2>
<p>Callers can also use the <a class="el" href="classicu_1_1AlphabeticIndex_1_1ImmutableIndex.html" title="Immutable, thread-safe version of AlphabeticIndex.">AlphabeticIndex::ImmutableIndex</a>, or the <a class="el" href="classicu_1_1AlphabeticIndex.html" title="AlphabeticIndex supports the creation of a UI index appropriate for a given language.">AlphabeticIndex</a> itself, to support sorting on a client that doesn't support <a class="el" href="classicu_1_1AlphabeticIndex.html" title="AlphabeticIndex supports the creation of a UI index appropriate for a given language.">AlphabeticIndex</a> functionality.</p>
<p>The <a class="el" href="classicu_1_1AlphabeticIndex_1_1ImmutableIndex.html" title="Immutable, thread-safe version of AlphabeticIndex.">ImmutableIndex</a> is both immutable and thread-safe. The corresponding <a class="el" href="classicu_1_1AlphabeticIndex.html" title="AlphabeticIndex supports the creation of a UI index appropriate for a given language.">AlphabeticIndex</a> methods are not thread-safe because they "lazily" build the index buckets. </p><ul>
<li>
ImmutableIndex.getBucket(index) provides random access to all buckets and their labels and label types. </li>
<li>
The <a class="el" href="classicu_1_1AlphabeticIndex.html" title="AlphabeticIndex supports the creation of a UI index appropriate for a given language.">AlphabeticIndex</a> bucket iterator or <a class="el" href="classicu_1_1AlphabeticIndex_1_1ImmutableIndex.html#a6877e928195ded74638b258562676259" title="Returns the index-th bucket.">ImmutableIndex.getBucket</a>(0..getBucketCount-1) can be used to get a list of the labels, such as "...", "A", "B",..., and send that list to the client. </li>
<li>
<p class="startli">When the client has a new name, it sends that name to the server. The server needs to call the following methods, and communicate the bucketIndex and collationKey back to the client.</p>
<pre>
int32_t bucketIndex = index.getBucketIndex(name, status);
const <a class="el" href="classicu_1_1UnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides similar function...">UnicodeString</a> &label = immutableIndex.getBucket(bucketIndex)->getLabel(); // optional
int32_t skLength = collator.getSortKey(name, sk, skCapacity);
</pre><p class="endli"></p>
</li>
<li>
The client would put the name (and associated information) into its bucket for bucketIndex. The sort key sk is a sequence of bytes that can be compared with a binary compare, and produce the right localized result. </li>
</ul>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003557">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
<p class="definition">Definition at line <a class="el" href="alphaindex_8h_source.html#l00192">192</a> of file <a class="el" href="alphaindex_8h_source.html">alphaindex.h</a>.</p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a803432b44141fc56a51739570bf259fc" name="a803432b44141fc56a51739570bf259fc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a803432b44141fc56a51739570bf259fc">◆ </a></span>AlphabeticIndex() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">icu::AlphabeticIndex::AlphabeticIndex </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classicu_1_1LocalPointerBase.html">const</a> <a class="el" href="classicu_1_1Locale.html">Locale</a> & </td>
<td class="paramname"><em>locale</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>
</div><div class="memdoc">
<p>Construct an <a class="el" href="classicu_1_1AlphabeticIndex.html" title="AlphabeticIndex supports the creation of a UI index appropriate for a given language.">AlphabeticIndex</a> object for the specified locale. </p>
<p>If the locale's data does not include index characters, a set of them will be synthesized based on the locale's exemplar characters. The locale determines the sorting order for both the index characters and the user item names appearing under each Index character.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">locale</td><td>the desired locale. </td></tr>
<tr><td class="paramname">status</td><td>Error code, will be set with the reason if the construction of the <a class="el" href="classicu_1_1AlphabeticIndex.html" title="AlphabeticIndex supports the creation of a UI index appropriate for a given language.">AlphabeticIndex</a> object fails. </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003560">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
</div>
</div>
<a id="a2af8a73527a5ca7d320b258b0dcd299c" name="a2af8a73527a5ca7d320b258b0dcd299c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2af8a73527a5ca7d320b258b0dcd299c">◆ </a></span>AlphabeticIndex() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">icu::AlphabeticIndex::AlphabeticIndex </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classicu_1_1RuleBasedCollator.html">RuleBasedCollator</a> * </td>
<td class="paramname"><em>collator</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>
</div><div class="memdoc">
<p>Construct an <a class="el" href="classicu_1_1AlphabeticIndex.html" title="AlphabeticIndex supports the creation of a UI index appropriate for a given language.">AlphabeticIndex</a> that uses a specific collator. </p>
<p>The index will be created with no labels; the <a class="el" href="classicu_1_1AlphabeticIndex.html#a1ee642894d40ee57c84e91f8df8b20ef" title="Add Labels to this Index.">addLabels()</a> function must be called after creation to add the desired labels to the index.</p>
<p>The index adopts the collator, and is responsible for deleting it. The caller should make no further use of the collator after creating the index.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">collator</td><td>The collator to use to order the contents of this index. </td></tr>
<tr><td class="paramname">status</td><td>Error code, will be set with the reason if the operation fails. </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003561">Stable:</a></b></dt><dd>ICU 51 </dd></dl>
</div>
</div>
<a id="a32244f2579e2b0f0061d9d2d0a4a0323" name="a32244f2579e2b0f0061d9d2d0a4a0323"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a32244f2579e2b0f0061d9d2d0a4a0323">◆ </a></span>~AlphabeticIndex()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classicu_1_1LocalPointerBase.html">virtual</a> icu::AlphabeticIndex::~AlphabeticIndex </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#_stable003564">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ab084e3fbc3bbccc6eaf58903af5f3188" name="ab084e3fbc3bbccc6eaf58903af5f3188"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab084e3fbc3bbccc6eaf58903af5f3188">◆ </a></span>addLabels() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classicu_1_1LocalPointerBase.html">virtual</a> <a class="el" href="classicu_1_1AlphabeticIndex.html">AlphabeticIndex</a> & icu::AlphabeticIndex::addLabels </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classicu_1_1LocalPointerBase.html">const</a> <a class="el" href="classicu_1_1Locale.html">Locale</a> & </td>
<td class="paramname"><em>locale</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">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Add the index characters from a <a class="el" href="classicu_1_1Locale.html" title="A Locale object represents a specific geographical, political, or cultural region.">Locale</a> to the index. </p>
<p>The labels are added to those that are already in the index; they do not replace the existing index characters. The collation order for this index is not changed; it remains that of the locale that was originally specified when creating this Index.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">locale</td><td>The locale whose index characters are to be added. </td></tr>
<tr><td class="paramname">status</td><td>Error code, will be set with the reason if the operation fails. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>this, for chaining </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003563">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
</div>
</div>
<a id="a1ee642894d40ee57c84e91f8df8b20ef" name="a1ee642894d40ee57c84e91f8df8b20ef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1ee642894d40ee57c84e91f8df8b20ef">◆ </a></span>addLabels() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classicu_1_1LocalPointerBase.html">virtual</a> <a class="el" href="classicu_1_1AlphabeticIndex.html">AlphabeticIndex</a> & icu::AlphabeticIndex::addLabels </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classicu_1_1LocalPointerBase.html">const</a> <a class="el" href="classicu_1_1UnicodeSet.html">UnicodeSet</a> & </td>
<td class="paramname"><em>additions</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">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Add Labels to this Index. </p>
<p>The labels are additions to those that are already in the index; they do not replace the existing ones. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">additions</td><td>The additional characters to add to the index, such as A-Z. </td></tr>
<tr><td class="paramname">status</td><td>Error code, will be set with the reason if the operation fails. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>this, for chaining </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003562">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
</div>
</div>
<a id="a57d68dd57ee114b7eaa4bd0ba1a25f9d" name="a57d68dd57ee114b7eaa4bd0ba1a25f9d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a57d68dd57ee114b7eaa4bd0ba1a25f9d">◆ </a></span>addRecord()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classicu_1_1LocalPointerBase.html">virtual</a> <a class="el" href="classicu_1_1AlphabeticIndex.html">AlphabeticIndex</a> & icu::AlphabeticIndex::addRecord </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classicu_1_1LocalPointerBase.html">const</a> <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classicu_1_1LocalPointerBase.html">const</a> <a class="el" href="classicu_1_1LocalPointerBase.html">void</a> * </td>
<td class="paramname"><em>data</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">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Add a record to the index. </p>
<p>Each record will be associated with an index <a class="el" href="classicu_1_1AlphabeticIndex_1_1Bucket.html" title="An index "bucket" with a label string and type.">Bucket</a> based on the record's name. The list of records for each bucket will be sorted based on the collation ordering of the names in the index's locale. Records with duplicate names are permitted; they will be kept in the order that they were added.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>The display name for the Record. The Record will be placed in a bucket based on this name. </td></tr>
<tr><td class="paramname">data</td><td>An optional pointer to user data associated with this item. When iterating the contents of a bucket, both the data pointer the name will be available for each Record. </td></tr>
<tr><td class="paramname">status</td><td>Error code, will be set with the reason if the operation fails. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>This, for chaining. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003575">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
</div>
</div>
<a id="a869d3fd2c47e3197257ea56be7a8549c" name="a869d3fd2c47e3197257ea56be7a8549c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a869d3fd2c47e3197257ea56be7a8549c">◆ </a></span>buildImmutableIndex()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classicu_1_1AlphabeticIndex_1_1ImmutableIndex.html">ImmutableIndex</a> * icu::AlphabeticIndex::buildImmutableIndex </td>
<td>(</td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>errorCode</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Builds an immutable, thread-safe version of this instance, without data records. </p>
<dl class="section return"><dt>Returns</dt><dd>an immutable index instance </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003565">Stable:</a></b></dt><dd>ICU 51 </dd></dl>
</div>
</div>
<a id="a844f00cfc958ea965550379465c51647" name="a844f00cfc958ea965550379465c51647"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a844f00cfc958ea965550379465c51647">◆ </a></span>clearRecords()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classicu_1_1LocalPointerBase.html">virtual</a> <a class="el" href="classicu_1_1AlphabeticIndex.html">AlphabeticIndex</a> & icu::AlphabeticIndex::clearRecords </td>
<td>(</td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</em></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>Remove all Records from the Index. </p>
<p>The set of Buckets, which define the headings under which records are classified, is not altered.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">status</td><td>Error code, will be set with the reason if the operation fails. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>This, for chaining. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003576">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
</div>
</div>
<a id="af0bb2d389a1051a3d8872063b06e8f49" name="af0bb2d389a1051a3d8872063b06e8f49"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af0bb2d389a1051a3d8872063b06e8f49">◆ </a></span>getBucketCount()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classicu_1_1LocalPointerBase.html">virtual</a> <a class="el" href="classicu_1_1LocalPointerBase.html">int32_t</a> icu::AlphabeticIndex::getBucketCount </td>
<td>(</td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</em></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>Get the number of labels in this index. </p>
<p>Note: may trigger lazy index construction.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">status</td><td>Error code, will be set with the reason if the operation fails. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number of labels in this index, including any under, over or in-flow labels. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003577">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
</div>
</div>
<a id="aac626348bc56a95f560d654057175db1" name="aac626348bc56a95f560d654057175db1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aac626348bc56a95f560d654057175db1">◆ </a></span>getBucketIndex() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classicu_1_1LocalPointerBase.html">virtual</a> <a class="el" href="classicu_1_1LocalPointerBase.html">int32_t</a> icu::AlphabeticIndex::getBucketIndex </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>Get the zero based index of the current <a class="el" href="classicu_1_1AlphabeticIndex_1_1Bucket.html" title="An index "bucket" with a label string and type.">Bucket</a> from an iteration over the Buckets of this index. </p>
<p>Return -1 if no iteration is in process. </p><dl class="section return"><dt>Returns</dt><dd>the index of the current <a class="el" href="classicu_1_1AlphabeticIndex_1_1Bucket.html" title="An index "bucket" with a label string and type.">Bucket</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003580">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
</div>
</div>
<a id="a9c1fc4ff54b7267c3fceafa0cf5f9f04" name="a9c1fc4ff54b7267c3fceafa0cf5f9f04"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9c1fc4ff54b7267c3fceafa0cf5f9f04">◆ </a></span>getBucketIndex() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classicu_1_1LocalPointerBase.html">virtual</a> <a class="el" href="classicu_1_1LocalPointerBase.html">int32_t</a> icu::AlphabeticIndex::getBucketIndex </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classicu_1_1LocalPointerBase.html">const</a> <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"><em>itemName</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">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Given the name of a record, return the zero-based index of the <a class="el" href="classicu_1_1AlphabeticIndex_1_1Bucket.html" title="An index "bucket" with a label string and type.">Bucket</a> in which the item should appear. </p>
<p>The name need not be in the index. A Record will not be added to the index by this function. <a class="el" href="classicu_1_1AlphabeticIndex_1_1Bucket.html" title="An index "bucket" with a label string and type.">Bucket</a> numbers are zero-based, in <a class="el" href="classicu_1_1AlphabeticIndex_1_1Bucket.html" title="An index "bucket" with a label string and type.">Bucket</a> iteration order.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">itemName</td><td>The name whose bucket position in the index is to be determined. </td></tr>
<tr><td class="paramname">status</td><td>Error code, will be set with the reason if the operation fails. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The bucket number for this name. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003579">Stable:</a></b></dt><dd>ICU 4.8</dd></dl>
</div>
</div>
<a id="a6ba9f08d7bef00306110253e940732c0" name="a6ba9f08d7bef00306110253e940732c0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6ba9f08d7bef00306110253e940732c0">◆ </a></span>getBucketLabel()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classicu_1_1LocalPointerBase.html">virtual</a> <a class="el" href="classicu_1_1LocalPointerBase.html">const</a> <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & icu::AlphabeticIndex::getBucketLabel </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 the name of the Label of the current bucket from an iteration over the buckets. </p>
<p>If the iteration is before the first <a class="el" href="classicu_1_1AlphabeticIndex_1_1Bucket.html" title="An index "bucket" with a label string and type.">Bucket</a> (<a class="el" href="classicu_1_1AlphabeticIndex.html#a6e78dc3fc44d1649ecb81bb5627625dc" title="Advance the iteration over the Buckets of this index.">nextBucket()</a> has not been called), or after the last, return an empty string.</p>
<dl class="section return"><dt>Returns</dt><dd>the bucket label. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003582">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
</div>
</div>
<a id="af58c25fdb90decd8de2f2cd14dbee3b6" name="af58c25fdb90decd8de2f2cd14dbee3b6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af58c25fdb90decd8de2f2cd14dbee3b6">◆ </a></span>getBucketLabelType()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classicu_1_1LocalPointerBase.html">virtual</a> <a class="el" href="alphaindex_8h.html#a969464092cba264934f2c66c7c621dc8">UAlphabeticIndexLabelType</a> icu::AlphabeticIndex::getBucketLabelType </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 the type of the label for the current <a class="el" href="classicu_1_1AlphabeticIndex_1_1Bucket.html" title="An index "bucket" with a label string and type.">Bucket</a> (selected by the iteration over Buckets.) </p>
<dl class="section return"><dt>Returns</dt><dd>the label type. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003583">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
</div>
</div>
<a id="aebfae2c51f0a3645dd479df4eccca21d" name="aebfae2c51f0a3645dd479df4eccca21d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aebfae2c51f0a3645dd479df4eccca21d">◆ </a></span>getBucketRecordCount()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classicu_1_1LocalPointerBase.html">virtual</a> <a class="el" href="classicu_1_1LocalPointerBase.html">int32_t</a> icu::AlphabeticIndex::getBucketRecordCount </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>Get the number of <name, data> Records in the current <a class="el" href="classicu_1_1AlphabeticIndex_1_1Bucket.html" title="An index "bucket" with a label string and type.">Bucket</a>. </p>
<p>If the current bucket iteration position is before the first label or after the last, return 0.</p>
<dl class="section return"><dt>Returns</dt><dd>the number of Records. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003584">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
</div>
</div>
<a id="a17ff93b36d701a8da0cfadf0fde0f489" name="a17ff93b36d701a8da0cfadf0fde0f489"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a17ff93b36d701a8da0cfadf0fde0f489">◆ </a></span>getCollator()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classicu_1_1LocalPointerBase.html">virtual</a> <a class="el" href="classicu_1_1LocalPointerBase.html">const</a> <a class="el" href="classicu_1_1RuleBasedCollator.html">RuleBasedCollator</a> & icu::AlphabeticIndex::getCollator </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>Get the <a class="el" href="classicu_1_1Collator.html" title="The Collator class performs locale-sensitive string comparison.">Collator</a> that establishes the ordering of the items in this index. </p>
<p>Ownership of the collator remains with the <a class="el" href="classicu_1_1AlphabeticIndex.html" title="AlphabeticIndex supports the creation of a UI index appropriate for a given language.">AlphabeticIndex</a> instance.</p>
<p>The returned collator is a reference to the internal collator used by this index. It may be safely used to compare the names of items or to get sort keys for names. However if any settings need to be changed, or other non-const methods called, a cloned copy must be made first.</p>
<dl class="section return"><dt>Returns</dt><dd>The collator </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003566">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
</div>
</div>
<a id="a6db8ebc8094f43505bd41312d12359e6" name="a6db8ebc8094f43505bd41312d12359e6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6db8ebc8094f43505bd41312d12359e6">◆ </a></span>getInflowLabel()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classicu_1_1LocalPointerBase.html">virtual</a> <a class="el" href="classicu_1_1LocalPointerBase.html">const</a> <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & icu::AlphabeticIndex::getInflowLabel </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>Get the default label used for abbreviated buckets <em>between</em> other index characters. </p>
<p>For example, consider the labels when Latin (X Y Z) and Greek (Α Β Γ) are used: </p><pre class="fragment">X Y Z ... Α Β Γ.
</pre> <dl class="section return"><dt>Returns</dt><dd>inflow label </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003567">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
</div>
</div>
<a id="aff2a5c09badb0e65cd6a6cba233b23bc" name="aff2a5c09badb0e65cd6a6cba233b23bc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aff2a5c09badb0e65cd6a6cba233b23bc">◆ </a></span>getMaxLabelCount()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classicu_1_1LocalPointerBase.html">virtual</a> <a class="el" href="classicu_1_1LocalPointerBase.html">int32_t</a> icu::AlphabeticIndex::getMaxLabelCount </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>Get the limit on the number of labels permitted in the index. </p>
<p>The number does not include over, under and inflow labels.</p>
<dl class="section return"><dt>Returns</dt><dd>maxLabelCount maximum number of labels. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003573">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
</div>
</div>
<a id="ab61215544c693712aae915d1617ea136" name="ab61215544c693712aae915d1617ea136"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab61215544c693712aae915d1617ea136">◆ </a></span>getOverflowLabel()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classicu_1_1LocalPointerBase.html">virtual</a> <a class="el" href="classicu_1_1LocalPointerBase.html">const</a> <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & icu::AlphabeticIndex::getOverflowLabel </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>Get the special label used for items that sort after the last normal label, and that would not otherwise have an appropriate label. </p>
<dl class="section return"><dt>Returns</dt><dd>the overflow label </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003569">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
</div>
</div>
<a id="a30ac7565e8a1dacea468a6a05e1253db" name="a30ac7565e8a1dacea468a6a05e1253db"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a30ac7565e8a1dacea468a6a05e1253db">◆ </a></span>getRecordCount()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classicu_1_1LocalPointerBase.html">virtual</a> <a class="el" href="classicu_1_1LocalPointerBase.html">int32_t</a> icu::AlphabeticIndex::getRecordCount </td>
<td>(</td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</em></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>Get the total number of Records in this index, that is, the number of <name, data> pairs added. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">status</td><td>Error code, will be set with the reason if the operation fails. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number of records in this index, that is, the total number of (name, data) items added with <a class="el" href="classicu_1_1AlphabeticIndex.html#a57d68dd57ee114b7eaa4bd0ba1a25f9d" title="Add a record to the index.">addRecord()</a>. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003578">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
</div>
</div>
<a id="a11188d4d0e9aa385a0e8ff9cf048f47e" name="a11188d4d0e9aa385a0e8ff9cf048f47e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a11188d4d0e9aa385a0e8ff9cf048f47e">◆ </a></span>getRecordData()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classicu_1_1LocalPointerBase.html">virtual</a> <a class="el" href="classicu_1_1LocalPointerBase.html">const</a> <a class="el" href="classicu_1_1LocalPointerBase.html">void</a> * icu::AlphabeticIndex::getRecordData </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 the data pointer of the Record currently being iterated over. </p>
<p>Return nullptr if the current iteration position before the first item in this <a class="el" href="classicu_1_1AlphabeticIndex_1_1Bucket.html" title="An index "bucket" with a label string and type.">Bucket</a>, or after the last.</p>
<dl class="section return"><dt>Returns</dt><dd>The current Record's data pointer. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003588">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
</div>
</div>
<a id="a6c182ca06b204660f9994b55b27b8c7e" name="a6c182ca06b204660f9994b55b27b8c7e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6c182ca06b204660f9994b55b27b8c7e">◆ </a></span>getRecordName()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classicu_1_1LocalPointerBase.html">virtual</a> <a class="el" href="classicu_1_1LocalPointerBase.html">const</a> <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & icu::AlphabeticIndex::getRecordName </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>