Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Search  

BiDi Class Reference

This class is deprecated and will be removed. More...

#include <bidi.h>

Inheritance diagram for BiDi::

UObject List of all members.

Public Methods

 BiDi ()
 @memo Default constructor, calls ubidi_open(). More...

 BiDi (UErrorCode &rErrorCode)
 @memo Constructor, calls ubidi_open(). More...

 BiDi (int32_t maxLength, int32_t maxRunCount, UErrorCode &rErrorCode)
 @memo Preallocating constructor, calls ubidi_openSized(). More...

 ~BiDi ()
 @memo Destructor, calls ubidi_close(). More...

void setInverse (UBool isInverse)
 Modify the operation of the BiDi algorithm such that it approximates an "inverse BiDi" algorithm. More...

UBool isInverse ()
 Is this BiDi object set to perform the inverse BiDi algorithm? More...

BiDi & setPara (const UChar *text, int32_t length, UBiDiLevel paraLevel, UBiDiLevel *embeddingLevels, UErrorCode &rErrorCode)
 @memo Set this object for one paragraph's text. More...

BiDi & setLine (const BiDi &rParaBiDi, int32_t start, int32_t limit, UErrorCode &rErrorCode)
 @memo Set this object for one line of the paragraph object's text. More...

UBiDiDirection getDirection () const
 @memo Get the directionality of the text. More...

const UChar * getText () const
 @memo Get the pointer to the text. More...

int32_t getLength () const
 @memo Get the length of the text. More...

UBiDiLevel getParaLevel () const
 @memo Get the paragraph level of the text. More...

UBiDiLevel getLevelAt (int32_t charIndex) const
 @memo Get the level for one character. More...

const UBiDiLevelgetLevels (UErrorCode &rErrorCode)
 @memo Get an array of levels for each character. More...

void getLogicalRun (int32_t logicalStart, int32_t &rLogicalLimit, UBiDiLevel &rLevel) const
 @memo Get a logical run. More...

int32_t countRuns (UErrorCode &rErrorCode)
 @memo Get the number of runs. More...

UBiDiDirection getVisualRun (int32_t runIndex, int32_t &rLogicalStart, int32_t &rLength)
 @memo Get one run's logical start, length, and directionality, which can be 0 for LTR or 1 for RTL. More...

int32_t getVisualIndex (int32_t logicalIndex, UErrorCode &rErrorCode)
 @memo Get the visual position from a logical text position. More...

int32_t getLogicalIndex (int32_t visualIndex, UErrorCode &rErrorCode)
 @memo Get the logical text position from a visual position. More...

void getLogicalMap (int32_t *indexMap, UErrorCode &rErrorCode)
 @memo Get a logical-to-visual index map (array) for the characters in the UBiDi (paragraph or line) object. More...

void getVisualMap (int32_t *indexMap, UErrorCode &rErrorCode)
 @memo Get a visual-to-logical index map (array) for the characters in the UBiDi (paragraph or line) object. More...

int32_t writeReordered (UChar *dest, int32_t destSize, uint16_t options, UErrorCode &rErrorCode)
 Use the BiDi object containing the reordering information for one paragraph or line of text as set by setPara() or setLine() and write a reordered string to the destination buffer. More...

virtual UClassID getDynamicClassID () const
 ICU "poor man's RTTI", returns a UClassID for the actual class. More...


Static Public Methods

void reorderLogical (const UBiDiLevel *levels, int32_t length, int32_t *indexMap)
 @memo Same as ubidi_reorderLogical(). More...

void reorderVisual (const UBiDiLevel *levels, int32_t length, int32_t *indexMap)
 @memo Same as ubidi_reorderVisual(). More...

void invertMap (const int32_t *srcMap, int32_t *destMap, int32_t length)
 @memo Same as ubidi_invertMap(). More...

int32_t writeReverse (const UChar *src, int32_t srcLength, UChar *dest, int32_t destSize, uint16_t options, UErrorCode &rErrorCode)
 Reverse a Right-To-Left run of Unicode text. More...

