GUI Development

Concurrent Processing Routines

ADD_EXEC_ON_SELECT

Adds a single new item to the EXEC_ON_SELECT list.

DROP_EXEC_ON_SELECT

Drops a single item from the EXEC_ON_SELECT list.

EXEC_ON_SELECT

Registers callback procedures on input for a vector of logical unit numbers (LUNs).

SELECT_READ_LUN

Waits for input on any list of logical unit numbers.

WAVE Widget Utilities

WgAnimateTool

Creates a window for animating a sequence of images.

WgCbarTool

Creates a simple color bar that can be used to view and interactively shift a PV‑WAVE color table.

WgCeditTool

Creates a full-featured set of menus and widgets enclosed in a window; this window allows you to edit the values in PV‑WAVE color tables in many different ways.

WgControlsBox

Displays slider and returns user-selected slider value.

WgCtTool

Creates a simple widget that can be used interactively to modify a PV‑WAVE color table.

WgFileSelection

Creates a file selection widget which lets the user display the contents of directories and select files.

WgIsoSurfTool

Creates a window with a built-in set of controls; these controls allow you to easily view and modify an iso-surface taken from a three-dimensional block of data.

WgList

Displays a list of items and returns an array of indices into the list corresponding to user-selected items.

WgOrbit

Creates an interactive window for viewing objects.

WgMovieTool

Creates a window that cycles through a sequence of images.

WgSImageTool

Creates a GUI with sliders allowing the user to modify pixel values of the image and get basic statistics of the image.

WgSliceTool

Creates a window with a built-in set of controls; these controls allow you to easily select and view “slices” from a three-dimensional block of data.

WgSlideShow

Views multiple images in a slide show widget.

WgStripTool

Creates a window that displays data in a style that simulates a real-time, moving strip chart.

WgSurfaceTool

Creates a surface window with a built-in set of controls: these controls allow you to interactively modify surface parameters and view the result of those modifications.

WgText

Displays a single-line text field for user input.

WgTextTool

Creates a scrolling window for viewing text from a file or character string.

VDA Tools Manager Routines

TmAddSelectedVars

Adds selected variables from a VDA Tool to the list of selected variables in the Tools Manager.

TmAddVar

Adds a variable to a VDA Tool.

TmAxis

Adds axes to a VDA Tool.

TmCodeGen

Writes a specified string to the code generation file.

TmCopy

Copies the selected graphical elements from the specified VDA Tool to the clipboard.

TmCut

Cuts the selected graphical elements from the specified VDA Tool and moves them to the clipboard.

TmDelVar

Removes variables from a VDA Tool.

TmDelete

Permanently deletes the selected graphical elements from the specified VDA Tool.

TmDeselectVars

Clears the current list of selected variables.

TmDynamicDisplay

Displays selected data in all active VDA Tools, provided that the VDA Tools can display the related variable(s).

TmEndCodeGen

Closes the file in which generated code is written.

TmEnumerateAttributes

Obtains the attributes for a specified graphical element, variable, or other item in a VDA Tool.

TmEnumerateItems

Obtains the items defined for a specified VDA Tool.

TmEnumerateMethods

Obtains the methods that were set for a VDA Tool.

TmEnumerateSelectedVars

Returns the names of variables on the selected variables list.

TmEnumerateToolNames

Returns all the registered VDA Tool names.

TmEnumerateVars

Returns all the variables associated with an instance of a VDA Tool.

TmExecuteMethod

Executes a method that was set by TmSetMethod.

TmExport

Exports $MAIN$-level variables to specified VDA Tools or to all currently active VDA Tools.

TmExportSelection

Exports the contents of the variable selection list to specified VDA Tools.

TmGetAttribute

Returns the value that was set for an attribute in a VDA Tool instance.

TmGetMessage

Loads a string resource file into the resource database and extracts a message string from the database.

TmGetMethod

Returns the data structure of the specified method.

TmGetTop

