RTOGGLE Gadget
- Last UpdatedNov 07, 2024
- 2 minute read
Members
|
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 (grayed-in) status. |
|
callback |
STRING Get/Set |
Callback string. |
|
tag |
STRING Get/Set |
Tag text. |
Methods
|
Name |
Result |
Purpose |
|---|---|---|
|
FullName( ) |
STRING |
Get the full gadget name, for example, '!!Form.gadget'. |
|
Name( ) |
STRING |
Get the gadget's name, for example, 'gadget'. |
|
Owner( ) |
FORM |
Get owning form. |
|
SetPopup( MENU ) |
NO RESULT |
Links the given menu with the gadget as a pop-up. |
|
RemovePopup( MENU ) |
NO RESULT |
Removes the given pop-up menu from the gadget. |
|
GetPickedPopup( ) |
MENU |
Returns the last picked pop-up 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 Color Name. Some gadgets do not support this property in all circumstances, for example, gadgets which are showing a pixmap. Gadgets whose color has not been set explicitly may not have a color with a known colorname. In this case, an error is raised. |
Command
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 you select 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 'selected' or 'unselected'.
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.