Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Header Files   Compound Members   File Members  

BiDi Class Reference

BiDi is a C++ wrapper class for UBiDi. More...

#include <bidi.h>

List of all members.


Public Members

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

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

 BiDi (UTextOffset maxLength, UTextOffset maxRunCount, UErrorCode &rErrorCode)
Preallocating constructor, calls ubidi_openSized(). More...

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

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

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

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

UTextOffset getLength () const
Get the length of the text. More...

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

UBiDiLevel getLevelAt (UTextOffset charIndex) const
Get the level for one character. More...

const UBiDiLevel* getLevels (UErrorCode &rErrorCode)
Get an array of levels for each character. More...

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

UTextOffset countRuns (UErrorCode &rErrorCode)
Get the number of runs. More...

UBiDiDirection getVisualRun (UTextOffset runIndex, UTextOffset &rLogicalStart, UTextOffset &rLength)
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)
Get the visual position from a logical text position. More...

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

void getLogicalMap (UTextOffset *indexMap, UErrorCode &rErrorCode)
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)
Get a visual-to-logical index map (array) for the characters in the UBiDi (paragraph or line) object. More...


Static Public Members

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

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

void invertMap (const UTextOffset *srcMap, UTextOffset *destMap, UTextOffset length)
Same as ubidi_invertMap(). More...


Protected Members

UBiDipBiDi


Detailed Description

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

Member Function Documentation

BiDi::BiDi () [inline]

Default constructor, calls ubidi_open().

Stable:

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

Constructor, calls ubidi_open().

Stable:

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

Preallocating constructor, calls ubidi_openSized().

Stable:

BiDi::~BiDi () [inline]

Destructor, calls ubidi_close().

Stable:

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

Set this object for one paragraph's text.

Stable:

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

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

Stable:

UBiDiDirection BiDi::getDirection () const [inline]

Get the directionality of the text.

Stable:

UTextOffset BiDi::getLength () const [inline]

Get the length of the text.

Stable:

UBiDiLevel BiDi::getParaLevel () const [inline]

Get the paragraph level of the text.

Stable:

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

Get the level for one character.

Stable:

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

Get an array of levels for each character.

Stable:

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

Get a logical run.

Stable:

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

Get the number of runs.

Stable:

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

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

Stable:

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

Get the visual position from a logical text position.

Stable:

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

Get the logical text position from a visual position.

Stable:

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

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

Stable:

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

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

Stable:

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

Same as ubidi_reorderLogical().

Stable:

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

Same as ubidi_reorderVisual().

Stable:

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

Same as ubidi_invertMap().

Stable:

Member Data Documentation

UBiDi* BiDi::pBiDi [protected]


The documentation for this class was generated from the following file:
Generated at Thu Feb 10 15:30:23 2000 for icu by doxygen 1.0.0 written by Dimitri van Heesch, © 1997-1999