Gets the top-level widget ID for a VDA Tool.

TmGetUniqueToolName

Returns a unique name for a particular instance of a specified VDA Tool.

TmGetVarMainName

Returns the $MAIN$ level name of a variable.

TmInit

Initializes the VDA Tools Manager layer.

TmList

Creates a list item.

TmListAppend

Adds a new item at the end of the specified list.

TmListClear

Resets a specified list to its initial state, clearing all previously defined items.

TmListDelete

Deletes an item in the specified list.

TmListDestroy

Clears all items and destroys the list.

TmListExtend

Extends the specified list by adding empty items.

TmListGetMethod

Returns the procedure name associated with the specified list method name.

TmListInsert

Inserts a new item into the specified list.

TmListReplace

Replaces an item in a list with a new item.

TmListRetrieve

Gets the items currently set in the specified list.

TmListSetMethod

Sets the method procedure name for a specific list method.

TmPaste

Pastes the graphical elements from the clipboard to the specified VDA Tool.

TmRegister

Registers a VDA Tool with the Tools Manager.

TmRestoreTemplate

Restores a saved VDA Tool template.

TmRestoreTools

Restores the VDA Tools that were saved with the TmSaveTools procedure.

TmSaveTools

Saves the specified VDA Tools in a file.

TmSetAttribute

Set an attribute for an item in the given VDA Tool.

TmSetMethod

Sets a method for a given VDA Tool.

TmStartCodegen

Opens a file into which PV‑WAVE code is written.

TmUnregister

Removes the specified VDA Tool from the Tools Manager registry.

VDA Tools Manager Graphical Element Routines

TmAddGrael Procedure

Adds a graphical element to the graphical element list for the specified instance of a VDA Tool.

TmAddSelectedGrael Procedure

Adds a graphical element to the graphical element selection list.

TmAxis Procedure

Adds axes to a VDA Tool.

TmBitmap Procedure

Adds a bitmap (2D array) to a VDA Tool.

TmBottomGrael Procedure

Sets the specified graphical element to be on the bottom of the display list (displayed behind the other graphical elements).

TmDelGrael Procedure

Removes a specified graphical element from the list of graphical elements associated with a VDA Tool instance.

TmDelSelectedGraels Procedure

Deletes a graphical element from the list of selected graphical elements.

TmEnumerateGraelMethods Function

Obtain a list of all the methods set for a graphical element in a specified VDA Tool.

TmEnumerateGraels Function

Returns all the graphical elements that were set for a given VDA Tool.

TmEnumerateSelectedGraels Function

Obtains a list of graphical elements or other items currently on the graphical items selection list.

TmExecuteGraelMethod Procedure

Executes a method for a graphical method based on the method name.

TmGetGraelMethod Function

Obtains the data structure for the specified method.

TmGetGraelRectangle Function

Returns the rectangular boundary of a graphical element.

TmGetUniqueGraelName Function

Obtains a unique name based on the name of the specified graphical element.

TmGroupGraels Function

Groups a number of selected graphical elements as one graphical element with a unique name.

TmLegend Procedure

Adds a legend to a VDA Tool. The exact size and position of the legend is determined interactively by the user.

TmLine Procedure

Adds a line to a VDA Tool. The exact length and position of the line is determined interactively by the user.

TmRect Procedure

Adds a rectangle to a VDA Tool. The exact size and position of the rectangle is determined interactively by the user.

TmSetGraelMethod Procedure

Sets the name of the method procedure for a given method name and graphical element.

TmSetGraelRectangle Procedure

Sets selection rectangle for graphical element, or set of graphical elements.

TmText Procedure

Adds text to a VDA Tool. The position of the text and the text itself are determined interactively by the user.

TmTopGrael Procedure

Sets the specified graphical element to be at the top of the display list (displayed in front of other graphical elements).

TmUngroupGraels Procedure

Ungroups a group of graphical elements.

VDA Utilities Routines

WoAddButtons

