PRadioButtons

(VTS Library)

Description: Parameter Setting Radio Buttons. This module draws a set of labeled radio buttons with (optional) title and border.

Returns: Nothing

Usage: Steady State

Format: \DialogLibrary\PRadioButtons(ParmNum, FocusID, Border, Title, BtnsOnLeft, AlignTitle, L1 [, L2, ..., L16])

Parameters: ParmNum { numeric } { required } { no default: }

Any numeric expression giving the parameter number (from 0) in the caller to alter.

FocusID { numeric } { optional } { default: see note }

An optional parameter that is any numeric expression for the focus number of the first radio button; each radio button following will have a focus ID number equal to the next number in sequence. If this value is 0, the radio buttons will display the current setting of the parameter, but its value will not be able to be changed and the buttons will appear grayed out.

If this parameter is omitted or invalid, the next available focus ID will be assigned.

Border { Boolean } { optional } { no default: }

An optional parameter that is any logical expression; if true (non-0) the buttons will have a raised border, if false (0) there will be no border around the buttons.

Title { text } { optional } { default: "" }

An optional parameter that is any text expression to be used as a title with the radio buttons. The default value is to have no title.

BtnsOnLeft { Boolean } { optional } { default: TRUE }

An optional parameter that is any logical expression; if true (non-0) the radio buttons will appear to the left of their labels, if false (0) they will be to the right. The default value is true.

AlignTitle { Boolean } { optional } { default: TRUE }

An optional parameter that is any logical expression; if true (non-0) the title is drawn within the radio buttons' boundaries, if false(0) the buttons fill their bounding area and the title is added at the top (i.e. it extends past the top boundary). The default is true.

L1, L2, ...L16 { text } { optional } { no default: }

A list or an array of text expressions used to label the buttons. The number of labels determines the number of buttons. If the first parameter in this list is of type array, the labels are taken from this array and no other parameter can follow. If the first parameter is not an array, there must be at least one other parameter (label) following this one, but all others are optional, up to a total of 16 label parameters.

Comments: This module is a member of the VTS Dialog Library and must therefore be called from within a GUITransform and prefaced by \DialogLibrary\.

This parameter tool expects the first parameter of its calling module to contain an array of tag parameters. It will then set the element indicated by ParmNum to the selected item.

The boundaries of the calling transform define the outline of the buttons including their border, if there is one; if the area is too small to fully display the buttons they will extend beyond their right and bottom boundaries. Buttons and their border will never overlap each other and will always be shown in their entirety, although the labels may be clipped or entirely deleted.

For any optional parameter that is to be set, all optional parameters preceding the desired one must be present, although they may be invalid.

Example:

GUITransform(50, 400, 450, 100,

1, 1, 1, 1, 1,

0, 0, 1, 0,

0, 0, 0,

\DialogLibrary\PRadioButtons(7 { Parm num },

2 { Focus ID },

1 { Draw a border },

"" { No title required },

0 { Buttons on right },

Invalid { Not req'd (no title) },

"On", "Off", "Reverse", "Out of Service"

{ Labels }));