SHIP:Node:display

From Serious Documentation
Jump to: navigation, search

Node Home

Node Type Description
display Contains the visual GUI layout for a specific LCD display/touch set.

The display node in the Layout Area within a SHIP GUI contains the visual GUI layout for a specific LCD display/touch set. Future SHIP versions support multiple display/touch sets within one SHIP environment: each display node encompasses one set. If the SIM or hardware platform supports multiple display/touch sets, there will be multiple display nodes under the layout node.

The names of the display nodes are traditionally d0, d1, etc., but this is not mandated. The name can be set to any valid name, such as mainDisplay, or dMain for example.

Ancestors

The following nodes are permitted to have displays as descendants:

Node Type Description
layout Top of the Layout Area within a SHIP GUI, which completely describes how the GUI is visually organized.

display nodes are permitted only directly underneath these nodes.

Descendants

The following nodes are permitted within displays:

Node Type Description
box A generic rectangular container, available as a reusable resource or layout element.
constant Defines a constant value for use in SHIPTide properties or SAIL scripts.
file
group Lightweight node that encloses other nodes for pure organizational benefit, or to create an array of nodes.
listener Monitors one or more properties (including variable values!) for changes, and on changes invokes a script.
page Visual layout area for a specific GUI "page", or "screen"
script Run-time algorithms, written in SHIPSail.
text Defines a text resource or a visual text representation.
timer Generates delays and timed alarm events.
variable Run-time value accessible by scripts and able to generate events on change.

only these nodes are permitted directly underneath the display node.

these nodes are permitted only directly underneath the display node.

Properties

Property Data Type Description
name** String The name used to identify this node in SHIPTide.
width Dimension In pixels, the width of the display/touch panel in the orientation you desire.
height Dimension In pixels, the height of the display/touch panel in the orientation you desire.
glass Reference:glass The name of the attached glass in the platform
touch Reference:touch The name of the attached touch in the platform
enabled Boolean If true (default), listeners within this display are enabled.

*available at SHIPEngine run time only and cannot be set in SHIPTide. Use a Sail script at shiplaunch time if this property needs to be set when the GUI starts to run.

**available only in SHIPTide; cannot be accessed from Sail scripts at run-time.

Examples