*BrowserContextMenuItem()

Creates a new, user-defined context menu item in the Session Browser that links selected items to Tcl scripts.

Syntax

*BrowserContextMenuItem (label, path, TCL procedure, entity type)

Application

HyperGraph

Inputs

label
The label displayed when you right-click on the context menu.
path
Path to the Tcl script field that gets sourced when the menu item is selected.
TCL procedure
Tcl procedure that is executed when a menu item is selected.
The following five arguments are passed to this Tcl procedure for each selected item in the Session Browser:
  • Page ID
  • Window ID
  • Entity Type
  • Entity ID
  • Point Number
Each of these arguments is one-based. Point Number allows the same procedure to work for HyperGraph window context menus and Session Browser context menus. When the procedure is called from a Session Browser context menu, an arbritrary value is passed for Point Number.
entity type
Entity to which the menu is associated. Possible values include plot, curve, or page.

Context

*BeginDefaults() block.

Example

*BeginDefaults()

     *BrowserContextMenuItem("Turn On",{getenv("ALTAIR_HOME") + "/utility/scripts/plotting/general_context_menu_curve.tcl"},::general_curve_context_menu::on_selected_curves,curve)
     *BrowserContextMenuItem("Turn Off",{getenv("ALTAIR_HOME") + "/utility/scripts/plotting/general_context_menu_curve.tcl"},::general_curve_context_menu::off_selected_curves,curve)
     *BrowserContextMenuItem("Delete",{getenv("ALTAIR_HOME") + "/utility/scripts/plotting/general_context_menu_curve.tcl"},::general_curve_context_menu::delete_selected_curves,curve)

     *BeginBrowserContextMenu("Single Curve Math")
        *BrowserContextMenuItem("Integral",{getenv("ALTAIR_HOME") + "/utility/scripts/plotting/include/context_menu_curve.tcl"},::vst_curve_context_menu::integrate_curve,curve)
        *BrowserContextMenuItem("Double Integral",{getenv("ALTAIR_HOME") + "/utility/scripts/plotting/include/context_menu_curve.tcl"},::vst_curve_context_menu::dblintegrate_curve,curve)
        *BrowserContextMenuItem("Derivitive",{getenv("ALTAIR_HOME") + "/utility/scripts/plotting/include/context_menu_curve.tcl"},::vst_curve_context_menu::derivitive_curve,curve)
     *EndBrowserContextMenu()

*EndDefaults()