Roku Object Reference - imaginArt

oTextWidget ()
An object used for putting text on the screen.
Object creation:
• CreateObject("roTextWidget", r As roRectangle, line_count As
Integer, text_mode As Integer, pause_time As Integer)
o r – roRectangle that contains the text
o line_count – the number of lines of text to show in the rectangle
o text_mode – 0 for an animated ‘teletype’ like view or 1 for static text.
o pause_time – how long each string is displayed prior to displaying the next string
• CreateObject("roTextWidget", r As roRectangle, line_count As
Integer, text_mode As Integer, array As roAssociativeArray)
o r – roRectangle that contains the text
o line_count – the number of lines of text to show in the rectangle
o
o
text_mode – 0 for an animated ‘teletype’ like view or 1 for static text.
array is an associative array that can include the following values
• “LineCount” – the number of lines of text to show in the rectangle
• “TextMode” - 0 for an animated ‘teletype’ like view or 1 for static text.
• “PauseTime” - how long each string is displayed prior to displaying the next string
• “Rotation” – the rotation of the text in the widget, 0 degrees (0), 90 degrees (1), 180
degrees (2), 270 degrees (3)
• “Alignment” – the alignment of the text. Left (0), center (1), or right(2)
The object includes the following interfaces:
• PushString(str As String) As Boolean
o The string is added to the list of strings to display. Strings are displayed in order and when the
end is reached it loops.
• PopStrings(number_of_string_to_pop As Integer) As Boolean
o Pops strings off the front of the list (last in first out). The popping is done the next time the
widget wraps so that strings can be added and removed seamlessly to the widget.
• GetStringCount() As Integer
o Returns the number of strings that will exist once any pending pops have taken place.
• Clear() As Boolean
o Clears the list of strings leaving the widget blank and ready for more PushString() calls.
This object also uses the ifWidget interface which provides:
• SetForegroundColor(color As Integer) As Boolean
• SetBackgroundColor(color As Integer) As Boolean
o color is in ARGB format.
• SetFont(font_filename As String) As Boolean
o font_filename is a TrueType font, for example: CF:/Ariel.ttf
• SetBackgroundBitmap(background_bitmap_filename As String, stretch As
Boolean) As Boolean
o If stretch is true, the image is stretched to the size of the window.
• SetSafeTextRegion(rect As roRectangle) As Boolean
o rect specifies the rectangle within the widget where the text can be drawn safely.
• Show() As Boolean
o Displays the widget – after creation, the widget is hidden until Show() is called.
• Hide() As Boolean
o Hides the widget.
44