LAnnAutomation::EnumTextTokenTableCallBack

#include "ltwrappr.h"

virtual L_INT LAnnAutomation::EnumTextTokenTableCallBack(nTextTokenCount, nIndex, pTextToken)

L_INT nTextTokenCount;

/* total number of tokens in the text token table */

L_INT nIndex;

/* index of the text token */

pANNTEXTTOKEN pTextToken;

/* pointer to a structure that defines the text token */

Processes each text token in the annotation text token table from the LAnnAutomation::EnumerateTextTokenTable function. This function is called zero or more times as a result of a call to LAnnAutomation::EnumerateTextTokenTable.

Parameter

Description

nTextTokenCount

Total number of tokens in the text token table.

nIndex

Index of the particular token. The index is zero-based.

pTextToken

A pointer to an ANNTEXTTOKENstructure that defines the the text token. For more information, see the documentation for the ANNTEXTTOKEN structure.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

The LAnnAutomation::EnumerateTextTokenTable function calls the LAnnAutomation::EnumTextTokenTableCallBack function for each token in the annotation text token table. For example, suppose there are four entries in the text token table. A call to LAnnAutomation::EnumerateTextTokenTable() will call your overridden call back LAnnAutomation::EnumTextTokenTableCallBack function four timesonce for each token. For each of the four calls, nTextTokenCount will be 4. Since nIndex is zero-based, nIndex will be 0 in the first call to your callback function, and 3 in the last call to your callback function.

To enable this call back function you must call LBase::EnableCallBack before calling LAnnAutomation::EnumerateTextTokenTable function.

Required DLLs and Libraries

LTANN

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

See Also

Functions:

Class Members

Topics:

Annotation Functions: Object Properties

 

Implementing Annotations

 

Automated User Interface for Annotations

 

Annotation Functions: Creating and Deleting Annotations

 

Types of Annotations

 

Annotation Functions: Implementing Custom Annotations

 

Annotation Functions: Creating Custom Annotations

 

Fixed Annotations

 

Minimizing Flicker With Double Buffering

 

Annotation Functions: Working with the Toolbar

Example

For an example, refer to LAnnAutomation::EnumerateTextTokenTable.