Adds a baWoAddButtons Procedurenk of buttons to a button bar.

WoAddMessage

Adds a message to a message area created by WoMessage.

WoAddStatus

Display a message in the status bar of a VDA Tool.

WoBuildResourceFilename

Returns the full path name for a specified resource file.

WoButtonBar

Creates predefined, two-row button bar that can be included in a VDA Tool.

WoButtonBarSet

Changes the setting of a button in a button bar.

WoButtonBarSetSensitivity

Sets the sensitivity of one or more buttons on a button bar.

WoCheckFile

Confirms if a file is readable or writable.

WoColorButton

Creates a button that brings up a color table dialog box used to set colors in a VDA Tool. The button has an associated color pixmap that reflects the currently selected color.

WoColorButtonGetValue

Gets the currently selected color index from a color button created by WoColorButton.

WoColorButtonSetValue

Sets the current color index for a color button created by WoColorButton, and updates the color button’s color pixmap.

WoColorConvert

Convert from a long RGB value to an index into the current color table, or from an index in the current color table to an RGB value.

WoColorGrid

Creates a grid of color squares from the current color table.

WoColorGridGetValue

Gets the color indices for a range of colors in a color grid.

WoColorGridSetValue

Sets the color indices for a range of colors in the color grid.

WoColorWheel

Creates a color wheel that can be used to modify a single color in the current color table.

WoConfirmClose

Displays a dialog box requiring the user to confirm a window close action.

WoDialogStatus

Saves or restores the status of a dialog box by saving or restoring the state of its widgets as stored in the Tools Manager.

WoFontOptionMenu

Creates an option menu with the standard list of software (vector-drawn) fonts found in PV‑WAVE.

WoFontOptionMenuGetValue

Gets the software font command for the currently selected font.

WoFontOptionMenuSetValue

Sets the current font and updates the font option menu.

WoGenericDialog

Creates a generic dialog box for use in VDA Tools.

WoGetToolNameFromTitle

Gets the unique name of a VDA tool given the unique window title of the VDA Tool.

WoGetUniqueWindowTitle

Given a window title, adds a numeric suffix to make the title unique.

WoLabeledText

Creates a group of aligned text widgets (widgets with a label and a text field).

WoLinestyleOptionMenu

Creates an option menu for selecting linestyles.

WoLinestyleOptionMenuGetValue

Gets the currently selected linestyle.

WoLineStyleOptionMenuSetValue

Sets the option menu to a specified linestyle.

WoLoadResources

Loads resources and strings from a file for VDA tools.

WoLoadStrings

Loads strings from a resource file for use by the VDA tools.

WoMenuBar

Create a menu bar for a VDA Tool.

WoMenuBarSetSensitivity

Sets the sensitivity of one or more items in a menu.

WoMenuBarSetToggle

Sets the status of a menu toggle button.

WoMessage

Creates a message area for a VDA Tool

WoSaveAsPixmap

Saves graphics from a specified VDA Tool as a pixmap.

WoSetCursor

Changes the cursor for a VDA Tool.

WoSetToolIcon

Assigns a pixmap to be the icon for a VDA Tool.

WoSetWindowTitle

Specifies a unique title for a VDA Tool window.

WoStatus

Create a status bar for a VDA Tool.

WoVariableOptionMenu

Creates an option menu containing the names of all of the variables associated with the current tool.

WoVariableOptionMenuGetValue

Gets the currently selected variable name from an option menu that was created with the WoVariableOptionMenu function.

WoVariableOptionMenuSetValue

Sets the current selection in the variable option menu.

WAVE Widgets Routines

WwAlert

Creates a modal (blocking) or modeless (non-blocking) popup alert box containing a message and optional control buttons.

WwAlertPopdown

Destroys an alert box.

WwButtonBox

Creates horizontal or vertical box containing push buttons.

WwCallback

Adds or removes a WAVE Widgets callback.

WwCommand

Creates a command window.

WwControlsBox

Creates a box containing sliders.

