Difference between revisions of "SHIP:Node:layout"

From Serious Documentation
Jump to: navigation, search
(Properties)
(Properties)
Line 18: Line 18:
 
{| class="wikitable" style="margin: 1em auto 1em auto;"  
 
{| class="wikitable" style="margin: 1em auto 1em auto;"  
 
! scope="col" | Property
 
! scope="col" | Property
! scope="col" | Data Type
+
! scope="col" | DataType
 
! scope="col" | Description
 
! scope="col" | Description
 
|-
 
|-
|{{:SHIP:Property:layout:name}}
+
|{{:SHIP:Property:all:name}}
 
|}
 
|}
 
{{SHIP:TideTimePropertyNote}}
 
{{SHIP:TideTimePropertyNote}}
 +
 +
Note that the {{Prop|all|name}} property for the {{Node|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 ==
 
== Examples ==
 
The layout node is not explicitly shown in [[SHIPTide]].
 
The layout node is not explicitly shown in [[SHIPTide]].

Revision as of 07:40, 23 January 2013

Node Home

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]".

Parent Nodes

The following nodes are permitted to hold this node:

  • none

The layout node is a top level node within SHIP. All SHIP Nodes are described here.

Child Nodes

The following nodes are permitted to exist within this 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.