Index

C/C++ Functions

txTextRefresh

DT_SWORD txTextRefresh(DT_TXDOC text_doc, DT_SLONG area_index)

Short Description: Refresh state

This function refreshes the state of the associated text document instance.

Parameters

ParameterDescription

text_doc

Handle of the associated text document instance.

area_index

The index of the textflow area to refresh. Set to -1 to refresh all textflow areas in the specified text document.

Return Value

If the function was successful, the return value is 1. Otherwise, the function returns 0.

Comments

A call to this function tells D-Type Unicode Text Module that the entire visible screen area is about to be repainted, due to some important change made to the current state of the text document. This will cause D-Type Unicode Text Module to clear any device specific metrics cached during previous calls to txTextDraw so that subsequent text selection actions (e.g. cursor movement and/or selection highlighting) can be performed correctly.

The following are situations when it is necessary to repaint the entire visible screen area and call the txTextRefresh function:

The following are situations when it is not necessary to repaint the entire visible screen area and call the txTextRefresh function:

Note 1

In the future this function may become obsolete. It is expected that D-Type Unicode Text Module will automatically take care of clearing device specific metrics. Until then, the txTextRefresh function must be called manually.

 

Index