Class Documentation

Name:Menu
Version:1.0
ID:ID_MENU
Status:In Development
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.



Actions

The Menu class supports the following actions:

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.

Methods

The Menu class implements the following methods:

ExecuteItem  Executes the currently selected menu item.

Structure

The Menu object consists of the following public fields:

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.
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  The pixel width of the menu.
XCoord  The horizontal position of the menu.
YCoord  The vertical position of the menu.
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:SelectionField
Short:This field is used in conjunction with the SelectionObject field.
Type:STRING
Status:Set

This field needs to be set in conjunction with the SelectionObject field - please refer to it for more detail.


Field:SelectionObject
Short:If the menu object should send user selections to another object, set this field.
Type:OBJECTID
Status:Read/Write

When the user selects a menu item, you can send the entered data to the field of another object. In order to do this, you need to point to that object through the SelectionObject field and specify the destination field name by setting the SelectionField string. So long as both fields are set correctly, the destination object will always reflect the last item selected from the menu object.


Field:Width
Short:The pixel width of the menu.
Type:LONG
Status:Read/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