TextWidget::SetRenderLineCount

Defined in: C4Widgets.h

Sets the number of lines rendered in a text box.

Prototype

void SetRenderLineCount(int32 count);

Parameters

count The maximum number of lines to render.

Description

The SetRenderLineCount function sets the number of lines rendered in a text box. This line count is only considered when the kTextMultipleLines flag is set (see TextWidget::SetTextFlags). If the count parameter is 0 (the default), then there is no limit to the number of lines rendered.

The index of the first line is set using the TextWidget::SetFirstRenderLine function. Beginning with this line, at most count lines are rendered. Line breaks are determined by wrapping text within the width of the text box specified upon construction or by using the Widget::SetWidgetSize function.