TextElement::SetElementSize

Sets the size of a text element's render box.

Prototype

void SetElementSize(float width, float height);

Parameters

`width`	The width of the text box. This can be 0.0.
`height`	The height of the text box. This can be 0.0.

Description

The SetElementSize function sets the size of a text element's render box. The text box is used in different ways depending on the value of the text flags (see TextElement::SetTextFlags).

If the kTextWrapped flag is set, then the width of the text box determines the maximum width of each rendered line. The width also determines how right- and center-aligned text is positioned. The height os the text box is not used for anything other than the background size for an editable text element. Multi-line text elements are bottomless unless the rendered line count is set using the TextElement::SetRenderLineCount function.

If the kTextWrapped flag is not set, then text is always rendered on a single line. If the kTextClipped flag is set, then the text is clipped against the left and right edges of the text box. Otherwise, the width of the text box only affects alignment positioning. If the text box has a width of 0.0 (the default), then the left end, right end, or center of the text will coincide with the text element's local origin.