Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

UEnumeration Class Reference

Inheritance diagram for UEnumeration:

ICU List of all members.

Public Member Functions

 this (Handle handle)
 ~this ()
uint count ()
void reset ()
bool next (out char[] dst)
bool next (inout wchar[] dst)

Static Public Member Functions

 this ()
 ~this ()

Public Attributes

package Handle handle

Static Public Attributes

FunctionLoader Bind[] targets

Private Types

typedef void * Handle
enum  Error { OK, BufferOverflow = 15 }

Static Private Member Functions

bool isError (Error e)
void testError (Error e, char[] msg)
char * toString (char[] string)
wchar * toString (wchar[] string)
uint length (char *s)
uint length (wchar *s)
char[] toArray (char *s)
wchar[] toArray (wchar *s)

Static Private Attributes

void * library

Detailed Description

UEnumeration is returned by a number of ICU classes, for providing access to such things as ULocale lists and so on,

Definition at line 96 of file UEnumeration.d.


Member Typedef Documentation

typedef void* Handle [protected, inherited]
 

Use this for the primary argument-type to most ICU functions

Definition at line 63 of file ICU.d.


Member Enumeration Documentation

enum Error [protected, inherited]
 

ICU error codes (the ones which are referenced)

Enumeration values:
OK 
BufferOverflow 

Definition at line 100 of file ICU.d.


Constructor & Destructor Documentation

~this  )  [inline]
 

Disposes of the storage used by a UEnumeration object

Definition at line 115 of file UEnumeration.d.

~this  )  [inline, static]
 

Definition at line 260 of file UEnumeration.d.


Member Function Documentation

this Handle  handle  )  [inline]
 

Definition at line 104 of file UEnumeration.d.

uint count  )  [inline]
 

Returns the next element in the iterator's list.

If there are no more elements, returns NULL. If the iterator is out-of-sync with its service, status is set to U_ENUM_OUT_OF_SYNC_ERROR and NULL is returned. If the native service string is a UChar* string, it is converted to char* with the invariant converter. The result is terminated by (char)0. If the conversion fails (because a character cannot be converted) then status is set to U_INVARIANT_CONVERSION_ERROR and the return value is undefined (but non-NULL).

Definition at line 136 of file UEnumeration.d.

References ICU::testError().

void reset  )  [inline]
 

Resets the iterator to the current list of service IDs.

This re-establishes sync with the service and rewinds the iterator to start at the first element

Definition at line 154 of file UEnumeration.d.

References ICU::testError().

bool next out char[]  dst  )  [inline]
 

Returns the next element in the iterator's list.

If there are no more elements, returns NULL. If the iterator is out-of-sync with its service, status is set to U_ENUM_OUT_OF_SYNC_ERROR and NULL is returned. If the native service string is a char* string, it is converted to UChar* with the invariant converter.

Definition at line 174 of file UEnumeration.d.

References ICU::testError().

Referenced by UTimeZone::opApply().

bool next inout wchar[]  dst  )  [inline]
 

Returns the next element in the iterator's list.

If there are no more elements, returns NULL. If the iterator is out-of-sync with its service, status is set to U_ENUM_OUT_OF_SYNC_ERROR and NULL is returned. If the native service string is a char* string, it is converted to UChar* with the invariant converter.

Definition at line 198 of file UEnumeration.d.

References ICU::testError().

this  )  [inline, static]
 

Definition at line 251 of file UEnumeration.d.

bool isError Error  e  )  [inline, static, protected, inherited]
 

Definition at line 110 of file ICU.d.

Referenced by UConverter::detectSignature(), UString::format(), UCollator::getLocale(), and UConverter::this().

void testError Error  e,
char[]  msg
[inline, static, protected, inherited]
 

Definition at line 128 of file ICU.d.

