---

BiDi Class Reference

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

#include <bidi.h>

Public Methods
	BiDi ()
	@memo Default constructor, calls ubidi_open(). More...
	BiDi (UErrorCode &rErrorCode)
	@memo Constructor, calls ubidi_open(). More...
	BiDi (UTextOffset maxLength, UTextOffset 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, UTextOffset length, UBiDiLevel paraLevel, UBiDiLevel *embeddingLevels, UErrorCode &rErrorCode)
	@memo Set this object for one paragraph's text. More...
BiDi &	setLine (const BiDi &rParaBiDi, UTextOffset start, UTextOffset 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...
UTextOffset	getLength () const
	@memo Get the length of the text. More...
UBiDiLevel	getParaLevel () const
	@memo Get the paragraph level of the text. More...
UBiDiLevel	getLevelAt (UTextOffset charIndex) const
	@memo Get the level for one character. More...
const UBiDiLevel *	getLevels (UErrorCode &rErrorCode)
	@memo Get an array of levels for each character. More...
void	getLogicalRun (UTextOffset logicalStart, UTextOffset &rLogicalLimit, UBiDiLevel &rLevel) const
	@memo Get a logical run. More...
UTextOffset	countRuns (UErrorCode &rErrorCode)
	@memo Get the number of runs. More...
UBiDiDirection	getVisualRun (UTextOffset runIndex, UTextOffset &rLogicalStart, UTextOffset &rLength)
	@memo Get one run's logical start, length, and directionality, which can be 0 for LTR or 1 for RTL. More...
UTextOffset	getVisualIndex (UTextOffset logicalIndex, UErrorCode &rErrorCode)
	@memo Get the visual position from a logical text position. More...
UTextOffset	getLogicalIndex (UTextOffset visualIndex, UErrorCode &rErrorCode)
	@memo Get the logical text position from a visual position. More...
void	getLogicalMap (UTextOffset *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 (UTextOffset *indexMap, UErrorCode &rErrorCode)
	@memo Get a visual-to-logical index map (array) for the characters in the UBiDi (paragraph or line) object. More...
UTextOffset	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...
Static Public Methods
void	reorderLogical (const UBiDiLevel *levels, UTextOffset length, UTextOffset *indexMap)
	@memo Same as ubidi_reorderLogical(). More...
void	reorderVisual (const UBiDiLevel *levels, UTextOffset length, UTextOffset *indexMap)
	@memo Same as ubidi_reorderVisual(). More...
void	invertMap (const UTextOffset *srcMap, UTextOffset *destMap, UTextOffset length)
	@memo Same as ubidi_invertMap(). More...
UTextOffset	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...
Protected Attributes
UBiDi *	pBiDi

---

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.

---

Constructor & Destructor Documentation

BiDi::BiDi (    )  [inline]

@memo Default constructor, calls ubidi_open(). Deprecated:

BiDi::BiDi (  UErrorCode &    rErrorCode )  [inline]

@memo Constructor, calls ubidi_open(). Deprecated:

BiDi::BiDi (  UTextOffset    maxLength, UTextOffset    maxRunCount, UErrorCode &    rErrorCode )  [inline]

@memo Preallocating constructor, calls ubidi_openSized(). Deprecated:

BiDi::~BiDi (    )  [inline]

@memo Destructor, calls ubidi_close(). Deprecated:

---

Member Function Documentation

UTextOffset BiDi::countRuns (  UErrorCode &    rErrorCode )  [inline]

@memo Get the number of runs. Deprecated:

UBiDiDirection BiDi::getDirection (    )  const [inline]

@memo Get the directionality of the text. Deprecated:

UTextOffset BiDi::getLength (    )  const [inline]

@memo Get the length of the text. Deprecated:

UBiDiLevel BiDi::getLevelAt (  UTextOffset    charIndex )  const [inline]

@memo Get the level for one character. Deprecated:

const UBiDiLevel * BiDi::getLevels (  UErrorCode &    rErrorCode )  [inline]

@memo Get an array of levels for each character. Deprecated:

UTextOffset BiDi::getLogicalIndex (  UTextOffset    visualIndex, UErrorCode &    rErrorCode )  [inline]

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

void BiDi::getLogicalMap (  UTextOffset *    indexMap, UErrorCode &    rErrorCode )  [inline]

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

void BiDi::getLogicalRun (  UTextOffset    logicalStart, UTextOffset &    rLogicalLimit, UBiDiLevel &    rLevel )  const [inline]

@memo Get a logical run. Deprecated:

UBiDiLevel BiDi::getParaLevel (    )  const [inline]

@memo Get the paragraph level of the text. Deprecated:

const UChar * BiDi::getText (    )  const [inline]

@memo Get the pointer to the text. Deprecated:

UTextOffset BiDi::getVisualIndex (  UTextOffset    logicalIndex, UErrorCode &    rErrorCode )  [inline]

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

void BiDi::getVisualMap (  UTextOffset *    indexMap, UErrorCode &    rErrorCode )  [inline]

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

UBiDiDirection BiDi::getVisualRun (  UTextOffset    runIndex, UTextOffset &    rLogicalStart, UTextOffset &    rLength )  [inline]

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

void BiDi::invertMap (  const UTextOffset *    srcMap, UTextOffset *    destMap, UTextOffset    length )  [inline, static]

@memo Same as ubidi_invertMap(). Deprecated:

UBool BiDi::isInverse (    )  [inline]

Is this BiDi object set to perform the inverse BiDi algorithm? See also: setInverse Deprecated:

void BiDi::reorderLogical (  const UBiDiLevel *    levels, UTextOffset    length, UTextOffset *    indexMap )  [inline, static]

@memo Same as ubidi_reorderLogical(). Deprecated:

void BiDi::reorderVisual (  const UBiDiLevel *    levels, UTextOffset    length, UTextOffset *    indexMap )  [inline, static]

@memo Same as ubidi_reorderVisual(). Deprecated:

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:

BiDi & BiDi::setLine (  const BiDi &    rParaBiDi, UTextOffset    start, UTextOffset    limit, UErrorCode &    rErrorCode )  [inline]

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

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

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

UTextOffset 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:

UTextOffset 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:

---

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

• bidi.h

---