Index

C/C++ Functions

txTextSetFlowPlus

DT_SWORD txTextSetFlowPlus(DT_TXDOC text_doc, DT_SLONG nr_of_areas, const DT_TX_TEXTFLOW_AREA areas[], const DT_SLONG pages[], DT_SWORD reserved)

Short Description: Set textflow areas for the text document (enhanced)

This function establishes an automatic text flow across linked textflow areas. The flow of text from one area to another is then handled automatically by D-Type Unicode Text Module.

Parameters

ParameterDescription

text_doc

Handle of the associated text document instance.

nr_of_areas

Number of linked textflow areas supplied via the areas array.

areas

An array of DT_TX_TEXTFLOW_AREA structures. Each structure represents one textflow area. The size of this array must be nr_of_areas elements.

pages

The corresponding array of page indexes. This array must be the same in size as the areas array. Each element of the pages array represents the page number that will hold the corresponding textflow area in the areas array.

Alternatively, pages can be set to DV_NULL. This indicates that each texflow area is to be placed on its own page in the text document. The first textflow area (area with index 0) will be placed on the first page (page with index 0), the second textflow area (area with index 1) will be placed on the second page (page with index 1), the third textflow area (area with index 2) will be placed on the third page (page with index 2) etc.

reserved

Reserved for future use. Must be set to 0.

Return Value

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

Comments

A single text document may span multiple textflow areas. The flow of text from one area to another is handled automatically by D-Type Unicode Text Module. Each textflow area can have its own independent position, size, 2D perspective transformation matrix and other parameters as defined by the DT_TX_TEXTFLOW_AREA structure.

This is an optional function because not all types of applications need to use more than a single textflow area and/or more than a single page of text.

 

Index