alphaindex.h File Reference

C++ API: Index Characters. More...

#include "unicode/utypes.h"
#include "unicode/uobject.h"
#include "unicode/locid.h"

Go to the source code of this file.

Namespaces

namespace  icu

Data Structures

class  icu::AlphabeticIndex
 class AlphabeticIndex supports the creation of a UI index appropriate for a given language, such as: More...
struct  icu::AlphabeticIndex::Record
 A record, or item, in the index. More...
struct  icu::AlphabeticIndex::Bucket
 A Bucket holds an index label and references to everything belonging to that label. More...

Enumerations

enum  UAlphabeticIndexLabelType { U_ALPHAINDEX_NORMAL = 0, U_ALPHAINDEX_UNDERFLOW = 1, U_ALPHAINDEX_INFLOW = 2, U_ALPHAINDEX_OVERFLOW = 3 }
 Constants for Alphabetic Index Label Types. More...


Detailed Description

C++ API: Index Characters.

Definition in file alphaindex.h.


Enumeration Type Documentation

enum UAlphabeticIndexLabelType

Constants for Alphabetic Index Label Types.

The form of these enum constants anticipates having a plain C API for Alphabetic Indexes that will also use them.

Stable:
ICU 4.8
Enumerator:
U_ALPHAINDEX_NORMAL  Normal Label, typically the starting letter of the names in the bucket with this label.

Stable:
ICU 4.8
U_ALPHAINDEX_UNDERFLOW  Undeflow Label.

The bucket with this label contains names in scripts that sort before any of the bucket labels in this index.

Stable:
ICU 4.8
U_ALPHAINDEX_INFLOW  Inflow Label.

The bucket with this label contains names in scripts that sort between two of the bucket labels in this index. Inflow labels are created when an index contains normal labels for multiple scripts, and skips other scripts that sort between some of the included scripts.

Stable:
ICU 4.8
U_ALPHAINDEX_OVERFLOW  Overflow Label.

Te bucket with this label contains names in scripts that sort after all of the bucket labels in this index.

Stable:
ICU 4.8

Definition at line 33 of file alphaindex.h.


Generated on 25 Nov 2014 for ICU 50.1.2 by  doxygen 1.4.7