User manual

ScanVue5® Mini Kiosk
User Manual
M37574–01T
Industrial Electronic Engineers, Inc.
23-June-2008 RevT Page 92
Appendix H—Expanded Text API
With the standard text API, only one font size with a single foreground and background
color can be displayed at a time. To support different fonts and colors on the screen at
the same time, usually done within defined window areas (known as text boxes), an
expanded text API is provided so that multiple text boxes can be defined, positioned and
displayed with each text box having its own character property controls (font style, size
and colors).
Up to eight (8) text boxes can be placed on the screen similtaneously including the
default text box defined in the INI file. Each different font style used must be in a new
text box, but each character within a single text box can have a different foreground and
background color selected from the 256 colors available on the color palette. Any text
box may be defined as “transparent” in which the text in that box will appear to float on
top of the screen image or wallpaper with no visible text box background color. The
whole text box is transparent not just individual characters.
API Notation
Items in braces { and } are optional. If not explicitly specified, the last value used for that
item (the default value) is used. Items in angle brackets < and > are parameter values
and are described in the text following.
Defining a Text Box
The following section describes how to define a text box. Up to 8 different text boxes can
be defined. Once a text box is defined, it retains its properties until the unit is powered
down or it is changed by another text message to that box even if its no longer being
displayed.
Except for the default text box in the .INI file, text boxes are created at run-time by an
escape sequence. A text box can be changed at any time, which deletes the old box
and creates a new one. A text box can contain many different colors but only a single
font. If the text box is set to transparent, the whole text box not individual characters
within that text box are transparent. Text boxes are identified by an ID # from 0-7.
Text boxes can be created with either trivial or nominal mode packets. Currently, no
error reporting is provided.
<ESC>[D<ID>;<Fc>;{<FONT>};{<Fg>}{,<Bg>};{<Cr>}{,<Cc>};{<Ph>}{,<Pv>};{<TO>};
where:
<ID> Text Box ID #, ASCII 0-7. 0 is the .INI default text box
<Fc> Control Function—2 decimal digits, 0-9
00 = mixed text (text over an image)
01 = transparent text
02 = exclusive text