UClassID getStaticClassID ()
 ICU "poor man's RTTI", returns a UClassID for this class. More...


Protected Attributes

UBiDipBiDi

Static Private Attributes

const char fgClassID
 The address of this static class variable serves as this class's ID for ICU "poor man's RTTI". More...


Detailed Description

This class is deprecated and will be removed.

Use the C API with the UBiDi type and ubidi_... functions. The BiDi class was just a pure 1:1 wrapper for the ubidi_ API.

Old documentation:

BiDi is a C++ wrapper class for UBiDi. You need one BiDi object in place of one UBiDi object. For details on the API and implementation of the Unicode BiDi algorithm, see ubidi.h.

See also:
UBiDi
Deprecated:
To be removed after 2002-sep-30; use the C API with UBiDi and ubidi_... functions.

Definition at line 44 of file bidi.h.


Constructor & Destructor Documentation

BiDi::BiDi   [inline]
 

@memo Default constructor, calls ubidi_open().

Deprecated:

Definition at line 263 of file bidi.h.

BiDi::BiDi UErrorCode   rErrorCode [inline]
 

@memo Constructor, calls ubidi_open().

Deprecated:

Definition at line 267 of file bidi.h.

BiDi::BiDi int32_t    maxLength,
int32_t    maxRunCount,
UErrorCode   rErrorCode
[inline]
 

@memo Preallocating constructor, calls ubidi_openSized().

Deprecated:

Definition at line 278 of file bidi.h.

BiDi::~BiDi   [inline]
 

@memo Destructor, calls ubidi_close().

Deprecated:

Definition at line 282 of file bidi.h.


Member Function Documentation

int32_t BiDi::countRuns UErrorCode   rErrorCode [inline]
 

@memo Get the number of runs.

Deprecated:

Definition at line 351 of file bidi.h.

UBiDiDirection BiDi::getDirection   const [inline]
 

@memo Get the directionality of the text.

Deprecated:

Definition at line 315 of file bidi.h.

virtual UClassID BiDi::getDynamicClassID void    const [inline, virtual]
 

ICU "poor man's RTTI", returns a UClassID for the actual class.

Draft:
This API has been introduced in ICU 2.2. It is still in draft state and may be modified in a future release.

Reimplemented from UObject.

Definition at line 240 of file bidi.h.

int32_t BiDi::getLength   const [inline]
 

@memo Get the length of the text.

Deprecated:

Definition at line 325 of file bidi.h.

UBiDiLevel BiDi::getLevelAt int32_t    charIndex const [inline]
 

@memo Get the level for one character.

Deprecated:

Definition at line 335 of file bidi.h.

const UBiDiLevel * BiDi::getLevels UErrorCode   rErrorCode [inline]
 

@memo Get an array of levels for each character.

Deprecated:

Definition at line 340 of file bidi.h.

int32_t BiDi::getLogicalIndex int32_t    visualIndex,
UErrorCode   rErrorCode
[inline]
 

@memo Get the logical text position from a visual position.

Deprecated:

Definition at line 366 of file bidi.h.

void BiDi::getLogicalMap int32_t   indexMap,
UErrorCode   rErrorCode
[inline]
 

@memo Get a logical-to-visual index map (array) for the characters in the UBiDi (paragraph or line) object.

Deprecated:

Definition at line 371 of file bidi.h.

void BiDi::getLogicalRun int32_t    logicalStart,
int32_t   rLogicalLimit,
UBiDiLevel   rLevel
const [inline]
 

@memo Get a logical run.

Deprecated:

Definition at line 345 of file bidi.h.

UBiDiLevel BiDi::getParaLevel   const [inline]
 

@memo Get the paragraph level of the text.

Deprecated:

Definition at line 330 of file bidi.h.

UClassID BiDi::getStaticClassID   [inline, static]
 

ICU "poor man's RTTI", returns a UClassID for this class.

Draft:
This API has been introduced in ICU 2.2. It is still in draft state and may be modified in a future release.

Definition at line 247 of file bidi.h.

const UChar * BiDi::getText   const [inline]
 

