nw::font::TextWriterBase::SetWidthLimit Member Function

Syntax

void SetWidthLimit(
     f32 limit
);

Arguments

Name Description
in limit The width to wrap automatically.

Return Values

None.

Description

Specifies the width to wrap automatically.

By default, the automatic wrapping feature is disabled. Specifying a valid wrap width will enable the automatic wrapping feature.

To prevent strings from exceeding the specified width, the automatic wrapping feature breaks lines. The automatic wrapping feature will affect each member function of "Calculating the Rendered Size of the Text" and "Text Rendering."

At each point where automatic wrapping should occur, it makes an internal request to TagProcessor for code = '\n' processing. Consequently, the TagProcessor configured in TextWriter must process code = '\n' as a line break.

See Also

nw::font::TextWriter::GetWidthLimit
nw::font::TextWriter::ResetWidthLimit

Revision History

2009/11/09
Initial version.

CONFIDENTIAL