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.

Data Structures
class	AlphabeticIndex
	class AlphabeticIndex supports the creation of a UI index appropriate for a given language, such as: More...
struct	AlphabeticIndex::Record
	A record, or item, in the index. More...
struct	AlphabeticIndex::Bucket
	A Bucket holds an index label and references to everything belonging to that label. More...
Typedefs
typedef enum UAlphabeticIndexLabelType	UAlphabeticIndexLabelType
	Constants for Alphabetic Index Label Types.
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.

---

Typedef Documentation

typedef enum UAlphabeticIndexLabelType 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.

Draft:

This API may be changed in the future versions and was introduced in ICU 4.8

---

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.

Draft:

This API may be changed in the future versions and was introduced in ICU 4.8

Enumerator:

U_ALPHAINDEX_NORMAL	Normal Label, typically the starting letter of the names in the bucket with this label. Draft: This API may be changed in the future versions and was introduced in 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. Draft: This API may be changed in the future versions and was introduced in 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. Draft: This API may be changed in the future versions and was introduced in 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. Draft: This API may be changed in the future versions and was introduced in ICU 4.8

Definition at line 31 of file alphaindex.h.