Table of contents

General

• BiDi algorithm for ICU
  • Sample code for the ICU BiDi API

Classes

• BiDi BiDi is a C++ wrapper class for UBiDi
• BreakIterator The BreakIterator class implements methods for finding the location of boundaries in text
• Calendar Calendar is an abstract base class for converting between a UDate object and a set of integer fields such as YEAR, MONTH, DAY, HOUR, and so on
• CharacterIterator Abstract class defining a protcol for accessing characters in a text-storage object
• ChoiceFormat A ChoiceFormat allows you to attach a format to a range of numbers
• CollationElementIterator The CollationElementIterator class is used as an iterator to walk through each character of an international string
• CollationKey Collation keys are generated by the Collator class
• Collator The Collator class performs locale-sensitive String comparison
• DateFormat DateFormat is an abstract class for a family of classes that convert dates and times from their internal representations to textual form and back again in a language-independent manner
• DateFormatSymbols DateFormatSymbols is a public class for encapsulating localizable date-time formatting data -- including timezone data
• DecimalFormat Concrete class for formatting decimal numbers, allowing a variety of parameters, and localization to Western, Arabic, or Indic numbers
• DecimalFormatSymbols This class represents the set of symbols needed by DecimalFormat to format numbers
• FieldPosition FieldPosition is a simple class used by Format and its subclasses to identify fields in formatted output
• Format Base class for all formats
• Formattable Formattable objects can be passed to the Format class or its subclasses for formatting
• GregorianCalendar Concrete class which provides the standard calendar used by most of the world
• MessageFormat Provides means to produce concatenated messages in language-neutral way
• Normalizer Normalizer transforms Unicode text into an equivalent composed or decomposed form, allowing for easier sorting and searching of text
• NumberFormat Abstract base class for all number formats
• ParsePosition ParsePosition is a simple class used by Format and its subclasses to keep track of the current position during parsing
• ResourceBundle A class representing a collection of resource information pertaining to a given locale
• RuleBasedCollator The RuleBasedCollator class provides the simple implementation of Collator, using data-driven tables
• SimpleDateFormat SimpleDateFormat is a concrete class for formatting and parsing dates in a language-independent manner
• SimpleTimeZone SimpleTimeZone is a concrete subclass of TimeZone that represents a time zone for use with a Gregorian calendar
• StringCharacterIterator A concrete subclass of CharacterIterator that iterates over the characters in a UnicodeString
• TimeZone TimeZone represents a time zone offset, and also figures out daylight savings
• UCharCharacterIterator A concrete subclass of CharacterIterator that iterates over the characters in a UnicodeString
• Unicode The Unicode class allows you to query the properties associated with individual Unicode character values
• UnicodeSet A mutable set of Unicode characters
• UnicodeString UnicodeString is a concrete implementation of the abstract class UnicodeText

Functions, Macros

