blob: 00fc5755f8cb4d028f194f7438bebb11d481a8c7 [file] [log] [blame]
/*
**********************************************************************
* Copyright (C) 2001, International Business Machines
* Corporation and others. All Rights Reserved.
**********************************************************************
* Date Name Description
* 05/24/01 aliu Creation.
**********************************************************************
*/
#ifndef TITLETRN_H
#define TITLETRN_H
#include "unicode/utypes.h"
#if !UCONFIG_NO_TRANSLITERATION
#include "unicode/translit.h"
#include "unicode/locid.h"
U_NAMESPACE_BEGIN
/**
* A transliterator that converts all letters (as defined by
* <code>UCharacter.isLetter()</code>) to lower case, except for those
* letters preceded by non-letters. The latter are converted to title
* case using <code>u_totitle()</code>.
* @author Alan Liu
*/
class U_I18N_API TitlecaseTransliterator : public Transliterator {
public:
/**
* Constructs a transliterator.
* @param loc the given locale.
*/
TitlecaseTransliterator(const Locale& loc = Locale::getDefault());
/**
* Destructor.
*/
virtual ~TitlecaseTransliterator();
/**
* Copy constructor.
*/
TitlecaseTransliterator(const TitlecaseTransliterator&);
/**
* Assignment operator.
*/
TitlecaseTransliterator& operator=(const TitlecaseTransliterator&);
/**
* Transliterator API.
* @return a copy of the object.
*/
Transliterator* clone(void) 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 getStaticClassID();
protected:
/**
* Implements {@link Transliterator#handleTransliterate}.
* @param text the buffer holding transliterated and
* untransliterated text
* @param offset the start and limit of the text, the position
* of the cursor, and the start and limit of transliteration.
* @param incremental if true, assume more text may be coming after
* pos.contextLimit. Otherwise, assume the text is complete.
*/
void handleTransliterate(Replaceable& text, UTransPosition& offset,
UBool isIncremental) const;
public:
/**
* Static memory cleanup function. FOR INTERNAL USE ONLY; DO NOT
* CALL.
*/
static void cleanup();
private:
Locale loc;
UChar* buffer;
};
U_NAMESPACE_END
#endif /* #if !UCONFIG_NO_TRANSLITERATION */
#endif