Referenced by UCalendar::add(), USet::applyPattern(), UChar::charFromName(), UNormalize::check(), UNormalize::compare(), UDomainName::compare(), UConverter::UTranscoder::convert(), count(), UConverter::decode(), UConverter::encode(), UTransform::execute(), USearch::first(), UResourceBundle::get(), UCalendar::get(), UCollator::getAttribute(), UResourceBundle::getBinary(), UCollator::getBound(), UChar::getCharName(), UChar::getComment(), UCollator::getContractions(), UResourceBundle::getInt(), UResourceBundle::getIntVector(), UCalendar::getLimit(), UResourceBundle::getLocale(), UCalendar::getMillis(), UConverter::getName(), UResourceBundle::getNextString(), UCollator::getShortDefinitionString(), UResourceBundle::getString(), UCollator::getTailoredSet(), UDateFormat::getTwoDigitYearStart(), UCollator::getVariableTop(), UCalendar::inDaylightTime(), UNormalize::isNormalized(), USearch::last(), USearch::next(), next(), UCollator::normalizeShortDefinitionString(), UDateFormat::parse(), USearch::previous(), reset(), UCalendar::roll(), UCollator::setAttribute(), USearch::setCollator(), UCalendar::setDate(), UCalendar::setDateTime(), UTransform::setFilter(), USearch::setIterator(), UCalendar::setMillis(), USearch::setOffset(), USearch::setPattern(), UDecimalFormat::setPattern(), UMessageFormat::setPattern(), USearch::setText(), UBreakIterator::setText(), UCalendar::setTimeZone(), UDateFormat::setTwoDigitYearStart(), UCollator::setVariableTop(), UTransform::this(), UStringPrep::this(), USet::this(), USearch::this(), UResourceBundle::this(), UNumberFormat::this(), UMessageFormat::this(), UDateFormat::this(), UCollator::this(), UCalendar::this(), UBreakIterator::this(), URuleIterator::this(), and UText::toUtf8().

char* toString char[]  string  )  [inline, static, protected, inherited]
 

Definition at line 138 of file ICU.d.

References string.

Referenced by UChar::charFromName(), UConverter::compareNames(), UCollator::getDisplayName(), UResourceBundle::getResource(), UCollator::getShortDefinitionString(), UResourceBundle::getString(), UCalendar::getTimeZoneName(), UCollator::normalizeShortDefinitionString(), UMessageFormat::setLocale(), UStringPrep::this(), UResourceBundle::this(), UDateFormat::this(), UCollator::this(), UBreakIterator::this(), UText::toLower(), and UText::toUpper().

wchar* toString wchar[]  string  )  [inline, static, protected, inherited]
 

Definition at line 160 of file ICU.d.

References string.

uint length char *  s  )  [inline, static, protected, inherited]
 

Definition at line 182 of file ICU.d.

References strlen().

uint length wchar *  s  )  [inline, static, protected, inherited]
 

Definition at line 191 of file ICU.d.

References wcslen().

char [] toArray char *  s  )  [inline, static, protected, inherited]
 

Definition at line 200 of file ICU.d.

References strlen().

Referenced by UConverter::detectSignature(), UResourceBundle::getKey(), UResourceBundle::getLocale(), UMessageFormat::getLocale(), UCollator::getLocale(), UConverter::getName(), UChar::getPropertyName(), UChar::getPropertyValueName(), and UConverter::opApply().

wchar [] toArray wchar *  s  )  [inline, static, protected, inherited]
 

Definition at line 211 of file ICU.d.

References wcslen().


Member Data Documentation

package Handle handle
 

Definition at line 98 of file UEnumeration.d.

void* library [static, private]
 

Bind the ICU functions from a shared library. This is complicated by the issues regarding D and DLLs on the Windows platform

Definition at line 219 of file UEnumeration.d.

FunctionLoader Bind [] targets [static]
 

Initial value:

 
                [
                {cast(void**) &uenum_close, "uenum_close"}

Definition at line 238 of file UEnumeration.d.


The documentation for this class was generated from the following file:
Generated on Tue Jan 25 21:18:42 2005 for Mango by doxygen 1.3.6