[apple/icu.git] / icuSources / i18n / nultrans.h

/*
**********************************************************************
*   Copyright (c) 2000-2004, International Business Machines
*   Corporation and others.  All Rights Reserved.
**********************************************************************
*   Date        Name        Description
*   01/11/2000  aliu        Creation.
**********************************************************************
*/
#ifndef NULTRANS_H
#define NULTRANS_H

#include "unicode/utypes.h"

#if !UCONFIG_NO_TRANSLITERATION

#include "unicode/translit.h"

U_NAMESPACE_BEGIN

/**
 * A transliterator that leaves text unchanged.
 * @author Alan Liu
 * @internal Use transliterator factory methods instead since this class will be removed in that release.
 */
class U_I18N_API NullTransliterator : public Transliterator {

public:

    /**
     * ID for this transliterator.
     * @internal Use transliterator factory methods instead since this class will be removed in that release.
     */
    static const UChar ID[]; // public for Transliterator

    /**
     * ID for this transliterator.
     * @internal Use transliterator factory methods instead since this class will be removed in that release.
     */
    static const UChar SHORT_ID[]; // public for Transliterator

    /**
     * Constructs a transliterator.
     * @internal Use transliterator factory methods instead since this class will be removed in that release.
     */
    NullTransliterator();

    /**
     * Destructor.
     * @internal Use transliterator factory methods instead since this class will be removed in that release.
     */
    virtual ~NullTransliterator();

    /**
     * Transliterator API.
     * @internal Use transliterator factory methods instead since this class will be removed in that release.
     */
    virtual Transliterator* clone(void) const;

    /**
     * Implements {@link Transliterator#handleTransliterate}.
     * @internal Use transliterator factory methods instead since this class will be removed in that release.
     */
    virtual void handleTransliterate(Replaceable& text, UTransPosition& offset,
                                     UBool isIncremental) const;

    /**
     * ICU "poor man's RTTI", returns a UClassID for the actual class.
     *
     * @draft ICU 2.2
     */
    virtual UClassID getDynamicClassID() const;

    /**
     * ICU "poor man's RTTI", returns a UClassID for this class.
     *
     * @draft ICU 2.2
     */
    static UClassID U_EXPORT2 getStaticClassID();

};

U_NAMESPACE_END

#endif /* #if !UCONFIG_NO_TRANSLITERATION */

#endif
Commit	Line	Data
b75a7d8f A	1	/*
b75a7d8f A	2	**********************************************************************
374ca955	3	* Copyright (c) 2000-2004, International Business Machines
b75a7d8f A	4	* Corporation and others. All Rights Reserved.
	5	**********************************************************************
	6	* Date Name Description
	7	* 01/11/2000 aliu Creation.
	8	**********************************************************************
	9	*/
	10	#ifndef NULTRANS_H
	11	#define NULTRANS_H
	12
	13	#include "unicode/utypes.h"
	14
	15	#if !UCONFIG_NO_TRANSLITERATION
	16
	17	#include "unicode/translit.h"
	18
	19	U_NAMESPACE_BEGIN
	20
	21	/**
	22	* A transliterator that leaves text unchanged.
	23	* @author Alan Liu
	24	* @internal Use transliterator factory methods instead since this class will be removed in that release.
	25	*/
	26	class U_I18N_API NullTransliterator : public Transliterator {
	27
	28	public:
	29
	30	/**
	31	* ID for this transliterator.
	32	* @internal Use transliterator factory methods instead since this class will be removed in that release.
	33	*/
	34	static const UChar ID[]; // public for Transliterator
	35
	36	/**
	37	* ID for this transliterator.
	38	* @internal Use transliterator factory methods instead since this class will be removed in that release.
	39	*/
	40	static const UChar SHORT_ID[]; // public for Transliterator
	41
	42	/**
	43	* Constructs a transliterator.
	44	* @internal Use transliterator factory methods instead since this class will be removed in that release.
	45	*/
	46	NullTransliterator();
	47
	48	/**
	49	* Destructor.
	50	* @internal Use transliterator factory methods instead since this class will be removed in that release.
	51	*/
	52	virtual ~NullTransliterator();
	53
	54	/**
	55	* Transliterator API.
	56	* @internal Use transliterator factory methods instead since this class will be removed in that release.
	57	*/
374ca955	58	virtual Transliterator* clone(void) const;
b75a7d8f A	59
	60	/**
	61	* Implements {@link Transliterator#handleTransliterate}.
	62	* @internal Use transliterator factory methods instead since this class will be removed in that release.
	63	*/
	64	virtual void handleTransliterate(Replaceable& text, UTransPosition& offset,
	65	UBool isIncremental) const;
	66
	67	/**
	68	* ICU "poor man's RTTI", returns a UClassID for the actual class.
	69	*
	70	* @draft ICU 2.2
	71	*/
374ca955	72	virtual UClassID getDynamicClassID() const;
b75a7d8f A	73
	74	/**
	75	* ICU "poor man's RTTI", returns a UClassID for this class.
	76	*
	77	* @draft ICU 2.2
	78	*/
374ca955	79	static UClassID U_EXPORT2 getStaticClassID();
b75a7d8f	80
b75a7d8f A	81	};
b75a7d8f A	82
b75a7d8f A	83	U_NAMESPACE_END
	84
	85	#endif /* #if !UCONFIG_NO_TRANSLITERATION */
	86
	87	#endif