SetTextCelFormatFlags

Sets text formatting flags.

Synopsis

void SetTextCelFormatFlags (TextCel *tCel, uint32 formatFlags)

Description

Sets text formatting options used for subsequent rendering.

The formatFlags parameter contains one or more formatting options, ORed together. Available options are:

TC_FORMAT_LEFT_JUSTIFY-left-justify text

TC_FORMAT_RIGHT_JUSTIFY-right-justify text

TC_FORMAT_CENTER_JUSTIFY-center-justify text

TC_FORMAT_WORDWRAP-auto-word-wrap text

Changing the formatting options does not affect pixels already in the cel. You can make a series of calls to UpdateTextInCel() with the replaceExisting flag set to FALSE, intermixed with calls to SetTextCelFormatFlags(). This allows you to create, for example, a paragraph of word-wrapped text, followed by a line of centered text, followed by another word-wrapped paragraph. Turning word wrap on and off at locations other than a paragraph boundary might produce undesirable results. Word wrapping should only be changed immediately following a newline.

Arguments

tCel
Pointer to a TextCel structure.
formatFlags
New formatting options.

Associated Files

lib3do.lib, textlib.h