Roku Object Reference - imaginArt

oTextField ()
A text field represents an area of the screen that can contain arbitrary text. This feature is intended for
presenting diagnostic and usage information rather than for generating a user interface. The roTextField
object implements the ifTextField and ifStreamSend interfaces.
The object is created with several parameters:
• CreateObject("roTextField", xpos As Integer, ypos As Integer,
width_in_chars As Integer, height_in_chars As Integer, metadata As
Object)
o xpos = Horizontal coordinate for the top left of the text field.
o ypos = Vertical coordinate for the top left of the text field. The top of the screen is zero.
o width_in_chars = Width of the text field in character cells.
o
o
height_in_chars = Height of the text field in character cells.
metadata = Optionally a roAssociativeArray containing extra parameters for the text field. If
you don't require this then pass zero.
Note that in TV modes a border around the screen may not be displayed due to overscanning. You may
want to use the roVideoMode object’s GetSafeX and GetSafeY functions to ensure that the coordinates you
use will be visible.
The metadata object supports the following extra parameters:
o "CharWidth" the width of each character cell in pixels.
o "CharHeight" the height of each character cell in pixels.
o "BackgroundColor" the background color of the text field as an integer specifying eight bits for each of
red, green and blue in the form &Hrrggbb.
o "TextColor" the color of the text as an integer specifying eight bits for each of red, green and blue in
the form &Hrrggbb.
o "Size" an alternative to "CharWidth" and "CharHeight" for specifying either normal size text (0) or
double-sized text (1).
The ifTextField interface provides:
o Cls() As Void
o Clear the text field.
o GetWidth() As Integer
o Return the width of the text field.
o GetHeight() As Integer
o Return the height of the text field.
o SetCursorPos(x As Integer, As Integer) As Void
o Move the cursor to the specified position. Subsequent output will appear at this position.
o GetValue() As Integer
o Return the value of the character currently under the cursor.
The ifStreamSend interface provides (note – the ifStreamSend interface is also described in the section
documenting the various Roku file objects – the interface is described again below in a manner more
specific to the roTextField object):
o SendByte(byte As Integer) As Void
o Write the character indicated by the specified number at the current cursor position within the
text field and advance the cursor.
o SendLine(string As String) As Void
o Write the characters specified at the current cursor position followed by the end of line
sequence.
o SendBlock(string As String) As Void
40