ICU 56.1: UTextFuncs Struct Reference

ICU 56.1 56.1

- Main Page
- Related Pages
- Modules
- Namespaces
- Data Structures
- Files

- Data Structures
- Data Structure Index
- Class Hierarchy
- Data Fields

Data Fields
UTextFuncs Struct Reference

(public) Function dispatch table for UText. More...

`#include <utext.h>`

## Data Fields
int32_t | tableSize
| (public) Function table size, sizeof(UTextFuncs) Intended for use should the table grow to accomodate added functions in the future, to allow tests for older format function tables that do not contain the extensions. More...
int32_t | reserved1
| (private) Alignment padding. More...
int32_t | reserved2
int32_t | reserved3
UTextClone * | clone
| (public) Function pointer for UTextClone More...
UTextNativeLength * | nativeLength
| (public) function pointer for UTextLength May be expensive to compute! More...
UTextAccess * | access
| (public) Function pointer for UTextAccess. More...
UTextExtract * | extract
| (public) Function pointer for UTextExtract. More...
UTextReplace * | replace
| (public) Function pointer for UTextReplace. More...
UTextCopy * | copy
| (public) Function pointer for UTextCopy. More...
UTextMapOffsetToNative * | mapOffsetToNative
| (public) Function pointer for UTextMapOffsetToNative. More...
UTextMapNativeIndexToUTF16 * | mapNativeIndexToUTF16
| (public) Function pointer for UTextMapNativeIndexToUTF16. More...
UTextClose * | close
| (public) Function pointer for UTextClose. More...
UTextClose * | spare1
| (private) Spare function pointer More...
UTextClose * | spare2
| (private) Spare function pointer More...
UTextClose * | spare3
| (private) Spare function pointer More...

## Detailed Description

(public) Function dispatch table for UText.

Conceptually very much like a C++ Virtual Function Table. This struct defines the organization of the table. Each text provider implementation must provide an actual table that is initialized with the appropriate functions for the type of text being handled.

Stable:
  ICU 3.6

Definition at line 1209 of file utext.h.

## Field Documentation

UTextAccess* UTextFuncs::access

(public) Function pointer for UTextAccess.

See also
  UTextAccess

Stable:
  ICU 3.6

Definition at line 1257 of file utext.h.

UTextClone* UTextFuncs::clone

(public) Function pointer for UTextClone

See also
  UTextClone

Stable:
  ICU 3.6

Definition at line 1240 of file utext.h.

UTextClose* UTextFuncs::close

(public) Function pointer for UTextClose.

See also
  UTextClose

Stable:
  ICU 3.6

Definition at line 1305 of file utext.h.

UTextCopy* UTextFuncs::copy

(public) Function pointer for UTextCopy.

See also
  UTextCopy

Stable:
  ICU 3.6

Definition at line 1281 of file utext.h.

UTextExtract* UTextFuncs::extract

(public) Function pointer for UTextExtract.

See also
  UTextExtract

Stable:
  ICU 3.6

Definition at line 1265 of file utext.h.

UTextMapNativeIndexToUTF16* UTextFuncs::mapNativeIndexToUTF16

(public) Function pointer for UTextMapNativeIndexToUTF16.

See also
  UTextMapNativeIndexToUTF16

Stable:
  ICU 3.6

Definition at line 1297 of file utext.h.

UTextMapOffsetToNative* UTextFuncs::mapOffsetToNative

(public) Function pointer for UTextMapOffsetToNative.

See also
  UTextMapOffsetToNative

Stable:
  ICU 3.6

Definition at line 1289 of file utext.h.

UTextNativeLength* UTextFuncs::nativeLength

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

See also
  UTextLength

Stable:
  ICU 3.6

Definition at line 1249 of file utext.h.

UTextReplace* UTextFuncs::replace

(public) Function pointer for UTextReplace.

See also
  UTextReplace

Stable:
  ICU 3.6

Definition at line 1273 of file utext.h.

int32_t UTextFuncs::reserved1

(private) Alignment padding.

Do not use, reserved for use by the UText framework only.

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

Definition at line 1231 of file utext.h.

int32_t UTextFuncs::reserved2

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

Definition at line 1231 of file utext.h.

int32_t UTextFuncs::reserved3

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

Definition at line 1231 of file utext.h.

UTextClose* UTextFuncs::spare1

(private) Spare function pointer

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

Definition at line 1311 of file utext.h.

UTextClose* UTextFuncs::spare2

(private) Spare function pointer

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

Definition at line 1317 of file utext.h.

UTextClose* UTextFuncs::spare3

(private) Spare function pointer

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

Definition at line 1323 of file utext.h.

int32_t UTextFuncs::tableSize

(public) Function table size, sizeof(UTextFuncs) Intended for use should the table grow to accomodate added functions in the future, to allow tests for older format function tables that do not contain the extensions.

Fields are placed for optimal alignment on 32/64/128-bit-pointer machines, by normally grouping together 4 32-bit fields, 4 pointers, 2 64-bit fields in sequence.

Stable:
  ICU 3.6

Definition at line 1224 of file utext.h.

The documentation for this struct was generated from the following file:

- utext.h