BIDICURSOR Class Reference

An extention of BIDISTRING to handle cursor support. More...

#include <bidi.h>

Inheritance diagram for BIDICURSOR:

[legend]List of all members.

Public Member Functions
	BIDICURSOR ()
	BIDICURSOR (const UNICODE *source, DIRECTION DefaultDirection=DIRECTION_LTR)
virtual	~BIDICURSOR ()
UINT32	CursorLeft (UINT32 count)
UINT32	CursorRight (UINT32 count)
DIRECTION	GetCursorDirection () const
ORDER	GetCursorMotion () const
UINT32	GetCursorPosition () const
UINT32	GetCursorPositionVisual () const
ORDER	SetCursorMotion (ORDER CursorMotion)
void	SetCursorPositionVisual (UINT32 pos)

---

Detailed Description

An extention of BIDISTRING to handle cursor support.

This takes a lot more memory than BIDISTRING itself.

Definition at line 258 of file bidi.h.

---

Constructor & Destructor Documentation

BIDICURSOR::BIDICURSOR (   )

BIDICURSOR::BIDICURSOR (  const UNICODE *  source, DIRECTION  DefaultDirection = DIRECTION_LTR )

Construct with initial values. Note, this one doesn't let you specify the string order. The string passed to the constructor must be in logical order.

virtual BIDICURSOR::~BIDICURSOR (   )  [virtual]

---

Member Function Documentation

UINT32 BIDICURSOR::CursorLeft (  UINT32  count  )

Move the cursor to the left. This method moves the cursor to the left in either the logical or visual order depending on the current setting of CursorMotion. It moves the cursor "count" spaces to the left and returns the new offset from the beginning of the logical string.

UINT32 BIDICURSOR::CursorRight (  UINT32  count  )

Move the cursor to the right. This method moves the cursor to the right in either the logical or visual order depending on the current setting of CursorMotion. It moves the cursor "count" spaces to the right and returns the new offset from the beginning of the logical string.

DIRECTION BIDICURSOR::GetCursorDirection (   )  const

Return the direction of the text under the cursor. Returns the direction that the text under the cursor should be read.

ORDER BIDICURSOR::GetCursorMotion (   )  const

Returns the current CursorMotion setting. Logical cursor motion means that moving to the right will step through the data in the order it is in memory, which may or may not be the same as on the screen. Visual motion is what you expect on the screen.

UINT32 BIDICURSOR::GetCursorPosition (   )  const

Get the current cursor position relative to the start of the string in it's logical order. The cursor should be thought of as a box covering the character position returned.

UINT32 BIDICURSOR::GetCursorPositionVisual (   )  const

Get the current cursor position relative to the start of the string in it's visual order. The cursor should be thought of as a box covering the character position returned.

ORDER BIDICURSOR::SetCursorMotion (  ORDER  CursorMotion  )

Set the cursor motion. Returns the previous value

void BIDICURSOR::SetCursorPositionVisual (  UINT32  pos  )

Set the cursor position (visual order, left-most glyph == 0).

---

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

• mi32/bidi.h

---