ꦫꦣꦺꦤ꧀ꦄꦤ꧀ꦠꦱꦺꦤ

PATH: usr / include / unicode

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

#ifndef LOCDSPNM_H
#define LOCDSPNM_H

#include "unicode/utypes.h"

/**
 * \file
 * \brief C++ API: Provides display names of Locale and its components.
 */

#if !UCONFIG_NO_FORMATTING

#include "unicode/locid.h"
#include "unicode/uscript.h"
#include "unicode/uldnames.h"
#include "unicode/udisplaycontext.h"

U_NAMESPACE_BEGIN

/**
 * Returns display names of Locales and components of Locales. For
 * more information on language, script, region, variant, key, and
 * values, see Locale.
 * @stable ICU 4.4
 */
class U_I18N_API LocaleDisplayNames : public UObject {
public:
    /**
     * Destructor.
     * @stable ICU 4.4
     */
    virtual ~LocaleDisplayNames();

/**
     * Convenience overload of
     * {@link #createInstance(const Locale& locale, UDialectHandling dialectHandling)}
     * that specifies STANDARD dialect handling.
     * @param locale the display locale
     * @return a LocaleDisplayNames instance
     * @stable ICU 4.4
     */
    static LocaleDisplayNames* U_EXPORT2 createInstance(const Locale& locale);

/**
     * Returns an instance of LocaleDisplayNames that returns names
     * formatted for the provided locale, using the provided
     * dialectHandling.
     *
     * @param locale the display locale
     * @param dialectHandling how to select names for locales
     * @return a LocaleDisplayNames instance
     * @stable ICU 4.4
     */
    static LocaleDisplayNames* U_EXPORT2 createInstance(const Locale& locale,
                            UDialectHandling dialectHandling);

#ifndef U_HIDE_INTERNAL_API
    /**
     * Returns an instance of LocaleDisplayNames that returns names formatted
     * for the provided locale, using the provided UDisplayContext settings.
     *
     * @param locale the display locale
     * @param contexts List of one or more context settings (e.g. for dialect
     *               handling, capitalization, etc.
     * @param length Number of items in the contexts list
     * @return a LocaleDisplayNames instance
     * @internal ICU 50 technology preview
     */
    static LocaleDisplayNames* U_EXPORT2 createInstance(const Locale& locale,
                            UDisplayContext *contexts, int32_t length);
#endif  /* U_HIDE_INTERNAL_API */

// getters for state
    /**
     * Returns the locale used to determine the display names. This is
     * not necessarily the same locale passed to {@link #createInstance}.
     * @return the display locale
     * @stable ICU 4.4
     */
    virtual const Locale& getLocale() const = 0;

/**
     * Returns the dialect handling used in the display names.
     * @return the dialect handling enum
     * @stable ICU 4.4
     */
    virtual UDialectHandling getDialectHandling() const = 0;

/**
     * Returns the UDisplayContext value for the specified UDisplayContextType.
     * @param type the UDisplayContextType whose value to return
     * @return the UDisplayContext for the specified type.
     * @internal ICU 50 technology preview
     */
    virtual UDisplayContext getContext(UDisplayContextType type) const = 0;

// names for entire locales
    /**
     * Returns the display name of the provided locale.
     * @param locale the locale whose display name to return
     * @param result receives the locale's display name
     * @return the display name of the provided locale
     * @stable ICU 4.4
     */
    virtual UnicodeString& localeDisplayName(const Locale& locale,
                         UnicodeString& result) const = 0;

/**
     * Returns the display name of the provided locale id.
     * @param localeId the id of the locale whose display name to return
     * @param result receives the locale's display name
     * @return the display name of the provided locale
     * @stable ICU 4.4
     */
    virtual UnicodeString& localeDisplayName(const char* localeId,
                         UnicodeString& result) const = 0;

// names for components of a locale id
    /**
     * Returns the display name of the provided language code.
     * @param lang the language code
     * @param result receives the language code's display name
     * @return the display name of the provided language code
     * @stable ICU 4.4
     */
    virtual UnicodeString& languageDisplayName(const char* lang,
                           UnicodeString& result) const = 0;

/**
     * Returns the display name of the provided script code.
     * @param script the script code
     * @param result receives the script code's display name
     * @return the display name of the provided script code
     * @stable ICU 4.4
     */
    virtual UnicodeString& scriptDisplayName(const char* script,
                         UnicodeString& result) const = 0;

/**
     * Returns the display name of the provided script code.
     * @param scriptCode the script code number
     * @param result receives the script code's display name
     * @return the display name of the provided script code
     * @stable ICU 4.4
     */
    virtual UnicodeString& scriptDisplayName(UScriptCode scriptCode,
                         UnicodeString& result) const = 0;

/**
     * Returns the display name of the provided region code.
     * @param region the region code
     * @param result receives the region code's display name
     * @return the display name of the provided region code
     * @stable ICU 4.4
     */
    virtual UnicodeString& regionDisplayName(const char* region,
                         UnicodeString& result) const = 0;

/**
     * Returns the display name of the provided variant.
     * @param variant the variant string
     * @param result receives the variant's display name
     * @return the display name of the provided variant
     * @stable ICU 4.4
     */
    virtual UnicodeString& variantDisplayName(const char* variant,
                          UnicodeString& result) const = 0;

/**
     * Returns the display name of the provided locale key.
     * @param key the locale key name
     * @param result receives the locale key's display name
     * @return the display name of the provided locale key
     * @stable ICU 4.4
     */
    virtual UnicodeString& keyDisplayName(const char* key,
                      UnicodeString& result) const = 0;

/**
     * Returns the display name of the provided value (used with the provided key).
     * @param key the locale key name
     * @param value the locale key's value
     * @param result receives the value's display name
     * @return the display name of the provided value
     * @stable ICU 4.4
     */
    virtual UnicodeString& keyValueDisplayName(const char* key, const char* value,
                           UnicodeString& result) const = 0;

private:
    // No ICU "poor man's RTTI" for this class nor its subclasses.
    virtual UClassID getDynamicClassID() const;
};

