PMultiCheckBox

(Dialog Library)

Description:	Tool used to display the standard set of check boxes. Commonly used in the Owner tab of a configuration folder.
Returns:	Nothing
Usage:	Steady State only.
Function Groups:	Graphics
Related to:	GUITransform | PAddressEntry | PAlmPriority | PAreaSelect | PCheckBox | PColorEdit | PColorSelect | PContributor | PDroplist | PEditField | PEditName | PFileChooser | PHSliderBar | PHueSelect | PImageSelect | PIPAddressList | PIPListenerGroup | PPageSelect | PPhraseEdit | PRadioButtons | PSecBit | PSelectObject | PServerListName | PSpinbox | PTimeZone | PTypeToggle | SiteDispParms
Format:	\DialogLibrary.PMulticheck box(ParmNum [, LeftToRight, CheckBoxLabels, ID, DrawBevel, Label, BitOffset])
Parameters:

ParmNum

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

LeftToRight

Required. If TRUE, order from left to right. If FALSE, order from top to bottom.

CheckBoxLabels

Required. An array of labels for the checkboxes.

ID

Starting with FocusID with one for each checkbox. Boolean. If this value is FALSE (0), the field will display its current setting, but cannot be opened (i.e. its value cannot be changed), and will appear disabled (grayed-out).

DrawBevel

Optional Boolean expression that when set to TRUE, causes a bevel to be drawn around the control. Default: False

Label

Required. A text expression to be used as a label for the checkboxes.

BitOffset

Offset at which to start the bit setting.

Comments:

This module is a member of the VTScada Dialog Library and must therefore be called from within a GUITransform and prefaced by \DialogLibrary.. The "P" tools (Pcheck box, PContributor, PColorSelect, PDroplist, and PEditfield) were intended only for use in configuration folders and drawing panel modules, and therefore are subject to the system security restraints. This parameter tool expects the first parameter of its calling module to contain an array of tag parameters.

Example:

{ Variable declarations }
[

...

  CheckboxItemLabels          { Array of labels for options checkboxes        };
  PROTECTED HavePrivs         { TRUE if user has tag modify priv              };

...

]

...

{ InitState }
InitConfigFolder [
  If 1 SwitchTab;
  [

...


    CheckboxItemLabels      = New(4);

...

  ]
]

...

{ TabState }
OptionsState [

...

  { PMultiCheckboxes don't check configure priv }
  HavePrivs = \SecurityManager\SecurityCheck(\SecurityManager\PrivBitTagModify, 1);

...

  { Tag options settings }
  CheckboxItemLabels[0] = GetPhrase("Option 1");
  CheckboxItemLabels[1] = GetPhrase("Option 2");
  CheckboxItemLabels[2] = GetPhrase("Option 3");
  CheckboxItemLabels[3] = GetPhrase("Option 4");
  GUITransform(40, 308, WIDTH/2 - 10, 220,
               1, 1, 1, 1, 1            { No scaling                     },
               0, 0, 1, 0               { No movement; visible; reserved },
               0, 0, 0                  { Not selectable                 },
               \DialogLibrary\PMultiCheckBox(\#Options, 0, CheckboxItemLabels,
                                             HavePrivs ? 1 { to 4 } : 0, 0, Invalid, 0));
]