Menu handling module

Stream with textuale description of the different menu entries. Each line is linked to the same line in MNUSHWSTM (holding the display status) and MNUACTTYPSTM, MNUACTNAMSTM (holding the typ and optionally action). Each line holds the text to be shown if this line should be shown in the menu.

Type and action for the menu entry as linewise list linked to MNUACTTYPSTM, MNUTXTSTM and MNUSHWSTM. Possible contents are up to 8 character with the name of the action. <trn> transaction to be executed <fct> function to be called <menu> menu entry to be used <job> job to be executed

Type of the menu entry as linewise list linked to MNUACTNAMSTM, MNUTXTSTM and MNUSHWSTM. Possible contents are a 1 character code to determine the type of action: T transaction to be executed (default: visible) O optional transaction (default: not visible) F function to be called M menu entry to be used J job to be executed

Linewise show or don't show status for the individual menu entries of MNUTXTSTM. Empty Don't show N Never show (due to rights) S Show (for Transaction/Function entries) X Show (for Menu nodes with expanded subentries) C Show (for menu nodes with collapsed subentries)

When selecting menu entries to expand or collaps subtrees entries might switch between empty, C and X.

Linking of the used buttons with the menu entries in MNUACTSTM.

BUTLTxx is linked to line xx in this stream. The content of this line is the line index in MNUACTSTM of the associated menu entry.

If a MnuChkDynTrn rule is available this flag is automatically set.

This field should hold the index of the currently executing transaction. The field might be set directly before executing the LnkChainTransaction / LnkCallTransaction. When drawing the Menu the line identified by MNUSELIDX will be marked as currently active.

Field to hold the internaly selected target for the duration of the transaction internal processing. Clicking on the menu entry places the selected index into MNUCURIDX and the selected target in MNUCURTRN.

Field to hold the internaly selected target for the duration of the transaction internal processing. Clicking on the menu entry places the selected index into MNUCURIDX and the selected target in MNUCURTRN.

When picking up of a SPT is selected, this field holds the SPTINR of the target. MNUCURTRN will be loaded with the target transaction.

Stream holding the object id of all currently drawn dynamic menu objects to be able to destroy them when redrawing the menu. The stream gets invalid after a chain as TradeDesign cleans up all panel objects and thus all dynamically created menu objects are destroyed.

List of all defined icon buttons. Each line holds delimited by tabs Location character 2-digit index [& “S”ame ] full field path of controlfield name of the iconfile Hint

Stream holding the object id of all currently drawn icon buttons to be able to destroy them when redrawing the buttons. The stream gets invalid after a chain as TradeDesign cleans up all panel objects and thus all dynamically created icon button are destroyed.

Pixel position below current lowest shown menu entry.

This value holds the height of the current menu entry in pixel in case no additional text line is used.

direct selection of a contract

With this field the tracsactions to be selected may be restricted. The content defines the restriction of codes and is used as selection Sql for ATPGET with “COD like '<LCHSEL>%'

Is used to support the selectiion of info transactions in event BUTINF.

If not empty then launched BUTINF

This field holds the offset of the first shown menu entry. If this value is greater than zero, the leading scroll up button will be shown and the menu is shifted down by that size.

holds the number of menu entries which could not be shown as the previous entry was already reached or exceeded the lower limit of the available menu space.

Function to embed a literal into a bit button description
either single or double quotes are used
in case the passed text includes both types of quotes the
text cannot be used properly

Function to return the index of the first fitting trn entry
ArgAct name of transaction, menu etc.
ArgTyp list of types to be searched
In case no fitting entry is found a zero is returned

central function to determine the menu to be opened to handle the passed object type

ArgCCI holds the reference to the object to show / handle
ArgTrn holds the transaction where the menu shall be shown

Corresponding function: GetSelTrnForObj

central function to determine the transaction to be used to handle the passed object type
ArgCCI holds the reference to the object to show / handle
typically the passed object is a contract and the resulting transaction
is the xxTSEL transaction used to show the available transaction for that type of contract

Corresponding function: GetSelMnuForObj

create framefield and set attributes for button
argArea Area for Button / pass field ID as extension to the LT area code
“LB” Left Bottom
“T” Top
argIdx relative index (position, 1-x) or level (menu level, 0,1,2) of control in area (for “LB” lowest button ('exit') has argIdx 1)

function to return the LNKOBJ of a target transaction as defined in ATP
ArgTrn holds the transaction
The function returns an empty value if not matching entry is found

ArgBut BitButton to be used
ArgLoc Location where the button shall be placed
Possible values are MnuButLeftBottom, MnuButLeftMenuTop, MnuButLeftMenuSub, MnuButTopGlobal,
MnuButTopTransaction, MnuButTopSelectedLine, MnuButTopExtension,
MnuButSameAsPrevious
ArgIco optional Icon to be used in case the default name built based on the passed BitButton can not be used
The default name is “but_” + <ArgBut> + ”.png“
ArgCapt holds a optional caption text, an & character might mark the following character as shortcut
ArgHint holds a optional hint text

Corresponding function: ButDraw

rule to (re-)draw to collect and draw the currently active icon buttons
The buttons are collected by calling all RegisterButton rules.

corresponding routine ButAddButton

set attributes for button

function to calculate the visibility flag to reflect a collaps or expand of the menu tree

Argidx holds the index of the selected menu entry (either positive or negative)
In case the passed index is zero the current open transaction list is (re-)checked
based on the current context

The purpose is to adjust the expand state of the menu tree to either
expand the specified entry (in case of a positive index) or to
toogle the collapsed / expand status of the specified menu entry (in case of a negative index)

This function does not show the updated menu. A call to MnuDraw will do that

Central rule to load a menu for the passed profile
ArgPrf holds the profile to be loaded

Corresponding functions: MnuDefInit, MnuDefLoadMnu, MnuDefCompleted

rule to (re-)draw the menu according to the currently loaded set of
menus and the profile.

SYSMNU internal rule to initiate the handling of a selection
ArgTrn holds the target transaction
ArgIdx holds the menu index associated to the target. This index might be a menu entry
or a different transaction
ArgInr holds an optional SPTINR to identify the SPT to be picked in the target transaction

Function to be called to clear a selected target TRN in case the navigation is not executed

Execute the chain to the passed target
ArgTrn holds ”.“ to return to first, a TRN or an empty value
if an empty value is passed, nothing is done and the routine returns

Function to be called to retrieve the selected target TRN
in case no target TRN is selected the value ”.“ is returned

Function to be called to return to the calling transaction and execute the currently set selection there
ArgTrn selection

Function to be called to set the selected target TRN

Function to check and return the index of the actual menu entry if the same
ArgAct name of transaction, menu etc.
ArgTyp list of types to be checked
In case the check is unsuccessful a zero is returned

function to determine the business sector of transaction to be opened
ArgTrn holds the transaction to be started