Name: | Menu |
Version: | 1.0 |
ID: | ID_MENU |
Status: | Beta |
Category: | GUI |
Date: | January 2004 |
Author: | Rocklyte Systems |
Copyright: | Rocklyte Systems (c) 2002-2004. All rights reserved. |
Short: | The Menu class is used to construct menus from XML files. |
The Menu class supports the following actions:
Activate Displays the menu. Focus Sends the focus to the menu and activates keyboard monitoring. Hide Hides the menu and open sub-menus. LostFocus Removes the focus from the menu and deactivates keyboard monitoring. Refresh Refreshes a menu from its source file. SetUnlistedField Arguments can be passed to a menu configuration file as unlisted fields. Show Shows the menu.
The Menu class implements the following methods:
ExecuteItem Executes the currently selected menu item.
The Menu object consists of the following public fields:
FontColour Sets the default font colour for menu items. FontHighlight Sets the default font colour for highlighted menu items. Location Identifies the location of a menu configuration file to load. MenuFile ... Node The node that you wish to use for building a menu from its file source. Relative The drawable that the menu should be offset from on the display. SelectionField This field is used in conjunction with the SelectionObject field. SelectionObject If the menu object should send user selections to another object, set this field. Width A fixed menu width can be applied by setting this field. XCoord The horizontal position of the menu. YCoord The vertical position of the menu.
Field: | FontColour |
Short: | Sets the default font colour for menu items. |
Type: | STRING |
Status: | Set |
Field: | FontHighlight |
Short: | Sets the default font colour for highlighted menu items. |
Type: | STRING |
Status: | Set |
Field: | Location |
Synonyms: | Src |
Short: | Identifies the location of a menu configuration file to load. |
Type: | STRING |
Status: | Get/Set |
Field: | MenuFile |
Short: | ... |
Type: | STRING |
Status: | Set |
Field: | Node |
Short: | The node that you wish to use for building a menu from its file source. |
Type: | STRING |
Status: | Get/Set |
Field: | Relative |
Short: | The drawable that the menu should be offset from on the display. |
Type: | OBJECTID |
Status: | Read/Write |
Field: | SelectionObject | |
Short: | If the menu object should send user selections to another object, set this field. | |
Type: | OBJECTID | |
Status: | Read/Write | |
|
Field: | Width | |
Short: | A fixed menu width can be applied by setting this field. | |
Type: | LONG | |
Status: | Set | |
|
Field: | XCoord | |
Short: | The horizontal position of the menu. | |
Type: | LONG | |
Status: | Set | |
|
Field: | YCoord | |
Short: | The vertical position of the menu. | |
Type: | LONG | |
Status: | Set | |
|