@memo Get the pointer to the text.

Deprecated:

Definition at line 320 of file bidi.h.

int32_t BiDi::getVisualIndex int32_t    logicalIndex,
UErrorCode   rErrorCode
[inline]
 

@memo Get the visual position from a logical text position.

Deprecated:

Definition at line 361 of file bidi.h.

void BiDi::getVisualMap int32_t   indexMap,
UErrorCode   rErrorCode
[inline]
 

@memo Get a visual-to-logical index map (array) for the characters in the UBiDi (paragraph or line) object.

Deprecated:

Definition at line 376 of file bidi.h.

UBiDiDirection BiDi::getVisualRun int32_t    runIndex,
int32_t   rLogicalStart,
int32_t   rLength
[inline]
 

@memo Get one run's logical start, length, and directionality, which can be 0 for LTR or 1 for RTL.

Deprecated:

Definition at line 356 of file bidi.h.

void BiDi::invertMap const int32_t   srcMap,
int32_t   destMap,
int32_t    length
[inline, static]
 

@memo Same as ubidi_invertMap().

Deprecated:

Definition at line 391 of file bidi.h.

UBool BiDi::isInverse   [inline]
 

Is this BiDi object set to perform the inverse BiDi algorithm?

See also:
setInverse
Deprecated:

Definition at line 293 of file bidi.h.

void BiDi::reorderLogical const UBiDiLevel   levels,
int32_t    length,
int32_t   indexMap
[inline, static]
 

@memo Same as ubidi_reorderLogical().

Deprecated:

Definition at line 381 of file bidi.h.

void BiDi::reorderVisual const UBiDiLevel   levels,
int32_t    length,
int32_t   indexMap
[inline, static]
 

@memo Same as ubidi_reorderVisual().

Deprecated:

Definition at line 386 of file bidi.h.

void BiDi::setInverse UBool    isInverse [inline]
 

Modify the operation of the BiDi algorithm such that it approximates an "inverse BiDi" algorithm.

This function must be called before setPara().

Parameters:
isInverse  specifies "forward" or "inverse" BiDi operation
See also:
setPara , writeReordered
Deprecated:

Definition at line 288 of file bidi.h.

BiDi & BiDi::setLine const BiDi &    rParaBiDi,
int32_t    start,
int32_t    limit,
UErrorCode   rErrorCode
[inline]
 

@memo Set this object for one line of the paragraph object's text.

Deprecated:

Definition at line 307 of file bidi.h.

BiDi & BiDi::setPara const UChar *    text,
int32_t    length,
UBiDiLevel    paraLevel,
UBiDiLevel   embeddingLevels,
UErrorCode   rErrorCode
[inline]
 

@memo Set this object for one paragraph's text.

Deprecated:

Definition at line 298 of file bidi.h.

int32_t BiDi::writeReordered UChar *    dest,
int32_t    destSize,
uint16_t    options,
UErrorCode   rErrorCode
[inline]
 

Use the BiDi object containing the reordering information for one paragraph or line of text as set by setPara() or setLine() and write a reordered string to the destination buffer.

See also:
ubidi_writeReordered
Deprecated:

Definition at line 396 of file bidi.h.

int32_t BiDi::writeReverse const UChar *    src,
int32_t    srcLength,
UChar *    dest,
int32_t    destSize,
uint16_t    options,
UErrorCode   rErrorCode
[inline, static]
 

Reverse a Right-To-Left run of Unicode text.

See also:
ubidi_writeReverse
Deprecated:

Definition at line 403 of file bidi.h.


Member Data Documentation

const char BiDi::fgClassID [static, private]
 

The address of this static class variable serves as this class's ID for ICU "poor man's RTTI".

Definition at line 258 of file bidi.h.

UBiDi* BiDi::pBiDi [protected]
 

Definition at line 250 of file bidi.h.

Referenced by setLine().


The documentation for this class was generated from the following file:
Generated on Thu Aug 15 14:13:51 2002 for ICU 2.2 by doxygen1.2.11.1 written by Dimitri van Heesch, © 1997-2001