SHIP:Node:page

From Serious Documentation
Revision as of 04:46, 28 November 2012 by Admin (talk | contribs) (Properties)
Jump to: navigation, search

Node Home

A GUI is generally composed of numerous graphically designed layout screens. Touch buttons navigate within an interactive GUI page and also cause screens to change from one to another. Since the word "screen" can easily be confused with the physical glass screen (vs. the GUI pixel content on the screen), SHIP uses the term "page" instead. The page in the GUI contains the visual layout for a specific GUI page. You can, and probably will, have many pages in a given GUI.

The names of the page nodes traditionally start with lower case "p", such as 'pHome, pSettings', etc., but this is not mandated. The name can be set to any valid name, such as homePage, or main for example.

Parent Nodes

The following nodes are permitted to hold this node:

Child Nodes

The following nodes are permitted to exist within this node:

Properties

Property Data Type Description
Must specify a property (e.g. visible)[[SHIP:Property:name:{{{2}}}|{{{2}}}]] name Any valid node name
Must specify a property (e.g. visible)[[SHIP:Property:visible:{{{2}}}|{{{2}}}]] boolean (default true sets the visibility of this page
Must specify a property (e.g. visible)[[SHIP:Property:enabled:{{{2}}}|{{{2}}}]] boolean (default true allows events in this page
Must specify a property (e.g. visible)[[SHIP:Property:object:{{{2}}}|{{{2}}}]] reference (optional) name of an attached object in the resources area
Must specify a property (e.g. visible)[[SHIP:Property:bgcolor:{{{2}}}|{{{2}}}]] color Background color of the page
Must specify a property (e.g. visible)[[SHIP:Property:fillcolor:{{{2}}}|{{{2}}}]] color Fill color of the page
Must specify a property (e.g. visible)[[SHIP:Property:innercolor:{{{2}}}|{{{2}}}]] color Inner color of the page
Must specify a property (e.g. visible)[[SHIP:Property:mt:{{{2}}}|{{{2}}}]],Must specify a property (e.g. visible)[[SHIP:Property:mr:{{{2}}}|{{{2}}}]],Must specify a property (e.g. visible)[[SHIP:Property:mb:{{{2}}}|{{{2}}}]],Must specify a property (e.g. visible)[[SHIP:Property:ml:{{{2}}}|{{{2}}}]] dimension Pixel width of margin (top, right, bottom, left)
Must specify a property (e.g. visible)[[SHIP:Property:pt:{{{2}}}|{{{2}}}]],Must specify a property (e.g. visible)[[SHIP:Property:pr:{{{2}}}|{{{2}}}]],Must specify a property (e.g. visible)[[SHIP:Property:pb:{{{2}}}|{{{2}}}]],Must specify a property (e.g. visible)[[SHIP:Property:pl:{{{2}}}|{{{2}}}]] dimension Pixel width of padding (top, right, bottom, left)
Must specify a property (e.g. visible)[[SHIP:Property:bct:{{{2}}}|{{{2}}}]],Must specify a property (e.g. visible)[[SHIP:Property:bcr:{{{2}}}|{{{2}}}]],Must specify a property (e.g. visible)[[SHIP:Property:bcb:{{{2}}}|{{{2}}}]],Must specify a property (e.g. visible)[[SHIP:Property:bcl:{{{2}}}|{{{2}}}]] color Color of border (top, right, bottom, left)

Examples