Difference between revisions of "SHIP:Node:layout"

From Serious Documentation
Jump to: navigation, search
(→‎Properties)
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
[[SHIP:Node|Node Home]]
 
[[SHIP:Node|Node Home]]
 
__TOC__
 
__TOC__
 +
{| class="wikitable" style="margin: 1em auto 1em auto;"
 +
! scope="col" | Node Type
 +
! scope="col" | Description
 +
|-
 +
|<onlyinclude>{{Node|layout}}{{#if: {{{1|}}}|{{{1}}} }}||Top of the Layout Area within a [[SHIP]] GUI, which completely describes how the GUI is visually organized.</onlyinclude>
 +
|}
 
The {{Node|layout}} node is the top of the Layout Area within a [[SHIP]] GUI, which completely describes how the visual GUI is organized into {{Node|page|pages}} and objects with {{Node|page|pages}}.
 
The {{Node|layout}} node is the top of the Layout Area within a [[SHIP]] GUI, which completely describes how the visual GUI is organized into {{Node|page|pages}} and objects with {{Node|page|pages}}.
  
 
The name of the  {{Node|layout}} node  is also '''layout''', so objects in the layout area can be prefixed by "layout.<nowiki>[name]</nowiki>".
 
The name of the  {{Node|layout}} node  is also '''layout''', so objects in the layout area can be prefixed by "layout.<nowiki>[name]</nowiki>".
  
−
== Parent Nodes ==
+
== Ancestors ==
−
The following nodes are permitted to hold this node:
+
The {{Node|layout}} is a top level node within [[SHIP]] and cannot be held in any other node type.
−
* none
 
  
−
The {{Node|layout}} node is a top level node within [[SHIP]].  All [[SHIP:Node|SHIP Nodes are described here]].
+
All [[SHIP:Node|SHIP Nodes are described here]].
  
−
== Child Nodes ==
+
== Descendants ==
−
The following nodes are permitted to exist within this node:
+
The following nodes are permitted within the {{Node|layout}} node:
−
* {{Node|display}}
+
 
 +
{| class="wikitable" style="margin: 1em auto 1em auto;"
 +
! scope="col" | Node Type
 +
! scope="col" | Description
 +
|-
 +
|{{:SHIP:Node:box}}
 +
|-
 +
|{{:SHIP:Node:constant}}
 +
|-
 +
|{{:SHIP:Node:display|{{†}}}}
 +
|-
 +
|{{:SHIP:Node:group}}
 +
|-
 +
|{{:SHIP:Node:listener}}
 +
|-
 +
|{{:SHIP:Node:script}}
 +
|-
 +
|{{:SHIP:Node:text}}
 +
|-
 +
|{{:SHIP:Node:timer}}
 +
|-
 +
|{{:SHIP:Node:variable}}
 +
|}
 +
{{†}}only these are permitted ''directly'' underneath the {{Node|layout}} node.
  
 
== Properties ==
 
== Properties ==
Line 28: Line 56:
  
 
== Examples ==
 
== Examples ==
−
The layout node is not explicitly shown in [[SHIPTide]].
+
The {{Node|layout}} node is not explicitly shown in [[SHIPTide]].

Latest revision as of 06:41, 27 January 2013

Node Home

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

The layout node is the top of the Layout Area within a SHIP GUI, which completely describes how the visual GUI is organized into pages and objects with pages.

The name of the layout node is also layout, so objects in the layout area can be prefixed by "layout.[name]".

Ancestors

The layout is a top level node within SHIP and cannot be held in any other node type.

All SHIP Nodes are described here.

Descendants

The following nodes are permitted within the layout node:

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.
display† Contains the visual GUI layout for a specific LCD display/touch set.
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.
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 are permitted directly underneath the layout node.

Properties

Property DataType Description
name** String The name used to identify this node in SHIPTide.

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

Note that the name property for the layout node is hard-coded to "layout" and this cannot be changed in SHIPTide by the GUI designer. While possible, it is strongly discouraged that the GUI designer assign the name "layout" to any other node in the GUI to avoid confusion.

Examples

The layout node is not explicitly shown in SHIPTide.

Retrieved from "https://techref.myserious.com/index.php?title=SHIP:Node:layout&oldid=2331"