• addTest Add a test to the subtree
• getTest Retreive a specific subtest (subtree)
• icu_digitsAfterDecimal Returns the number of digits after the decimal point in a double number x
• icu_isNaN Platform utilities isolates the platform dependencies of the libarary
• icu_log10 Returns the common log of the double value d
• icu_tzset Time zone utilities Wrappers for C runtime library functions relating to timezones
• log_err Log an error message
• log_info Log an informational message
• log_verbose Log a verbose informational message
• processArgs Processes the command line arguments
• runTests Run a subtree of tests
• scsu_compress Compress a Unicode character array into a byte array
• scsu_decompress Decompress a byte array into a Unicode character array
• scsu_init Initialize a UnicodeCompressor
• scsu_reset Reset the compressor to its initial state
• showTests Show the names of all nodes
• u_austrcpy Copy ustring to a byte string encoded in the default codepage
• u_charCellWidth Returns a value indicating the display-cell width of the character when used in Asian text, according to the Unicode standard (see p
• u_charDigitValue Retrives the decimal numeric value of a digit character
• u_charDirection Returns the linguistic direction property of a character
• u_charScript Returns the script associated with a character
• u_charType Returns a value indicating a character category according to Unicode 2
• u_formatMessage Format a message for a locale
• u_getVersion The function is used to get the Unicode standard Version that is used
• u_isalpha Determines whether the specified character is a letter according to Unicode 2
• u_isbase Determines whether the specified character is of the base form according to Unicode 2
• u_iscntrl Determines whether the specified character is a control character or not
• u_isdefined Determines whether the specified numeric value is actually a defined character according to Unicode 2
• u_isdigit Determines whether the specified character is a digit according to Unicode 2
• u_isIDIgnorable A convenience method for determining if a Unicode character should be regarded as an ignorable character in a Unicode identifier
• u_isIDPart A convenience method for determining if a Unicode character may be part of a Unicode identifier other than the starting character
• u_isIDStart A convenience method for determining if a Unicode character is allowed to start in a Unicode identifier
• u_isJavaIDPart A convenience method for determining if a Unicode character may be part of a Java identifier other than the starting character
• u_isJavaIDStart A convenience method for determining if a Unicode character is allowed as the first character in a Java identifier
• u_islower Determines whether the specified UChar is a lowercase character according to Unicode 2
• u_isprint Determines whether the specified character is a printable character according to Unicode 2
• u_isspace Determines if the specified character is a space character or not
• u_istitle Determines whether the specified character is a titlecase character according to Unicode 2
• u_isupper Determines whether the specified character is an uppercase character according to Unicode 2
• u_normalize Normalize a string
• u_parseMessage Parse a message
• u_strcat Concatenate two ustrings
• u_strchr Find the first occurrence of a specified character in a ustring
• u_strcmp Compare two ustrings for bitwise equality
• u_strcpy Copy a ustring
• u_strlen Determine the length of an array of UChar
• u_strncat Concatenate two ustrings
• u_strncmp Compare two ustrings for bitwise equality
• u_strncpy Copy a ustring
• u_tolower The given character is mapped to its lowercase equivalent according to Unicode 2
• u_totitle The given character is mapped to its titlecase equivalent according to Unicode 2
• u_toupper The given character is mapped to its uppercase equivalent according to Unicode 2
• u_uastrcpy Copy a byte string encoded in the default codepage to a ustring
• u_uastrncpy Copy a byte string encoded in the default codepage to a ustring
• ubidi_close ubidi_close() must be called to free the memory associated with a UBiDi object
• ubidi_countRuns Get the number of runs
• ubidi_getDirection Get the directionality of the text
• ubidi_getLength Get the length of the text
• ubidi_getLevelAt Get the level for one character
• ubidi_getLevels Get an array of levels for each character
• ubidi_getLogicalIndex Get the logical text position from a visual position
• ubidi_getLogicalMap Get a logical-to-visual index map (array) for the characters in the UBiDi (paragraph or line) object
• ubidi_getLogicalRun Get a logical run
• ubidi_getParaLevel Get the paragraph level of the text
• ubidi_getVisualIndex Get the visual position from a logical text position
• ubidi_getVisualMap Get a visual-to-logical index map (array) for the characters in the UBiDi (paragraph or line) object
• ubidi_getVisualRun Get one run's logical start, length, and directionality, which can be 0 for LTR or 1 for RTL
• ubidi_invertMap Invert an index map
• ubidi_open Allocate a UBiDi structure
• ubidi_openSized Allocate a UBiDi structure with preallocated memory for internal structures
• ubidi_reorderLogical This is a convenience function that does not use a UBiDi object
• ubidi_reorderVisual This is a convenience function that does not use a UBiDi object
• ubidi_setLine ubidi_getLine() sets a UBiDi to contain the reordering information, especially the resolved levels, for all the characters in a line of text
• ubidi_setPara Perform the Unicode BiDi algorithm
• ubrk_close Close a UBreakIterator
• ubrk_countAvailable Determine how many locales have text breaking information available
• ubrk_current Determine the most recently-returned text boundary
• ubrk_first Determine the index of the first character in the text being scanned
• ubrk_following Determine the text boundary following the specified offset
• ubrk_getAvailable Get a locale for which text breaking information is available
• ubrk_last Determine the index immediately beyond the last character in the text being scanned
• ubrk_next Determine the text boundary following the current text boundary
• ubrk_open Open a new UBreakIterator for locating text boundaries for a specified locale
• ubrk_openRules Open a new UBreakIterator for locating text boundaries using specified breaking rules
• ubrk_preceding Determine the text boundary preceding the specified offset
• ubrk_previous Determine the text boundary preceding the current text boundary
• ucal_add Add a specified signed amount to a particular field in a UCalendar
• ucal_clear Clear all fields in a UCalendar
• ucal_clearField Clear a field in a UCalendar
• ucal_close Close a UCalendar
• ucal_countAvailable Determine how many locales have calendars available
• ucal_countAvailableTZIDs Determine how many TimeZones exist with a certain offset
• ucal_equivalentTo Determine if two UCalendars represent the same date
• ucal_get Get the current value of a field from a UCalendar
• ucal_getAttribute Get a numeric attribute associated with a UCalendar
• ucal_getAvailable Get a locale for which calendars are available
• ucal_getAvailableTZIDs Get an available TimeZone ID
• ucal_getLimit Determine a limit for a field in a UCalendar
• ucal_getMillis Get a UCalendar's current time in millis
• ucal_getNow Get the current date and time
• ucal_getTimeZoneDisplayName Get the display name for a UCalendar's TimeZone
• ucal_inDaylightTime Determine if a UCalendar is currently in daylight savings time
• ucal_isSet Determine if a field in a UCalendar is set
• ucal_open Open a UCalendar
• ucal_roll Add a specified signed amount to a particular field in a UCalendar
• ucal_set Set the value of a field in a UCalendar
• ucal_setAttribute Set a numeric attribute associated with a UCalendar
• ucal_setDate Set a UCalendar's current date
• ucal_setDateTime Set a UCalendar's current date
• ucal_setMillis Set a UCalendar's current time in millis
• ucal_setTimeZone Set the TimeZone used by a UCalendar
• ucnv_close Deletes the unicode converter
• ucnv_countAvailable returns the number of available converters
• ucnv_flushCache SYSTEM API Iterates through every cached converter and frees all the unused ones
• ucnv_fromUChars Transcodes the source Unicode string to the target string in a codepage encoding with the specified Unicode converter
• ucnv_fromUnicode Transcodes an array of unicode characters to an array of codepage characters
• ucnv_getAvailableName provides a string containing the internal name (based on the alias file) of the converter
• ucnv_getCCSID Gets a codepage number associated with the converter
• ucnv_getDefaultName returns the current default converter name
• ucnv_getDisplayName Returns the display name of the converter passed in based on the Locale passed in, in the case the locale contains no display name, the internal ASCII name will be filled in
• ucnv_getFromUCallBack Gets the current callback function used by the converter when illegal or invalid sequence found
• ucnv_getInvalidChars Fills in the output parameter, errBytes, with the error characters from the last failing conversion
• ucnv_getInvalidUChars Fills in the output parameter, errChars, with the error characters from the last failing conversion
• ucnv_getMaxCharSize Returns the maximum length of bytes used by a character
• ucnv_getMinCharSize Returns the minimum byte length for characters in this codepage
• ucnv_getName Gets the name of the converter (zero-terminated)
• ucnv_getPlatform Gets a codepage platform associated with the converter
• ucnv_getStarters Gets the "starter" bytes for the converters of type MBCS will fill in an U_ILLEGAL_ARGUMENT_ERROR if converter passed in is not MBCS
• ucnv_getSubstChars Fills in the output parameter, subChars, with the substitution characters as multiple bytes
• ucnv_getToUCallBack Gets the current calback function used by the converter when illegal or invalid sequence found
• ucnv_getType Gets the type of conversion associated with the converter e
• ucnv_open Creates a UConverter object with the names specified as a C string
• ucnv_openCCSID Creates a UConverter object using a CCSID number
• ucnv_openU Creates a Unicode converter with the names specified as unicode string
• ucnv_reset Resets the state of stateful conversion to the default state
• ucnv_setDefaultName sets the current default converter name
• ucnv_setFromUCallBack Gets the current callback function used by the converter when illegal or invalid sequence found
• ucnv_setSubstChars Sets the substitution chars when converting from unicode to a codepage
• ucnv_setToUCallBack Gets the current callback function used by the converter when illegal or invalid sequence found
• ucnv_toUChars Transcode the source string in codepage encoding to the target string in Unicode encoding
• ucnv_toUnicode Converts an array of codepage characters into an array of unicode characters
• ucol_close Close a UCollator
• ucol_closeElements Close a UCollationElements
• ucol_countAvailable Determine how many locales have collation rules available
• ucol_equal Compare two strings for equality
• ucol_getAvailable Get a locale for which collation rules are available
• ucol_getDisplayName Get the display name for a UCollator
• ucol_getMaxExpansion Get the maximum length of any expansion sequences that end with the specified comparison order
• ucol_getNormalization Get the normalization mode used in a UCollator
• ucol_getOffset Get the offset of the current source character
• ucol_getRules Get the collation rules from a UCollator
• ucol_getSortKey Get a sort key for a string from a UCollator
• ucol_getStrength Get the collation strength used in a UCollator
• ucol_greater Determine if one string is greater than another
• ucol_greaterOrEqual Determine if one string is greater than or equal to another
• ucol_keyHashCode Generate a hash code for a collation key
• ucol_next Get the ordering priority of the next collation element in the text
• ucol_open Open a UCollator for comparing strings
• ucol_openElements Open the collation elements for a string
• ucol_openRules Open a UCollator for comparing strings
• ucol_previous Get the ordering priority of the previous collation element in the text
• ucol_reset Reset the collation elements to their initial state
• ucol_setNormalization Set the normalization mode used in a UCollator
• ucol_setOffset Set the offset of the current source character
• ucol_setStrength Set the collation strength used in a UCollator
• ucol_setText Set the text containing the collation elements
• ucol_strcoll Compare two strings
• udat_applyPattern Set the pattern used by an UDateFormat
• udat_clone Open a copy of a UDateFormat
• udat_close Close a UDateFormat
• udat_countAvailable Determine how many locales have date/time formatting patterns available
• udat_countSymbols Count the number of particular symbols for an UDateFormat
• udat_format Format a date using an UDateFormat
• udat_get2DigitYearStart Get the year relative to which all 2-digit years are interpreted
• udat_getAvailable Get a locale for which date/time formatting patterns are available
• udat_getCalendar Get the UCalendar associated with an UDateFormat
• udat_getNumberFormat Get the UNumberFormat associated with an UDateFormat
• udat_getSymbols Get the symbols associated with an UDateFormat
• udat_isLenient Determine if an UDateFormat will perform lenient parsing
• udat_open Open a new UDateFormat for formatting and parsing dates and times
• udat_openPattern Open a new UDateFormat for formatting dates and times
• udat_parse Parse a string into an date/time using a UDateFormat
• udat_set2DigitYearStart Set the year relative to which all 2-digit years will be interpreted
• udat_setCalendar Set the UCalendar associated with an UDateFormat
• udat_setLenient Specify whether an UDateFormat will perform lenient parsing
• udat_setNumberFormat Set the UNumberFormat associated with an UDateFormat
• udat_setSymbols Set the symbols associated with an UDateFormat
• udat_toPattern Extract the pattern from a UDateFormat
• uloc_countAvailable Gets the size of the all available locale list
• uloc_getAvailable Gets the specified locale from a list of all available locales
• uloc_getCountry Gets the country code for the specified locale
• uloc_getDataDirectory Gets the directory containing the locale data files
• uloc_getDefault Gets the system's default locale
• uloc_getDisplayCountry Gets the country name suitable for display for the specified locale
• uloc_getDisplayLanguage Gets the language name suitable for display for the specified locale
• uloc_getDisplayName Gets the full name suitable for display for the specified locale
• uloc_getDisplayVariant Gets the variant code suitable for display for the specified locale
• uloc_getISO3Country Gets the ISO country code for the specified locale
• uloc_getISO3Language Gets the ISO language code for the specified locale
• uloc_getISOCountries Gets a list of all available 2-letter country codes defined in ISO 639
• uloc_getISOLanguages Gets a list of all available language codes defined in ISO 639
• uloc_getLanguage Gets the language code for the specified locale
• uloc_getLCID Gets the Win32 LCID value for the specified locale
• uloc_getName Gets the full name for the specified locale
• uloc_getVariant Gets the variant code for the specified locale
• uloc_setDataDirectory Sets the directory containing the locale data files
• uloc_setDefault Sets the system's default locale
• unum_clone Open a copy of a UNumberFormat
• unum_close Close a UNumberFormat
• unum_countAvailable Determine how many locales have number formatting patterns available
• unum_format Format an integer using a UNumberFormat
• unum_formatDouble Format a double using a UNumberFormat
• unum_getAttribute Get a numeric attribute associated with a UNumberFormat
• unum_getAvailable Get a locale for which number formatting patterns are available
• unum_getDoubleAttribute Get a numeric attribute associated with a UNumberFormat
• unum_getSymbols Get the symbols associated with a UNumberFormat
• unum_getTextAttribute Get a text attribute associated with a UNumberFormat
• unum_open Open a new UNumberFormat for formatting and parsing numbers
• unum_openPattern Open a new UNumberFormat for formatting and parsing numbers
• unum_parse Parse a string into an integer using a UNumberFormat
• unum_parseDouble Parse a string into a double using a UNumberFormat
• unum_setAttribute Set a numeric attribute associated with a UNumberFormat
• unum_setDoubleAttribute Set a numeric attribute associated with a UNumberFormat
• unum_setSymbols Set the symbols associated with a UNumberFormat
• unum_setTextAttribute Set a text attribute associated with a UNumberFormat
• unum_toPattern Extract the pattern from a UNumberFormat
• ures_close close a resource bundle, all pointers returned from the various ures_getXXX calls on this particular bundle are INVALID henceforth
• ures_countArrayItems
• ures_get returns a resource string, given a resource bundle and a key
• ures_get2dArrayItem returns a resource string which is part of a 2D array, given a resource bundle a key to the array and the index pair of the desired string
• ures_getArrayItem returns a resource string which is part of an array, given a resource bundle a key to the array and the index of the desired string
• ures_getTaggedArrayItem returns a resource string which is part of a tagged array, given a resource bundle a key to the array and the key of the desired string
• ures_getVersionNumber Return the version number associated with this ResourceBundle
• ures_open Opens a UResourceBundle, from which users can extract strings by using their corresponding keys
• ures_openW Opens a UResourceBundle, from which users can extract strings by using their corresponding keys

Variables

• ERR_MSG Set this to zero to disable log_verbose() messages, otherwise nonzero to see log_verbose() messages
• ERROR_COUNT Count of errors from all tests
• UBiDi Forward declaration of the UBiDi structure for the declaration of the API functions
• UBiDiLevel UBiDiLevel is the type of the level values in this BiDi implementation
• UBreakIterator A text-break iterator
• UCalendar A calendar
• UCHAR_MAX_VALUE The maximum value a UChar can have
• UCHAR_MIN_VALUE The minimum value a UChar can have
• UClassID UClassID is used to identify classes without using RTTI, since RTTI is not yet supported by all C++ compilers
• UCNV_NUMBER_OF_SUPPORTED_CONVERTER_TYPES Number of converter types for which we have conversion routines
• UCollationElements The UCollationElements struct
• UCollator A collator
• UDate Date and Time data type
• UDateFormat A date formatter
• UDateFormatSymbols Date format symbols
• UNumberFormat A number formatter
• UResourceBundle A UResourceBundle
• VERBOSITY Set this to zero to disable log_verbose() messages, otherwise nonzero to see log_verbose() messages

Macros

• ICU_VERSION ICU package code version number
• U_COMMON_API Control of symbol import/export
• UBIDI_DEFAULT_LTR If there is no strong character, then set the paragraph level to 0 (left-to-right).
• UBIDI_DEFAULT_RTL If there is no strong character, then set the paragraph level to 1 (right-to-left).
• UBIDI_LEVEL_OVERRIDE Bit flag for level input: overrides directional properties.
• UBIDI_MAX_EXPLICIT_LEVEL Maximum explicit embedding level (The maximum resolved level can be up to UBIDI_MAX_EXPLICIT_LEVEL+1).
• UBRK_DONE Value indicating all text boundaries have been returned
• UCOL_NULLORDER This indicates the last element in a UCollationElements has been consumed
• UCOL_PRIMARYMASK Bit mask for primary collation strength
• UCOL_SECONDARYMASK Bit mask for secondary collation strength
• UCOL_TERTIARYMASK Bit mask for tertiary collation strength
• ULOC_ENGLISH Useful constants for language
• ULOC_FRANCE Useful constants for country
• ULocale A Locale object represents a specific geographical, political, or cultural region
• UNFSYMBOLSMAXSIZE The maximum size for a textual number format symbol
• USCSU_BUFSIZE The size of the internal buffer for a UnicodeCompressor

Enums, Unions, Structs

• UBiDiDirection UBiDiDirection values indicate the text direction.
• UBreakIteratorType The possible types of text boundaries
• UCalendarAMPMs Possible AM/PM values in a UCalendar
• UCalendarAttribute Types of UCalendar attributes
• UCalendarDateFields Possible fields in a UCalendar
• UCalendarDaysOfWeek Possible days of the week in a UCalendar
• UCalendarDisplayNameType Possible formats for a UCalendar's display name
• UCalendarLimitType Possible limit values for a UCalendar
• UCalendarMonths Possible months in a UCalendar
• UCalendarType Possible types of UCalendars
• UCellWidth Values returned by the u_getCellWidth() function
• UCharCategory Data for enumerated Unicode general category types
• UCharDirection This specifies the language directional property of a character set
• UCharScript Script range as defined in the Unicode standard
• UCollationResult Possible values for a comparison result
• UCollationStrength Possible collation strengths
• UDateFormatStyle The possible date/time format styles
• UDateFormatSymbolType The possible types of date format symbols
• UErrorCode Error code to replace exception handling
• UFieldPosition A struct representing a range of text containing a specific field
• UnicodeCompressor The UnicodeCompressor struct
• UNormalizationMode Possible collation normalization modes
• UNormalizationOption Possible normalization options
• UNumberFormatAttribute The possible UNumberFormat numeric attributes
• UNumberFormatStyle The possible number format styles
• UNumberFormatSymbols The UNumberFormatSymbols struct
• UNumberFormatTextAttribute The possible UNumberFormat text attributes

this page has been generated automatically by doc++

(c)opyright by Malte Zöckler, Roland Wunderling
contact: doc++@zib.de