Difference between revisions of "Page"
| Line 10: | Line 10: | ||
=== Parameters === | === Parameters === | ||
| + | *'''page type''': menu, page, or popup | ||
| + | *'''orientation''': if the project is orientation enabled, specifies the orientation (landscape or portrait) | ||
*'''gestures''': list of gestures that can be performed on the page (see [[gestures]]) | *'''gestures''': list of gestures that can be performed on the page (see [[gestures]]) | ||
| Line 31: | Line 33: | ||
If the project is orientation-enabled, the orientation can be specified (if omitted, the default is landscape). | If the project is orientation-enabled, the orientation can be specified (if omitted, the default is landscape). | ||
=== Parameters === | === Parameters === | ||
| − | *'''page type''': | + | *'''page type''': menu, page, or popup |
| + | *'''id''': identifies the page. It's used on [[link]] objects to link it | ||
| + | *'''title''': title shown at the top of the page, if the skin includes it | ||
*'''orientation''': if the project is orientation enabled, specifies the orientation (landscape or portrait) | *'''orientation''': if the project is orientation enabled, specifies the orientation (landscape or portrait) | ||
| + | *'''locations''': locations assigned to this page | ||
| + | *'''protected''': can be null, pin or puk. Specifies if to access the page, a pin or pin and puk is requested | ||
*'''gestures''': list of gestures that can be performed on the page (see [[gestures]]) | *'''gestures''': list of gestures that can be performed on the page (see [[gestures]]) | ||
| Line 54: | Line 60: | ||
= Popup = | = Popup = | ||
| − | A popup page, identified by a name and a type. | + | A popup page, identified by a name and a popup type: simple or modal. |
| − | If the | + | It can have a close button, if it's necessary or if specified by the ''closebutton'' attribute. |
| + | ==== Simple Popup ==== | ||
| + | A simple popup opens up next to the object that generated it (eg. a [[link]] or [[user]] object) and it's closed by the same object. If there's no space, the popup will be opened at the center of the page, with a close button to close it. | ||
| + | ==== Modal Popup ==== | ||
| + | A modal popup is an exclusive popup that will open in the center of the page, while the background is grayed out. | ||
| + | To close it, click on the background or on the close button (if it's visible). | ||
| + | |||
=== Parameters === | === Parameters === | ||
| − | *'''page type''': | + | *'''page type''': menu, page, or popup |
| − | *''' | + | *'''id''': identifies the page. It's used on [[link]] objects to link it |
| − | *''' | + | *'''title''': title shown at the top of the page, if the skin includes it |
| + | *'''size''': width and height of the popup | ||
| + | *'''type''': popup type: simple or modal. The default is simple | ||
=== Syntax === | === Syntax === | ||
| − | ( | + | (popup) defines the beginning of the page, (endofpopup) defines the end of the page. |
| − | ( | + | A size [[meta]] is used to define the popup's size. |
| − | ( | + | (popup <id>; <title>) |
| + | (#size <width>x<height>) | ||
... | ... | ||
| − | ( | + | (endofpopup) |
Eg. | Eg. | ||
| − | ( | + | (popup mypopup; My Title; modal) |
| + | (#size 300x250) | ||
... | ... | ||
| − | ( | + | (endofpopup) |
| − | |||
| − | |||
| − | |||
| − | |||
=== UI Attributes === | === UI Attributes === | ||
{{:UI Object Attributes (Page)}} | {{:UI Object Attributes (Page)}} | ||
Revision as of 14:34, 7 January 2014
A project page. There are three types of pages: menu, page, popup. For page and popup types, some names are reserved and can't be used, not even as the initial part of a longer name. The reserved names are: menu, temp, music, cameras, timer, logout. While it is normal to have more link objects directed to the same page, it is an error to have more than one (page) object with the same name.
Contents
Menu
Main page of the project. There has to be one menu in each project. There can be a landscape and a portrait version, specified with an attribute.
Parameters
- page type: menu, page, or popup
- orientation: if the project is orientation enabled, specifies the orientation (landscape or portrait)
- gestures: list of gestures that can be performed on the page (see gestures)
Syntax
(menu) defines the beginning of the page. Orientation is specified as (menu#landscape) or (menu#portrait) when the project is orientation-enabled. (endofmenu) defines the end of the page.
(menu[#<orientation>]) ... (endofmenu)
Eg.
(menu) ... (endofmenu) (menu#portrait) ... (endofmenu)
Page
A generic page, identified by a name. If the project is orientation-enabled, the orientation can be specified (if omitted, the default is landscape).
Parameters
- page type: menu, page, or popup
- id: identifies the page. It's used on link objects to link it
- title: title shown at the top of the page, if the skin includes it
- orientation: if the project is orientation enabled, specifies the orientation (landscape or portrait)
- locations: locations assigned to this page
- protected: can be null, pin or puk. Specifies if to access the page, a pin or pin and puk is requested
- gestures: list of gestures that can be performed on the page (see gestures)
Syntax
(page) defines the beginning of the page. Orientation is specified as (page#landscape) or (page#portrait) when the project is orientation-enabled. (endofpage) defines the end of the page.
(page[#<orientation>]) ... (endofpage)
Eg.
(page) ... (endofpage) (page#portrait) ... (endofpage)
UI Attributes
Popup
A popup page, identified by a name and a popup type: simple or modal. It can have a close button, if it's necessary or if specified by the closebutton attribute.
Simple Popup
A simple popup opens up next to the object that generated it (eg. a link or user object) and it's closed by the same object. If there's no space, the popup will be opened at the center of the page, with a close button to close it.
Modal Popup
A modal popup is an exclusive popup that will open in the center of the page, while the background is grayed out. To close it, click on the background or on the close button (if it's visible).
Parameters
- page type: menu, page, or popup
- id: identifies the page. It's used on link objects to link it
- title: title shown at the top of the page, if the skin includes it
- size: width and height of the popup
- type: popup type: simple or modal. The default is simple
Syntax
(popup) defines the beginning of the page, (endofpopup) defines the end of the page. A size meta is used to define the popup's size.
(popup <id>; <title>) (#size <width>x<height>) ... (endofpopup)
Eg.
(popup mypopup; My Title; modal) (#size 300x250) ... (endofpopup)
