Module Document - Application_Menu

<table cellspacing="0" cellpadding="0"> <tr height="150"> <td align="left"><img src="../../../../img/logo.gif" alt="IAC logo"></img></td> <td width="100%" rowspan="2" align="left" valign="center"> <table cellspacing="0" cellpadding="0"> <tr> <td> <a name="Application_Menu"> <table width="84%" border="0" align="center"> <tr bgcolor="FFFFAA" align="center"> <td nowrap width="15%" height="32"> <tt class="label">1829</tt></td> <td nowrap width="100%"> <tt class="label">Application_Menu</tt></td> <td nowrap width="150"><tt class="label">07/16/94</tt></td> </tr> <tr><td align="left" colspan="3"><p>The ApplMenu module reads a menu description file and creates an AVS menu that conforms to this description. It also controls this menu and issues the appropriate CLI commands when various menu choices are made by a user.</p></td></tr> <tr><td align="left" colspan="3"><table class="avs5_repository"> <tr valign="top"><td><b>Author:</b></td><td>Joseph Fall, Essential Planning Systems</td></tr> <tr><td><b>Version:</b></td><td>1.000</td></tr> <tr><td><b>Language:</b></td><td>C</td></tr> <tr> <td><b>Path:</b></td><td>source/data_input/Application_Menu/</td></tr> </table></td></tr> <tr><td align="left" colspan="3"><p> <a href="Application.shtml" target="_top"> <img src="../../../../../img/doc_mod.gif" border="0" width="30" height="30" alt="Module Document - Application_Menu"></a> <a href="source/data_input/Application_Menu/Application_Menu.tar.gz"> <img src="../../../../../img/targz.gif" border="0" width="52" height="30" alt="Archive - Application_Menu.tar.gz"></a> <a href="source/data_input/Application_Menu/Application_Menu.tar.Z"> <img src="../../../../../img/tarz.gif" border="0" width="52" height="30" alt="Archive - Application_Menu.tar.Z"></a> <a href="source/data_input/Application_Menu/Application_Menu.zip"> <img src="../../../../../img/zip.gif" border="0" width="52" height="30" alt="Archive - Application_Menu.zip"></a> </p></td> </tr> </table> <br> </td> </tr> <tr> <td>  <html> <head> <title> ApplMenu - Read a menu description file and control the menu described there in. </title> </head> <body bgcolor=#FFFFCC> <h2> ApplMenu - Read a menu description file and control the menu described there in. </h2> <h3>Name</h3> <blockquote> <pre> ApplMenu - Read a menu description file and control the menu described there in. </pre> </blockquote> <h3>Summary</h3> <blockquote> <pre> Name Application_Menu Availability </pre> </blockquote> <h3>Type</h3> <blockquote> <pre> input </pre> </blockquote> <h3>Inputs</h3> <blockquote> <pre> none </pre> </blockquote> <h3>Outputs</h3> <blockquote> <pre> none </pre> </blockquote> <h3>Parameters</h3> <blockquote> <pre> MenuFile "string" "browser" MenuChoice "string" "none" </pre> </blockquote> <h3>Description</h3> <blockquote> <pre> The ApplMenu module reads a menu description file and creates an AVS menu that conforms to this description. It also controls this menu and issues the appropriate CLI commands when various menu choices are made by a user. PARAMETERS MenuFile (string - filename) The Menu File is the file name of the menu description file to be used by ApplMenu. The menu may be reloaded at any time, old menu items will be removed and the new menu will be created. MenuChoice (string - no widget) The Menu Choice is a hidden parameter used to recieve the menu pick number. Users never need to worry about this parameter. MENU DESCRIPTION FILE SYNTAX A Menu File has a simple format. All lines are either blank, a comment (any line that begins with a #), or a command. All command lines have the same syntax: Command_Name : Command_Action There are only 5 Command_Name's that are recognized in a menu file: Init : cli command Menu : Pulldown menu name Action : Menu item name (initially enabled). ActionD: Menu item name (initially disabled). Cmd : cli command The colons are mandatory to seperate the Command_Name and the Command_Action. However, spacing and indenting makes no difference. The Init command will cause the CLI command following to be executed once when the menu is loaded for the Menu File. The Menu command will cause a new pulldown menu to be created with the name given as the Command_Action. All Action commands following a Menu will be part of that pulldown (until the next Menu command). The Action command will cause a new menu entry to be added to the current pulldown Menu. All Cmd commands following an Action will be part of that Action. The Cmd command will cause the CLI command following to be executed when the associated Action is selected from the menu. For simple actions, the Cmd may just be a single CLI command, but usually, there will be a script of CLI commands which will be sourced when the menu button is choosen. These may be any commands recognized by the AVS CLI interpreter. Often, commands will come in pairs, one to take some action and one to undo that action. In this case there will also be commands to disable the current option and to enable it's partner option. Currently, ApplMenu has the following limitations: Max. number of menu items (Action's) = 50 seperate menu buttons Max. length of a Menu or Action name = 30 characters Max. total size for all CLI Cmd's for 1 Action = 400 characters. Note: The above are simply constants that may be changed in the source. </pre> </blockquote> <h3>Example</h3> <blockquote> <pre> The following is an example menu file. If the MenuFile parameter is set to read this file, a menu will be created with all of the pulldowns and actions described... ------------------------------------------------------------------------------ ### ### Menu file for 2D_Viewer application. ### # Initialize environment variables for this menu. Init : var_set NetDir -env AVSNET Init : var_set ScriptDir $NetDir/2Dscripts # Control menu selections. Menu : Control Action : Data Selection Cmd : present SelectPage Action : Viewer Cmd : present ViewerPage Action : Quit Cmd : net_clear # Viewer menu selections. Menu : Viewers Action : Disable Main Viewer Cmd : menu Viewers -disable "Disable Main Viewer" Cmd : module MainImageViewer -off Cmd : menu Viewers -enable "Enable Main Viewer" ActionD: Enable Main Viewer Cmd : menu Viewers -disable "Enable Main Viewer" Cmd : module MainImageViewer -on Cmd : menu Viewers -enable "Disable Main Viewer" Action : Disable Main ColorMap Cmd : menu Viewers -disable "Disable Main ColorMap" Cmd : net_read $ScriptDir/Remove_color.scr Cmd : menu Viewers -enable "Enable Main ColorMap" ActionD: Enable Main ColorMap Cmd : menu Viewers -disable "Enable Main ColorMap" Cmd : net_read $ScriptDir/Add_color.scr Cmd : menu Viewers -enable "Disable Main ColorMap" Action : Add Extra Viewer Cmd : net_read $ScriptDir/Add_viewer.scr # RGB menu selections. Menu : RGB Action : View RGB Cmd : menu RGB -disable "View RGB" Cmd : net_read $ScriptDir/Add_rgb.scr Cmd : menu RGB -enable "Remove RGB" ActionD: Remove RGB Cmd : menu RGB -disable "Remove RGB" Cmd : net_read $ScriptDir/Remove_rgb.scr Cmd : menu RGB -enable "View RGB" # Vectors menu selections. Menu : Vectors Action : Add Vectors Cmd : menu Vectors -disable "Add Vectors" Cmd : net_read $ScriptDir/Add_vectors.scr Cmd : menu Vectors -enable "Remove Vectors" ActionD: Remove Vectors Cmd : menu Vectors -disable "Remove Vectors" Cmd : net_read $ScriptDir/Remove_vectors.scr Cmd : menu Vectors -enable "Add Vectors" # Options menu selections. Menu : Options Action : Distance Measure Cmd : menu Options -disable "Distance Measure" Cmd : net_read $ScriptDir/Add_measure.scr Cmd : menu Options -enable "Remove Measure" ActionD: Remove Measure Cmd : menu Options -disable "Remove Measure" Cmd : net_read $ScriptDir/Remove_measure.scr Cmd : menu Options -enable "Distance Measure" Action : Profile Cmd : menu Options -disable "Profile" Cmd : net_read $ScriptDir/Add_profile.scr Cmd : menu Options -enable "Remove Profile" ActionD: Remove Profile Cmd : menu Options -disable "Remove Profile" Cmd : net_read $ScriptDir/Remove_profile.scr Cmd : menu Options -enable "Profile" # Output menu selections. Menu : Output Action : Add Postscript Cmd : menu Output -disable "Add Postscript" Cmd : net_read $ScriptDir/Add_ps.scr Cmd : menu Output -enable "Remove Postscript" ActionD: Remove Postscript Cmd : menu Output -disable "Remove Postscript" Cmd : net_read $ScriptDir/Remove_ps.scr Cmd : menu Output -enable "Add Postscript" </pre> </blockquote> </body> </html>  </td> </tr> </table> </td> </tr> <tr height="100%"> <td class="sideLink" width="25%" align="left" valign="top" nowrap="nowrap"> <p><a href="../../../../../general/index.shtml" target="_top">General Information</a></p> <p><a href="../../../../../repository/index.shtml" target="_top">Repositories</a></p> <p class="sideLinkLevel2"><a href="../../../../new/index.shtml" target="_top">  New Releases</a></p> <p class="sideLinkLevel2"><a href="../../../../download/index.shtml" target="_top">  Download</a></p> <p class="sideLinkLevel2"><a href="../../../../submit/index.shtml" target="_top">  Submit</a></p> <p class="sideLinkLevel2"><a href="../../../../pfiles/index.shtml" target="_top">  Project Files</a></p> <p class="sideLinkLevel2"><a href="../../../../avs5/index.shtml" target="_top">  AVS5</a></p> <p class="sideLinkLevel3"><a href="../../../input.shtml" target="_top">    Data Input</a></p> <p class="sideLinkLevel3"><a href="../../../filters.shtml" target="_top">    Filters</a></p> <p class="sideLinkLevel3"><a href="../../../mappers.shtml" target="_top">    Mappers</a></p> <p class="sideLinkLevel3"><a href="../../../output.shtml" target="_top">    Data Output</a></p> <p class="sideLinkLevel3"><a href="../../../misc.shtml" target="_top">    Miscellaneous</a></p> <p class="sideLinkLevel2"><a href="../../../../express/index.shtml" target="_top">  AVS/Express</a></p> <p class="sideLinkLevel2"><a href="../../../../pog/index.shtml" target="_top">  Project Guidelines</a></p> <p><a href="../../../../../usergroup/index.shtml" target="_top">User Group</a></p> <p><a href="../../../../../training/index.shtml" target="_top">Training Materials</a></p> </td> </tr> </table> <table width="100%" border="0" cellspacing="0" cellpadding="0" bgcolor="c6c6e0"> <tr> <td><img src="../../../../../img/foot1.gif" alt="IAC" width="155" height="25"></td> <td width="100%"> Last Updated:  26th November 2002 </td> </tr> </table>