Home | History | Annotate | Download | only in unicode

Lines Matching defs:Region

13  * \brief C++ API: Region classes (territory containment)
29 * Type representing the unknown region.
66 * Type representing a region whose code has been deprecated, usually
91 * <code>Region</code> is the class representing a Unicode Region Code, also known as a
92 * Unicode Region Subtag, which is defined based upon the BCP 47 standard. We often think of
93 * "regions" as "countries" when defining the characteristics of a locale. Region codes There are different
94 * types of region codes that are important to distinguish.
96 * Macroregion - A code for a "macro geographical (continental) region, geographical sub-region, or
101 * Macroregions are represented in ICU by one of three region types: WORLD ( region code 001 ),
105 * TERRITORY - A Region that is not a Macroregion. These are typically codes for countries, but also
111 * UNKNOWN - The code ZZ is defined by Unicode LDML for use to indicate that the Region is unknown,
112 * or that the value supplied as a region was invalid.
114 * DEPRECATED - Region codes that have been defined in the past but are no longer in modern usage,
118 * that a region code has been assigned for it. Some of these are UNM.49 codes that do't fall into
120 * their own region code. Region "EU" (European Union) is one such region code that is a grouping.
121 * Groupings will never be returned by the getContainingRegion() API, since a different type of region
122 * ( WORLD, CONTINENT, or SUBCONTINENT ) will always be the containing region instead.
124 * The Region class is not intended for public subclassing.
130 class U_I18N_API Region : public UObject {
136 virtual ~Region();
142 UBool operator==(const Region &that) const;
148 UBool operator!=(const Region &that) const;
151 * Returns a pointer to a Region using the given region code. The region code can be either 2-letter ISO code,
152 * 3-letter ISO code, UNM.49 numeric code, or other valid Unicode Region Code as defined by the LDML specification.
154 * If the region code is NULL or not recognized, the appropriate error code will be set ( U_ILLEGAL_ARGUMENT_ERROR )
157 static const Region* U_EXPORT2 getInstance(const char *region_code, UErrorCode &status);
160 * Returns a pointer to a Region using the given numeric region code. If the numeric region code is not recognized,
164 static const Region* U_EXPORT2 getInstance (int32_t code, UErrorCode &status);
173 * Returns a pointer to the region that contains this region. Returns NULL if this region is code "001" (World)
174 * or "ZZ" (Unknown region). For example, calling this method with region "IT" (Italy) returns the
175 * region "039" (Southern Europe).
178 const Region* getContainingRegion() const;
181 * Return a pointer to the region that geographically contains this region and matches the given type,
182 * moving multiple steps up the containment chain if necessary. Returns NULL if no containing region can be found
185 * with region "IT" (Italy) for type "URGN_CONTINENT" returns the region "150" ( Europe ).
188 const Region* getContainingRegion(URegionType type) const;
191 * Return an enumeration over the IDs of all the regions that are immediate children of this region in the
192 * region hierarchy. These returned regions could be either macro regions, territories, or a mixture of the two,
193 * depending on the containment data as defined in CLDR. This API may return NULL if this region doesn't have
194 * any sub-regions. For example, calling this method with region "150" (Europe) returns an enumeration containing
202 * Returns an enumeration over the IDs of all the regions that are children of this region anywhere in the region
203 * hierarchy and match the given type. This API may return an empty enumeration if this region doesn't have any
204 * sub-regions that match the given type. For example, calling this method with region "150" (Europe) and type
211 * Returns true if this region contains the supplied other region anywhere in the region hierarchy.
214 UBool contains(const Region &other) const;
218 * regions for this region. Returns null for a non-deprecated region. For example, calling this method with region
226 * Return this region's canonical region code.
232 * Return this region's numeric code.
233 * Returns a negative value if the given region does not have a numeric code assigned to it.
239 * Returns the region type of this region.
257 Region *containingRegion;
266 Region();
270 * Initializes the region data from the ICU resource bundles. The region data
274 * If the region data has already loaded, then this method simply returns without doing