Whitebeam Library Definition

Site Map
 
Home
 
Application Guide
Reference
  Installation
  Configuration
  XML Markup
  JavaScript Classes
  ROM
  Templates
  Environment
  Dev Process
  Tools
  External Links
  Example libraries
Community
Contact Whitebeam
To-Do
Download
Credits
Licence
Whitebeam Users
 
 
 

Whitebeam Library Definition

menuinfo

Menu item attributes.

See Also

rbaddmenulist()    rbaddmenutree()   

Elements

The menuinfo struct has 8 elements:

Name Type/Value Range/Length Description
keystringtext Optional. Unique identifier of a menu item in the application (defaults to name).
namestringtext Optional. Display text of a menu item.
parentstringtext Optional. key of an existing menu item to which other specified attributes are applied or of parent of sub menu items.
blockidstringtext Optional. Identifier (rb:id attribute value) of <rb:block> tag that defines the menu item. The body of the block can be any valid XML/HTML designed to fit within the menu bar but in place of the menu bullet and display (hyper)text.
hrefstringtext Optional. Location of the menu item in the format:
protocol://hostname/pathname?search#hash
A full pathname should be specified with blockid and name attributes to ensure default menu item selection.
targetstringtext Optional. A companion attribute to href e.g. _blank displays selection in a new browser window.
expandstringyes Optional. Selects a menu item with a similar but complementary result to default or forced menu item selection.
rlevelnumber1.. Optional. Mandatory for rbaddmenulist. Relative level of menu item within the list (set to 1 for the first item in the array).

Remarks

By default, the last menu item with href attribute value that is the longest substring of the location (URL/URI) obtained from the browser becomes the selected menu item. The menu tree leading up to and including the selected menu item is automatically expanded and the selected item is automatically highlighted.

The style of menu item text can be specified (perhaps in a style sheet) with definitions:
  a.menu when selectable (i.e. href specified);
  .menunormal when unselectable;
  .menuselect once selected.

Where a menu item is defined with a blockid attribute, default selection will only be possible if href attribute is set appropriately. The order of precedence is parent, blockid, name if any combination of these attributes are specified.

By default, each menu level is implemented as a row per menu item indented by one column from the previous level. The menu item bullet is in the first column for that level and name in next column. When a blockid is specified, its content spans both of columns (i.e. a bullet is not automatically applied) of that level.

Whitebeam release 1.3.36
(loadtime : 11ms)