UText Struct Reference

UText struct. More...

#include <utext.h>


Data Fields

const void * context
 (protected) Pointer to string or wrapped object or similar.
const void * p
 (protected) Pointer fields available for use by the text provider.
const void * q
const void * r
void * pExtra
 (protected) Pointer to additional space requested by the text provider during the utext_open operation.
int32_t extraSize
 (protected) Size in bytes of the extra space (pExtra).
int32_t flags
 (private) Flags for managing the allocation and freeing of memory associated with this UText.
uint32_t magic
 (private) Magic.
int32_t sizeOfStruct
 (public) sizeOfStruct=sizeof(UText) Allows possible backward compatible extension.
int32_t a
 (protected) Integer fields for use by text provider.
int32_t b
int32_t c
int32_t providerProperties
 Text provider properties.
UTextChunk chunk
 descriptor for the text chunk that includes or is adjacent to the current iteration position.
UTextCloneclone
 (public) Function pointer for UTextClone
UTextNativeLengthnativeLength
 (public) function pointer for UTextLength May be expensive to compute!
UTextAccessaccess
 (public) Function pointer for UTextAccess.
UTextExtractextract
 (public) Function pointer for UTextExtract.
UTextReplacereplace
 (public) Function pointer for UTextReplace.
UTextCopycopy
 (public) Function pointer for UTextCopy.
UTextMapOffsetToNativemapOffsetToNative
 (public) Function pointer for UTextMapOffsetToNative.
UTextMapNativeIndexToUTF16mapNativeIndexToUTF16
 (public) Function pointer for UTextMapNativeIndexToUTF16.
UTextCloseclose
 (public) Function pointer for UTextClose.


Detailed Description

UText struct.

Provides the interface between the generic UText access code and the UText provider code that works on specific kinds of text (UTF-8, noncontiguous UTF-16, whatever.)

Applications that are using predefined types of text providers to pass text data to ICU services will have no need to view the internals of the UText structs that they open.

Draft:
This API may be changed in the future versions and was introduced in ICU 3.4

Definition at line 1046 of file utext.h.


Field Documentation

int32_t UText::a
 

(protected) Integer fields for use by text provider.

Not used by caller.

Draft:
This API may be changed in the future versions and was introduced in ICU 3.4

Definition at line 1108 of file utext.h.

UTextAccess* UText::access
 

(public) Function pointer for UTextAccess.

See also:
UTextAccess
Draft:
This API may be changed in the future versions and was introduced in ICU 3.4

Definition at line 1150 of file utext.h.

UTextChunk UText::chunk
 

descriptor for the text chunk that includes or is adjacent to the current iteration position.

Draft:
This API may be changed in the future versions and was introduced in ICU 3.4

Definition at line 1124 of file utext.h.

UTextClone* UText::clone
 

(public) Function pointer for UTextClone

See also:
UTextClone
Draft:
This API may be changed in the future versions and was introduced in ICU 3.4

Definition at line 1133 of file utext.h.

UTextClose* UText::close
 

(public) Function pointer for UTextClose.

See also:
UTextClose
Draft:
This API may be changed in the future versions and was introduced in ICU 3.4

Definition at line 1198 of file utext.h.

const void* UText::context
 

(protected) Pointer to string or wrapped object or similar.

Not used by caller.

Draft:
This API may be changed in the future versions and was introduced in ICU 3.4

Definition at line 1052 of file utext.h.

UTextCopy* UText::copy
 

(public) Function pointer for UTextCopy.

See also:
UTextCopy
Draft:
This API may be changed in the future versions and was introduced in ICU 3.4

Definition at line 1174 of file utext.h.

UTextExtract* UText::extract
 

(public) Function pointer for UTextExtract.

See also:
UTextExtract
Draft:
This API may be changed in the future versions and was introduced in ICU 3.4

Definition at line 1158 of file utext.h.

int32_t UText::extraSize
 

(protected) Size in bytes of the extra space (pExtra).

Draft:
This API may be changed in the future versions and was introduced in ICU 3.4

Definition at line 1072 of file utext.h.

int32_t UText::flags
 

(private) Flags for managing the allocation and freeing of memory associated with this UText.

Internal:
Do not use. This API is for interal use only.

Definition at line 1079 of file utext.h.

uint32_t UText::magic
 

(private) Magic.

Try to detect when we are handed junk. utext_openXYZ() functions take an initialized, but not necessarily open, UText struct as an, optional fill-in parameter. This magic field is used to check for that initialization. Text provider close functions must NOT clear the magic field because that would prevent reuse of the UText struct.

Internal:
Do not use. This API is for interal use only.

Definition at line 1092 of file utext.h.

UTextMapNativeIndexToUTF16* UText::mapNativeIndexToUTF16
 

(public) Function pointer for UTextMapNativeIndexToUTF16.

See also:
UTextMapNativeIndexToUTF16
Draft:
This API may be changed in the future versions and was introduced in ICU 3.4

Definition at line 1190 of file utext.h.

UTextMapOffsetToNative* UText::mapOffsetToNative
 

(public) Function pointer for UTextMapOffsetToNative.

See also:
UTextMapOffsetToNative
Draft:
This API may be changed in the future versions and was introduced in ICU 3.4

Definition at line 1182 of file utext.h.

UTextNativeLength* UText::nativeLength
 

(public) function pointer for UTextLength May be expensive to compute!

See also:
UTextLength
Draft:
This API may be changed in the future versions and was introduced in ICU 3.4

Definition at line 1142 of file utext.h.

const void* UText::p
 

(protected) Pointer fields available for use by the text provider.

Not used by UText common code.

Draft:
This API may be changed in the future versions and was introduced in ICU 3.4

Definition at line 1059 of file utext.h.

void* UText::pExtra
 

(protected) Pointer to additional space requested by the text provider during the utext_open operation.

Draft:
This API may be changed in the future versions and was introduced in ICU 3.4

Definition at line 1066 of file utext.h.

int32_t UText::providerProperties
 

Text provider properties.

This set of flags is maintainted by the text provider implementation.

Draft:
This API may be changed in the future versions and was introduced in ICU 3.4

Definition at line 1116 of file utext.h.

UTextReplace* UText::replace
 

(public) Function pointer for UTextReplace.

See also:
UTextReplace
Draft:
This API may be changed in the future versions and was introduced in ICU 3.4

Definition at line 1166 of file utext.h.

int32_t UText::sizeOfStruct
 

(public) sizeOfStruct=sizeof(UText) Allows possible backward compatible extension.

Draft:
This API may be changed in the future versions and was introduced in ICU 3.4

Definition at line 1101 of file utext.h.


The documentation for this struct was generated from the following file:
Generated on Tue Sep 13 11:03:38 2005 for ICU 3.4 by  doxygen 1.4.4