Fantasy Grounds :: The Virtual Tabletop for Pen & Paper Roleplaying Games

Inherits	widget
Context	widgetcontainer

A text widget is a specialized version of widget.

Text widgets contain a text string, rendered in the given font. The size of the widget will vary based on the text content, and can be limited to a maximum width.

Interface

getText

function getText( )

Retrieve the text string displayed in the widget.

Return values

(string)

Returns the text displayed in the widget

setFont

function setFont( name )

Sets the font resource used for rendering the text in the widget.

Parameters

name (string)

The name of the font resource

setMaxWidth

function setMaxWidth( width )

Set the maximum width of the widget. If the maximum width is set and the text contained in the widget is longer than allowed, an ellipsis ('...') will be placed at the end of the displayed string.

Parameters

width (number)

The maximum width of the widget in pixels. To disable the maximum width setting, set the value to 0.

setText

function setText( text )

Set the text string displayed in the widget.

Parameters

text (string)

Text displayed in the widget