RTOGGLE Gadget

Software Customisation Reference Manual

Summary of Objects, Members and Methods : Object Type Details : RTOGGLE Gadget


Name	Result	Purpose
val	BOOLEAN Get/Set	Current value true or false.
index	REAL Get Only	Index of radio button within the group.
onVal	STRING Get/Set	Associated selected value.
offVal	STRING Get/Set	Associated unselected value.
visible	BOOLEAN Get/Set	Visibility.
active	BOOLEAN Get/Set	Active (greyed-in) status.
callback	STRING Get/Set	Callback string.
tag	STRING Get/Set	Tag text.

Table 2: 107.

RTOGGLE Object Members


Name	Result	Purpose
FullName( )	STRING	Get the full gadget name, e.g.'!!Form.gadget'.
Name( )	STRING	Get the gadget's name, e.g. 'gadget'.
Owner( )	FORM	Get owning form.
SetPopup( MENU )	NO RESULT	Links the given menu with the gadget as a popup.
RemovePopup( MENU )	NO RESULT	Removes the given popup menu from the gadget.
GetPickedPopup( )	MENU	Returns the last picked popup menu for the gadget.
Refresh( )	NO RESULT	Refreshes the display of the gadget.
Shown( )	BOOLEAN	Get ‘shown’ status.
SetToolTip( STRING )	NO RESULT	Sets or edits the text of the TOOLTIP.
Type( )	STRING	Get the gadget type as a string.
Background()	STRING	Get Background Colour Name. Some gadgets do not support this property in all circumstances, e.g. gadgets which are showing a pixmap. Gadgets whose colour has not been set explicitly, may not have a colour with a known colourname. In this case an error is raised..

Table 2: 108.

RTOGGLE Object Methods

The RTOGGLE gadget (which is very similar to the TOGGLE gadget) is allowed only within FRAMES. You can added them to a FRAME with the usual positioning and layout commands. The RTOGGLE gadgets are implicitly numbered 1,2,3… as they are added.

The FRAME gadget can have an assigned callback, which is executed when the radio group selection is changed, i.e. whenever the user selects an unselected radio-toggle. As there is only a SELECT action supported, it can be either a simple callback or an open callback.


.-------<------------. / \| >- RTOGgle gname -+- tagtext ------------\| +- CALLback text —-----\| +- <fgpos> ------------\| +- <fganch> -----------\| +- TOOLTIP text -------\| +- CORE ---------------* Core managed gadget \| +- STATES offval onval . ‘----------------------+- TOOLTIP text -. ‘----------------‘--->

Note:

offval and onval are string values associated with the radio button states unselected or selected.
Default values are onval = ‘ON’, offval = ‘OFF’.

In order to simplify the task of replacing the use of the (now removed) RADIO gadget by the radio group Frame gadget, the RTOGGLE gadget’s UNSELECT events are raised only if a PML open callback has been defined. This allows the simple replacement of TOGGLE gadgets by RTOGGLE gadgets without the need to modify their callbacks.

1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.