WwDialog

Creates a blocking or nonblocking dialog box.

WwDrawing

Creates a drawing area, which allows users to display graphics generated by PV‑WAVE.

WwFileSelection

Creates a file selection widget, which lets the user display the contents of directories and select files.

WwGenericDialog

Creates a generic dialog box that can be filled with custom widgets.

WwGetButton

Obtains the index of a pressed or released button passed as an event structure by a WAVE Widgets event handler.

WwGetKey

Obtains the ASCII value of a pressed or released key passed as an event structure by a WAVE Widgets event handler.

WwGetPosition

Obtains the coordinates of a selected point inside a widget. The selected point coordinates are passed in an event structure by a WAVE Widgets event handler.

WwGetValue

Returns a specific value for a given widget.

WwHandler

Adds or removes a WAVE Widgets event handler from a widget.

WwInit

Initializes the WAVE Widgets environment, opens the display, creates the first top-level shell, and creates a layout widget.

WwLayout

Creates a layout widget that is used to control the arrangement of other widgets.

WwList

Creates a scrolling list widget.

WwListUtils

Manages the contents of a list widget.

WwLoop

Handles the dispatching of events and calling of PV‑WAVE callbacks.

WwMainWindow

Creates a top-level window and a layout widget.

WwMenuBar

Creates a menu bar.

WwMenuItem

Adds, modifies, or deletes specified menu items.

WwMessage

Creates a blocking or nonblocking message box.

WwMultiClickHandler

Adds or removes a multi-click event handler.

WwOptionMenu

Creates an option menu.

WwPickFile

Creates a modal file selection dialog that blocks until a file name has been selected.

WwPopupMenu

Creates a popup menu.

WwPreview

Creates an ASCII data preview widget.

WwPreviewUtils

Manages the contents of a preview widget.

WwRadioBox

Creates a box containing radio buttons.

WwResource

Queries, creates, saves, or modifies the widget resource database.

WwSeparator

Creates a horizontal or vertical line that separates components in a graphical user interface.

WwSetCursor

Sets the cursor for a widget.

WwSetValue

Sets the specified value for a given widget.

WwTable

Creates an editable 2D array of cells containing string data, similar to a spreadsheet.

WwTableUtils

Manages the contents of a table widget.

WwText

Creates a text widget that can be used for both single-line text entry or as a full text editor. In addition, this function can create a static text label.

WwTimer

Registers a WAVE Widgets timer procedure.

WwToolBox

Creates an array of graphic buttons (icons).

Widget Toolbox Routines

WtAddCallback

Registers a PV‑WAVE callback routine for a given widget.

WtAddHandler

Registers the X event handler function for a given widget.

WtClose

Closes the current Xt (Motif) session, and destroys all children of the top-level widget created in WtInit. This routine can also be used to destroy additional widget trees.

WtCreate

Creates a widget or shell instance specified by widget class.

WtCursor

Sets or changes the cursor.

WtGet

Retrieves widget resources.

WtInit

Initializes the Widget Toolbox and the Xt toolkit, opens the display, and creates the first top-level shell.

WtInput

Registers a PV‑WAVE input source handler procedure.

WtList

Controls the characteristics of scrolling list widgets.

WtLookupString

Maps a KeyPress or KeyRelease event to its KeyEvent structure (and optionally, to its Keysym) when a user presses a key.

WtLoop

Handles the dispatching of events and calling of PV‑WAVE callback routines.

WtMainLoop

Handles the dispatching of events.

WtPointer

The pointer utility function.

WtPreview

Handles utility functions for the preview widget (XvnPreview).

WtProcessEvent

Handles the dispatching of a Widget Toolbox event.

WtResource

Queries, creates, saves, or modifies the widget resource database.

WtSet

Sets widget resources.

WtTable

Modifies an xbaeMatrix class widget.

WtTimer

Registers a callback function for a given timer.

WtWorkProc

Registers a PV‑WAVE work procedure for background processing.