#include <resbund.h>
Public Members | |||
![]() | ![]() | ResourceBundle ( const UnicodeString& path, const Locale& locale, UErrorCode& err) | |
![]() | ![]() | Constructor. More... | |
![]() | ![]() | ResourceBundle ( const UnicodeString& path, UErrorCode& err) | |
![]() | ![]() | ResourceBundle (UErrorCode &err) | |
![]() | ![]() | ResourceBundle ( const wchar_t* path, const Locale& locale, UErrorCode& err) | |
![]() | ![]() | ResourceBundle ( const char* path, const Locale& locale, UErrorCode& err) | |
![]() | ![]() | ResourceBundle (const ResourceBundle &original) | |
![]() | ![]() | ResourceBundle (UResourceBundle *res, UErrorCode &status) | |
![]() | ![]() | ResourceBundle& | operator= (const ResourceBundle& other) |
![]() | ![]() | ~ResourceBundle () | |
![]() | ![]() | int32_t | getSize (void) const |
![]() | ![]() | Returns the size of a resource. More... | |
![]() | ![]() | UnicodeString | getString (UErrorCode& status) const |
![]() | ![]() | returns a string from a string resource type. More... | |
![]() | ![]() | const uint8_t* | getBinary (int32_t& len, UErrorCode& status) const |
![]() | ![]() | UBool | hasNext (void) const |
![]() | ![]() | Checks whether the resource has another element to iterate over. More... | |
![]() | ![]() | void | resetIterator (void) |
![]() | ![]() | Resets the internal context of a resource so that iteration starts from the first element. More... | |
![]() | ![]() | const char* | getKey (void) |
![]() | ![]() | Returns the key associated with this resource. More... | |
![]() | ![]() | const char* | getName (void) |
![]() | ![]() | UResType | getType (void) |
![]() | ![]() | Returns the type of a resource. More... | |
![]() | ![]() | ResourceBundle | getNext (UErrorCode& status) |
![]() | ![]() | Returns the next resource in a given resource or NULL if there are no more resources. More... | |
![]() | ![]() | UnicodeString | getNextString (UErrorCode& status) |
![]() | ![]() | Returns the next string in a resource or NULL if there are no more resources to iterate over. More... | |
![]() | ![]() | UnicodeString | getNextString (const char ** key, UErrorCode& status) |
![]() | ![]() | Returns the next string in a resource or NULL if there are no more resources to iterate over. More... | |
![]() | ![]() | ResourceBundle | get (int32_t index, UErrorCode& status) const |
![]() | ![]() | Returns the resource in a resource at the specified index. More... | |
![]() | ![]() | UnicodeString | getStringEx (int32_t index, UErrorCode& status) const |
![]() | ![]() | Returns the string in a given resource at the specified index. More... | |
![]() | ![]() | ResourceBundle | get (const char* key, UErrorCode& status) const |
![]() | ![]() | Returns a resource in a resource that has a given key. More... | |
![]() | ![]() | UnicodeString | getStringEx (const char* key, UErrorCode& status) const |
![]() | ![]() | Returns a string in a resource that has a given key. More... | |
![]() | ![]() | const UnicodeString* | getString ( const char *resourceTag, UErrorCode& err) const |
![]() | ![]() | Returns the contents of a string resource. More... | |
![]() | ![]() | const UnicodeString* | getStringArray ( const char *resourceTag, int32_t& numArrayItems, UErrorCode& err) const |
![]() | ![]() | Returns the contents of a string-array resource. More... | |
![]() | ![]() | const UnicodeString* | getArrayItem ( const char *resourceTag, int32_t index, UErrorCode& err) const |
![]() | ![]() | Returns a single item from a string-array resource. More... | |
![]() | ![]() | const UnicodeString** | get2dArray (const char *resourceTag, int32_t& rowCount, int32_t& columnCount, UErrorCode& err) const |
![]() | ![]() | Return the contents of a 2-dimensional array resource. More... | |
![]() | ![]() | const UnicodeString* | get2dArrayItem ( const char *resourceTag, int32_t rowIndex, int32_t columnIndex, UErrorCode& err) const |
![]() | ![]() | Return a single string from a 2-dimensional array resource. More... | |
![]() | ![]() | const UnicodeString* | getTaggedArrayItem ( const char *resourceTag, const UnicodeString& itemTag, UErrorCode& err) const |
![]() | ![]() | Returns a single item from a tagged-array resource This will return the contents of a single item in a resource of type tagged-array. More... | |
![]() | ![]() | void | getTaggedArray ( const char *resourceTag, UnicodeString*& itemTags, UnicodeString*& items, int32_t& numItems, UErrorCode& err) const |
![]() | ![]() | Returns a tagged-array resource. More... | |
![]() | ![]() | const char* | getVersionNumber (void) const |
![]() | ![]() | Return the version number associated with this ResourceBundle. More... | |
![]() | ![]() | void | getVersion (UVersionInfo versionInfo) const |
![]() | ![]() | const Locale& | getLocale (void) const |
![]() | ![]() | Return the Locale associated with this ResourceBundle. More... | |
Friends | |||
![]() | ![]() | class | RuleBasedCollator |
A resource bundle provides a way of accessing locale- specfic information in a data file. You create a resource bundle that manages the resources for a given locale and then ask it for individual resources.
The resource bundle file is a text (ASCII or Unicode) file with the format:
. locale { . tag1 {...} . tag2 {...} . }
Four data types are supported. These are solitary strings, comma-delimited lists of strings, 2-dimensional arrays of strings, and tagged lists of strings.
Note that all data is textual. Adjacent strings are merged by the low-level tokenizer, so that the following effects occur: foo bar, baz // 2 elements, "foo bar", and "baz" "foo" "bar", baz // 2 elements, "foobar", and "baz" Note that a single intervening space is added between merged strings, unless they are both double quoted. This extends to more than two strings in a row.
Whitespace is ignored, as in a C source file.
Solitary strings have the format:
. Tag { Data }
Comma-delimited lists have the format:
. Tag { Data, Data, Data }
Tagged lists have the format:
. Tag { Subtag { Data } Subtag {Data} }
Two-dimensional arrays have the format:
. TwoD { . { r1c1, r1c2, ..., r1cm }, . { r2c1, r2c2, ..., r2cm }, . ... . { rnc1, rnc2, ..., rncm } . }
. Odd { {} {} {} } // 3 x 0 array
. Smallest { {} } // 1 x 0 array
This is an example for using a possible custom resource:
. Locale currentLocale; . UErrorCode success = U_ZERO_ERROR; . ResourceBundle myResources("MyResources", currentLocale, success ); . . UnicodeString button1Title, button2Title; . myResources.getString("OkKey", button1Title, success ); . myResources.getString("CancelKey", button2Title, success );
Definition at line 149 of file resbund.h.
ResourceBundle::ResourceBundle (const UnicodeString & path, const Locale & locale, UErrorCode & err) |
Constructor.
path | This is a full pathname in the platform-specific format for the directory containing the resource data files we want to load resources from. We use locale IDs to generate filenames, and the filenames have this string prepended to them before being passed to the C++ I/O functions. Therefore, this string must always end with a directory delimiter (whatever that is for the target OS) for this class to work correctly. |
locale | This is the locale this resource bundle is for. To get resources for the French locale, for example, you would create a ResourceBundle passing Locale::FRENCH for the "locale" parameter, and all subsequent calls to that resource bundle will return resources that pertain to the French locale. If the caller doesn't pass a locale parameter, the default locale for the system (as returned by Locale::getDefault()) will be used. The UErrorCode& err parameter is used to return status information to the user. To check whether the construction succeeded or not, you should check the value of U_SUCCESS(err). If you wish more detailed information, you can check for informational error results which still indicate success. U_USING_FALLBACK_ERROR indicates that a fall back locale was used. For example, 'de_CH' was requested, but nothing was found there, so 'de' was used. U_USING_DEFAULT_ERROR indicates that the default locale data was used; neither the requested locale nor any of its fall back locales could be found. |
ResourceBundle::ResourceBundle (const UnicodeString & path, UErrorCode & err) |
ResourceBundle::ResourceBundle (UErrorCode & err) |
ResourceBundle::ResourceBundle (const wchar_t * path, const Locale & locale, UErrorCode & err) |
ResourceBundle::ResourceBundle (const char * path, const Locale & locale, UErrorCode & err) |
ResourceBundle::ResourceBundle (const ResourceBundle & original) |
ResourceBundle::ResourceBundle (UResourceBundle * res, UErrorCode & status) |
ResourceBundle& ResourceBundle::operator= (const ResourceBundle & other) |
ResourceBundle::~ResourceBundle () |
int32_t ResourceBundle::getSize (void) const |
Returns the size of a resource.
Size for scalar types is always 1, and for vector/table types is the number of child resources.
UnicodeString ResourceBundle::getString (UErrorCode & status) const |
returns a string from a string resource type.
status: |
fills in the outgoing error code could be U_MISSING_RESOURCE_ERROR if the key is not found could be a non-failing error e.g.: U_USING_FALLBACK_ERROR ,U_USING_DEFAULT_ERROR |
const uint8_t* ResourceBundle::getBinary (int32_t & len, UErrorCode & status) const |
UBool ResourceBundle::hasNext (void) const |
Checks whether the resource has another element to iterate over.
void ResourceBundle::resetIterator (void) |
Resets the internal context of a resource so that iteration starts from the first element.
const char * ResourceBundle::getKey (void) |
Returns the key associated with this resource.
Not all the resources have a key - only those that are members of a table.
const char* ResourceBundle::getName (void) |
UResType ResourceBundle::getType (void) |
Returns the type of a resource.
Available types are defined in enum UResType
ResourceBundle ResourceBundle::getNext (UErrorCode & status) |
Returns the next resource in a given resource or NULL if there are no more resources.
status | fills in the outgoing error code |
UnicodeString ResourceBundle::getNextString (UErrorCode & status) |
Returns the next string in a resource or NULL if there are no more resources to iterate over.
status | fills in the outgoing error code |
UnicodeString ResourceBundle::getNextString (const char ** key, UErrorCode & status) |
Returns the next string in a resource or NULL if there are no more resources to iterate over.
key | fill in for key associated with this string |
status | fills in the outgoing error code |
ResourceBundle ResourceBundle::get (int32_t index, UErrorCode & status) const |
Returns the resource in a resource at the specified index.
index | an index to the wanted resource. |
status | fills in the outgoing error code |
UnicodeString ResourceBundle::getStringEx (int32_t index, UErrorCode & status) const |
Returns the string in a given resource at the specified index.
index | an index to the wanted string. |
status | fills in the outgoing error code |
ResourceBundle ResourceBundle::get (const char * key, UErrorCode & status) const |
Returns a resource in a resource that has a given key.
This procedure works only with table resources.
key | a key associated with the wanted resource |
status | fills in the outgoing error code. |
UnicodeString ResourceBundle::getStringEx (const char * key, UErrorCode & status) const |
Returns a string in a resource that has a given key.
This procedure works only with table resources.
key | a key associated with the wanted string |
status | fills in the outgoing error code |
const UnicodeString * ResourceBundle::getString (const char * resourceTag, UErrorCode & err) const |
Returns the contents of a string resource.
Resource data is undifferentiated Unicode text. The resource file may contain quoted strings or escape sequences; these will be parsed prior to the data's return.
resourceTag | The resource tag of the string resource the caller wants |
err | Set to U_MISSING_RESOURCE_ERROR if a resource with the specified tag couldn't be found. |
const UnicodeString * ResourceBundle::getStringArray (const char * resourceTag, int32_t & numArrayItems, UErrorCode & err) const |
Returns the contents of a string-array resource.
This will return the contents of a string-array (comma-delimited-list) resource as a C++ array of UnicodeString objects. The number of elements in the array is returned in numArrayItems. Calling getStringArray on a resource of type string will return an array with one element; calling it on a resource of type tagged-array results in a U_MISSING_RESOURCE_ERROR error.
resourceTag | The resource tag of the string-array resource the caller wants |
numArrayItems | Receives the number of items in the array the function returns. |
err | Set to U_MISSING_RESOURCE_ERROR if a resource with the specified tag couldn't be found. |
const UnicodeString * ResourceBundle::getArrayItem (const char * resourceTag, int32_t index, UErrorCode & err) const |
Returns a single item from a string-array resource.
This will return the contents of a single item in a resource of string-array (comma-delimited-list) type. If the resource is not an array, a U_MISSING_RESOURCE_ERROR will be returned in err.
resourceTag | The resource tag of the resource the caller wants to extract an item from. |
index | The index (zero-based) of the particular array item the user wants to extract from the resource. |
err | Set to U_MISSING_RESOURCE_ERROR if a resource with the specified tag couldn't be found, or if the index was out of range. |
const UnicodeString ** ResourceBundle::get2dArray (const char * resourceTag, int32_t & rowCount, int32_t & columnCount, UErrorCode & err) const |
Return the contents of a 2-dimensional array resource.
The return value will be a UnicodeString** array. (This is really an array of pointers; each pointer is a ROW of the data.) The number of rows and columns is returned. If the resource is of the wrong type, or not present, U_MISSING_RESOURCE_ERROR is placed in err.
resourceTag | The resource tag of the string-array resource the caller wants |
rowCount | Receives the number of rows in the array the function returns. |
columnCount | Receives the number of columns in the array the function returns. |
err | Set to U_MISSING_RESOURCE_ERROR if a resource with the specified tag couldn't be found. |
const UnicodeString * ResourceBundle::get2dArrayItem (const char * resourceTag, int32_t rowIndex, int32_t columnIndex, UErrorCode & err) const |
Return a single string from a 2-dimensional array resource.
If the resource does not exists, or if it is not a 2-d array, or if the row or column indices are out of bounds, err is set to U_MISSING_RESOURCE_ERROR.
resourceTag | The resource tag of the resource the caller wants to extract an item from. |
rowIndex | The row index (zero-based) of the array item the user wants to extract from the resource. |
columnIndex | The column index (zero-based) of the array item the user wants to extract from the resource. |
err | Set to U_MISSING_RESOURCE_ERROR if a resource with the specified tag couldn't be found, if the resource data was in the wrong format, or if either index is out of bounds. |
const UnicodeString * ResourceBundle::getTaggedArrayItem (const char * resourceTag, const UnicodeString & itemTag, UErrorCode & err) const |
Returns a single item from a tagged-array resource This will return the contents of a single item in a resource of type tagged-array.
If this function is called for a resource that is not of type tagged-array, it will set err to MISSING_RESOUCE_ERROR.
resourceTag | The resource tag of the resource the caller wants to extract an item from. |
itemTag | The item tag for the item the caller wants to extract. |
err | Set to U_MISSING_RESOURCE_ERROR if a resource with the specified resource tag couldn't be found, or if an item with the specified item tag coldn't be found in the resource. |
void ResourceBundle::getTaggedArray (const char * resourceTag, UnicodeString *& itemTags, UnicodeString *& items, int32_t & numItems, UErrorCode & err) const |
Returns a tagged-array resource.
The contents of the resource is returned as two separate arrays of UnicodeStrings, the addresses of which are placed in "itemTags" and "items". After calling this function, the items in the resource will be in the list pointed to by "items", and for each items[i], itemTags[i] will be the tag that corresponds to it. The total number of entries in both arrays is returned in numItems.
resourceTag | The resource tag of the resource the caller wants to extract an item from. |
itemTags | Set to point to an array of UnicodeStrings representing the tags in the specified resource. The caller DOES own this array, and must delete it. |
items | Set to point to an array of UnicodeStrings containing the individual resource items themselves. itemTags[i] will contain the tag corresponding to items[i]. The caller DOES own this array, and must delete it. |
numItems | Receives the number of items in the arrays pointed to by items and itemTags. |
err | Set to U_MISSING_RESOURCE_ERROR if a resource with the specified tag couldn't be found. |
const char * ResourceBundle::getVersionNumber (void) const |
Return the version number associated with this ResourceBundle.
This version number is a string of the form MAJOR.MINOR, where MAJOR is the version number of the current analytic code package, and MINOR is the version number contained in the resource file as the value of the tag "Version". A change in the MINOR version indicated an updated data file. A change in the MAJOR version indicates a new version of the code which is not binary-compatible with the previous version. If no "Version" tag is present in a resource file, the MINOR version "0" is assigned.
For example, if the Collation sort key algorithm changes, the MAJOR version increments. If the collation data in a resource file changes, the MINOR version for that file increments.
void ResourceBundle::getVersion (UVersionInfo versionInfo) const |
const Locale & ResourceBundle::getLocale (void) const |
friend class RuleBasedCollator [friend]
|