inline LocaleDisplayNames* LocaleDisplayNames::createInstance(const Locale& locale) {
  return LocaleDisplayNames::createInstance(locale, ULDN_STANDARD_NAMES);
}

U_NAMESPACE_END

#endif

[-] tzrule.h [edit]
[-] utrans.h [edit]
[-] ucnv.h [edit]
[-] dtrule.h [edit]
[-] format.h [edit]
[-] uvernum.h [edit]
[-] utf32.h [edit]
[-] ubidi.h [edit]
[-] enumset.h [edit]
[-] normlzr.h [edit]
[-] measfmt.h [edit]
[-] ubrk.h [edit]
[-] upluralrules.h [edit]
[-] sortkey.h [edit]
[-] bytestrie.h [edit]
[-] fpositer.h [edit]
[-] utf_old.h [edit]
[-] tmutamt.h [edit]
[-] uconfig.h [edit]
[-] alphaindex.h [edit]
[-] vtzone.h [edit]
[-] locdspnm.h [edit]
[-] numsys.h [edit]
[-] simpletz.h [edit]
[-] tznames.h [edit]
[-] stringpiece.h [edit]
[-] parseerr.h [edit]
[-] ucsdet.h [edit]
[-] appendable.h [edit]
[+] ..
[-] dtptngen.h [edit]
[-] dtintrv.h [edit]
[-] resbund.h [edit]
[-] ptypes.h [edit]
[-] ustdio.h [edit]
[-] symtable.h [edit]
[-] ucnv_err.h [edit]
[-] utypes.h [edit]
[-] bytestream.h [edit]
[-] dtfmtsym.h [edit]
[-] unorm2.h [edit]
[-] udateintervalformat.h [edit]
[-] ucat.h [edit]
[-] usearch.h [edit]
[-] platform.h [edit]
[-] unum.h [edit]
[-] locid.h [edit]
[-] uversion.h [edit]
[-] regex.h [edit]
[-] strenum.h [edit]
[-] ucasemap.h [edit]
[-] utmscale.h [edit]
[-] decimfmt.h [edit]
[-] messagepattern.h [edit]
[-] brkiter.h [edit]
[-] ucurr.h [edit]
[-] uset.h [edit]
[-] tztrans.h [edit]
[-] udata.h [edit]
[-] currpinf.h [edit]
[-] datefmt.h [edit]
[-] rbbi.h [edit]
[-] parsepos.h [edit]
[-] rbtz.h [edit]
[-] ucnv_cb.h [edit]
[-] ucoleitr.h [edit]
[-] udat.h [edit]
[-] putil.h [edit]
[-] coll.h [edit]
[-] gender.h [edit]
[-] ucharstriebuilder.h [edit]
[-] unimatch.h [edit]
[-] currunit.h [edit]
[-] ugender.h [edit]
[-] colldata.h [edit]
[-] uchriter.h [edit]
[-] tmunit.h [edit]
[-] ulocdata.h [edit]
[-] timezone.h [edit]
[-] unirepl.h [edit]
[-] umisc.h [edit]
[-] tmutfmt.h [edit]
[-] ushape.h [edit]
[-] dtitvinf.h [edit]
[-] usetiter.h [edit]
[-] uniset.h [edit]
[-] listformatter.h [edit]
[-] umsg.h [edit]
[-] ustream.h [edit]
[-] ustringtrie.h [edit]
[-] icudataver.h [edit]
[-] bytestriebuilder.h [edit]
[-] bms.h [edit]
[-] uldnames.h [edit]
[-] uregex.h [edit]
[-] schriter.h [edit]
[-] uenum.h [edit]
[-] uclean.h [edit]
[-] bmsearch.h [edit]
[-] utf16.h [edit]
[-] normalizer2.h [edit]
[-] calendar.h [edit]
[-] udatpg.h [edit]
[-] unifunct.h [edit]
[-] dbbi.h [edit]
[-] utext.h [edit]
[-] uchar.h [edit]
[-] tzfmt.h [edit]
[-] urep.h [edit]
[-] uscript.h [edit]
[-] urename.h [edit]
[-] std_string.h [edit]
[-] choicfmt.h [edit]
[-] rep.h [edit]
[-] idna.h [edit]
[-] unorm.h [edit]
[-] dtitvfmt.h [edit]
[-] utrace.h [edit]
[-] uidna.h [edit]
[-] search.h [edit]
[-] uobject.h [edit]
[-] basictz.h [edit]
[-] dcfmtsym.h [edit]
[-] coleitr.h [edit]
[-] translit.h [edit]
[-] ures.h [edit]
[-] unistr.h [edit]
[-] udisplaycontext.h [edit]
[-] fmtable.h [edit]
[-] rbnf.h [edit]
[-] gregocal.h [edit]
[-] uiter.h [edit]
[-] umachine.h [edit]
[-] plurrule.h [edit]
[-] plurfmt.h [edit]
[-] ucnvsel.h [edit]
[-] curramt.h [edit]
[-] ucal.h [edit]
[-] measure.h [edit]
[-] utf8.h [edit]
[-] uspoof.h [edit]
[-] icuplug.h [edit]
[-] chariter.h [edit]
[-] stringtriebuilder.h [edit]
[-] caniter.h [edit]
[-] utf.h [edit]
[-] fieldpos.h [edit]
[-] ucharstrie.h [edit]
[-] tblcoll.h [edit]
[-] ustring.h [edit]
[-] errorcode.h [edit]
[-] stsearch.h [edit]
[-] localpointer.h [edit]
[-] usprep.h [edit]
[-] docmain.h [edit]
[-] msgfmt.h [edit]
[-] selfmt.h [edit]
[-] unifilt.h [edit]
[-] uloc.h [edit]
[-] measunit.h [edit]
[-] ucol.h [edit]
[-] numfmt.h [edit]
[-] smpdtfmt.h [edit]