[apple/icu.git] / icuSources / i18n / unicode / coleitr.h

/*
******************************************************************************
*   Copyright (C) 1997-2003, International Business Machines
*   Corporation and others.  All Rights Reserved.
******************************************************************************
*/

/**
* File coleitr.h
*
* 
*
* Created by: Helena Shih
*
* Modification History:
*
*  Date       Name        Description
*
*  8/18/97    helena      Added internal API documentation.
* 08/03/98    erm         Synched with 1.2 version CollationElementIterator.java
* 12/10/99    aliu        Ported Thai collation support from Java.
* 01/25/01    swquek      Modified into a C++ wrapper calling C APIs (ucoliter.h)
* 02/19/01    swquek      Removed CollationElementsIterator() since it is 
*                         private constructor and no calls are made to it
*/

#ifndef COLEITR_H
#define COLEITR_H

#include "unicode/utypes.h"

#if !UCONFIG_NO_COLLATION

#include "unicode/uobject.h"
#include "unicode/tblcoll.h"
#include "unicode/ucoleitr.h"

/** 
 * The UCollationElements struct.
 * For usage in C programs.
 * @stable ICU 2.0
 */
typedef struct UCollationElements UCollationElements;

U_NAMESPACE_BEGIN

/**
* The CollationElementIterator class is used as an iterator to walk through     
* each character of an international string. Use the iterator to return the
* ordering priority of the positioned character. The ordering priority of a 
* character, which we refer to as a key, defines how a character is collated in 
* the given collation object.
* For example, consider the following in Spanish:
* <pre>
* \code
*        "ca" -> the first key is key('c') and second key is key('a').
*        "cha" -> the first key is key('ch') and second key is key('a').
* \endcode
* </pre>
* And in German,
* <pre>
* \code
Commit	Line	Data
b75a7d8f A	1	/*
	2	******************************************************************************
	3	* Copyright (C) 1997-2003, International Business Machines
	4	* Corporation and others. All Rights Reserved.
	5	******************************************************************************
	6	*/
	7
	8	/**
	9	* File coleitr.h
	10	*
	11	*
	12	*
	13	* Created by: Helena Shih
	14	*
	15	* Modification History:
	16	*
	17	* Date Name Description
	18	*
	19	* 8/18/97 helena Added internal API documentation.
	20	* 08/03/98 erm Synched with 1.2 version CollationElementIterator.java
	21	* 12/10/99 aliu Ported Thai collation support from Java.
	22	* 01/25/01 swquek Modified into a C++ wrapper calling C APIs (ucoliter.h)
	23	* 02/19/01 swquek Removed CollationElementsIterator() since it is
	24	* private constructor and no calls are made to it
	25	*/
	26
	27	#ifndef COLEITR_H
	28	#define COLEITR_H
	29
	30	#include "unicode/utypes.h"
	31
	32	#if !UCONFIG_NO_COLLATION
	33
	34	#include "unicode/uobject.h"
	35	#include "unicode/tblcoll.h"
	36	#include "unicode/ucoleitr.h"
	37
	38	/**
	39	* The UCollationElements struct.
	40	* For usage in C programs.
	41	* @stable ICU 2.0
	42	*/
	43	typedef struct UCollationElements UCollationElements;
	44
	45	U_NAMESPACE_BEGIN
	46
	47	/**
	48	* The CollationElementIterator class is used as an iterator to walk through
	49	* each character of an international string. Use the iterator to return the
	50	* ordering priority of the positioned character. The ordering priority of a
	51	* character, which we refer to as a key, defines how a character is collated in
	52	* the given collation object.
	53	* For example, consider the following in Spanish:
	54	* <pre>
	55	* \code
	56	* "ca" -> the first key is key('c') and second key is key('a').
	57	* "cha" -> the first key is key('ch') and second key is key('a').
	58	* \endcode
	59	* </pre>
	60	* And in German,
	61	* <pre>
	62	* \code
	63