DL Logo

PDWord Functions

PDWordGetCharPoint

Header: DLExtrasProcs.h:106

Description

Gets the placement point of the character at a given index position in the word. If the specified character is constructed with multiple bytes, only the first byte returns a valid quad. Otherwise, this method returns false. The placement point is specified in user space coordinates.

Related Methods

Syntax

ASBool PDWordGetCharPoint(PDWord word, ASInt16 byteIdx, ASFixedPoint *point);

Parameters

word
The word whose character placement point is obtained.
byteIdx
The byte index within the word of the character whose placement point is obtained. Valid values are 0 to PDWordGetLength(word)-1.
point
(Filled by the method) Pointer to the character's placement point, specified in user-space coordinates.

Returns

Returns true if the word has an nth quad, false otherwise.

PDWordGetNthQuadPoint

Header: DLExtrasProcs.h:86

Description

Gets the specified word's nth quad placement point, specified in user space coordinates.

Related Methods

Syntax

ASBool PDWordGetNthQuadPoint(PDWord word, ASInt16 nTh, ASFixedPoint *point);

Parameters

word
The word whose nth quad is obtained.
nTh
The quad placement point to obtain. A word's first quad has an index of zero.
point
(Filled by the method) Pointer to the word's nth quad placement point, specified in user-space coordinates.

Returns

Returns true if the word has an nth quad, false otherwise.

PDWordIsLastWordInRegion

Header: DLExtrasProcs.h:116

Description

Routine to check if a word is the last word in a region as determined by the WordFinder.

Syntax

ASBool PDWordIsLastWordInRegion(PDWord word);

Parameters

word
The word to check.

Returns

Returns true if the given PDWord is the last word in a region, false otherwise.